From e0e868a2821305ea7200a12cf0dbd9b37ea10396 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 13:53:15 +0900 Subject: [PATCH 01/10] =?UTF-8?q?[Swagger=20=EC=B4=88=EA=B8=B0=20=EC=A0=81?= =?UTF-8?q?=EC=9A=A9]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 +++++++++++++++- build.gradle | 3 ++ .../global/config/SwaggerConfig.java | 31 +++++++++++++++++++ src/main/resources/application.properties | 8 +++++ 4 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java diff --git a/README.md b/README.md index dc03b06..cfbab31 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ - **Security**: Spring Security + JWT - **Build Tool**: Gradle - **Container**: Docker + Kubernetes +- **API Documentation**: Swagger (SpringDoc OpenAPI) ## 개발 가이드 @@ -31,7 +32,30 @@ src/main/java/com/bio/bio_backend/ └── BioBackendApplication.java ``` -### 2. 트랜잭션 관리 +### 2. API 문서화 (Swagger) + +#### Swagger UI 접속 + +- **URL**: `http://localhost:8080/service/swagger-ui.html` +- **API Docs**: `http://localhost:8080/service/api-docs` + +#### 주요 어노테이션 + +```java +@Tag(name = "Member", description = "회원 관리 API") +@Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") +@ApiResponses(value = { + @ApiResponse(responseCode = "201", description = "회원 가입 성공"), + @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터") +}) +``` + +#### 설정 파일 + +- **SwaggerConfig.java**: OpenAPI 기본 정보 설정 +- **application.properties**: Swagger UI 커스터마이징 + +### 3. 트랜잭션 관리 #### 기본 설정 diff --git a/build.gradle b/build.gradle index 5753559..ccc0e45 100644 --- a/build.gradle +++ b/build.gradle @@ -61,6 +61,9 @@ dependencies { // p6spy implementation 'com.github.gavlyukovskiy:p6spy-spring-boot-starter:1.9.0' + + // SpringDoc OpenAPI (Swagger) + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.9' } tasks.named('test') { diff --git a/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java b/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java new file mode 100644 index 0000000..1ef3edb --- /dev/null +++ b/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java @@ -0,0 +1,31 @@ +package com.bio.bio_backend.global.config; + +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.info.Contact; +import io.swagger.v3.oas.models.info.License; +import io.swagger.v3.oas.models.servers.Server; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import java.util.List; + +@Configuration +public class SwaggerConfig { + + @Bean + public OpenAPI openAPI() { + return new OpenAPI() + .info(new Info() + .title("대상 미생물 분석 시스템 Backend API") + .description("대상 미생물 분석 시스템 Backend 서비스의 REST API 문서") + .version("v1.0.0") + .license(new License() + .name("STAM License") + .url("https://stam.kr/"))) + .servers(List.of( + new Server().url("http://localhost:8080/service").description("Local Development Server"), + new Server().url("https://api.bio.com/service").description("Production Server") + )); + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index cfa157e..09f9612 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -54,3 +54,11 @@ token.expiration_time_access=180000 token.expiration_time_refresh=604800000 token.secret_key= c3RhbV9qd3Rfc2VjcmV0X3Rva2Vuc3RhbV9qd3Rfc2VjcmV0X3Rva2Vu +# Swagger 설정 +springdoc.api-docs.path=/api-docs +springdoc.swagger-ui.path=/swagger-ui.html +springdoc.swagger-ui.operationsSorter=method +springdoc.swagger-ui.tagsSorter=alpha +springdoc.swagger-ui.doc-expansion=none +springdoc.swagger-ui.disable-swagger-default-url=true + From 2ead0f0f12dfe855bbfe28b00957067bf9acb914 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 14:39:36 +0900 Subject: [PATCH 02/10] =?UTF-8?q?[=EC=98=A4=EB=A5=98=20=EC=B2=98=EB=A6=AC?= =?UTF-8?q?=20=EA=B0=9C=EC=84=A0]=20-=20ApiException=20=EB=B0=8F=20ApiResp?= =?UTF-8?q?onseCode=20=EC=B6=94=EA=B0=80,=20GlobalExceptionHandler?= =?UTF-8?q?=EC=97=90=EC=84=9C=20ApiException=20=EC=B2=98=EB=A6=AC=20?= =?UTF-8?q?=EB=A1=9C=EC=A7=81=20=EA=B5=AC=ED=98=84,=20README=EC=97=90=20?= =?UTF-8?q?=EC=98=A4=EB=A5=98=20=EB=93=B1=EB=A1=9D=20=EB=B0=8F=20=EC=82=AC?= =?UTF-8?q?=EC=9A=A9=20=EB=B0=A9=EB=B2=95=20=EB=AC=B8=EC=84=9C=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 27 +++++++++++++++ .../member/service/MemberServiceImpl.java | 4 ++- .../global/exception/ApiException.java | 24 +++++++++++++ .../exception/GlobalExceptionHandler.java | 31 +++++++++++++++-- .../global/utils/ApiResponseCode.java | 34 +++++-------------- 5 files changed, 90 insertions(+), 30 deletions(-) create mode 100644 src/main/java/com/bio/bio_backend/global/exception/ApiException.java diff --git a/README.md b/README.md index cfbab31..596ca76 100644 --- a/README.md +++ b/README.md @@ -78,3 +78,30 @@ public class MemberServiceImpl { - **클래스 레벨**: `@Transactional(readOnly = true)` 기본 설정 - **메서드별**: 데이터 수정 시에만 `@Transactional` 개별 적용 - **설정**: `spring.jpa.open-in-view=false` (성능 최적화) + +### 4. 오류 등록 및 사용 + +#### 오류 코드 등록 + +```java +// ApiResponseCode.java +public enum ApiResponseCode { + USER_ID_DUPLICATE("400", "이미 존재하는 사용자 ID입니다."), +} +``` + +#### 오류 사용 방법 + +```java +// Service에서 예외 발생 +throw new ApiException(ApiResponseCode.USER_ID_DUPLICATE); + +// Controller에서 예외 처리 (자동) +// GlobalExceptionHandler가 ApiException을 잡아서 응답 변환 +``` + +#### 핵심 규칙 + +- **오류 코드**: `ApiResponseCode` enum에 모든 오류 정의 +- **예외 클래스**: `ApiException`으로 비즈니스 로직 예외 처리 +- **자동 처리**: `GlobalExceptionHandler`가 일관된 응답 형태로 변환 diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java b/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java index 65ed12c..b40f0f4 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java @@ -6,6 +6,8 @@ import com.bio.bio_backend.domain.user.member.enums.MemberRole; import com.bio.bio_backend.domain.user.member.mapper.MemberMapper; import com.bio.bio_backend.domain.user.member.repository.MemberRepository; import com.bio.bio_backend.domain.user.member.exception.UserDuplicateException; +import com.bio.bio_backend.global.exception.ApiException; +import com.bio.bio_backend.global.utils.ApiResponseCode; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.security.core.userdetails.UserDetails; @@ -46,7 +48,7 @@ public class MemberServiceImpl implements MemberService { public MemberDto createMember(MemberDto memberDTO) { // userId 중복 체크 if (memberRepository.existsByUserId(memberDTO.getUserId())) { - throw new UserDuplicateException("User ID already exists"); + throw new ApiException(ApiResponseCode.USER_ID_DUPLICATE); } Member member = Member.builder() diff --git a/src/main/java/com/bio/bio_backend/global/exception/ApiException.java b/src/main/java/com/bio/bio_backend/global/exception/ApiException.java new file mode 100644 index 0000000..d339468 --- /dev/null +++ b/src/main/java/com/bio/bio_backend/global/exception/ApiException.java @@ -0,0 +1,24 @@ +package com.bio.bio_backend.global.exception; + +import lombok.Getter; +import com.bio.bio_backend.global.utils.ApiResponseCode; + +@Getter +public class ApiException extends RuntimeException { + private final ApiResponseCode responseCode; + + public ApiException(ApiResponseCode responseCode) { + super(responseCode.getDescription()); + this.responseCode = responseCode; + } + + public ApiException(ApiResponseCode responseCode, String message) { + super(message); + this.responseCode = responseCode; + } + + public ApiException(ApiResponseCode responseCode, Throwable cause) { + super(responseCode.getDescription(), cause); + this.responseCode = responseCode; + } +} \ No newline at end of file diff --git a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java index 558197b..349e4b1 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java @@ -6,6 +6,7 @@ import org.springframework.http.converter.HttpMessageNotReadableException; import org.springframework.web.HttpRequestMethodNotSupportedException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.bind.MethodArgumentNotValidException; import org.springframework.web.servlet.resource.NoResourceFoundException; import com.fasterxml.jackson.core.JsonProcessingException; @@ -73,8 +74,32 @@ public class GlobalExceptionHandler { return CustomApiResponse.fail(ApiResponseCode.JSON_PROCESSING_EXCEPTION, null); } - @ExceptionHandler(UserDuplicateException.class) - public CustomApiResponse handleUserDuplicateException(UserDuplicateException e) { - return CustomApiResponse.fail(ApiResponseCode.USER_ID_DUPLICATE, null); + @ExceptionHandler(ApiException.class) + public CustomApiResponse handleApiException(ApiException e) { + return CustomApiResponse.fail(e.getResponseCode(), null); + } + + @ExceptionHandler(MethodArgumentNotValidException.class) + public CustomApiResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { + // 검증 실패한 필드들의 상세 오류 정보 추출 + var errors = e.getBindingResult().getFieldErrors().stream() + .map(error -> new ValidationError(error.getField(), error.getDefaultMessage())) + .toList(); + + return CustomApiResponse.fail(ApiResponseCode.ARGUMENT_NOT_VALID, errors); + } + + // 검증 오류 상세 정보를 위한 내부 클래스 + private static class ValidationError { + private final String field; + private final String message; + + public ValidationError(String field, String message) { + this.field = field; + this.message = message; + } + + public String getField() { return field; } + public String getMessage() { return message; } } } diff --git a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java b/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java index e819ef6..0552807 100644 --- a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java +++ b/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java @@ -11,44 +11,30 @@ import org.springframework.http.HttpStatus; @Getter @AllArgsConstructor public enum ApiResponseCode { - - /*login & logout*/ - + // 200 OK LOGIN_SUCCESSFUL(HttpStatus.OK.value(), "Login successful"), - LOGOUT_SUCCESSFUL(HttpStatus.OK.value(), "Logout successful"), - USER_INFO_CHANGE(HttpStatus.OK.value(), "User info update successful"), - USER_DELETE_SUCCESSFUL(HttpStatus.OK.value(), "User delete is successful"), - // 401 Unauthorized - USER_NOT_FOUND(HttpStatus.UNAUTHORIZED.value(), "User not found. Authentication failed"), - - AUTHENTICATION_FAILED(HttpStatus.UNAUTHORIZED.value(), "Password is invalid"), - // 409 Conflict USER_ID_DUPLICATE(HttpStatus.CONFLICT.value(), "User ID already exists"), - /*auth*/ - // 401 Unauthorized - JWT_SIGNATURE_MISMATCH(HttpStatus.UNAUTHORIZED.value(), "JWT signature does not match. Authentication failed"), - - JWT_TOKEN_NULL(HttpStatus.UNAUTHORIZED.value(), "JWT token is null"), - - JWT_TOKEN_EXPIRED(HttpStatus.UNAUTHORIZED.value(), "Token is Expired"), - - All_TOKEN_INVALID(HttpStatus.UNAUTHORIZED.value(), "Access and Refresh tokens are expired or invalid"), - /*공통 Code*/ // 400 Bad Request COMMON_BAD_REQUEST(HttpStatus.BAD_REQUEST.value(), "Required request body is missing or Error"), - COMMON_FORMAT_WRONG(HttpStatus.BAD_REQUEST.value(), "Request format is incorrect"), + ARGUMENT_NOT_VALID(HttpStatus.BAD_REQUEST.value(), "Argument is not valid"), // 401 Unauthorized COMMON_UNAUTHORIZED(HttpStatus.UNAUTHORIZED.value(), "Unauthorized"), + USER_NOT_FOUND(HttpStatus.UNAUTHORIZED.value(), "User not found. Authentication failed"), + AUTHENTICATION_FAILED(HttpStatus.UNAUTHORIZED.value(), "Password is invalid"), + JWT_SIGNATURE_MISMATCH(HttpStatus.UNAUTHORIZED.value(), "JWT signature does not match. Authentication failed"), + JWT_TOKEN_NULL(HttpStatus.UNAUTHORIZED.value(), "JWT token is null"), + JWT_TOKEN_EXPIRED(HttpStatus.UNAUTHORIZED.value(), "Token is Expired"), + All_TOKEN_INVALID(HttpStatus.UNAUTHORIZED.value(), "Access and Refresh tokens are expired or invalid"), // 403 Forbidden COMMON_FORBIDDEN(HttpStatus.FORBIDDEN.value(), "Access is denied"), @@ -61,11 +47,7 @@ public enum ApiResponseCode { // 500 Internal Server Error INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR.value(), "An error occurred on the server"), - - ARGUMENT_NOT_VALID(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Argument is not valid"), - INDEX_OUT_OF_BOUND(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Index out of bounds for length"), - JSON_PROCESSING_EXCEPTION(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Check if it is a valid JSON format"); private final int statusCode; From 6a4388f51397f6c3c2f840f7e1b09537f247e224 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 15:23:59 +0900 Subject: [PATCH 03/10] =?UTF-8?q?[Swagger=20=EC=A0=81=EC=9A=A9]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../user/member/controller/MemberController.java | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java index 8394e2a..f2efc0b 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java @@ -1,5 +1,6 @@ package com.bio.bio_backend.domain.user.member.controller; +import com.bio.bio_backend.global.dto.CustomApiResponse; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; @@ -16,6 +17,12 @@ import com.bio.bio_backend.domain.user.member.service.MemberService; import com.bio.bio_backend.domain.user.member.mapper.MemberMapper; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.media.Content; +import io.swagger.v3.oas.annotations.media.Schema; + @RestController @RequiredArgsConstructor @@ -26,6 +33,12 @@ public class MemberController { private final MemberMapper memberMapper; private final BCryptPasswordEncoder bCryptPasswordEncoder; + @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.", tags = {"Member"}) + @ApiResponses({ + @ApiResponse(responseCode = "201", description = "회원 가입 성공", content = @Content(schema = @Schema(implementation = CreateMemberResponseDto.class))), + @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), + @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", content = @Content(schema = @Schema(implementation = CustomApiResponse.class))) + }) @PostMapping("/members") public ResponseEntity createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { MemberDto member = memberMapper.toMemberDto(requestDto); From a2c6c83ed750fa5c58bdc12a799d7952db0294d9 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 15:38:09 +0900 Subject: [PATCH 04/10] =?UTF-8?q?[Window=20=EB=B2=84=EC=A0=84=EC=9C=BC?= =?UTF-8?q?=EB=A1=9C=20=EB=B3=80=EA=B2=BD]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- nginx-1.28.0/conf/nginx.conf | 46 ++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/nginx-1.28.0/conf/nginx.conf b/nginx-1.28.0/conf/nginx.conf index 571f16a..3fa0ded 100644 --- a/nginx-1.28.0/conf/nginx.conf +++ b/nginx-1.28.0/conf/nginx.conf @@ -1,38 +1,48 @@ -# ./nginx/nginx.conf -# 이벤트 블록은 Nginx가 어떻게 연결을 처리할지 정의합니다. events { worker_connections 1024; } -# HTTP 블록은 웹 서버의 동작을 정의합니다. http { - # MIME 타입 파일을 포함하여 파일 확장자에 따라 콘텐츠 타입을 결정합니다. - include /etc/nginx/mime.types; + include mime.types; + default_type application/octet-stream; + sendfile on; + keepalive_timeout 65; + + # (선택) 로그 위치 + access_log logs/access.log; + error_log logs/error.log warn; + + # 웹소켓용 + map $http_upgrade $connection_upgrade { + default upgrade; + '' close; + } - # 기본 서버 설정을 정의합니다. server { - # 80번 포트에서 요청을 받습니다. listen 80; - server_name localhost; # 서버 이름을 localhost로 설정 + server_name localhost; - # 루트 경로(/)로 들어오는 모든 요청을 처리합니다. + # Nuxt(개발서버 3000) location / { - # 요청을 다른 서버(여기서는 Nuxt.js)로 전달합니다. proxy_pass http://localhost:3000; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + } - # 프록시 헤더를 설정하여 원본 요청 정보를 유지합니다. + # Spring Boot(8080) — /service 접두어 제거 + location /service/ { + proxy_pass http://localhost:8080; # 끝에 슬래시 넣으면 /service가 제거됨 proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; } - # /api/ 경로로 들어오는 요청을 처리합니다. (Spring Boot 컨테이너를 가리킨다고 가정) - location /service { - proxy_pass http://localhost:8080; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } + # (선택) 업로드 크게 받을 때 + # client_max_body_size 50m; } } \ No newline at end of file From b34636baae364788b081dfb2de567ed629cd4fe6 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 15:38:54 +0900 Subject: [PATCH 05/10] =?UTF-8?q?[nginx=20gitignore=20=EC=B6=94=EA=B0=80]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 6d79688..ea16835 100644 --- a/.gitignore +++ b/.gitignore @@ -42,4 +42,5 @@ bin/ # Temporary files created by the OS .DS_Store -Thumbs.db \ No newline at end of file +Thumbs.db +/nginx-1.28.0/logs/nginx.pid From d0612b61e9e196063bbed05d3e3e962784ae9229 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Wed, 13 Aug 2025 17:02:40 +0900 Subject: [PATCH 06/10] =?UTF-8?q?[API=20=EC=9D=91=EB=8B=B5=20=ED=91=9C?= =?UTF-8?q?=EC=A4=80=ED=99=94]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 103 +++++++++++++++++- .../member/controller/MemberController.java | 18 +-- .../CustomAuthenticationFailureHandler.java | 4 +- .../exception/GlobalExceptionHandler.java | 25 ++--- .../global/security/JwtTokenFilter.java | 2 +- .../global/utils/ApiResponseCode.java | 65 ++++++----- 6 files changed, 158 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 596ca76..3401e87 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,94 @@ src/main/java/com/bio/bio_backend/ └── BioBackendApplication.java ``` -### 2. API 문서화 (Swagger) +### 2. API 응답 표준화 (CustomApiResponse) + +#### 응답 구조 + +모든 API 응답은 `CustomApiResponse` 형태로 표준화되어 있습니다. + +```java +public class CustomApiResponse { + private int code; // HTTP 상태 코드 + private String message; // 응답 메시지 (ApiResponseCode enum 값) + private String description; // 응답 설명 + private T data; // 실제 데이터 (제네릭 타입) +} +``` + +#### 응답 예시 + +**성공 응답 (201 Created)** + +```json +{ + "code": 201, + "message": "COMMON_SUCCESS_CREATED", + "description": "Created successfully", + "data": { + "seq": 1, + "userId": "user123", + "name": "홍길동" + } +} +``` + +**실패 응답 (409 Conflict)** + +```json +{ + "code": 409, + "message": "USER_ID_DUPLICATE", + "description": "User ID already exists", + "data": null +} +``` + +#### 사용 방법 + +**Controller에서 응답 생성** + +```java +@PostMapping("/members") +public ResponseEntity> createMember(@RequestBody CreateMemberRequestDto requestDto) { + // ... 비즈니스 로직 ... + + // 성공 응답 + CustomApiResponse apiResponse = + CustomApiResponse.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); + + return ResponseEntity.status(HttpStatus.CREATED).body(apiResponse); +} +``` + +**공용 응답 코드 사용** + +```java +// ApiResponseCode.java +public enum ApiResponseCode { + // 공용 성공 코드 + COMMON_SUCCESS_CREATED(HttpStatus.CREATED.value(), "Created successfully"), + COMMON_SUCCESS_UPDATED(HttpStatus.OK.value(), "Updated successfully"), + COMMON_SUCCESS_DELETED(HttpStatus.OK.value(), "Deleted successfully"), + COMMON_SUCCESS_RETRIEVED(HttpStatus.OK.value(), "Retrieved successfully"), + + // 공용 오류 코드 + COMMON_BAD_REQUEST(HttpStatus.BAD_REQUEST.value(), "Required request body is missing or Error"), + COMMON_UNAUTHORIZED(HttpStatus.UNAUTHORIZED.value(), "Unauthorized"), + COMMON_FORBIDDEN(HttpStatus.FORBIDDEN.value(), "Access is denied"), + COMMON_NOT_FOUND(HttpStatus.NOT_FOUND.value(), "Resource is not found"), + COMMON_INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR.value(), "An error occurred on the server") +} +``` + +#### 핵심 규칙 + +- **모든 API 응답**: `CustomApiResponse`로 감싸서 반환 +- **공용 응답 코드**: `COMMON_` 접두사로 시작하는 범용 코드 사용 +- **일관된 구조**: `code`, `message`, `description`, `data` 필드로 표준화 +- **제네릭 활용**: ``를 통해 다양한 데이터 타입 지원 + +### 3. API 문서화 (Swagger) #### Swagger UI 접속 @@ -45,8 +132,12 @@ src/main/java/com/bio/bio_backend/ @Tag(name = "Member", description = "회원 관리 API") @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") @ApiResponses(value = { - @ApiResponse(responseCode = "201", description = "회원 가입 성공"), - @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터") + @ApiResponse(responseCode = "201", description = "회원 가입 성공", + content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), + @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", + content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), + @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", + content = @Content(schema = @Schema(implementation = CustomApiResponse.class))) }) ``` @@ -55,7 +146,7 @@ src/main/java/com/bio/bio_backend/ - **SwaggerConfig.java**: OpenAPI 기본 정보 설정 - **application.properties**: Swagger UI 커스터마이징 -### 3. 트랜잭션 관리 +### 4. 트랜잭션 관리 #### 기본 설정 @@ -79,14 +170,14 @@ public class MemberServiceImpl { - **메서드별**: 데이터 수정 시에만 `@Transactional` 개별 적용 - **설정**: `spring.jpa.open-in-view=false` (성능 최적화) -### 4. 오류 등록 및 사용 +### 5. 오류 등록 및 사용 #### 오류 코드 등록 ```java // ApiResponseCode.java public enum ApiResponseCode { - USER_ID_DUPLICATE("400", "이미 존재하는 사용자 ID입니다."), + USER_ID_DUPLICATE(HttpStatus.CONFLICT.value(), "User ID already exists"), } ``` diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java index f2efc0b..f37dbb4 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java @@ -1,6 +1,7 @@ package com.bio.bio_backend.domain.user.member.controller; import com.bio.bio_backend.global.dto.CustomApiResponse; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; @@ -22,8 +23,9 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; +import com.bio.bio_backend.global.utils.ApiResponseCode; - +@Tag(name = "Member", description = "회원 관련 API") @RestController @RequiredArgsConstructor @Slf4j @@ -33,19 +35,21 @@ public class MemberController { private final MemberMapper memberMapper; private final BCryptPasswordEncoder bCryptPasswordEncoder; - @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.", tags = {"Member"}) + @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") @ApiResponses({ - @ApiResponse(responseCode = "201", description = "회원 가입 성공", content = @Content(schema = @Schema(implementation = CreateMemberResponseDto.class))), - @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), - @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", content = @Content(schema = @Schema(implementation = CustomApiResponse.class))) + @ApiResponse(responseCode = "201", description = "회원 가입 성공"), + @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터"), + @ApiResponse(responseCode = "409", description = "중복된 사용자 정보") }) @PostMapping("/members") - public ResponseEntity createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { + public ResponseEntity> createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { MemberDto member = memberMapper.toMemberDto(requestDto); MemberDto createdMember = memberService.createMember(member); CreateMemberResponseDto responseDto = memberMapper.toCreateMemberResponseDto(createdMember); - return ResponseEntity.status(HttpStatus.CREATED).body(responseDto); + CustomApiResponse apiResponse = CustomApiResponse.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); + + return ResponseEntity.status(HttpStatus.CREATED).body(apiResponse); } // @PostMapping("/member/list") diff --git a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java index 65b7563..0c52b84 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java @@ -40,10 +40,10 @@ public class CustomAuthenticationFailureHandler implements AuthenticationFailure if (exception instanceof UsernameNotFoundException) { apiResponse = CustomApiResponse.fail(ApiResponseCode.USER_NOT_FOUND, null); } else if (exception instanceof BadCredentialsException) { - apiResponse = CustomApiResponse.fail(ApiResponseCode.AUTHENTICATION_FAILED, null); + apiResponse = CustomApiResponse.fail(ApiResponseCode.COMMON_UNAUTHORIZED, null); } else { response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value()); - apiResponse = CustomApiResponse.fail(ApiResponseCode.INTERNAL_SERVER_ERROR, null); + apiResponse = CustomApiResponse.fail(ApiResponseCode.COMMON_INTERNAL_SERVER_ERROR, null); } String jsonResponse = objectMapper.writeValueAsString(apiResponse); diff --git a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java index 349e4b1..2bba0c7 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java @@ -2,6 +2,7 @@ package com.bio.bio_backend.global.exception; import java.util.Objects; +import lombok.Getter; import org.springframework.http.converter.HttpMessageNotReadableException; import org.springframework.web.HttpRequestMethodNotSupportedException; import org.springframework.web.bind.annotation.ExceptionHandler; @@ -17,7 +18,6 @@ import io.jsonwebtoken.MalformedJwtException; import io.jsonwebtoken.security.SignatureException; import com.bio.bio_backend.global.dto.CustomApiResponse; import com.bio.bio_backend.global.utils.ApiResponseCode; -import com.bio.bio_backend.domain.user.member.exception.UserDuplicateException; @RestControllerAdvice public class GlobalExceptionHandler { @@ -41,12 +41,12 @@ public class GlobalExceptionHandler { @ExceptionHandler(IllegalArgumentException.class) public CustomApiResponse handleIllegalArgumentException(IllegalArgumentException e){ - return CustomApiResponse.fail(ApiResponseCode.ARGUMENT_NOT_VALID, null); + return CustomApiResponse.fail(ApiResponseCode.COMMON_ARGUMENT_NOT_VALID, null); } @ExceptionHandler(IndexOutOfBoundsException.class) public CustomApiResponse handleIndexOutOfBoundsException(IndexOutOfBoundsException e){ - return CustomApiResponse.fail(ApiResponseCode.INDEX_OUT_OF_BOUND, null); + return CustomApiResponse.fail(ApiResponseCode.COMMON_INDEX_OUT_OF_BOUND, null); } @ExceptionHandler(SignatureException.class) @@ -71,7 +71,7 @@ public class GlobalExceptionHandler { @ExceptionHandler(JsonProcessingException.class) public CustomApiResponse handleExpiredJwtException(JsonProcessingException e) { - return CustomApiResponse.fail(ApiResponseCode.JSON_PROCESSING_EXCEPTION, null); + return CustomApiResponse.fail(ApiResponseCode.COMMON_JSON_PROCESSING_EXCEPTION, null); } @ExceptionHandler(ApiException.class) @@ -86,20 +86,9 @@ public class GlobalExceptionHandler { .map(error -> new ValidationError(error.getField(), error.getDefaultMessage())) .toList(); - return CustomApiResponse.fail(ApiResponseCode.ARGUMENT_NOT_VALID, errors); + return CustomApiResponse.fail(ApiResponseCode.COMMON_ARGUMENT_NOT_VALID, errors); } - + // 검증 오류 상세 정보를 위한 내부 클래스 - private static class ValidationError { - private final String field; - private final String message; - - public ValidationError(String field, String message) { - this.field = field; - this.message = message; - } - - public String getField() { return field; } - public String getMessage() { return message; } - } + private record ValidationError(String field, String message) { } } diff --git a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java index ca48a7a..6f054f7 100644 --- a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java +++ b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java @@ -83,7 +83,7 @@ public class JwtTokenFilter extends OncePerRequestFilter { response.setHeader("Authorization", "Bearer " + newAccessToken); filterChain.doFilter(request, response); } else { - sendJsonResponse(response, CustomApiResponse.fail(ApiResponseCode.All_TOKEN_INVALID, null)); + sendJsonResponse(response, CustomApiResponse.fail(ApiResponseCode.ALL_TOKEN_INVALID, null)); } } catch (Exception e) { request.setAttribute("exception", e); diff --git a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java b/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java index 0552807..beb0035 100644 --- a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java +++ b/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java @@ -12,43 +12,58 @@ import org.springframework.http.HttpStatus; @AllArgsConstructor public enum ApiResponseCode { - // 200 OK - LOGIN_SUCCESSFUL(HttpStatus.OK.value(), "Login successful"), - LOGOUT_SUCCESSFUL(HttpStatus.OK.value(), "Logout successful"), - USER_INFO_CHANGE(HttpStatus.OK.value(), "User info update successful"), - USER_DELETE_SUCCESSFUL(HttpStatus.OK.value(), "User delete is successful"), - - // 409 Conflict - USER_ID_DUPLICATE(HttpStatus.CONFLICT.value(), "User ID already exists"), - /*공통 Code*/ + // 200 OK + COMMON_SUCCESS(HttpStatus.OK.value(), "요청 성공"), + COMMON_SUCCESS_CREATED(HttpStatus.CREATED.value(), "성공적으로 생성되었습니다"), + COMMON_SUCCESS_UPDATED(HttpStatus.OK.value(), "성공적으로 수정되었습니다"), + COMMON_SUCCESS_DELETED(HttpStatus.OK.value(), "성공적으로 삭제되었습니다"), + COMMON_SUCCESS_RETRIEVED(HttpStatus.OK.value(), "성공적으로 조회되었습니다"), + // 400 Bad Request - COMMON_BAD_REQUEST(HttpStatus.BAD_REQUEST.value(), "Required request body is missing or Error"), - COMMON_FORMAT_WRONG(HttpStatus.BAD_REQUEST.value(), "Request format is incorrect"), - ARGUMENT_NOT_VALID(HttpStatus.BAD_REQUEST.value(), "Argument is not valid"), + COMMON_BAD_REQUEST(HttpStatus.BAD_REQUEST.value(), "필수 요청 본문이 누락되었거나 오류가 발생했습니다"), + COMMON_FORMAT_WRONG(HttpStatus.BAD_REQUEST.value(), "요청 형식이 올바르지 않습니다"), + COMMON_ARGUMENT_NOT_VALID(HttpStatus.BAD_REQUEST.value(), "인자가 유효하지 않습니다"), // 401 Unauthorized - COMMON_UNAUTHORIZED(HttpStatus.UNAUTHORIZED.value(), "Unauthorized"), - USER_NOT_FOUND(HttpStatus.UNAUTHORIZED.value(), "User not found. Authentication failed"), - AUTHENTICATION_FAILED(HttpStatus.UNAUTHORIZED.value(), "Password is invalid"), - JWT_SIGNATURE_MISMATCH(HttpStatus.UNAUTHORIZED.value(), "JWT signature does not match. Authentication failed"), - JWT_TOKEN_NULL(HttpStatus.UNAUTHORIZED.value(), "JWT token is null"), - JWT_TOKEN_EXPIRED(HttpStatus.UNAUTHORIZED.value(), "Token is Expired"), - All_TOKEN_INVALID(HttpStatus.UNAUTHORIZED.value(), "Access and Refresh tokens are expired or invalid"), + COMMON_UNAUTHORIZED(HttpStatus.UNAUTHORIZED.value(), "인증에 실패했습니다"), // 403 Forbidden - COMMON_FORBIDDEN(HttpStatus.FORBIDDEN.value(), "Access is denied"), + COMMON_FORBIDDEN(HttpStatus.FORBIDDEN.value(), "접근이 거부되었습니다"), // 404 Not Found - COMMON_NOT_FOUND(HttpStatus.NOT_FOUND.value(), "Resource is not found"), + COMMON_NOT_FOUND(HttpStatus.NOT_FOUND.value(), "리소스를 찾을 수 없습니다"), // 405 Method Not Allowed - COMMON_METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED.value(), "Method not Allowed"), + COMMON_METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED.value(), "허용되지 않는 메소드입니다"), + + // 409 Conflict + COMMON_CONFLICT(HttpStatus.CONFLICT.value(), "충돌이 발생했습니다"), // 500 Internal Server Error - INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR.value(), "An error occurred on the server"), - INDEX_OUT_OF_BOUND(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Index out of bounds for length"), - JSON_PROCESSING_EXCEPTION(HttpStatus.INTERNAL_SERVER_ERROR.value(), "Check if it is a valid JSON format"); + COMMON_INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR.value(), "서버에서 오류가 발생했습니다"), + COMMON_INDEX_OUT_OF_BOUND(HttpStatus.INTERNAL_SERVER_ERROR.value(), "인덱스가 범위를 벗어났습니다"), + COMMON_JSON_PROCESSING_EXCEPTION(HttpStatus.INTERNAL_SERVER_ERROR.value(), "유효한 JSON 형식인지 확인해주세요"), + + /*사용자 관련 Code*/ + // 200 OK + LOGIN_SUCCESSFUL(HttpStatus.OK.value(), "로그인에 성공했습니다"), + LOGOUT_SUCCESSFUL(HttpStatus.OK.value(), "로그아웃에 성공했습니다"), + USER_INFO_CHANGE(HttpStatus.OK.value(), "사용자 정보가 성공적으로 수정되었습니다"), + USER_DELETE_SUCCESSFUL(HttpStatus.OK.value(), "사용자가 성공적으로 삭제되었습니다"), + + // 409 Conflict + USER_ID_DUPLICATE(HttpStatus.CONFLICT.value(), "이미 존재하는 사용자 ID입니다"), + + // 401 Unauthorized + USER_NOT_FOUND(HttpStatus.UNAUTHORIZED.value(), "사용자를 찾을 수 없습니다. 인증에 실패했습니다"), + USER_PASSWORD_INVALID(HttpStatus.UNAUTHORIZED.value(), "비밀번호가 올바르지 않습니다"), + + // JWT 관련 + JWT_SIGNATURE_MISMATCH(HttpStatus.UNAUTHORIZED.value(), "JWT 서명이 일치하지 않습니다. 인증에 실패했습니다"), + JWT_TOKEN_NULL(HttpStatus.UNAUTHORIZED.value(), "JWT 토큰이 null입니다"), + JWT_TOKEN_EXPIRED(HttpStatus.UNAUTHORIZED.value(), "토큰이 만료되었습니다"), + ALL_TOKEN_INVALID(HttpStatus.UNAUTHORIZED.value(), "액세스 토큰과 리프레시 토큰이 모두 만료되었거나 유효하지 않습니다"); private final int statusCode; private final String description; From 77bc40088896bc8c74d3506277ee246cc255a520 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Thu, 14 Aug 2025 09:47:24 +0900 Subject: [PATCH 07/10] =?UTF-8?q?[API=20=EC=9D=91=EB=8B=B5=20=ED=91=9C?= =?UTF-8?q?=EC=A4=80=ED=99=94]=20CustomApiResponse=EB=A5=BC=20ApiResponseD?= =?UTF-8?q?to=EB=A1=9C=20=EB=B3=80=EA=B2=BD=ED=95=98=EC=97=AC=20API=20?= =?UTF-8?q?=EC=9D=91=EB=8B=B5=20=EA=B5=AC=EC=A1=B0=EB=A5=BC=20=ED=86=B5?= =?UTF-8?q?=EC=9D=BC=ED=95=98=EA=B3=A0,=20=EA=B4=80=EB=A0=A8=20=EC=BD=94?= =?UTF-8?q?=EB=93=9C=20=EB=B0=8F=20=EB=AC=B8=EC=84=9C=20=EC=97=85=EB=8D=B0?= =?UTF-8?q?=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 21 +++-- .../member/controller/MemberController.java | 33 ++++---- .../global/config/SwaggerConfig.java | 7 +- ...omApiResponse.java => ApiResponseDto.java} | 13 ++-- .../CustomAuthenticationFailureHandler.java | 10 +-- .../exception/GlobalExceptionHandler.java | 78 +++---------------- .../exception/JwtAccessDeniedHandler.java | 5 +- .../security/JwtAuthenticationFilter.java | 4 +- .../global/security/JwtTokenFilter.java | 8 +- 9 files changed, 54 insertions(+), 125 deletions(-) rename src/main/java/com/bio/bio_backend/global/dto/{CustomApiResponse.java => ApiResponseDto.java} (53%) diff --git a/README.md b/README.md index 3401e87..a142501 100644 --- a/README.md +++ b/README.md @@ -32,14 +32,14 @@ src/main/java/com/bio/bio_backend/ └── BioBackendApplication.java ``` -### 2. API 응답 표준화 (CustomApiResponse) +### 2. API 응답 표준화 (ApiResponseDto) #### 응답 구조 -모든 API 응답은 `CustomApiResponse` 형태로 표준화되어 있습니다. +모든 API 응답은 `ApiResponseDto` 형태로 표준화되어 있습니다. ```java -public class CustomApiResponse { +public class ApiResponseDto { private int code; // HTTP 상태 코드 private String message; // 응답 메시지 (ApiResponseCode enum 값) private String description; // 응답 설명 @@ -81,12 +81,12 @@ public class CustomApiResponse { ```java @PostMapping("/members") -public ResponseEntity> createMember(@RequestBody CreateMemberRequestDto requestDto) { +public ResponseEntity> createMember(@RequestBody CreateMemberRequestDto requestDto) { // ... 비즈니스 로직 ... // 성공 응답 - CustomApiResponse apiResponse = - CustomApiResponse.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); + ApiResponseDto apiResponse = + ApiResponseDto.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); return ResponseEntity.status(HttpStatus.CREATED).body(apiResponse); } @@ -114,7 +114,7 @@ public enum ApiResponseCode { #### 핵심 규칙 -- **모든 API 응답**: `CustomApiResponse`로 감싸서 반환 +- **모든 API 응답**: `ApiResponseDto`로 감싸서 반환 - **공용 응답 코드**: `COMMON_` 접두사로 시작하는 범용 코드 사용 - **일관된 구조**: `code`, `message`, `description`, `data` 필드로 표준화 - **제네릭 활용**: ``를 통해 다양한 데이터 타입 지원 @@ -132,12 +132,11 @@ public enum ApiResponseCode { @Tag(name = "Member", description = "회원 관리 API") @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") @ApiResponses(value = { - @ApiResponse(responseCode = "201", description = "회원 가입 성공", - content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), + @ApiResponse(responseCode = "201", description = "회원 가입 성공"), @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", - content = @Content(schema = @Schema(implementation = CustomApiResponse.class))), + content = @Content(schema = @Schema(implementation = ApiResponseDto.class))), @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", - content = @Content(schema = @Schema(implementation = CustomApiResponse.class))) + content = @Content(schema = @Schema(implementation = ApiResponseDto.class))) }) ``` diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java index f37dbb4..e1fd8e3 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java @@ -1,14 +1,11 @@ package com.bio.bio_backend.domain.user.member.controller; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestBody; -import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.bind.annotation.*; import jakarta.validation.Valid; import com.bio.bio_backend.domain.user.member.dto.MemberDto; @@ -27,6 +24,7 @@ import com.bio.bio_backend.global.utils.ApiResponseCode; @Tag(name = "Member", description = "회원 관련 API") @RestController +@RequestMapping("/members") @RequiredArgsConstructor @Slf4j public class MemberController { @@ -38,16 +36,15 @@ public class MemberController { @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") @ApiResponses({ @ApiResponse(responseCode = "201", description = "회원 가입 성공"), - @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터"), - @ApiResponse(responseCode = "409", description = "중복된 사용자 정보") + @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", content = @Content(schema = @Schema(implementation = ApiResponseDto.class))), + @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", content = @Content(schema = @Schema(implementation = ApiResponseDto.class))) }) - @PostMapping("/members") - public ResponseEntity> createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { + @PostMapping + public ResponseEntity> createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { MemberDto member = memberMapper.toMemberDto(requestDto); MemberDto createdMember = memberService.createMember(member); CreateMemberResponseDto responseDto = memberMapper.toCreateMemberResponseDto(createdMember); - - CustomApiResponse apiResponse = CustomApiResponse.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); + ApiResponseDto apiResponse = ApiResponseDto.success(ApiResponseCode.COMMON_SUCCESS_CREATED, responseDto); return ResponseEntity.status(HttpStatus.CREATED).body(apiResponse); } @@ -81,7 +78,7 @@ public class MemberController { // } // @PutMapping("/member") - // public CustomApiResponse updateMember(@RequestBody @Valid CreateMemberRequestDTO requestMember, @AuthenticationPrincipal MemberDTO registrant) { + // public ApiResponseDto updateMember(@RequestBody @Valid CreateMemberRequestDTO requestMember, @AuthenticationPrincipal MemberDTO registrant) { // // 현재 JWT는 사용자 id 값을 통하여 생성, 회원정보 변경 시 JWT 재발급 여부 검토 // MemberDTO member = mapper.map(requestMember, MemberDTO.class); @@ -93,31 +90,31 @@ public class MemberController { // member.setRegSeq(registrant.getSeq()); // memberService.updateMember(member); - // return CustomApiResponse.success(ApiResponseCode.USER_INFO_CHANGE, null); + // return ApiResponseDto.success(ApiResponseCode.USER_INFO_CHANGE, null); // } // @DeleteMapping("/member") - // public CustomApiResponse deleteMember(@RequestBody @Valid CreateMemberRequestDTO requestMember){ + // public ApiResponseDto deleteMember(@RequestBody @Valid CreateMemberRequestDTO requestMember){ // MemberDTO member = mapper.map(requestMember, MemberDTO.class); // memberService.deleteMember(member); - // return CustomApiResponse.success(ApiResponseCode.USER_DELETE_SUCCESSFUL, null); + // return ApiResponseDto.success(ApiResponseCode.USER_DELETE_SUCCESSFUL, null); // } // @PostMapping("/logout") - // public CustomApiResponse logout(@AuthenticationPrincipal MemberDTO member) { + // public ApiResponseDto logout(@AuthenticationPrincipal MemberDTO member) { // String id = member.getId(); // try { // memberService.deleteRefreshToken(id); // } catch (Exception e) { - // return CustomApiResponse.fail(ApiResponseCode.INTERNAL_SERVER_ERROR, null); + // return ApiResponseDto.fail(ApiResponseCode.INTERNAL_SERVER_ERROR, null); // } - // return CustomApiResponse.success(ApiResponseCode.LOGOUT_SUCCESSFUL, null); + // return ApiResponseDto.success(ApiResponseCode.LOGOUT_SUCCESSFUL, null); // } } diff --git a/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java b/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java index 1ef3edb..4b5a186 100644 --- a/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java +++ b/src/main/java/com/bio/bio_backend/global/config/SwaggerConfig.java @@ -2,7 +2,6 @@ package com.bio.bio_backend.global.config; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Info; -import io.swagger.v3.oas.models.info.Contact; import io.swagger.v3.oas.models.info.License; import io.swagger.v3.oas.models.servers.Server; import org.springframework.context.annotation.Bean; @@ -22,10 +21,6 @@ public class SwaggerConfig { .version("v1.0.0") .license(new License() .name("STAM License") - .url("https://stam.kr/"))) - .servers(List.of( - new Server().url("http://localhost:8080/service").description("Local Development Server"), - new Server().url("https://api.bio.com/service").description("Production Server") - )); + .url("https://stam.kr/"))); } } diff --git a/src/main/java/com/bio/bio_backend/global/dto/CustomApiResponse.java b/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java similarity index 53% rename from src/main/java/com/bio/bio_backend/global/dto/CustomApiResponse.java rename to src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java index 0634a8a..1d8e071 100644 --- a/src/main/java/com/bio/bio_backend/global/dto/CustomApiResponse.java +++ b/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java @@ -7,11 +7,10 @@ import com.bio.bio_backend.global.utils.ApiResponseCode; import lombok.Data; import lombok.RequiredArgsConstructor; -//공통 response Class @Data @RequiredArgsConstructor @JsonInclude(JsonInclude.Include.NON_NULL) -public class CustomApiResponse { +public class ApiResponseDto { private int code; private String message; @@ -20,19 +19,19 @@ public class CustomApiResponse { private static final int SUCCESS = 200; - private CustomApiResponse(int code, String message, String description, T data){ + private ApiResponseDto(int code, String message, String description, T data){ this.code = code; this.message = message; this.description = description; this.data = data; } - public static CustomApiResponse success(ApiResponseCode responseCode, T data) { - return new CustomApiResponse(SUCCESS, responseCode.name(), responseCode.getDescription(), data); + public static ApiResponseDto success(ApiResponseCode responseCode, T data) { + return new ApiResponseDto(SUCCESS, responseCode.name(), responseCode.getDescription(), data); } - public static CustomApiResponse fail(ApiResponseCode responseCode, T data) { - return new CustomApiResponse(responseCode.getStatusCode(), responseCode.name(), responseCode.getDescription(), data); + public static ApiResponseDto fail(ApiResponseCode responseCode, T data) { + return new ApiResponseDto(responseCode.getStatusCode(), responseCode.name(), responseCode.getDescription(), data); } } diff --git a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java index 0c52b84..01c54f5 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java @@ -14,7 +14,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.global.utils.ApiResponseCode; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -36,14 +36,14 @@ public class CustomAuthenticationFailureHandler implements AuthenticationFailure response.setCharacterEncoding("UTF-8"); response.setStatus(HttpStatus.UNAUTHORIZED.value()); - CustomApiResponse apiResponse; + ApiResponseDto apiResponse; if (exception instanceof UsernameNotFoundException) { - apiResponse = CustomApiResponse.fail(ApiResponseCode.USER_NOT_FOUND, null); + apiResponse = ApiResponseDto.fail(ApiResponseCode.USER_NOT_FOUND, null); } else if (exception instanceof BadCredentialsException) { - apiResponse = CustomApiResponse.fail(ApiResponseCode.COMMON_UNAUTHORIZED, null); + apiResponse = ApiResponseDto.fail(ApiResponseCode.COMMON_UNAUTHORIZED, null); } else { response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value()); - apiResponse = CustomApiResponse.fail(ApiResponseCode.COMMON_INTERNAL_SERVER_ERROR, null); + apiResponse = ApiResponseDto.fail(ApiResponseCode.COMMON_INTERNAL_SERVER_ERROR, null); } String jsonResponse = objectMapper.writeValueAsString(apiResponse); diff --git a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java index 2bba0c7..9707760 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java @@ -1,92 +1,32 @@ package com.bio.bio_backend.global.exception; -import java.util.Objects; - -import lombok.Getter; -import org.springframework.http.converter.HttpMessageNotReadableException; -import org.springframework.web.HttpRequestMethodNotSupportedException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; import org.springframework.web.bind.MethodArgumentNotValidException; -import org.springframework.web.servlet.resource.NoResourceFoundException; -import com.fasterxml.jackson.core.JsonProcessingException; - -import io.jsonwebtoken.ExpiredJwtException; -import io.jsonwebtoken.JwtException; -import io.jsonwebtoken.MalformedJwtException; -import io.jsonwebtoken.security.SignatureException; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.global.utils.ApiResponseCode; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; @RestControllerAdvice public class GlobalExceptionHandler { - @ExceptionHandler(HttpMessageNotReadableException.class) - public CustomApiResponse handleHttpMessageNotReadableException(HttpMessageNotReadableException e) { - if (Objects.requireNonNull(e.getMessage()).contains("JSON parse error")) { - return CustomApiResponse.fail(ApiResponseCode.COMMON_FORMAT_WRONG, null); - } - return CustomApiResponse.fail(ApiResponseCode.COMMON_BAD_REQUEST, null); - } - @ExceptionHandler(HttpRequestMethodNotSupportedException.class) - public CustomApiResponse handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) { - return CustomApiResponse.fail(ApiResponseCode.COMMON_METHOD_NOT_ALLOWED, null); - } - - @ExceptionHandler(NoResourceFoundException.class) - public CustomApiResponse handleNoResourceFoundException(NoResourceFoundException e){ - return CustomApiResponse.fail(ApiResponseCode.COMMON_NOT_FOUND, null); - } - - @ExceptionHandler(IllegalArgumentException.class) - public CustomApiResponse handleIllegalArgumentException(IllegalArgumentException e){ - return CustomApiResponse.fail(ApiResponseCode.COMMON_ARGUMENT_NOT_VALID, null); - } - - @ExceptionHandler(IndexOutOfBoundsException.class) - public CustomApiResponse handleIndexOutOfBoundsException(IndexOutOfBoundsException e){ - return CustomApiResponse.fail(ApiResponseCode.COMMON_INDEX_OUT_OF_BOUND, null); - } - - @ExceptionHandler(SignatureException.class) - public CustomApiResponse handleSignatureException(SignatureException e) { - return CustomApiResponse.fail(ApiResponseCode.JWT_SIGNATURE_MISMATCH, null); - } - - @ExceptionHandler(MalformedJwtException.class) - public CustomApiResponse handleMalformedJwtException(MalformedJwtException e) { - return CustomApiResponse.fail(ApiResponseCode.JWT_SIGNATURE_MISMATCH, null); - } - - @ExceptionHandler(JwtException.class) - public CustomApiResponse handleJwtExceptionException(JwtException e) { - return CustomApiResponse.fail(ApiResponseCode.JWT_TOKEN_NULL, null); - } - - @ExceptionHandler(ExpiredJwtException.class) - public CustomApiResponse handleExpiredJwtException(ExpiredJwtException e) { - return CustomApiResponse.fail(ApiResponseCode.JWT_TOKEN_EXPIRED, null); - } - - @ExceptionHandler(JsonProcessingException.class) - public CustomApiResponse handleExpiredJwtException(JsonProcessingException e) { - return CustomApiResponse.fail(ApiResponseCode.COMMON_JSON_PROCESSING_EXCEPTION, null); - } - @ExceptionHandler(ApiException.class) - public CustomApiResponse handleApiException(ApiException e) { - return CustomApiResponse.fail(e.getResponseCode(), null); + public ResponseEntity> handleApiException(ApiException e) { + ApiResponseDto response = ApiResponseDto.fail(e.getResponseCode(), null); + return ResponseEntity.status(e.getResponseCode().getStatusCode()).body(response); } @ExceptionHandler(MethodArgumentNotValidException.class) - public CustomApiResponse handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { + public ResponseEntity> handleMethodArgumentNotValidException(MethodArgumentNotValidException e) { // 검증 실패한 필드들의 상세 오류 정보 추출 var errors = e.getBindingResult().getFieldErrors().stream() .map(error -> new ValidationError(error.getField(), error.getDefaultMessage())) .toList(); - return CustomApiResponse.fail(ApiResponseCode.COMMON_ARGUMENT_NOT_VALID, errors); + ApiResponseDto response = ApiResponseDto.fail(ApiResponseCode.COMMON_ARGUMENT_NOT_VALID, errors); + return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(response); } // 검증 오류 상세 정보를 위한 내부 클래스 diff --git a/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java b/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java index dfe92f9..bcb1a23 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java @@ -14,7 +14,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.global.utils.ApiResponseCode; @Component @@ -35,8 +35,7 @@ public class JwtAccessDeniedHandler implements AccessDeniedHandler { } else { response.setStatus(HttpServletResponse.SC_FORBIDDEN); response.setContentType(MediaType.APPLICATION_JSON_VALUE); - new ObjectMapper().writeValue(response.getWriter(), - CustomApiResponse.fail(ApiResponseCode.COMMON_FORBIDDEN, null)); + new ObjectMapper().writeValue(response.getWriter(), ApiResponseDto.fail(ApiResponseCode.COMMON_FORBIDDEN, null)); } } } diff --git a/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java b/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java index 84df2b9..9a5caab 100644 --- a/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java +++ b/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java @@ -6,7 +6,7 @@ import jakarta.servlet.ServletException; import jakarta.servlet.http.Cookie; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.domain.user.member.dto.LoginRequestDto; import com.bio.bio_backend.domain.user.member.dto.LoginResponseDto; import com.bio.bio_backend.domain.user.member.dto.MemberDto; @@ -116,6 +116,6 @@ public class JwtAuthenticationFilter extends UsernamePasswordAuthenticationFilte response.setStatus(HttpStatus.OK.value()); response.setContentType(MediaType.APPLICATION_JSON_VALUE); new ObjectMapper().writeValue(response.getWriter(), - CustomApiResponse.success(ApiResponseCode.LOGIN_SUCCESSFUL, memberData)); + ApiResponseDto.success(ApiResponseCode.LOGIN_SUCCESSFUL, memberData)); } } diff --git a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java index 6f054f7..92afe3b 100644 --- a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java +++ b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java @@ -20,7 +20,7 @@ import jakarta.servlet.FilterChain; import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; -import com.bio.bio_backend.global.dto.CustomApiResponse; +import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.domain.user.member.service.MemberService; import com.bio.bio_backend.global.utils.ApiResponseCode; import com.bio.bio_backend.global.utils.JwtUtils; @@ -50,7 +50,7 @@ public class JwtTokenFilter extends OncePerRequestFilter { String refreshToken = jwtUtils.extractRefreshJwtFromCookie(request); if(accessToken == null){ - sendJsonResponse(response, CustomApiResponse.fail(ApiResponseCode.JWT_TOKEN_NULL, null)); + sendJsonResponse(response, ApiResponseDto.fail(ApiResponseCode.JWT_TOKEN_NULL, null)); return; } @@ -83,7 +83,7 @@ public class JwtTokenFilter extends OncePerRequestFilter { response.setHeader("Authorization", "Bearer " + newAccessToken); filterChain.doFilter(request, response); } else { - sendJsonResponse(response, CustomApiResponse.fail(ApiResponseCode.ALL_TOKEN_INVALID, null)); + sendJsonResponse(response, ApiResponseDto.fail(ApiResponseCode.ALL_TOKEN_INVALID, null)); } } catch (Exception e) { request.setAttribute("exception", e); @@ -92,7 +92,7 @@ public class JwtTokenFilter extends OncePerRequestFilter { filterChain.doFilter(request, response); } - private void sendJsonResponse(HttpServletResponse response, CustomApiResponse apiResponse) throws IOException { + private void sendJsonResponse(HttpServletResponse response, ApiResponseDto apiResponse) throws IOException { response.setContentType(MediaType.APPLICATION_JSON_VALUE); response.setCharacterEncoding("UTF-8"); response.setStatus(apiResponse.getCode()); From 21f121c49060cf24f3efbdb031cfa38b6ef73280 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Thu, 14 Aug 2025 10:50:38 +0900 Subject: [PATCH 08/10] =?UTF-8?q?[Swagger=20=EC=84=A4=EC=A0=95=20=EC=97=85?= =?UTF-8?q?=EB=8D=B0=EC=9D=B4=ED=8A=B8]=20=EA=B8=B0=EB=B3=B8=20=EB=AF=B8?= =?UTF-8?q?=EB=94=94=EC=96=B4=20=ED=83=80=EC=9E=85=EC=9D=84=20application/?= =?UTF-8?q?json=EC=9C=BC=EB=A1=9C=20=EC=84=A4=EC=A0=95=ED=95=98=EC=97=AC?= =?UTF-8?q?=20Swagger=20API=20=EB=AC=B8=EC=84=9C=EC=9D=98=20=EC=9D=91?= =?UTF-8?q?=EB=8B=B5=20=EB=B0=8F=20=EC=9A=94=EC=B2=AD=20=ED=98=95=EC=8B=9D?= =?UTF-8?q?=EC=9D=84=20=ED=91=9C=EC=A4=80=ED=99=94?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/resources/application.properties | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 09f9612..78a0296 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -61,4 +61,6 @@ springdoc.swagger-ui.operationsSorter=method springdoc.swagger-ui.tagsSorter=alpha springdoc.swagger-ui.doc-expansion=none springdoc.swagger-ui.disable-swagger-default-url=true +springdoc.default-produces-media-type=application/json +springdoc.default-consumes-media-type=application/json From baab0352d59e79bc24501a42dd3ed198c10e7466 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Thu, 14 Aug 2025 17:19:52 +0900 Subject: [PATCH 09/10] =?UTF-8?q?[=EC=83=81=EC=88=98=20=EB=A6=AC=ED=8C=A9?= =?UTF-8?q?=ED=86=A0=EB=A7=81]=20ApiResponseCode=EB=A5=BC=20global.constan?= =?UTF-8?q?ts=20=ED=8C=A8=ED=82=A4=EC=A7=80=EB=A1=9C=20=EC=9D=B4=EB=8F=99?= =?UTF-8?q?=ED=95=98=EA=B3=A0,=20=EA=B4=80=EB=A0=A8=20=EC=BD=94=EB=93=9C?= =?UTF-8?q?=EC=97=90=EC=84=9C=20ApiResponseCode=20=EC=B0=B8=EC=A1=B0?= =?UTF-8?q?=EB=A5=BC=20=EC=97=85=EB=8D=B0=EC=9D=B4=ED=8A=B8=ED=95=98?= =?UTF-8?q?=EC=97=AC=20=EC=BD=94=EB=93=9C=20=EC=9D=BC=EA=B4=80=EC=84=B1=20?= =?UTF-8?q?=EB=B0=8F=20=EA=B0=80=EB=8F=85=EC=84=B1=20=ED=96=A5=EC=83=81?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../user/member/controller/MemberController.java | 4 ++-- .../member/exception/UserDuplicateException.java | 12 ------------ .../user/member/service/MemberServiceImpl.java | 3 +-- .../global/{utils => constants}/ApiResponseCode.java | 2 +- .../bio/bio_backend/global/dto/ApiResponseDto.java | 2 +- .../bio_backend/global/exception/ApiException.java | 2 +- .../CustomAuthenticationFailureHandler.java | 2 +- .../global/exception/GlobalExceptionHandler.java | 2 +- .../global/exception/JwtAccessDeniedHandler.java | 2 +- .../global/security/JwtAuthenticationFilter.java | 4 +--- .../bio_backend/global/security/JwtTokenFilter.java | 4 +--- 11 files changed, 11 insertions(+), 28 deletions(-) delete mode 100644 src/main/java/com/bio/bio_backend/domain/user/member/exception/UserDuplicateException.java rename src/main/java/com/bio/bio_backend/global/{utils => constants}/ApiResponseCode.java (98%) diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java index e1fd8e3..7c6efb1 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java @@ -20,7 +20,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; @Tag(name = "Member", description = "회원 관련 API") @RestController @@ -39,7 +39,7 @@ public class MemberController { @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", content = @Content(schema = @Schema(implementation = ApiResponseDto.class))), @ApiResponse(responseCode = "409", description = "중복된 사용자 정보", content = @Content(schema = @Schema(implementation = ApiResponseDto.class))) }) - @PostMapping + @PostMapping("/register") public ResponseEntity> createMember(@RequestBody @Valid CreateMemberRequestDto requestDto) { MemberDto member = memberMapper.toMemberDto(requestDto); MemberDto createdMember = memberService.createMember(member); diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/exception/UserDuplicateException.java b/src/main/java/com/bio/bio_backend/domain/user/member/exception/UserDuplicateException.java deleted file mode 100644 index c399d48..0000000 --- a/src/main/java/com/bio/bio_backend/domain/user/member/exception/UserDuplicateException.java +++ /dev/null @@ -1,12 +0,0 @@ -package com.bio.bio_backend.domain.user.member.exception; - -public class UserDuplicateException extends RuntimeException { - - public UserDuplicateException(String message) { - super(message); - } - - public UserDuplicateException(String message, Throwable cause) { - super(message, cause); - } -} diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java b/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java index b40f0f4..673566f 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/service/MemberServiceImpl.java @@ -5,9 +5,8 @@ import com.bio.bio_backend.domain.user.member.entity.Member; import com.bio.bio_backend.domain.user.member.enums.MemberRole; import com.bio.bio_backend.domain.user.member.mapper.MemberMapper; import com.bio.bio_backend.domain.user.member.repository.MemberRepository; -import com.bio.bio_backend.domain.user.member.exception.UserDuplicateException; import com.bio.bio_backend.global.exception.ApiException; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.security.core.userdetails.UserDetails; diff --git a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java b/src/main/java/com/bio/bio_backend/global/constants/ApiResponseCode.java similarity index 98% rename from src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java rename to src/main/java/com/bio/bio_backend/global/constants/ApiResponseCode.java index beb0035..be3c7b0 100644 --- a/src/main/java/com/bio/bio_backend/global/utils/ApiResponseCode.java +++ b/src/main/java/com/bio/bio_backend/global/constants/ApiResponseCode.java @@ -1,4 +1,4 @@ -package com.bio.bio_backend.global.utils; +package com.bio.bio_backend.global.constants; import lombok.AllArgsConstructor; import lombok.Getter; diff --git a/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java b/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java index 1d8e071..baebd96 100644 --- a/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java +++ b/src/main/java/com/bio/bio_backend/global/dto/ApiResponseDto.java @@ -3,7 +3,7 @@ package com.bio.bio_backend.global.dto; import com.fasterxml.jackson.annotation.JsonInclude; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import lombok.Data; import lombok.RequiredArgsConstructor; diff --git a/src/main/java/com/bio/bio_backend/global/exception/ApiException.java b/src/main/java/com/bio/bio_backend/global/exception/ApiException.java index d339468..c352375 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/ApiException.java +++ b/src/main/java/com/bio/bio_backend/global/exception/ApiException.java @@ -1,7 +1,7 @@ package com.bio.bio_backend.global.exception; import lombok.Getter; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; @Getter public class ApiException extends RuntimeException { diff --git a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java index 01c54f5..2cc9ceb 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/CustomAuthenticationFailureHandler.java @@ -15,7 +15,7 @@ import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import com.bio.bio_backend.global.dto.ApiResponseDto; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; diff --git a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java index 9707760..5cc592e 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/GlobalExceptionHandler.java @@ -5,7 +5,7 @@ import org.springframework.web.bind.annotation.RestControllerAdvice; import org.springframework.web.bind.MethodArgumentNotValidException; import com.bio.bio_backend.global.dto.ApiResponseDto; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; diff --git a/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java b/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java index bcb1a23..3056d84 100644 --- a/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java +++ b/src/main/java/com/bio/bio_backend/global/exception/JwtAccessDeniedHandler.java @@ -15,7 +15,7 @@ import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import com.bio.bio_backend.global.dto.ApiResponseDto; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; @Component public class JwtAccessDeniedHandler implements AccessDeniedHandler { diff --git a/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java b/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java index 9a5caab..631bf5c 100644 --- a/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java +++ b/src/main/java/com/bio/bio_backend/global/security/JwtAuthenticationFilter.java @@ -11,7 +11,7 @@ import com.bio.bio_backend.domain.user.member.dto.LoginRequestDto; import com.bio.bio_backend.domain.user.member.dto.LoginResponseDto; import com.bio.bio_backend.domain.user.member.dto.MemberDto; import com.bio.bio_backend.domain.user.member.service.MemberService; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import com.bio.bio_backend.global.utils.JwtUtils; import lombok.RequiredArgsConstructor; import lombok.SneakyThrows; @@ -20,7 +20,6 @@ import org.springframework.core.env.Environment; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.security.authentication.AuthenticationManager; -import org.springframework.security.authentication.AuthenticationServiceException; import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; import org.springframework.security.core.Authentication; import org.springframework.security.core.AuthenticationException; @@ -31,7 +30,6 @@ import org.springframework.security.core.userdetails.UserDetails; import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter; import java.io.IOException; -import java.sql.Timestamp; import java.time.LocalDateTime; import java.util.Objects; diff --git a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java index 92afe3b..5680d36 100644 --- a/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java +++ b/src/main/java/com/bio/bio_backend/global/security/JwtTokenFilter.java @@ -1,10 +1,8 @@ package com.bio.bio_backend.global.security; import java.io.IOException; -import java.util.Arrays; import java.util.Objects; -import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.env.Environment; import org.springframework.http.MediaType; import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; @@ -22,7 +20,7 @@ import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import com.bio.bio_backend.global.dto.ApiResponseDto; import com.bio.bio_backend.domain.user.member.service.MemberService; -import com.bio.bio_backend.global.utils.ApiResponseCode; +import com.bio.bio_backend.global.constants.ApiResponseCode; import com.bio.bio_backend.global.utils.JwtUtils; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; From 0f1c5443eafbbfc117ed865cf288fa910a5cf945 Mon Sep 17 00:00:00 2001 From: sohot8653 Date: Fri, 15 Aug 2025 00:53:17 +0900 Subject: [PATCH 10/10] =?UTF-8?q?[=EB=A1=9C=EA=B7=B8=20=EA=B8=B0=EB=8A=A5?= =?UTF-8?q?=20=EC=B6=94=EA=B0=80]=20HttpLoggingFilter=EB=A5=BC=20=EA=B5=AC?= =?UTF-8?q?=ED=98=84=ED=95=98=EC=97=AC=20HTTP=20=EC=9A=94=EC=B2=AD=20?= =?UTF-8?q?=EB=B0=8F=20=EC=9D=91=EB=8B=B5=20=EB=A1=9C=EA=B9=85=20=EA=B8=B0?= =?UTF-8?q?=EB=8A=A5=EC=9D=84=20=EC=B6=94=EA=B0=80=ED=95=98=EA=B3=A0,=20Me?= =?UTF-8?q?mberController=EC=97=90=EC=84=9C=20=ED=9A=8C=EC=9B=90=20?= =?UTF-8?q?=EB=93=B1=EB=A1=9D=20API=EC=97=90=20LogExecution=20=EC=96=B4?= =?UTF-8?q?=EB=85=B8=ED=85=8C=EC=9D=B4=EC=85=98=EC=9D=84=20=EC=A0=81?= =?UTF-8?q?=EC=9A=A9=ED=95=98=EC=97=AC=20=EC=8B=A4=ED=96=89=20=EB=A1=9C?= =?UTF-8?q?=EA=B7=B8=EB=A5=BC=20=EA=B8=B0=EB=A1=9D=ED=95=98=EB=8F=84?= =?UTF-8?q?=EB=A1=9D=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 53 ++++++ .../member/controller/MemberController.java | 4 +- .../global/annotation/LogExecution.java | 15 ++ .../aop/MethodExecutionLoggingAspect.java | 55 ++++++ .../global/filter/HttpLoggingFilter.java | 166 ++++++++++++------ src/main/resources/application.properties | 88 +++++++--- src/main/resources/logback-spring.xml | 92 ++++++++++ 7 files changed, 387 insertions(+), 86 deletions(-) create mode 100644 src/main/java/com/bio/bio_backend/global/annotation/LogExecution.java create mode 100644 src/main/java/com/bio/bio_backend/global/aop/MethodExecutionLoggingAspect.java create mode 100644 src/main/resources/logback-spring.xml diff --git a/README.md b/README.md index a142501..cbc77af 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ src/main/java/com/bio/bio_backend/ │ ├── config/ # 설정 클래스 │ ├── security/ # 보안 설정 │ ├── exception/ # 예외 처리 +│ ├── aop/ # AOP 로깅 +│ ├── filter/ # HTTP 로깅 필터 │ └── utils/ # 유틸리티 └── BioBackendApplication.java ``` @@ -195,3 +197,54 @@ throw new ApiException(ApiResponseCode.USER_ID_DUPLICATE); - **오류 코드**: `ApiResponseCode` enum에 모든 오류 정의 - **예외 클래스**: `ApiException`으로 비즈니스 로직 예외 처리 - **자동 처리**: `GlobalExceptionHandler`가 일관된 응답 형태로 변환 + +### 6. 로깅 시스템 + +#### @LogExecution 어노테이션 사용법 + +**메서드 실행 로깅을 위한 필수 어노테이션입니다.** + +##### 기본 사용법 + +```java +@LogExecution("회원 등록") +@PostMapping("/register") +public ResponseEntity> createMember(@RequestBody CreateMemberRequestDto requestDto) { + // 메서드 실행 시 자동으로 로그 출력 +} +``` + +##### 로그 출력 예시 + +**메서드 시작 시:** +``` +[START] 회원 등록 | 호출경로: MemberController.createMember | 사용자: 고명빈(kmbin92) +``` + +**메서드 성공 시:** +``` +[SUCCESS] 회원 등록 | 호출경로: MemberController.createMember | 사용자: 고명빈(kmbin92) | 시간: 200ms +``` + +**메서드 실패 시:** +``` +[FAILED] 회원 등록 | 호출경로: MemberController.createMember | 사용자: 고명빈(kmbin92) | 시간: 23ms | 오류: 이미 존재하는 사용자 ID입니다 +``` + +##### 어노테이션 설정 + +```java +@LogExecution("사용자 정보 조회") +public UserDto getUserInfo() { } + +@LogExecution("주문 처리") +public OrderDto processOrder() { } +``` + +##### 로깅 시스템 구성 + +1. **MethodExecutionLoggingAspect**: 메서드 실행 로깅 (AOP) +2. **HttpLoggingFilter**: HTTP 요청/응답 로깅 (필터) +3. **logback-spring.xml**: 로그 파일 관리 및 설정 + +**중요**: `@LogExecution` 어노테이션이 없으면 메서드 실행 로그가 출력되지 않습니다 diff --git a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java index 7c6efb1..284b9fe 100644 --- a/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java +++ b/src/main/java/com/bio/bio_backend/domain/user/member/controller/MemberController.java @@ -21,6 +21,7 @@ import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; import com.bio.bio_backend.global.constants.ApiResponseCode; +import com.bio.bio_backend.global.annotation.LogExecution; @Tag(name = "Member", description = "회원 관련 API") @RestController @@ -33,7 +34,8 @@ public class MemberController { private final MemberMapper memberMapper; private final BCryptPasswordEncoder bCryptPasswordEncoder; - @Operation(summary = "회원 가입", description = "새로운 회원을 등록합니다.") + @LogExecution("회원 등록") + @Operation(summary = "회원 등록", description = "새로운 회원을 등록합니다.") @ApiResponses({ @ApiResponse(responseCode = "201", description = "회원 가입 성공"), @ApiResponse(responseCode = "400", description = "잘못된 요청 데이터", content = @Content(schema = @Schema(implementation = ApiResponseDto.class))), diff --git a/src/main/java/com/bio/bio_backend/global/annotation/LogExecution.java b/src/main/java/com/bio/bio_backend/global/annotation/LogExecution.java new file mode 100644 index 0000000..7ca161d --- /dev/null +++ b/src/main/java/com/bio/bio_backend/global/annotation/LogExecution.java @@ -0,0 +1,15 @@ +package com.bio.bio_backend.global.annotation; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * 메서드 실행 로깅 어노테이션 + */ +@Target(ElementType.METHOD) +@Retention(RetentionPolicy.RUNTIME) +public @interface LogExecution { + String value() default ""; +} diff --git a/src/main/java/com/bio/bio_backend/global/aop/MethodExecutionLoggingAspect.java b/src/main/java/com/bio/bio_backend/global/aop/MethodExecutionLoggingAspect.java new file mode 100644 index 0000000..3041aa1 --- /dev/null +++ b/src/main/java/com/bio/bio_backend/global/aop/MethodExecutionLoggingAspect.java @@ -0,0 +1,55 @@ +package com.bio.bio_backend.global.aop; + +import lombok.extern.slf4j.Slf4j; +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.Around; +import org.aspectj.lang.annotation.Aspect; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.stereotype.Component; + +@Aspect +@Component +@Slf4j +public class MethodExecutionLoggingAspect { + + @Around("@annotation(logExecution)") + public Object logExecution(ProceedingJoinPoint pjp, com.bio.bio_backend.global.annotation.LogExecution logExecution) throws Throwable { + String message = logExecution.value().isEmpty() ? + pjp.getSignature().getName() : logExecution.value(); + + String className = pjp.getTarget().getClass().getSimpleName(); + String methodName = pjp.getSignature().getName(); + + String userInfo = getCurrentUser(); + + long startTime = System.currentTimeMillis(); + log.info("[START] {} | 호출경로: {}.{} | 사용자: {}", + message, className, methodName, userInfo); + + try { + Object result = pjp.proceed(); + long duration = System.currentTimeMillis() - startTime; + log.info("[SUCCESS] {} | 호출경로: {}.{} | 사용자: {} | 시간: {}ms", + message, className, methodName, userInfo, duration); + return result; + } catch (Exception e) { + long duration = System.currentTimeMillis() - startTime; + log.error("[FAILED] {} | 호출경로: {}.{} | 사용자: {} | 시간: {}ms | 오류: {}", + message, className, methodName, userInfo, duration, e.getMessage()); + throw e; + } + } + + private String getCurrentUser() { + try { + Authentication auth = SecurityContextHolder.getContext().getAuthentication(); + if (auth != null && auth.isAuthenticated() && !"anonymousUser".equals(auth.getName())) { + return auth.getName(); + } + return "인증되지 않은 사용자"; + } catch (Exception e) { + return "알 수 없는 사용자"; + } + } +} diff --git a/src/main/java/com/bio/bio_backend/global/filter/HttpLoggingFilter.java b/src/main/java/com/bio/bio_backend/global/filter/HttpLoggingFilter.java index 91c98dd..80ee717 100644 --- a/src/main/java/com/bio/bio_backend/global/filter/HttpLoggingFilter.java +++ b/src/main/java/com/bio/bio_backend/global/filter/HttpLoggingFilter.java @@ -1,57 +1,109 @@ -//package com.bio.bio_backend.filter; -// -//import java.io.IOException; -//import java.sql.Timestamp; -// -//import org.springframework.security.core.Authentication; -//import org.springframework.security.core.context.SecurityContextHolder; -//import org.springframework.web.filter.OncePerRequestFilter; -// -//import jakarta.servlet.FilterChain; -//import jakarta.servlet.ServletException; -//import jakarta.servlet.http.HttpServletRequest; -//import jakarta.servlet.http.HttpServletResponse; -//import com.bio.bio_backend.domain.common.dto.AccessLogDTO; -//import com.bio.bio_backend.domain.common.service.AccessLogService; -//import com.bio.bio_backend.domain.user.member.dto.MemberDTO; -//import com.bio.bio_backend.global.utils.HttpUtils; -// -//public class HttpLoggingFilter extends OncePerRequestFilter { -// -//// private AccessLogService accessLogService; -// private HttpUtils httpUtils; -// -// public HttpLoggingFilter(AccessLogService accessLogService, HttpUtils httpUtils) { -// this.accessLogService = accessLogService; -// this.httpUtils = httpUtils; -// } -// -// @Override -// protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) -// throws ServletException, IOException { -// // Request 요청 시간 -// Long startedAt = System.currentTimeMillis(); -// filterChain.doFilter(request, response); -// Long finishedAt = System.currentTimeMillis(); -// -// Authentication auth = SecurityContextHolder.getContext().getAuthentication(); -// MemberDTO member = null; -// if(auth != null && auth.getPrincipal() instanceof MemberDTO) { -// member = (MemberDTO) auth.getPrincipal(); -// } -// -// AccessLogDTO log = new AccessLogDTO(); -// log.setMbrSeq(member == null ? -1 : member.getSeq()); -// log.setType(httpUtils.getResponseType(response.getContentType())); -// log.setMethod(request.getMethod()); -// log.setIp(httpUtils.getClientIp()); -// log.setUri(request.getRequestURI()); -// log.setReqAt(new Timestamp(startedAt)); -// log.setResAt(new Timestamp(finishedAt)); -// log.setElapsedTime(finishedAt - startedAt); -// log.setResStatus(String.valueOf(response.getStatus())); -// -// accessLogService.createAccessLog(log); -// } -// -//} +package com.bio.bio_backend.global.filter; + +import jakarta.servlet.FilterChain; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import lombok.extern.slf4j.Slf4j; +import org.springframework.stereotype.Component; +import org.springframework.web.filter.OncePerRequestFilter; +import org.springframework.web.util.ContentCachingRequestWrapper; +import org.springframework.web.util.ContentCachingResponseWrapper; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; + +@Slf4j +@Component +public class HttpLoggingFilter extends OncePerRequestFilter { + + @Override + protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) + throws ServletException, IOException { + + long startTime = System.currentTimeMillis(); + + // 요청 정보 로깅 (IP 정보 제거) + log.info("HTTP REQUEST: {} {} | Headers: {} | Body: {}", + request.getMethod(), request.getRequestURI(), + getRequestHeaders(request), getRequestBody(request)); + + ContentCachingRequestWrapper wrappedRequest = new ContentCachingRequestWrapper(request); + ContentCachingResponseWrapper wrappedResponse = new ContentCachingResponseWrapper(response); + + try { + filterChain.doFilter(wrappedRequest, wrappedResponse); + } finally { + long duration = System.currentTimeMillis() - startTime; + + // 응답 정보 로깅 + log.info("HTTP RESPONSE: {} {} | Status: {} | Time: {}ms | Headers: {} | Body: {}", + request.getMethod(), request.getRequestURI(), + wrappedResponse.getStatus(), duration, getResponseHeaders(wrappedResponse), getResponseBody(wrappedResponse)); + + wrappedResponse.copyBodyToResponse(); + } + } + + // 민감 정보 마스킹 메서드 + private String maskSensitiveData(String body) { + if (body == null || body.isEmpty()) return "N/A"; + + // 비밀번호, 토큰 등 민감 정보 마스킹 + return body.replaceAll("\"password\"\\s*:\\s*\"[^\"]*\"", "\"password\":\"***\"") + .replaceAll("\"token\"\\s*:\\s*\"[^\"]*\"", "\"token\":\"***\"") + .replaceAll("\"refreshToken\"\\s*:\\s*\"[^\"]*\"", "\"refreshToken\":\"***\""); + } + + private String getRequestHeaders(HttpServletRequest request) { + // 주요 헤더만 (Content-Type, Authorization, User-Agent) + Map headers = new HashMap<>(); + headers.put("Content-Type", request.getContentType()); + headers.put("User-Agent", request.getHeader("User-Agent")); + + // Authorization 헤더는 마스킹 + String auth = request.getHeader("Authorization"); + if (auth != null) { + headers.put("Authorization", auth.startsWith("Bearer ") ? "Bearer ***" : "***"); + } + + return headers.toString(); + } + + private String getRequestBody(HttpServletRequest request) { + try { + ContentCachingRequestWrapper wrapper = (ContentCachingRequestWrapper) request; + String body = new String(wrapper.getContentAsByteArray()); + return maskSensitiveData(body); + } catch (Exception e) { + return "N/A"; + } + } + + private String getResponseHeaders(HttpServletResponse response) { + // 응답 헤더 정보 + return "Content-Type: " + response.getContentType(); + } + + private String getResponseBody(HttpServletResponse response) { + try { + ContentCachingResponseWrapper wrapper = (ContentCachingResponseWrapper) response; + String body = new String(wrapper.getContentAsByteArray()); + return maskSensitiveData(body); + } catch (Exception e) { + return "N/A"; + } + } + + @Override + protected boolean shouldNotFilter(HttpServletRequest request) { + String path = request.getRequestURI(); + return path.startsWith("/static/") || + path.startsWith("/css/") || + path.startsWith("/js/") || + path.startsWith("/images/") || + path.equals("/actuator/health") || + path.equals("/favicon.ico"); + } +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties index 78a0296..667b6cf 100644 --- a/src/main/resources/application.properties +++ b/src/main/resources/application.properties @@ -1,60 +1,92 @@ +# ======================================== +# 기본 애플리케이션 설정 +# ======================================== server.port=8080 server.servlet.context-path=/service spring.application.name=bio_backend +spring.output.ansi.enabled=always + +# ======================================== +# 개발 도구 설정 +# ======================================== spring.devtools.livereload.enabled=true -#spring.devtools.restart.poll-interval=2000 -# 추가로 감시할 경로 (자바 소스 폴더) spring.devtools.restart.additional-paths=src/main/java - -# 데이터베이스 연결 정보 -# URL 형식: jdbc:postgresql://[호스트명]:[포트번호]/[데이터베이스명] +# ======================================== +# 데이터베이스 설정 +# ======================================== spring.datasource.url=jdbc:postgresql://stam.kr:15432/imas spring.datasource.username=imas_user spring.datasource.password=stam1201 spring.datasource.driver-class-name=org.postgresql.Driver +# ======================================== # JPA/Hibernate 설정 -# ddl-auto: 엔티티(Entity)에 맞춰 데이터베이스 스키마를 자동 생성/업데이트합니다. -# - create: 애플리케이션 시작 시 기존 스키마를 삭제하고 새로 생성 (개발용) -# - create-drop: 시작 시 생성, 종료 시 삭제 (테스트용) -# - update: 엔티티 변경 시 스키마 업데이트 (개발용) -# - validate: 엔티티와 스키마 일치 여부만 검증 (운영용) -# - none: 아무 작업도 하지 않음 +# ======================================== spring.jpa.hibernate.ddl-auto=none -spring.jpa.properties.javax.persistence.schema-generation.scripts.action=create -spring.jpa.properties.javax.persistence.schema-generation.scripts.create-target=ddl/schema.sql -spring.jpa.properties.hibernate.hbm2ddl.schema-generation.script.append=false - -# Hibernate log +spring.jpa.open-in-view=false spring.jpa.show-sql=false spring.jpa.properties.hibernate.format_sql=true spring.jpa.properties.hibernate.highlight_sql=true spring.jpa.properties.hibernate.use_sql_comments=false + +# 스키마 생성 설정 +spring.jpa.properties.javax.persistence.schema-generation.scripts.action=create +spring.jpa.properties.javax.persistence.schema-generation.scripts.create-target=ddl/schema.sql +spring.jpa.properties.hibernate.hbm2ddl.schema-generation.script.append=false + +# ======================================== +# 로그 레벨 설정 +# ======================================== +# 전체 애플리케이션 기본 로그 레벨 +logging.level.root=INFO + +# 프로젝트 패키지 로그 레벨 +logging.level.com.bio.bio_backend=DEBUG + +# 세부 패키지별 로그 레벨 +logging.level.com.bio.bio_backend..*.controller=INFO +logging.level.com.bio.bio_backend..*.service=DEBUG +logging.level.com.bio.bio_backend..*.repository=DEBUG +logging.level.com.bio.bio_backend.global.aop=DEBUG +logging.level.com.bio.bio_backend.global.filter=INFO + +# JPA/Hibernate 로깅 logging.level.org.hibernate.SQL=DEBUG logging.level.org.hibernate.orm.jdbc.bind=TRACE +logging.level.org.hibernate.type.descriptor.sql.BasicBinder=TRACE logging.level.org.springframework.data.jpa=DEBUG +logging.level.org.springframework.orm.jpa=INFO +logging.level.org.springframework.transaction=DEBUG -# Open Session in View 설정 (권장: false) -spring.jpa.open-in-view=false +# Spring Framework 로깅 +logging.level.org.springframework.web=WARN +logging.level.org.springframework.web.servlet.DispatcherServlet=WARN +logging.level.org.springframework.security=INFO -# P6Spy + +# ======================================== +# 로그 패턴 설정 +# ======================================== +logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n +logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + +# ======================================== +# P6Spy 설정 (SQL 로깅) +# ======================================== decorator.datasource.p6spy.enable-logging=true decorator.datasource.p6spy.log-format=%(sqlSingleLine) -# CONSOLE -spring.output.ansi.enabled=always - -# HikariCP 연결 풀 크기 설정 (선택사항) -# spring.datasource.hikari.maximum-pool-size=10 - -##JWT 설정 -## access : 30분 / refresh : 7일 +# ======================================== +# JWT 설정 +# ======================================== token.expiration_time_access=180000 token.expiration_time_refresh=604800000 -token.secret_key= c3RhbV9qd3Rfc2VjcmV0X3Rva2Vuc3RhbV9qd3Rfc2VjcmV0X3Rva2Vu +token.secret_key=c3RhbV9qd3Rfc2VjcmV0X3Rva2Vuc3RhbV9qd3Rfc2VjcmV0X3RhbV9qd3Rfc2VjcmV0X3Rva2Vu +# ======================================== # Swagger 설정 +# ======================================== springdoc.api-docs.path=/api-docs springdoc.swagger-ui.path=/swagger-ui.html springdoc.swagger-ui.operationsSorter=method diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml new file mode 100644 index 0000000..1eab898 --- /dev/null +++ b/src/main/resources/logback-spring.xml @@ -0,0 +1,92 @@ + + + + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + + logs/bio-backend.log + + + logs/bio-backend-%d{yyyy-MM-dd}.%i.log + + 30 + + 10MB + + 1GB + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + + logs/bio-backend-error.log + + ERROR + ACCEPT + DENY + + + logs/bio-backend-error-%d{yyyy-MM-dd}.%i.log + 30 + 10MB + 500MB + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file