Merge pull request #12 from 6QuizOnTheBlock/setting

Feature/seeting 10, 11 GlobalException Setting & S3 Setting

backEnd/build.gradle

@@ -43,6 +43,9 @@ dependencies {
     runtimeOnly 'com.mysql:mysql-connector-j'
     implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0'
 
+    // aws
+    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
+
     //querydsl
     implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
     annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"

backEnd/src/main/java/com/quiz/ourclass/global/config/AWSS3Config.java

@@ -0,0 +1,40 @@
+package com.quiz.ourclass.global.config;
+
+import com.amazonaws.auth.AWSStaticCredentialsProvider;
+import com.amazonaws.auth.BasicAWSCredentials;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.AmazonS3Client;
+import com.amazonaws.services.s3.AmazonS3ClientBuilder;
+import com.quiz.ourclass.global.util.AwsS3ObjectStorage;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class AWSS3Config {
+
+    @Value("${cloud.aws.s3.bucket}")
+    private String bucket;
+    @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 AmazonS3Client amazonS3Client() {
+        BasicAWSCredentials awsCredentials = new BasicAWSCredentials(accessKey, secretKey);
+        return (AmazonS3Client) AmazonS3ClientBuilder.standard()
+            .withRegion(region)
+            .withCredentials(new AWSStaticCredentialsProvider(awsCredentials))
+            .build();
+    }
+
+    @Bean
+    public AwsS3ObjectStorage awsS3ObjectStorageUpload(AmazonS3 amazonS3) {
+        AwsS3ObjectStorage awsS3ObjectStorageUpload = new AwsS3ObjectStorage(amazonS3);
+        awsS3ObjectStorageUpload.setBucket(bucket);
+        return awsS3ObjectStorageUpload;
+    }
+}

backEnd/src/main/java/com/quiz/ourclass/global/dto/ApiResponse.java

@@ -0,0 +1,21 @@
+package com.quiz.ourclass.global.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+public class ApiResponse<T> {
+
+    private String status;
+    private String message;
+    private T data;
+
+    public static <T> ApiResponse<T> success(T data) {
+        return new ApiResponse<>("success", "성공ㅋ", data);
+    }
+
+    public static <T> ApiResponse<T> fail(String message) {
+        return new ApiResponse<>("fail", message, null);
+    }
+}

backEnd/src/main/java/com/quiz/ourclass/global/exception/ErrorCode.java

@@ -0,0 +1,17 @@
+package com.quiz.ourclass.global.exception;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+@AllArgsConstructor
+public enum ErrorCode {
+    //domain
+    FILE_NOT_FOUND(HttpStatus.NOT_FOUND, "파일이 존재하지 않습니다."),
+    AWS_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "AWS 서버 에러입니다.");
+
+
+    private final HttpStatus status;
+    private final String message;
+}

backEnd/src/main/java/com/quiz/ourclass/global/exception/GlobalException.java

@@ -0,0 +1,17 @@
+package com.quiz.ourclass.global.exception;
+
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+public class GlobalException extends RuntimeException {
+
+    private final ErrorCode errorCode;
+    private final HttpStatus status;
+
+    public GlobalException(ErrorCode errorCode) {
+        super(errorCode.getMessage());
+        this.status = errorCode.getStatus();
+        this.errorCode = errorCode;
+    }
+}

backEnd/src/main/java/com/quiz/ourclass/global/exception/GlobalExceptionHandler.java

@@ -0,0 +1,28 @@
+package com.quiz.ourclass.global.exception;
+
+import com.quiz.ourclass.global.dto.ApiResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+@RequiredArgsConstructor
+public class GlobalExceptionHandler {
+
+    private static final HttpHeaders jsonHeaders;
+
+    static {
+        jsonHeaders = new HttpHeaders();
+        jsonHeaders.add(HttpHeaders.CONTENT_TYPE, "application/json");
+    }
+
+    @ExceptionHandler(GlobalException.class)
+    public ResponseEntity<ApiResponse<Object>> handleGlobalException(
+        GlobalException globalException) {
+        ApiResponse<Object> response = ApiResponse.fail(
+            globalException.getErrorCode().getMessage());
+        return new ResponseEntity<>(response, jsonHeaders, globalException.getStatus());
+    }
+}

backEnd/src/main/java/com/quiz/ourclass/global/util/AwsS3ObjectStorage.java

@@ -0,0 +1,61 @@
+package com.quiz.ourclass.global.util;
+
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.model.ObjectMetadata;
+import com.quiz.ourclass.global.exception.ErrorCode;
+import com.quiz.ourclass.global.exception.GlobalException;
+import java.io.IOException;
+import java.net.URL;
+import java.util.UUID;
+import lombok.Data;
+import lombok.extern.log4j.Log4j2;
+import org.springframework.web.multipart.MultipartFile;
+
+@Log4j2
+@Data
+public class AwsS3ObjectStorage {
+
+    private AmazonS3 amazonS3; //AmazonS3 config 미리 빈 주입
+    private String bucket; //빈 주입 시 setter
+    private String aiS3Url; //빈 주입 시 setter
+
+    public AwsS3ObjectStorage(AmazonS3 amazonS3) {
+        this.amazonS3 = amazonS3;
+    }
+
+    public String uploadFile(MultipartFile multipartFile) throws IOException {
+        // UUID 이용해 고유한 파일명 생성
+        String originalFileName = multipartFile.getOriginalFilename();
+        String fileName = UUID.randomUUID() + "_" + originalFileName;
+
+        ObjectMetadata metadata = new ObjectMetadata();
+        metadata.setContentLength(multipartFile.getSize());
+        metadata.setContentType(multipartFile.getContentType());
+
+        amazonS3.putObject(bucket, fileName, multipartFile.getInputStream(), metadata);
+        return amazonS3.getUrl(bucket, fileName).toString();
+    }
+
+    public int deleteFile(String fileUrl) {
+        try {
+            // URL에서 객체 키 추출
+            URL url = new URL(fileUrl);
+            // URL의 첫 번째 '/'를 제거하여 객체 키 얻기
+            String key = url.getPath().substring(1);
+
+            // 파일 존재 여부 확인
+            if (amazonS3.doesObjectExist(bucket, key)) {
+                // S3에서 파일 삭제
+                amazonS3.deleteObject(bucket, key);
+                log.info("File deleted successfully: {}", key);
+                return 1;
+            } else { // file not found
+                log.warn("File not found: {}", key);
+                throw new GlobalException(ErrorCode.FILE_NOT_FOUND);
+            }
+        } catch (Exception e) { //error
+            log.error("Failed to delete file!: {}", fileUrl, e);
+            throw new GlobalException(ErrorCode.AWS_SERVER_ERROR);
+        }
+    }
+}

backEnd/src/main/resources/application.yml

@@ -36,4 +36,18 @@ springdoc:
     path: /swagger-ui.html
     tags-sorter: alpha            # alpha: 알파벳 순 태그 정렬, method: HTTP Method 순 정렬
     operations-sorter: alpha      # alpha: 알파벳 순 태그 정렬, method: HTTP Method 순 정렬
-    display-request-duration: true
+    display-request-duration: true
+
+#aws s3 bucket
+cloud:
+  aws:
+    s3:
+      bucket: ulvanbucket
+    credentials:
+      access-key: AKIAQSCG2TLXCKNPB5FO
+      secret-key: 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
+    region:
+      static: ap-northeast-2
+      auto: false
+    stack:
+      auto: false