Feat/8 chapter7

build.gradle

@@ -1,6 +1,6 @@
 plugins {
 	id 'java'
-	id 'org.springframework.boot' version '3.5.6'
+	id 'org.springframework.boot' version '3.3.0'
 	id 'io.spring.dependency-management' version '1.1.7'
 }
 
@@ -39,7 +39,7 @@ dependencies {
 	annotationProcessor "io.github.openfeign.querydsl:querydsl-apt:7.0:jpa"
 	annotationProcessor "jakarta.persistence:jakarta.persistence-api"
 	annotationProcessor "jakarta.annotation:jakarta.annotation-api"
-	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'
+	implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0'
 }
 
 tasks.named('test') {

src/main/java/com/example/umc9th/config/AppConfig.java

@@ -0,0 +1,16 @@
+package com.example.umc9th.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.scheduling.annotation.EnableAsync;
+import org.springframework.web.client.RestTemplate;
+
+@Configuration
+@EnableAsync
+public class AppConfig {
+
+    @Bean
+    public RestTemplate restTemplate() {
+        return new RestTemplate();
+    }
+}

src/main/java/com/example/umc9th/config/discord/DevNotifierService.java

@@ -0,0 +1,14 @@
+package com.example.umc9th.config.discord;
+
+
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Service;
+
+@Service
+@Profile("!prod & !staging")
+public class DevNotifierService implements Notifier{
+    @Override
+    public void sendNotification(Exception e, String requestUri) {
+        System.out.println("디스코드 알림 전송(로컬 확인용)");
+    }
+}

src/main/java/com/example/umc9th/config/discord/DiscordNotifierService.java

@@ -0,0 +1,70 @@
+package com.example.umc9th.config.discord;
+
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Profile;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Service;
+import org.springframework.web.client.RestTemplate;
+
+import java.awt.*;
+import java.io.PrintWriter;
+import java.io.StringWriter;
+import java.util.*;
+import java.util.List;
+
+@Service
+@RequiredArgsConstructor
+@Profile({"prod","staging"})
+public class DiscordNotifierService implements Notifier{
+    private final RestTemplate restTemplate;
+
+    @Value( "${discord.webhook-url}")
+    private String discordWebhookUrl;
+
+    @Async
+    @Override
+    public void sendNotification(Exception e, String requestUri) {
+        try {
+            /*
+            RestTemplate은 HttpMessageConverter를 이용해 직렬화
+            -> MappingJackson2HttpMessageConverter
+
+            spring-boot-starter-web : Jackson 포함
+            */
+            Map<String, Object> payload = createDiscordPayload(e, requestUri);
+            restTemplate.postForEntity(discordWebhookUrl, payload, String.class);
+        } catch (Exception ex) {
+            // 알림 전송 실패 시, 원본 예외 처리에 영향을 주지 않도록 내부에서 처리
+            System.err.println("Discord 알림 전송 실패: " + ex.getMessage());
+        }
+    }
+
+    // Discord Embed 메시지 페이로드 생성
+    private Map<String, Object> createDiscordPayload(Exception e, String requestUri) {
+        // Embed 객체 생성
+        Map<String, Object> embed = new HashMap<>();
+        embed.put("title", "🚨 서버 에러 발생!");
+        embed.put("color", Color.RED.getRGB() & 0xFFFFFF); // 16진수 Red 컬러
+
+        // 스택 트레이스를 문자열로 변환 (간결하게)
+        StringWriter sw = new StringWriter();
+        e.printStackTrace(new PrintWriter(sw));
+        String stackTrace = sw.toString().substring(0, Math.min(1000, sw.toString().length())) + "..."; // 1000자로 제한
+
+        // Embed에 필드 추가
+        embed.put("fields", List.of(
+                Map.of("name", "Request URI", "value", "`" + requestUri + "`", "inline", false),
+                Map.of("name", "Exception Type", "value", "`" + e.getClass().getSimpleName() + "`", "inline", false),
+                Map.of("name", "Message", "value", e.getMessage(), "inline", false),
+                Map.of("name", "Stack Trace (Short)", "value", "```\n" + stackTrace + "\n```", "inline", false)
+        ));
+
+        // 최상위 페이로드
+        Map<String, Object> payload = new HashMap<>();
+        payload.put("username", "500에러 발생!"); // 웹훅 이름
+        payload.put("embeds", List.of(embed));
+
+        return payload;
+    }
+}

src/main/java/com/example/umc9th/config/discord/Notifier.java

@@ -0,0 +1,5 @@
+package com.example.umc9th.config.discord;
+
+public interface Notifier {
+    void sendNotification(Exception e, String requestUri);
+}

src/main/java/com/example/umc9th/domain/review/controller/ReviewController.java

@@ -2,11 +2,12 @@
 
 import com.example.umc9th.domain.review.dto.ReviewResponseDto;
 import com.example.umc9th.domain.review.service.ReviewService;
+import com.example.umc9th.global.apiPayload.ApiResponse;
+import com.example.umc9th.global.apiPayload.code.status.GeneralSuccessCode;
 import com.example.umc9th.global.dto.CursorResponseDto;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
-import org.springframework.data.domain.Slice;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
@@ -24,18 +25,18 @@ public class ReviewController {
             summary = "리뷰 조회",
             description = "가게별, 별점별로 리뷰를 조회합니다.")
     @GetMapping
-    public CursorResponseDto<ReviewResponseDto.Review> getReviews(
+    public ApiResponse<CursorResponseDto<ReviewResponseDto.Review>> getReviews(
             @RequestParam(required = false) String storeName,
             @RequestParam(required = false, defaultValue = "0.0") Float minStar,
             @RequestParam(required = false, defaultValue = "5.0") Float maxStar,
             @RequestParam(required = false) Long cursorId,
             @RequestParam(required = false, defaultValue = "10") Integer size) {
 
-        return reviewService.getReviews(storeName,
+        return ApiResponse.onSuccess(GeneralSuccessCode._OK,reviewService.getReviews(storeName,
                 minStar,
                 maxStar,
                 cursorId,
-                size);
+                size));
     }
 
 }

src/main/java/com/example/umc9th/domain/store/controller/StoreController.java

@@ -2,6 +2,8 @@
 
 import com.example.umc9th.domain.store.dto.StoreResponseDto;
 import com.example.umc9th.domain.store.service.StoreService;
+import com.example.umc9th.global.apiPayload.ApiResponse;
+import com.example.umc9th.global.apiPayload.code.status.GeneralSuccessCode;
 import com.example.umc9th.global.dto.CursorResponseDto;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -33,11 +35,11 @@ public class StoreController {
         1-4. 페이징: page + size (커서 기반 페이징 옵션 가능)
     """)
     @GetMapping
-    public CursorResponseDto<StoreResponseDto.SearchedStore> searchStore(@RequestParam(required = false) String storeName,
-                                                                         @RequestParam(required = false) String region,
-                                                                         @RequestParam(required = false) Long cursorId,
-                                                                         @RequestParam(required = false, defaultValue = "10") Integer size,
-                                                                         @RequestParam String sortType){
-        return storeService.searchStore(storeName, region, cursorId, size, sortType);
+    public ApiResponse<CursorResponseDto<StoreResponseDto.SearchedStore>> searchStore(@RequestParam(required = false) String storeName,
+                                                                                      @RequestParam(required = false) String region,
+                                                                                      @RequestParam(required = false) Long cursorId,
+                                                                                      @RequestParam(required = false, defaultValue = "10") Integer size,
+                                                                                      @RequestParam String sortType){
+        return ApiResponse.onSuccess(GeneralSuccessCode._OK,storeService.searchStore(storeName, region, cursorId, size, sortType));
     }
 }

src/main/java/com/example/umc9th/domain/user/controller/UserController.java

@@ -1,6 +1,9 @@
 package com.example.umc9th.domain.user.controller;
 
 import com.example.umc9th.domain.user.service.UserService;
+import com.example.umc9th.global.apiPayload.ApiResponse;
+import com.example.umc9th.global.apiPayload.code.BaseSuccessCode;
+import com.example.umc9th.global.apiPayload.code.status.GeneralSuccessCode;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
@@ -13,8 +16,7 @@ public class UserController {
     private final UserService userService;
 
     @DeleteMapping("/{userId}")
-    public ResponseEntity<Void> deleteUser(@PathVariable("userId") Long userId) {
-        userService.deleteUser(userId);
-        return ResponseEntity.noContent().build();
+    public ApiResponse<String> deleteUser(@PathVariable("userId") Long userId) {
+        return ApiResponse.onSuccess(GeneralSuccessCode._DELETED, userService.deleteUser(userId));
     }
 }

src/main/java/com/example/umc9th/domain/user/service/UserService.java

@@ -1,5 +1,5 @@
 package com.example.umc9th.domain.user.service;
 
 public interface UserService {
-    void deleteUser(Long userId);
+    String deleteUser(Long userId);
 }

src/main/java/com/example/umc9th/domain/user/service/UserServiceImpl.java

@@ -23,7 +23,7 @@ public class UserServiceImpl implements UserService {
 
     @Override
     @Transactional
-    public void deleteUser(Long userId) {
+    public String deleteUser(Long userId) {
         userMissionRepository.deleteByUserId(userId);
         inquiryRepository.deleteByUserId(userId);
         reviewRepository.deleteByUserId(userId);
@@ -32,5 +32,7 @@ public void deleteUser(Long userId) {
         notificationAgreementRepository.deleteByUserId(userId);
         termAgreementRepository.deleteByUserId(userId);
         userRepository.softDeleteUser(userId);
+
+        return "유저" + userId.toString() + "이 삭제되었습니다.";
     }
 }

src/main/java/com/example/umc9th/global/apiPayload/ApiResponse.java

@@ -0,0 +1,44 @@
+package com.example.umc9th.global.apiPayload;
+
+import com.example.umc9th.global.apiPayload.code.BaseSuccessCode;
+import com.example.umc9th.global.apiPayload.code.BaseErrorCode;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor
+@JsonPropertyOrder({"isSuccess","code","message","result"})
+public class ApiResponse<T> {
+
+    @JsonProperty("isSuccess")
+    private final Boolean isSuccess;
+
+    @JsonProperty("code")
+    private final String code;
+
+    @JsonProperty("message")
+    private final String message;
+
+    @JsonProperty("result")
+    private T result;
+
+    public static <T> ApiResponse<T> onSuccess(BaseSuccessCode code, T result) {
+        return new ApiResponse<>(
+                true, code.getCode(), code.getMessage(), result);
+    }
+
+    public static <T> ApiResponse<T> of(BaseSuccessCode code, T result) {
+        return new ApiResponse<>(
+                true,
+                code.getCode(),
+                code.getMessage(),
+                result);
+    }
+
+    public static <T> ApiResponse<T> onFailure(BaseErrorCode code, T result) {
+        return new ApiResponse<>(false, code.getCode(), code.getMessage(), result);
+    }
+}
+

src/main/java/com/example/umc9th/global/apiPayload/code/BaseErrorCode.java

@@ -0,0 +1,9 @@
+package com.example.umc9th.global.apiPayload.code;
+
+import org.springframework.http.HttpStatus;
+
+public interface BaseErrorCode {
+    HttpStatus getHttpStatus();
+    String getCode();
+    String getMessage();
+}

src/main/java/com/example/umc9th/global/apiPayload/code/BaseSuccessCode.java

@@ -0,0 +1,9 @@
+package com.example.umc9th.global.apiPayload.code;
+
+import org.springframework.http.HttpStatus;
+
+public interface BaseSuccessCode {
+    HttpStatus getHttpStatus();
+    String getCode();
+    String getMessage();
+}

src/main/java/com/example/umc9th/global/apiPayload/code/status/GeneralErrorCode.java

@@ -0,0 +1,39 @@
+package com.example.umc9th.global.apiPayload.code.status;
+
+import com.example.umc9th.global.apiPayload.code.BaseErrorCode;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+@AllArgsConstructor
+public enum GeneralErrorCode implements BaseErrorCode {
+
+    // 인증
+    USER_NOT_EXISTED(HttpStatus.NOT_FOUND,"USER_400","존재하지 않는 계정입니다"),
+    UNEXPECTED_TOKEN(HttpStatus.NOT_FOUND,"TOKEN_400","존재하지 않는 토큰 입니다"),
+
+    // 검색
+    PAGE_OUT_OF_RANGE(HttpStatus.BAD_REQUEST,"SEARCH_4001","요청한 페이지가 전체 페이지 수를 초과합니다."),
+    NO_RESULT(HttpStatus.NOT_FOUND,"SEARCH_40002","검색 결과가 없습니다."),
+
+     // 기본 에러
+    _BAD_REQUEST(HttpStatus.BAD_REQUEST, "COMMON_400", "잘못된 요청입니다."),
+    _UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "COMMON_401", "인증이 필요합니다."),
+    _FORBIDDEN(HttpStatus.FORBIDDEN, "COMMON_403", "금지된 요청입니다."),
+    _NO_RESULTS_FOUND(HttpStatus.NOT_FOUND, "COMMON_404", "검색 결과가 없습니다."),
+    _INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON_500", "서버 에러. 관리자에게 문의 바랍니다."),
+
+    MULTIPLE_FIELD_VALIDATION_ERROR(HttpStatus.BAD_REQUEST, "COMMON_001", "입력된 정보에 오류가 있습니다. 필드별 오류 메시지를 참조하세요."),
+    NO_MATCHING_ERROR_STATUS(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON_002", "서버 에러. 일치하는 errorStatus를 찾을 수 없습니다."),
+    REQUEST_BODY_INVALID(HttpStatus.BAD_REQUEST, "COMMON_003", "요청 본문을 읽을 수 없습니다. 빈 문자열 또는 null이 있는지 확인해주세요."),
+    INVALID_DATE_FORMAT(HttpStatus.BAD_REQUEST, "COMMON_004", "요청한 날짜/시간 형식이 올바르지 않습니다. 형식을 확인해주세요."),
+    DUPLICATE_UNIQUE_KEY(HttpStatus.CONFLICT, "COMMON_005", "이미 처리된 요청입니다."),
+
+    // s3 사진 첨부 에러
+    FILE_UPLOAD_FAILED(HttpStatus.INTERNAL_SERVER_ERROR, "FILE_001", "파일 업로드에 실패했습니다.");
+
+    private final HttpStatus httpStatus;
+    private final String code;
+    private final String message;
+}

src/main/java/com/example/umc9th/global/apiPayload/code/status/GeneralSuccessCode.java

@@ -0,0 +1,20 @@
+package com.example.umc9th.global.apiPayload.code.status;
+
+import com.example.umc9th.global.apiPayload.code.BaseSuccessCode;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import org.springframework.http.HttpStatus;
+
+@Getter
+@AllArgsConstructor
+public enum GeneralSuccessCode implements BaseSuccessCode {
+    _OK(HttpStatus.OK, "COMMON200", "성공입니다."),
+    _CREATED(HttpStatus.CREATED, "COMMON201", "요청 성공 및 리소스 생성됨"),
+    _DELETED(HttpStatus.NO_CONTENT, "COMMON204", "삭제가 완료되었습니다.");
+
+
+    private final HttpStatus httpStatus;
+    private final String code;
+    private final String message;
+
+}