Merge pull request #24 from pjhcsols/BE_J

[BE<-BE_J] S3 CRUD 기능 리팩토링 병합
pjhcsols · Oct 1, 2024 · 773bf40 · 773bf40
2 parents 6b50098 + a81d51f
commit 773bf40
Show file tree

Hide file tree

Showing 5 changed files with 242 additions and 86 deletions.
diff --git a/web3-credential-server/build.gradle b/web3-credential-server/build.gradle
@@ -37,9 +37,11 @@ dependencies {
     testImplementation 'org.assertj:assertj-core:3.20.2'
     implementation 'org.springframework.boot:spring-boot-starter-webflux'
     implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
-    implementation 'software.amazon.awssdk:s3:2.17.84' // 사용하고자 하는 AWS SDK 버전에 맞게 변경
+    implementation 'software.amazon.awssdk:s3:2.17.84'
     implementation group: 'org.apache.pdfbox', name: 'pdfbox', version: '2.0.31'
 
+    //implementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-server'
+
 
 
     testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'

diff --git a/web3-credential-server/build/tmp/compileJava/previous-compilation-data.bin b/web3-credential-server/build/tmp/compileJava/previous-compilation-data.bin
diff --git a/web3-credential-server/src/main/java/web3/s3Storage/controller/S3StorageController.java b/web3-credential-server/src/main/java/web3/s3Storage/controller/S3StorageController.java
@@ -1,5 +1,7 @@
 package web3.s3Storage.controller;
 
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
 import jakarta.persistence.EntityNotFoundException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -8,12 +10,14 @@
 import org.springframework.web.bind.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
 import web3.domain.wallet.Wallet;
+import web3.s3Storage.dto.DeleteCertRequest;
 import web3.s3Storage.dto.DeletePdfRequest;
 import web3.s3Storage.service.S3StorageService;
 import web3.service.wallet.WalletService;
 
 import java.io.IOException;
 import java.util.HashMap;
+import java.util.Map;
 
 @RestController
 @RequestMapping("/api/wallets")
@@ -28,11 +32,17 @@ public S3StorageController(S3StorageService s3StorageService, WalletService wall
         this.walletService = walletService;
     }
 
+    @Operation(summary = "인증서(pdf) 업로드",description = "인증서를 업로드합니다. 즉,s3 스토리지에 pdf 파일을 업로드 합니다.")
     @PostMapping("/upload-pdf")
-    public ResponseEntity<String> uploadPdf(@RequestParam("file") MultipartFile file,
-                                            @RequestParam("walletId") Long walletId,
-                                            @RequestParam String pdfInfo,
-                                            @RequestParam String pdfKey) {
+    public ResponseEntity<String> uploadPdf(
+            @Parameter(description = "업로드할 pdf 파일",required = true)
+            @RequestParam("file") MultipartFile file,
+            @Parameter(description = "사용자 지갑ID",required = true)
+            @RequestParam("walletId") Long walletId,
+            @Parameter(description = "pdf 정보",required = true)
+            @RequestParam String pdfInfo,
+            @Parameter(description = "pdf 키값",required = true)
+            @RequestParam String pdfKey) {
         Wallet wallet = walletService.getWalletById(walletId).orElseThrow(()-> new EntityNotFoundException("Wallet does not exist"));
         try {
             String pdfUrl = s3StorageService.uploadPdf(file, wallet,pdfInfo,pdfKey);
@@ -44,25 +54,49 @@ public ResponseEntity<String> uploadPdf(@RequestParam("file") MultipartFile file
     }
 
 
+    @Operation(summary = "모든 인증서 삭제(지갑 삭제)",description = "모든 인증서를 삭제합니다. 즉,s3 스토리지에 pdf 파일을 모두 삭제합니다.")
     @DeleteMapping("/delete-pdf")
-    public ResponseEntity<Void> deletePdf(@RequestBody DeletePdfRequest request) {
+    public ResponseEntity<Void> deleteWallet(
+            @Parameter(description = "지울 pdf 파일 경로 관련 Dto",required = true)
+            @RequestBody DeletePdfRequest request) {
         String urlToDelete = request.getUrlToDelete();
         System.out.println("urlToDelete = " + urlToDelete);
         s3StorageService.deletePdf(urlToDelete);
         return ResponseEntity.noContent().build();
     }
 
+    @Operation(summary = "특정 인증서 삭제",description = "지갑에서 특정 인증서를 삭제합니다. 즉,S3 스토리지에 pdf 파일에서 특정 페이지를 삭제합니다.")
+    @PatchMapping ("/delete-one")
+    public ResponseEntity<Void> deleteCertForPage(
+            @Parameter(description = "walletId와 삭제할 page가 담긴 Dto",required = true)
+            @RequestBody DeleteCertRequest request
+    ) throws IOException {
+        System.out.println("request = " + request);
+        Long walletId = request.getWalletId();
+        int page = request.getPage();
+        Wallet wallet = walletService.getWalletById(walletId).orElseThrow(()-> new EntityNotFoundException("Wallet does not exist"));
+        s3StorageService.deletePdfForPage(wallet,page);
+        return ResponseEntity.noContent().build();
+    }
+
+    @Operation(summary = "인증서 리스트 얻기",description = "개인의 인증서들을 모두 가져옵니다. 형식 : (페이지 - 설명)")
     @GetMapping("/certs")
-    public ResponseEntity<HashMap<String,String>> getCertList(@RequestParam("pdfUrl") String pdfUrl) {
+    public ResponseEntity<HashMap<String,String>> getCertList(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam("pdfUrl") String pdfUrl) {
         HashMap<String, String> certList = s3StorageService.getCertList(pdfUrl);
-        return ResponseEntity.ok().body(certList);
+        HashMap<String, String> decodedMetadata = s3StorageService.decodeMetadata(certList);
+        //return ResponseEntity.ok().body(certList);
+        return ResponseEntity.ok().body(decodedMetadata);
 
     }
 
+    @Operation(summary = "인증서 리스트 얻기 - pdf 형식",description = "개인의 인증서들을 pdf의 형식으로 모두 가져옵니다.")
     @GetMapping("/get-pdf")
-    public ResponseEntity<byte[]> getPdf(@RequestParam("pdfUrl") String pdfUrl) {
+    public ResponseEntity<byte[]> getPdf(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam("pdfUrl") String pdfUrl) {
         try {
-            System.out.println("pdfUrl = " + pdfUrl);
             byte[] pdfData = s3StorageService.getPdf(pdfUrl).readAllBytes();
             return ResponseEntity.ok().contentType(MediaType.APPLICATION_PDF).body(pdfData);
         } catch (IOException e) {
@@ -71,10 +105,15 @@ public ResponseEntity<byte[]> getPdf(@RequestParam("pdfUrl") String pdfUrl) {
         }
     }
 
+    @Operation(summary = "pdf 대체하기",description = "원하는 페이지를 원하는 pdf로 대체합니다.")
     @PostMapping("/replace-pdf")
-    public ResponseEntity<String> replacePdf(@RequestParam("file") MultipartFile file,
-                                             @RequestParam("page") int page,
-                                             @RequestParam("walletId") Long walletId) {
+    public ResponseEntity<String> replacePdf(
+            @Parameter(description = "pdf 파일",required = true)
+            @RequestParam("file") MultipartFile file,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam("page") int page,
+            @Parameter(description = "사용자 지갑ID",required = true)
+            @RequestParam("walletId") Long walletId) {
         try {
             System.out.println("file = " + file);
             Wallet wallet = walletService.getWalletById(walletId).orElseThrow(()-> new EntityNotFoundException("Wallet does not exist"));
@@ -86,16 +125,25 @@ public ResponseEntity<String> replacePdf(@RequestParam("file") MultipartFile fil
         }
     }
 
+    @Operation(summary = "메타데이터 얻기",description = "사용자의 모든 메타데이터의 정보들을 가져옵니다.")
     @GetMapping("/get-metadata")
-    public ResponseEntity<String> getMetadata(@RequestParam String pdfUrl,
-                                              @RequestParam int page) {
+    public ResponseEntity<String> getMetadata(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam String pdfUrl,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam int page) {
         String metadata = s3StorageService.getMetadataForPage(pdfUrl, page);
+
         return ResponseEntity.ok().body(metadata);
     }
 
+    @Operation(summary = "pdf key값 얻기",description = "사용자의 pdf에서 원하는 페이지의 key값을 가져옵니다.")
     @GetMapping("/get-pdfkey")
-    public ResponseEntity<String> getPdfKey(@RequestParam String pdfUrl,
-                                              @RequestParam int page) {
+    public ResponseEntity<String> getPdfKey(
+            @Parameter(description = "pdf 파일 경로",required = true)
+            @RequestParam String pdfUrl,
+            @Parameter(description = "페이지 번호",required = true)
+            @RequestParam int page) {
         String metadata = s3StorageService.getPdfKeyForPage(pdfUrl, page);
         return ResponseEntity.ok().body(metadata);
     }

diff --git a/web3-credential-server/src/main/java/web3/s3Storage/dto/DeleteCertRequest.java b/web3-credential-server/src/main/java/web3/s3Storage/dto/DeleteCertRequest.java
@@ -0,0 +1,20 @@
+package web3.s3Storage.dto;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Getter
+public class DeleteCertRequest {
+
+    private Long walletId;
+    private int page;
+
+    public void setWalletId(Long walletId) {
+        this.walletId = walletId;
+    }
+
+    public void setPage(int page) {
+        this.page = page;
+    }
+}