Feat: S3 파일 업로드 베이스 코드 구현

build.gradle

@@ -25,14 +25,20 @@ repositories {
 
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
-//    implementation 'org.springframework.boot:spring-boot-starter-security'
     implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
     implementation 'org.springframework.boot:spring-boot-starter-web'
-//    implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity6'
+    //implementation 'org.springframework.boot:spring-boot-starter-security'
+    //implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity6'
     // https://mvnrepository.com/artifact/io.github.cdimascio/dotenv-java
     implementation group: 'io.github.cdimascio', name: 'dotenv-java', version: '3.0.0'
     // https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui
-    implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.6.0'
+    implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.7.0'
+    // https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-aws
+    implementation group: 'org.springframework.cloud', name: 'spring-cloud-starter-aws', version: '2.2.6.RELEASE'
+    implementation 'javax.xml.bind:jaxb-api:2.3.1'
+    implementation 'com.sun.xml.bind:jaxb-core:2.3.0.1'
+    implementation 'com.sun.xml.bind:jaxb-impl:2.3.3'
+
     compileOnly 'org.projectlombok:lombok'
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
     runtimeOnly 'com.mysql:mysql-connector-j'
@@ -41,7 +47,7 @@ dependencies {
 
     implementation 'com.h2database:h2'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
-//    testImplementation 'org.springframework.security:spring-security-test'
+    //testImplementation 'org.springframework.security:spring-security-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }
 

src/main/java/com/seveneleven/devlens/global/config/S3Config.java

@@ -0,0 +1,31 @@
+package com.seveneleven.devlens.global.config;
+
+import com.amazonaws.auth.AWSStaticCredentialsProvider;
+import com.amazonaws.auth.BasicAWSCredentials;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.AmazonS3ClientBuilder;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class S3Config {
+    //application.properties에 있는 변수 값을 가져옴
+    @Value("${cloud.aws.credentials.access-key}")
+    private String accessKey;
+
+    @Value("${cloud.aws.credentials.secret-key}")
+    private String secretKey;
+
+    @Value("${cloud.aws.region.static}")
+    private String region;
+
+    @Bean
+    public AmazonS3 amazonS3Client() {
+        BasicAWSCredentials awsCredentials = new BasicAWSCredentials(accessKey, secretKey);
+        return AmazonS3ClientBuilder.standard()
+                .withRegion(region)
+                .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
+                .build();
+    }
+}

src/main/java/com/seveneleven/devlens/global/exception/BusinessException.java

@@ -2,7 +2,6 @@
 
 import com.seveneleven.devlens.global.response.ErrorCode;
 import lombok.Getter;
-import org.springframework.http.HttpStatus;
 
 @Getter
 public class BusinessException extends RuntimeException {

src/main/java/com/seveneleven/devlens/global/exception/GlobalExceptionHandler.java

@@ -13,6 +13,7 @@ public class GlobalExceptionHandler {
 
     @ExceptionHandler(BusinessException.class)
     public ResponseEntity<APIResponse<?>> handleBusinessException(BusinessException e) {
+        e.printStackTrace();
         return ResponseEntity
                 .status(e.getErrorCode().getStatus())
                 .body(APIResponse.fail(e.getErrorCode()));

src/main/java/com/seveneleven/devlens/global/response/APIResponse.java

@@ -29,6 +29,7 @@ public static <T> APIResponse<T> success(SuccessCode code, String message, T dat
         return new APIResponse<>(code.getStatusCode(), message, data);
     }
 
+    //실패
     public static <T> APIResponse<T> fail(ErrorCode code){
         return new APIResponse<>(code.getStatusCode(), code.getMessage(), null);
     }
@@ -37,6 +38,7 @@ public static <T> APIResponse<T> fail(ErrorCode code, String message) {
         return new APIResponse<>(code.getStatusCode(), message, null);
     }
 
+    //생성
     public static <T> APIResponse<T> create(int code, String message, T data) {
         return new APIResponse<>(code, message, data);
     }

src/main/java/com/seveneleven/devlens/global/response/ErrorCode.java

@@ -18,7 +18,7 @@ public enum ErrorCode {
 
 
     // 4000번대 코드 : 파일 s3 버킷 업/다운로드 관련
-
+    S3_UPLOAD_FAIL_ERROR(4000, HttpStatus.INTERNAL_SERVER_ERROR, "S3 파일 업로드에 실패했습니다."),
 
     // 5000번대 코드 : 서버 내부 오류 관련
     INTERNAL_SERVER_ERROR(5001, HttpStatus.INTERNAL_SERVER_ERROR, "서버 내부 오류가 발생했습니다."),

src/main/java/com/seveneleven/devlens/global/util/file/FileValidator.java

@@ -0,0 +1,149 @@
+package com.seveneleven.devlens.global.util.file;
+
+import org.springframework.web.multipart.MultipartFile;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public class FileValidator {
+
+    // 파일 카테고리별 허용 파일 포맷
+    private static final Map<String, Set<String>> ALLOWED_EXTENSIONS_BY_CATEGORY = Map.of(
+            "COMPANY_LOGO_IMAGE", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg"),
+            "USER_PROFILE_IMAGE", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg"),
+            "PROJECT_IMAGE", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg"),
+            "POST_ATTACHMENT", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg", ".pdf", ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".txt", ".zip", ".7z", ".rar", ".tar"),
+            "CHECK_REQUEST_ATTACHMENT", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg", ".pdf", ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".txt", ".zip", ".7z", ".rar", ".tar"),
+            "CHECK_REJECTION_ATTACHMENT", Set.of(".png", ".jpg", ".jpeg", ".gif", ".webp", ".svg", ".pdf", ".doc", ".docx", ".xls", ".xlsx", ".ppt", ".pptx", ".txt", ".zip", ".7z", ".rar", ".tar")
+    );
+
+    // 파일 카테고리별 허용 MIME 타입
+    private static final Map<String, List<String>> ALLOWED_MIME_TYPES_BY_CATEGORY = Map.of(
+            "COMPANY_LOGO_IMAGE", List.of("image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml"),
+            "USER_PROFILE_IMAGE", List.of("image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml"),
+            "PROJECT_IMAGE", List.of("image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml"),
+            "POST_ATTACHMENT", List.of(
+                    //image
+                    "image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml",
+                    //document
+                    "application/pdf", // .pdf
+                    "application/msword", // .doc
+                    "application/vnd.openxmlformats-officedocument.wordprocessingml.document", // .docx
+                    "application/vnd.ms-excel", // .xls
+                    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", // .xlsx
+                    "application/vnd.ms-powerpoint", // .ppt
+                    "application/vnd.openxmlformats-officedocument.presentationml.presentation", // .pptx
+                    "text/plain", // .txt
+                    //zip file
+                    "application/zip", // .zip
+                    "application/x-7z-compressed", // .7z
+                    "application/x-rar-compressed", // .rar
+                    "application/x-tar"         // .tar
+            ),
+            "CHECK_REQUEST_ATTACHMENT", List.of(
+                    //image
+                    "image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml",
+                    //document
+                    "application/pdf", // .pdf
+                    "application/msword", // .doc
+                    "application/vnd.openxmlformats-officedocument.wordprocessingml.document", // .docx
+                    "application/vnd.ms-excel", // .xls
+                    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", // .xlsx
+                    "application/vnd.ms-powerpoint", // .ppt
+                    "application/vnd.openxmlformats-officedocument.presentationml.presentation", // .pptx
+                    "text/plain", // .txt
+                    //zip file
+                    "application/zip", // .zip
+                    "application/x-7z-compressed", // .7z
+                    "application/x-rar-compressed", // .rar
+                    "application/x-tar"         // .tar
+            ),
+            "CHECK_REJECTION_ATTACHMENT", List.of(
+                    //image
+                    "image/png", "image/jpeg", "image/gif", "image/webp", "image/svg+xml",
+                    //document
+                    "application/pdf", // .pdf
+                    "application/msword", // .doc
+                    "application/vnd.openxmlformats-officedocument.wordprocessingml.document", // .docx
+                    "application/vnd.ms-excel", // .xls
+                    "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", // .xlsx
+                    "application/vnd.ms-powerpoint", // .ppt
+                    "application/vnd.openxmlformats-officedocument.presentationml.presentation", // .pptx
+                    "text/plain", // .txt
+                    //zip file
+                    "application/zip", // .zip
+                    "application/x-7z-compressed", // .7z
+                    "application/x-rar-compressed", // .rar
+                    "application/x-tar"         // .tar
+            )
+    );
+
+    private static final long MAX_FILE_SIZE = 20 * 1024 * 1024; // 20MB 제한
+
+    /**
+     * 파일 전체 검증 메서드
+     *
+     * @param file        업로드된 파일
+     * @param fileCategory 파일 카테고리
+     */
+    public static void validateFile(MultipartFile file, String fileCategory) {
+        if (file == null || file.isEmpty()) {
+            throw new IllegalArgumentException("File cannot be null or empty.");
+        }
+
+        String fileName = file.getOriginalFilename();
+        if (fileName == null || fileName.isBlank()) {
+            throw new IllegalArgumentException("Filename cannot be null or empty.");
+        }
+
+        validateFileCategory(fileCategory); // 파일 카테고리 검증
+        validateFileExtension(fileName, fileCategory); // 파일 확장자 검증
+        validateMimeType(file.getContentType(), fileCategory); // MIME 타입 검증
+        //validateFileSize(file.getSize()); // 파일 크기 검증
+    }
+
+    /**
+     * 파일 카테고리 검증
+     */
+    private static void validateFileCategory(String fileCategory) {
+        if (fileCategory == null || fileCategory.isBlank()) {
+            throw new IllegalArgumentException("File category cannot be null or blank.");
+        }
+        if (!ALLOWED_EXTENSIONS_BY_CATEGORY.containsKey(fileCategory)) {
+            throw new IllegalArgumentException("Invalid file category: " + fileCategory);
+        }
+    }
+
+    /**
+     * 파일 확장자 검증
+     */
+    private static void validateFileExtension(String fileName, String fileCategory) {
+        String fileExtension = fileName.substring(fileName.lastIndexOf(".")).toLowerCase();
+        Set<String> allowedExtensions = ALLOWED_EXTENSIONS_BY_CATEGORY.get(fileCategory);
+
+        if (allowedExtensions == null || !allowedExtensions.contains(fileExtension)) {
+            throw new IllegalArgumentException("Invalid file extension for category: " + fileCategory);
+        }
+    }
+
+    /**
+     * MIME 타입 검증
+     */
+    private static void validateMimeType(String mimeType, String fileCategory) {
+        List<String> allowedMimeTypes = ALLOWED_MIME_TYPES_BY_CATEGORY.get(fileCategory);
+
+        if (allowedMimeTypes == null || !allowedMimeTypes.contains(mimeType)) {
+            throw new IllegalArgumentException("Invalid file type for category: " + fileCategory);
+        }
+    }
+
+    /**
+     * 파일 크기 검증
+     */
+    private static void validateFileSize(long fileSize) {
+        if (fileSize > MAX_FILE_SIZE) {
+            throw new IllegalArgumentException("File size exceeds limit of 10MB.");
+        }
+    }
+}

src/main/java/com/seveneleven/devlens/global/util/file/Service/FileService.java

@@ -0,0 +1,80 @@
+package com.seveneleven.devlens.global.util.file.Service;
+
+import com.seveneleven.devlens.global.exception.BusinessException;
+import com.seveneleven.devlens.global.response.ErrorCode;
+import com.seveneleven.devlens.global.util.file.FileValidator;
+import com.seveneleven.devlens.global.util.file.dto.FileMetadataDto;
+import com.seveneleven.devlens.global.util.file.entity.FileMetadata;
+import com.seveneleven.devlens.global.util.file.repository.FileMetadataRepository;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+import org.springframework.web.multipart.MultipartFile;
+
+import java.time.LocalDateTime;
+
+@Service
+@RequiredArgsConstructor
+public class FileService {
+    private final FileMetadataRepository fileMetadataRepository;
+    private final S3ClientService s3ClientService;
+
+    /**
+     * 1. 파일 업로드
+     * @param file 업로드할 파일
+     * @param uploaderId 업로더 id
+     * @param fileCategory 파일 카테고리
+     * @param referenceId 파일 참조 ID
+     * @return FileMetadataDto 업로드한 파일 메타데이터
+     */
+    @Transactional
+    public FileMetadataDto uploadFile(MultipartFile file, Long uploaderId, String fileCategory, Long referenceId) throws Exception {
+        //1. 파일 검증
+        FileValidator.validateFile(file, fileCategory);
+
+        //2. 고유 파일 이름(UUID) 및 S3 키 생성
+        //파일명이 없거나 비어있으면 Unknown-File로 설정
+        String originalFilename = (file.getOriginalFilename() != null && !file.getOriginalFilename().isBlank())
+                ? file.getOriginalFilename() : "Unknown-File";
+        //UUID 생성
+        String uniqueFileName = s3ClientService.generateUniqueFileName(originalFilename);
+        //S3 키 생성
+        String s3Key = s3ClientService.generateS3Key(uploaderId, fileCategory, uniqueFileName);
+
+        //3. S3 업로드 및 FileMetadata 데이터 생성
+        String filePath = null;
+        try{
+            //S3 업로드
+            filePath = s3ClientService.uploadFile(file, s3Key);
+
+            //업로드하는 파일 메타데이터 생성
+            FileMetadata metadata = FileMetadata.builder()
+                    .fileCategory(fileCategory)
+                    .fileDisplayTitle(file.getOriginalFilename())
+                    .fileTitle(uniqueFileName)
+                    .writtenBy(uploaderId) //TODO) Audit
+                    .writtenAt(LocalDateTime.now()) //TODO) Audit
+                    .contentType(file.getContentType())
+                    .fileFormat(file.getOriginalFilename().substring(originalFilename.lastIndexOf('.') + 1))
+                    .fileSize(file.getSize() / 1024.0) // KB
+                    .filePath(filePath)
+                    .referenceId(referenceId) // 필요 시 설정
+                    .createdBy(1L) //TODO) Audit
+                    .createdAt(LocalDateTime.now()) //TODO) Audit
+                    .build();
+
+            //FileMetaData 저장
+            FileMetadata savedMetadata = fileMetadataRepository.save(metadata);
+
+            //DTO로 변환 후 반환
+            return FileMetadataDto.toDto(savedMetadata);
+
+        } catch (Exception e){
+            //저장 실패시 S3에서 삭제
+            s3ClientService.deleteFile(s3Key);
+
+            throw new BusinessException(e.getMessage(), ErrorCode.S3_UPLOAD_FAIL_ERROR);
+        }
+    }
+
+}