Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: PresignedUrl을 사용하여 이미지 업로드 기능 구현 #106

Merged
merged 24 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from 19 commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
d50d0ec
chore: endpoint 값 추가하여 config 수정
kdomo Jan 4, 2024
3d431ae
feat: 미션 기록 이미지 Presigned URL 생성
kdomo Jan 5, 2024
a19d76a
feat: 미션 기록 이미지 업로드 완료 처리
kdomo Jan 5, 2024
80c0352
chore: storage.yml에 endpoint 환경변수 추가
kdomo Jan 5, 2024
483c514
test: Test 코드 추가
kdomo Jan 5, 2024
b515665
style: spotless
kdomo Jan 5, 2024
1975f39
refactor: storage 저장 디렉토리 변경
kdomo Jan 8, 2024
b359a3a
feat: MissionRecord 도메인 uploadStatus validation 예외처리
kdomo Jan 8, 2024
8ead3bc
refactor: 해당 미션이 접속한 유저와 일치하지 않을때 예외 발생추가
kdomo Jan 8, 2024
656ce44
style: spotless
kdomo Jan 8, 2024
668b7d3
test: test코드 추가와 예외처리 변경
kdomo Jan 8, 2024
452a25f
style: spotless
kdomo Jan 8, 2024
7d7f513
remove: 사용하지 않는 에러 제거
kdomo Jan 8, 2024
536ee49
style: ImageController Swagger Tag 넘버링
kdomo Jan 9, 2024
cfbc205
refactor: ImageController RequestMapping 제거
kdomo Jan 9, 2024
ee79c30
refactor: Transactional 클래스레벨로 추출
kdomo Jan 9, 2024
903082f
style: spotless
kdomo Jan 9, 2024
89889b9
test: ImageController RequestMapping 제거 후 테스트코드 수정
kdomo Jan 9, 2024
d7b58a9
remove: .gitkeep 삭제
kdomo Jan 9, 2024
adba0ed
refactor: 메소드 네이밍 변경
kdomo Jan 10, 2024
c0f2905
refactor: MISSION_RECORD_USER_MISMATCH Service 레이어로 추출
kdomo Jan 10, 2024
4b03da5
Merge branch 'develop' into feature/101-presigned-url-image-upload
kdomo Jan 10, 2024
eda01ec
style: conflict 해결
kdomo Jan 10, 2024
cb9cfa3
style: spotless
kdomo Jan 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tag 값에 이미지 Numbering 4로 변경 가능하실까요??
아니면 나중에 응원하기, 팔로우와 같이 도메인이 계속 생길 때 순서도 다같이 얘기 해보면 좋을 거 같아요~

그리고 API 엔드포인트가 {도메인}/image이 아닌 image/{도메인} 으로 되어있어서 이렇게 하신 이유가 궁금해요!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

넘버링 해놓을게용, endpoint는 images제거 하도록 하겠슴니당

Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
package com.depromeet.domain.image.api;

import com.depromeet.domain.image.application.ImageService;
import com.depromeet.domain.image.dto.request.MissionRecordImageCreateRequest;
import com.depromeet.domain.image.dto.request.MissionRecordImageUploadCompleteRequest;
import com.depromeet.domain.image.dto.response.PresignedUrlResponse;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@Tag(name = "4. [이미지]", description = "이미지 관련 API입니다.")
@RestController
@RequiredArgsConstructor
public class ImageController {
private final ImageService imageService;

@Operation(
summary = "미션 기록 이미지 Presigned URL 생성",
description = "미션 기록 이미지 Presigned URL를 생성합니다.")
@PostMapping("/records/upload-url")
public PresignedUrlResponse missionRecordPresignedUrlCreate(
@Valid @RequestBody MissionRecordImageCreateRequest request) {
return imageService.createMissionRecordPresignedUrl(request);
}

@Operation(summary = "미션 기록 이미지 업로드 완료처리", description = "미션 기록 이미지 업로드 완료 시 호출하시면 됩니다.")
@PostMapping("/records/upload-complete")
public void missionRecordUploaded(
@Valid @RequestBody MissionRecordImageUploadCompleteRequest request) {
imageService.uploadCompleteMissionRecord(request);
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

클래스 전체를 @Transactional 감싸는 것은 어떠실까요??
조회만 하는 서비스 코드 구현 시에는 Trasactional readonly = true로 하는 게 어떨까해서요!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

오 이부분 놓쳤네용 감사함니다

Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
package com.depromeet.domain.image.application;

import com.amazonaws.HttpMethod;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.Headers;
import com.amazonaws.services.s3.model.CannedAccessControlList;
import com.amazonaws.services.s3.model.GeneratePresignedUrlRequest;
import com.depromeet.domain.image.domain.ImageFileExtension;
import com.depromeet.domain.image.domain.ImageType;
import com.depromeet.domain.image.dto.request.MissionRecordImageCreateRequest;
import com.depromeet.domain.image.dto.request.MissionRecordImageUploadCompleteRequest;
import com.depromeet.domain.image.dto.response.PresignedUrlResponse;
import com.depromeet.domain.member.domain.Member;
import com.depromeet.domain.mission.domain.Mission;
import com.depromeet.domain.missionRecord.dao.MissionRecordRepository;
import com.depromeet.domain.missionRecord.domain.MissionRecord;
import com.depromeet.global.error.exception.CustomException;
import com.depromeet.global.error.exception.ErrorCode;
import com.depromeet.global.util.MemberUtil;
import com.depromeet.global.util.SpringEnvironmentUtil;
import com.depromeet.infra.config.storage.StorageProperties;
import java.util.Date;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

@Service
@RequiredArgsConstructor
@Transactional
public class ImageService {
private final MemberUtil memberUtil;
private final SpringEnvironmentUtil springEnvironmentUtil;
private final StorageProperties storageProperties;
private final AmazonS3 amazonS3;
private final MissionRecordRepository missionRecordRepository;

public PresignedUrlResponse createMissionRecordPresignedUrl(
MissionRecordImageCreateRequest request) {
final Member currentMember = memberUtil.getCurrentMember();

MissionRecord missionRecord = findMissionRecordByMissionRecordId(request.missionRecordId());

Mission mission = missionRecord.getMission();
mission.validateUserMismatch(currentMember);

String fileName =
createFileName(
ImageType.MISSION_RECORD,
request.missionRecordId(),
request.imageFileExtension());
GeneratePresignedUrlRequest generatePresignedUrlRequest =
createGeneratePreSignedUrlRequest(
storageProperties.bucket(),
fileName,
request.imageFileExtension().getUploadExtension());

String presignedUrl = amazonS3.generatePresignedUrl(generatePresignedUrlRequest).toString();

missionRecord.updateUploadStatusPending();
return PresignedUrlResponse.from(presignedUrl);
}

private MissionRecord findMissionRecordByMissionRecordId(Long request) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

쿼리 메서드 네이밍 규칙과 비슷하게 findMissionRecordById(Long id) 로 지정하는 편이 나을 것 같습니다

return missionRecordRepository
.findById(request)
.orElseThrow(() -> new CustomException(ErrorCode.MISSION_RECORD_NOT_FOUND));
}

public void uploadCompleteMissionRecord(MissionRecordImageUploadCompleteRequest request) {
final Member currentMember = memberUtil.getCurrentMember();
MissionRecord missionRecord = findMissionRecordByMissionRecordId(request.missionRecordId());

Mission mission = missionRecord.getMission();
mission.validateUserMismatch(currentMember);

String imageUrl =
storageProperties.endpoint()
+ "/"
+ storageProperties.bucket()
+ "/"
+ springEnvironmentUtil.getCurrentProfile()
+ "/"
+ ImageType.MISSION_RECORD.getValue()
+ "/"
+ request.missionRecordId()
+ "/image."
+ request.imageFileExtension().getUploadExtension();
missionRecord.updateUploadStatusComplete(request.remark(), imageUrl);
}

private String createFileName(
ImageType imageType, Long targetId, ImageFileExtension imageFileExtension) {
return springEnvironmentUtil.getCurrentProfile()
+ "/"
+ imageType.getValue()
+ "/"
+ targetId
+ "/image."
+ imageFileExtension.getUploadExtension();
}

private GeneratePresignedUrlRequest createGeneratePreSignedUrlRequest(
String bucket, String fileName, String fileExtension) {
GeneratePresignedUrlRequest generatePresignedUrlRequest =
new GeneratePresignedUrlRequest(bucket, fileName, HttpMethod.PUT)
.withKey(fileName)
.withContentType("image/" + fileExtension)
.withExpiration(getPreSignedUrlExpiration());

generatePresignedUrlRequest.addRequestParameter(
Headers.S3_CANNED_ACL, CannedAccessControlList.PublicRead.toString());

return generatePresignedUrlRequest;
}

private Date getPreSignedUrlExpiration() {
Date expiration = new Date();
var expTimeMillis = expiration.getTime();
expTimeMillis += 1000 * 60 * 30;
expiration.setTime(expTimeMillis);
return expiration;
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

만약 Request 받은 이미지의 확장자가
정의된 3개의 확장자 중에서 존재하지 않으면 어떻게 되나요??

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSON parse error를 응답합니다아
image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

프론트와 이미지 확장자 스펙 논의 필요

Copy link
Member Author

@kdomo kdomo Jan 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(24.01.08) 논의완료
slack논의결과

기존과 같이 JPEG, JPG, PNG로 가면 될 것 같슴니당

Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.depromeet.domain.image.domain;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public enum ImageFileExtension {
JPEG("jpeg"),
JPG("jpg"),
PNG("png"),
;

private final String uploadExtension;
}
14 changes: 14 additions & 0 deletions src/main/java/com/depromeet/domain/image/domain/ImageType.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package com.depromeet.domain.image.domain;

import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor
public enum ImageType {
MISSION_RECORD("mission_record"),
MEMBER_PROFILE("member_profile"),
MEMBER_BACKGROUND("member_background"),
;
private final String value;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package com.depromeet.domain.image.dto.request;

import com.depromeet.domain.image.domain.ImageFileExtension;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;

public record MissionRecordImageCreateRequest(
@NotNull(message = "미션 기록 ID는 비워둘 수 없습니다.")
@Schema(description = "미션 기록 ID", defaultValue = "1")
Long missionRecordId,
@NotNull(message = "이미지 파일의 확장자는 비워둘 수 없습니다.")
@Schema(description = "이미지 파일의 확장자", defaultValue = "JPEG")
ImageFileExtension imageFileExtension) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.depromeet.domain.image.dto.request;

import com.depromeet.domain.image.domain.ImageFileExtension;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

public record MissionRecordImageUploadCompleteRequest(
@NotNull(message = "미션 기록 ID는 비워둘 수 없습니다.")
@Schema(description = "미션 기록 ID", defaultValue = "1")
Long missionRecordId,
@NotNull(message = "이미지 파일의 확장자는 비워둘 수 없습니다.")
@Schema(description = "이미지 파일의 확장자", defaultValue = "JPEG")
ImageFileExtension imageFileExtension,
@Size(max = 200, message = "미션 일지는 20자 이하까지만 입력 가능합니다.") String remark) {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.depromeet.domain.image.dto.response;

import io.swagger.v3.oas.annotations.media.Schema;

public record PresignedUrlResponse(@Schema(description = "Presigned URL") String presignedUrl) {
public static PresignedUrlResponse from(String presignedUrl) {
return new PresignedUrlResponse(presignedUrl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
import com.depromeet.domain.common.model.BaseTimeEntity;
import com.depromeet.domain.member.domain.Member;
import com.depromeet.domain.missionRecord.domain.MissionRecord;
import com.depromeet.global.error.exception.CustomException;
import com.depromeet.global.error.exception.ErrorCode;
import jakarta.persistence.CascadeType;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
Expand Down Expand Up @@ -115,4 +117,10 @@ public void updateMission(String name, String content, MissionVisibility visibil
this.content = content;
this.visibility = visibility;
}

public void validateUserMismatch(Member member) {
if (!member.getId().equals(this.member.getId())) {
throw new CustomException(ErrorCode.MISSION_RECORD_USER_MISMATCH);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import com.depromeet.domain.common.model.BaseTimeEntity;
import com.depromeet.domain.mission.domain.Mission;
import com.depromeet.global.error.exception.CustomException;
import com.depromeet.global.error.exception.ErrorCode;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.EnumType;
Expand Down Expand Up @@ -77,4 +79,20 @@ public static MissionRecord createMissionRecord(
.mission(mission)
.build();
}

public void updateUploadStatusPending() {
if (this.uploadStatus != ImageUploadStatus.NONE) {
throw new CustomException(ErrorCode.MISSION_RECORD_UPLOAD_STATUS_IS_NOT_NONE);
}
this.uploadStatus = ImageUploadStatus.PENDING;
}

public void updateUploadStatusComplete(String remark, String imageUrl) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이미 COMPLETED 인 경우 다시 완료처리할 수 없도록 예외 발생시키는 게 좋을 것 같습니다

if (this.uploadStatus != ImageUploadStatus.PENDING) {
throw new CustomException(ErrorCode.MISSION_RECORD_UPLOAD_STATUS_IS_NOT_PENDING);
}
this.uploadStatus = ImageUploadStatus.COMPLETE;
this.remark = remark;
this.imageUrl = imageUrl;
}
}
Empty file.
Empty file.
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ public class MissionRecordService {
private final MissionRecordRepository missionRecordRepository;

public Long createMissionRecord(MissionRecordCreateRequest request) {
final Mission mission = findMission(request);
final Mission mission = findMissionByMissionId(request.missionId());
final Member member = memberUtil.getCurrentMember();

Duration duration =
Duration.ofMinutes(request.durationMin()).plusSeconds(request.durationSec());

validateMissionRecordUserMismatch(mission, member);
mission.validateUserMismatch(member);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

현재 로그인한 멤버와 미션을 만든 멤버가 일치하는지까지는 비교할 수 있다고 보지만, 예외를 터트리는 건 미션 엔티티의 책임이 아니라고 보는데 어떻게 생각하시나요?

미션 엔티티는 자신의 상태를 논리적 모순 없이 잘 들고있기만 하면 되는 것이고 그걸 어기게 되는 경우(가령 미션을 만든 멤버가 null인 경우)에만 예외를 발생시켜야 하지 외부 상태에 대해서 예외를 발생시키는 것은 서비스 레이어에서 책임져야할 것 같아요.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ImageService와 MissionRecordService 에서 중복으로 사용되서 Mission으로 빼두었는데,
Mission 엔티티 책임이 아닌거같네용
수정해두겠습니다

validateMissionRecordDuration(duration);

MissionRecord missionRecord =
Expand All @@ -38,18 +38,12 @@ public Long createMissionRecord(MissionRecordCreateRequest request) {
return missionRecordRepository.save(missionRecord).getId();
}

private Mission findMission(MissionRecordCreateRequest request) {
private Mission findMissionByMissionId(Long missionId) {
return missionRepository
.findByMissionId(request.missionId())
.findByMissionId(missionId)
.orElseThrow(() -> new CustomException(ErrorCode.MISSION_NOT_FOUND));
}

private void validateMissionRecordUserMismatch(Mission mission, Member member) {
if (!member.getId().equals(mission.getMember().getId())) {
throw new CustomException(ErrorCode.MISSION_RECORD_USER_MISMATCH);
}
}

private void validateMissionRecordDuration(Duration duration) {
if (duration.getSeconds() > 3600L) {
throw new CustomException(ErrorCode.MISSION_RECORD_DURATION_OVERBALANCE);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,13 @@ public enum ErrorCode {
MISSION_VISIBILITY_NULL(HttpStatus.BAD_REQUEST, "미션 공개 여부가 null입니다."),

// MissionRecord
MISSION_RECORD_NOT_FOUND(HttpStatus.NOT_FOUND, "해당 미션 기록을 찾을 수 없습니다."),
MISSION_RECORD_USER_MISMATCH(HttpStatus.BAD_REQUEST, "미션을 생성한 유저와 로그인된 계정이 일치하지 않습니다"),
MISSION_RECORD_DURATION_OVERBALANCE(HttpStatus.BAD_REQUEST, "미션 참여 시간이 지정 된 시간보다 초과하였습니다"),
MISSION_RECORD_UPLOAD_STATUS_IS_NOT_NONE(
HttpStatus.BAD_REQUEST, "미션 기록의 이미지 업로드 상태가 NONE이 아닙니다."),
MISSION_RECORD_UPLOAD_STATUS_IS_NOT_PENDING(
HttpStatus.BAD_REQUEST, "미션 기록의 이미지 업로드 상태가 PENDING이 아닙니다."),
;

private final HttpStatus status;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.amazonaws.auth.AWSCredentials;
import com.amazonaws.auth.AWSStaticCredentialsProvider;
import com.amazonaws.auth.BasicAWSCredentials;
import com.amazonaws.client.builder.AwsClientBuilder;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3ClientBuilder;
import lombok.RequiredArgsConstructor;
Expand All @@ -19,9 +20,13 @@ public AmazonS3 amazonS3() {
AWSCredentials credentials =
new BasicAWSCredentials(
storageProperties.accessKey(), storageProperties.secretKey());
AwsClientBuilder.EndpointConfiguration endpointConfiguration =
new AwsClientBuilder.EndpointConfiguration(
storageProperties.endpoint(), storageProperties.region());

return AmazonS3ClientBuilder.standard()
.withEndpointConfiguration(endpointConfiguration)
.withCredentials(new AWSStaticCredentialsProvider(credentials))
.withRegion(storageProperties.region())
.build();
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "storage")
public record StorageProperties(String accessKey, String secretKey, String region, String bucket) {}
public record StorageProperties(
String accessKey, String secretKey, String region, String bucket, String endpoint) {}
3 changes: 2 additions & 1 deletion src/main/resources/application-storage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ spring:
storage:
accessKey: ${STORAGE_ACCESS_KEY:}
secretKey: ${STORAGE_SECRET_KEY:}
region: ${STORAGE_REGION:}
bucket: ${STORAGE_BUCKET:}
region: ${STORAGE_REGION:}
endpoint: ${STORAGE_ENDPOINT:https://kr.object.ncloudstorage.com}
Loading