From 905906b923917b6792a206707ed3a4f850f5db29 Mon Sep 17 00:00:00 2001 From: kric_jspark Date: Fri, 27 Mar 2026 11:01:47 +0900 Subject: [PATCH] =?UTF-8?q?260327=5F01=5FENH:=20=ED=94=84=EB=A1=9C?= =?UTF-8?q?=EC=A0=9D=ED=8A=B8=20=EA=B5=AC=EC=A1=B0=20=EB=A6=AC=ED=8E=99?= =?UTF-8?q?=ED=86=A0=EB=A7=81=20=EB=B0=8F=20README.md=20=EA=B0=B1=EC=8B=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1571 +++-------------- build.gradle | 13 +- .../apikey/ApiKeyAdminAutoConfiguration.java | 5 +- .../apikey/ApiKeyJpaAutoConfiguration.java | 4 +- .../ApiKeyPreloadAutoConfiguration.java | 8 +- .../auth/apikey/ApiKeyProperties.java | 2 +- .../auth/jwt/JwtAutoConfiguration.java | 19 +- .../auth/jwt/JwtProperties.java | 4 +- .../redis/CommonRedisAutoConfiguration.java | 9 +- .../CommonSchedulingAutoConfiguration.java | 8 +- .../KriSecurityAutoConfiguration.java | 11 +- .../security/KriSecurityProperties.java | 2 +- .../swagger/KriSwaggerAutoConfiguration.java | 24 +- .../swagger/KriSwaggerProperties.java | 6 +- .../web/CommonWebAutoConfiguration.java | 39 + .../webmvc/KriIpAccessProperties.java | 2 +- .../webmvc/KriWebMvcAutoConfiguration.java | 13 +- .../auth/apikey/ApiKeyAdminController.java | 8 +- .../auth/apikey/ApiKeyUserClaimsProvider.java | 4 +- .../auth/dto/JwtUserClaimsDto.java | 4 +- .../{ => feature}/auth/jwt/JwtService.java | 74 +- .../cache/AbstractListCache.java | 6 +- .../{ => feature}/cache/AbstractMapCache.java | 3 +- .../{ => feature}/datetime/DateTimeUtil.java | 2 +- .../datetime/LenientLocalDateTime.java | 2 +- .../LenientLocalDateTimeDeserializer.java | 4 +- .../common/{ => feature}/enums/CodeEnum.java | 2 +- .../{ => feature}/enums/CodeEnumUtils.java | 2 +- .../{ => feature}/excel/ExcelColumn.java | 2 +- .../{ => feature}/excel/ExcelMapper.java | 4 +- .../common/{ => feature}/excel/ExcelUtil.java | 4 +- .../common/{ => feature}/file/FileUtil.java | 4 +- .../{ => feature}/http/ExternalApiClient.java | 4 +- .../http/ExternalApiResponse.java | 4 +- .../jpa/AbstractCodeEnumConverter.java | 6 +- .../{ => feature}/jpa/BaseUuidEntity.java | 2 +- .../common/{ => feature}/json/JsonUtil.java | 2 +- .../{ => feature}/redis/RedisQueueHelper.java | 2 +- .../common/{ => feature}/util/CommonUtil.java | 2 +- .../{ => feature}/util/NumericUtil.java | 2 +- .../common/{ => feature}/util/StringUtil.java | 4 +- .../{ => feature}/web/BusinessException.java | 2 +- .../web}/RequestUserContext.java | 4 +- .../web}/page/PageRequestDto.java | 2 +- .../web}/page/PageResponseDto.java | 2 +- .../web}/page/Pageables.java | 2 +- .../auth/apikey/ApiKeyAuthFilter.java | 26 +- .../PreloadedApiKeyUserClaimsProvider.java | 51 +- .../persistence/entity/TApiKeyEntity.java | 7 +- .../entity/TApiKeyServiceMapEntity.java | 2 +- .../entity/TApiKeyServiceMapEntityId.java | 2 +- .../repository/ApiKeyRepository.java | 6 +- .../security/JwtAuthenticationFilter.java | 4 +- .../swagger/SwaggerIpFilter.java | 4 +- .../common/{ => runtime}/web/ErrorAdvice.java | 7 +- .../{ => runtime}/web/MdcHandlerConfig.java | 6 +- .../{ => runtime}/web/ServiceMdcAspect.java | 4 +- .../common/{ => runtime}/web/TraceFilter.java | 4 +- .../webmvc/CodeEnumConverter.java | 8 +- .../webmvc/IpAccessControlInterceptor.java | 2 +- .../webmvc/IpAccessControlService.java | 3 +- .../common/{ => runtime}/webmvc/IpUtil.java | 4 +- .../RequestUserContextArgumentResolver.java | 23 +- .../web/CommonWebAutoConfiguration.java | 24 - ...ot.autoconfigure.AutoConfiguration.imports | 20 +- 65 files changed, 531 insertions(+), 1581 deletions(-) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/apikey/ApiKeyAdminAutoConfiguration.java (71%) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/apikey/ApiKeyJpaAutoConfiguration.java (98%) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/apikey/ApiKeyPreloadAutoConfiguration.java (73%) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/apikey/ApiKeyProperties.java (97%) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/jwt/JwtAutoConfiguration.java (61%) rename src/main/java/com/kri/common/{ => autoconfigure}/auth/jwt/JwtProperties.java (94%) rename src/main/java/com/kri/common/{ => autoconfigure}/redis/CommonRedisAutoConfiguration.java (86%) rename src/main/java/com/kri/common/{ => autoconfigure}/scheduling/CommonSchedulingAutoConfiguration.java (62%) rename src/main/java/com/kri/common/{ => autoconfigure}/security/KriSecurityAutoConfiguration.java (92%) rename src/main/java/com/kri/common/{ => autoconfigure}/security/KriSecurityProperties.java (92%) rename src/main/java/com/kri/common/{ => autoconfigure}/swagger/KriSwaggerAutoConfiguration.java (85%) rename src/main/java/com/kri/common/{ => autoconfigure}/swagger/KriSwaggerProperties.java (72%) create mode 100644 src/main/java/com/kri/common/autoconfigure/web/CommonWebAutoConfiguration.java rename src/main/java/com/kri/common/{ => autoconfigure}/webmvc/KriIpAccessProperties.java (96%) rename src/main/java/com/kri/common/{ => autoconfigure}/webmvc/KriWebMvcAutoConfiguration.java (87%) rename src/main/java/com/kri/common/{ => endpoint}/auth/apikey/ApiKeyAdminController.java (88%) rename src/main/java/com/kri/common/{ => feature}/auth/apikey/ApiKeyUserClaimsProvider.java (84%) rename src/main/java/com/kri/common/{ => feature}/auth/dto/JwtUserClaimsDto.java (92%) rename src/main/java/com/kri/common/{ => feature}/auth/jwt/JwtService.java (64%) rename src/main/java/com/kri/common/{ => feature}/cache/AbstractListCache.java (97%) rename src/main/java/com/kri/common/{ => feature}/cache/AbstractMapCache.java (98%) rename src/main/java/com/kri/common/{ => feature}/datetime/DateTimeUtil.java (99%) rename src/main/java/com/kri/common/{ => feature}/datetime/LenientLocalDateTime.java (95%) rename src/main/java/com/kri/common/{ => feature}/datetime/LenientLocalDateTimeDeserializer.java (98%) rename src/main/java/com/kri/common/{ => feature}/enums/CodeEnum.java (56%) rename src/main/java/com/kri/common/{ => feature}/enums/CodeEnumUtils.java (92%) rename src/main/java/com/kri/common/{ => feature}/excel/ExcelColumn.java (91%) rename src/main/java/com/kri/common/{ => feature}/excel/ExcelMapper.java (99%) rename src/main/java/com/kri/common/{ => feature}/excel/ExcelUtil.java (95%) rename src/main/java/com/kri/common/{ => feature}/file/FileUtil.java (97%) rename src/main/java/com/kri/common/{ => feature}/http/ExternalApiClient.java (98%) rename src/main/java/com/kri/common/{ => feature}/http/ExternalApiResponse.java (95%) rename src/main/java/com/kri/common/{ => feature}/jpa/AbstractCodeEnumConverter.java (80%) rename src/main/java/com/kri/common/{ => feature}/jpa/BaseUuidEntity.java (96%) rename src/main/java/com/kri/common/{ => feature}/json/JsonUtil.java (99%) rename src/main/java/com/kri/common/{ => feature}/redis/RedisQueueHelper.java (92%) rename src/main/java/com/kri/common/{ => feature}/util/CommonUtil.java (83%) rename src/main/java/com/kri/common/{ => feature}/util/NumericUtil.java (95%) rename src/main/java/com/kri/common/{ => feature}/util/StringUtil.java (93%) rename src/main/java/com/kri/common/{ => feature}/web/BusinessException.java (99%) rename src/main/java/com/kri/common/{webmvc => feature/web}/RequestUserContext.java (73%) rename src/main/java/com/kri/common/{webmvc => feature/web}/page/PageRequestDto.java (93%) rename src/main/java/com/kri/common/{webmvc => feature/web}/page/PageResponseDto.java (95%) rename src/main/java/com/kri/common/{webmvc => feature/web}/page/Pageables.java (98%) rename src/main/java/com/kri/common/{ => runtime}/auth/apikey/ApiKeyAuthFilter.java (64%) rename src/main/java/com/kri/common/{ => runtime}/auth/apikey/PreloadedApiKeyUserClaimsProvider.java (61%) rename src/main/java/com/kri/common/{auth => runtime/auth/apikey}/persistence/entity/TApiKeyEntity.java (93%) rename src/main/java/com/kri/common/{auth => runtime/auth/apikey}/persistence/entity/TApiKeyServiceMapEntity.java (87%) rename src/main/java/com/kri/common/{auth => runtime/auth/apikey}/persistence/entity/TApiKeyServiceMapEntityId.java (94%) rename src/main/java/com/kri/common/{auth => runtime/auth/apikey}/persistence/repository/ApiKeyRepository.java (82%) rename src/main/java/com/kri/common/{ => runtime}/security/JwtAuthenticationFilter.java (95%) rename src/main/java/com/kri/common/{ => runtime}/swagger/SwaggerIpFilter.java (98%) rename src/main/java/com/kri/common/{ => runtime}/web/ErrorAdvice.java (98%) rename src/main/java/com/kri/common/{ => runtime}/web/MdcHandlerConfig.java (83%) rename src/main/java/com/kri/common/{ => runtime}/web/ServiceMdcAspect.java (90%) rename src/main/java/com/kri/common/{ => runtime}/web/TraceFilter.java (90%) rename src/main/java/com/kri/common/{ => runtime}/webmvc/CodeEnumConverter.java (83%) rename src/main/java/com/kri/common/{ => runtime}/webmvc/IpAccessControlInterceptor.java (94%) rename src/main/java/com/kri/common/{ => runtime}/webmvc/IpAccessControlService.java (82%) rename src/main/java/com/kri/common/{ => runtime}/webmvc/IpUtil.java (94%) rename src/main/java/com/kri/common/{ => runtime}/webmvc/RequestUserContextArgumentResolver.java (76%) delete mode 100644 src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java diff --git a/README.md b/README.md index 5edbdd3..3b25c2e 100644 --- a/README.md +++ b/README.md @@ -1,1337 +1,354 @@ -# KriCommon Starter +# KriCommon 설정/기능 정리 -Spring Boot 기반 사내 서비스에서 공통으로 사용하는 기능들을 모아둔 라이브러리입니다. -`example-service` 같은 개별 서비스는 이 라이브러리를 통해 다음과 같은 기능을 **일관된 방식으로 재사용**할 수 있습니다. +## 개요 -- 공통 Security 자동 구성 (JWT + API Key, `com.kri.common.security`) -- JWT 기반 인증/인가 (`com.kri.common.auth.jwt`) -- 외부 API Key 인증 (`com.kri.common.auth.apikey`) -- 공통 WebMvc 설정 (CORS + Swagger IP 접근 제어, `com.kri.common.web`) -- 공통 Web 예외 처리 & 로깅 (`ErrorAdvice`, `BusinessException`, MDC/Trace) -- Redis 큐 헬퍼 (`com.kri.common.redis.RedisQueueHelper`) -- 스케줄링 활성화 (`com.kri.common.scheduling`) -- 기본 logback 설정 (`logback-spring.xml`) +현재 패키지 구조는 아래 4축으로 정리되어 있습니다. -### 공용 HTTP 클라이언트: ExternalApiClient +- `com.kri.common.autoconfigure`: Spring Boot 자동 구성 진입점과 `Properties` +- `com.kri.common.feature`: 서비스에서 직접 import/주입/구현하는 공개 기능 +- `com.kri.common.runtime`: 자동 구성에 의해 조립되어 동작하는 내부 실행 구성요소 +- `com.kri.common.endpoint`: yml 설정으로 자동 노출되는 공통 엔드포인트 -외부 API와 통신하기 위한 경량 공용 모듈을 제공합니다. 추가 의존성 없이 Java 17의 `java.net.http.HttpClient`를 사용합니다. - -- 패키지: `com.kri.common.http` -- 주요 클래스: `ExternalApiClient`, `ExternalApiResponse` - -지원 메서드(문자열 body 기반) - -- `ExternalApiResponse get(String url, Map headers)` -- `ExternalApiResponse post(String url, Map headers, String body)` -- `ExternalApiResponse put(String url, Map headers, String body)` -- `ExternalApiResponse patch(String url, Map headers, String body)` -- `ExternalApiResponse delete(String url, Map headers)` - -기본 동작 - -- 연결 타임아웃: 10초, 요청 타임아웃: 30초 -- body가 있고 `Content-Type` 헤더가 없으면 자동으로 `application/json; charset=utf-8` 설정 -- 예외 발생 시 `RuntimeException`으로 래핑하여 전달하며, `InterruptedException` 발생 시 인터럽트 플래그를 복원 - -응답 객체(`ExternalApiResponse`) - -- 필드: `statusCode`(int), `headers`(Map>), `body`(String) -- 정적 팩토리: `ExternalApiResponse.of(int, HttpHeaders, String)` - -간단 사용 예시 - -```java -import com.kri.common.http.ExternalApiClient; -import com.kri.common.http.ExternalApiResponse; -import java.util.Map; - -ExternalApiClient client = new ExternalApiClient(); - -// POST 예시 -ExternalApiResponse postResp = client.post( - "https://api.example.com/items", - Map.of("X-API-KEY", "your-key"), - "{\"name\":\"sample\"}" -); -int status = postResp.getStatusCode(); -String body = postResp.getBody(); - -// GET 예시 -ExternalApiResponse getResp = client.get( - "https://api.example.com/items/123", - Map.of("Authorization", "Bearer token") -); -if (getResp.getStatusCode() == 200) { - System.out.println(getResp.getBody()); -} -``` - -고급 사용: 커스텀 HttpClient/타임아웃 - -```java -import java.net.http.HttpClient; -import java.time.Duration; - -HttpClient httpClient = HttpClient.newBuilder() - .connectTimeout(Duration.ofSeconds(5)) - .build(); - -ExternalApiClient client = new ExternalApiClient(httpClient, Duration.ofSeconds(15)); -``` - -주의사항 - -- 메서드 시그니처는 문자열 기반 body를 사용하므로, JSON 외 포맷을 전송할 경우 적절한 `Content-Type`을 직접 지정하세요. -- 대용량 응답이 예상된다면 현재 구현은 `BodyHandlers.ofString()`을 사용한다는 점에 유의하세요. - -이 문서는 **KriCommon을 사용하는 서비스(`example-service`)** 기준으로 작성되었습니다. -(WebSocket 관련 기능은 현재 포함하지 않았으며, 추후 필요 시 별도 확장 예정입니다.) +설정 키는 `kri.*`만 사용합니다. --- -## 빠른 시작(10분 내 적용) +## 직접 import해서 사용하는 기능 -아래 순서대로 복붙하면, JWT 발급/검증과 Swagger까지 바로 동작 확인이 가능합니다. +### 인증/보안 -1) Gradle 설정 추가 +#### `com.kri.common.feature.auth.jwt.JwtService` -`example-service/build.gradle` - -```gradle -repositories { - mavenCentral() - - // 사내 Gitea Maven 레지스트리 - def giteaUser = findProperty("giteaUser") ?: "" - def giteaToken = findProperty("giteaToken") ?: "" - maven { - name = "gitea" - url = uri("https://gitea.kric.com/api/packages/KRi/maven") - credentials { - username = giteaUser - password = giteaToken - } - } -} - -dependencies { - implementation "org.springframework.boot:spring-boot-starter-web" - implementation "org.springframework.boot:spring-boot-starter-security" - implementation "org.springframework.boot:spring-boot-starter-validation" - - // Swagger UI - implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0" - - // KriCommon - implementation "com.kri.common:starter:1.0.15" -} +```java +import com.kri.common.feature.auth.jwt.JwtService; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; ``` -2) application.yml 설정(최소값) +- 사용법: 빈 주입 후 `generateAccessToken`, `generateRefreshToken`, `toAuthentication` 호출 +- 설명: JWT 발급, 파싱, `Authentication` 변환을 처리합니다. -`example-service/src/main/resources/application.yml` +#### `com.kri.common.feature.auth.dto.JwtUserClaimsDto` + +```java +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; +``` + +- 사용법: builder로 사용자 정보를 생성해 `JwtService`에 전달 +- 설명: JWT 클레임 공통 DTO입니다. + +#### `com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider` + +```java +import com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider; +``` + +- 사용법: 서비스에서 구현체를 만들어 Bean 등록 +- 설명: API Key를 사용자 클레임으로 매핑하는 공개 확장 포인트입니다. + +#### `com.kri.common.feature.web.RequestUserContext` + +```java +import com.kri.common.feature.web.RequestUserContext; +``` + +- 사용법: 컨트롤러 파라미터로 선언 +- 설명: 현재 인증 사용자와 클라이언트 IP를 전달받는 요청 컨텍스트입니다. + +### 웹/페이징 + +#### `com.kri.common.feature.web.page.PageRequestDto` + +```java +import com.kri.common.feature.web.page.PageRequestDto; +``` + +- 사용법: 조회 API 요청 DTO로 사용 +- 설명: pageIndex, pageSize, sortBy, sortDir를 공통 형식으로 받습니다. + +#### `com.kri.common.feature.web.page.Pageables` + +```java +import com.kri.common.feature.web.page.Pageables; +``` + +- 사용법: `Pageables.of(req, EntityOrDto.class)` +- 설명: 정렬 가능 필드를 검증해 `Pageable` 객체를 만듭니다. + +#### `com.kri.common.feature.web.page.PageResponseDto` + +```java +import com.kri.common.feature.web.page.PageResponseDto; +``` + +- 사용법: `PageResponseDto.from(page)` +- 설명: Spring Data `Page`를 API 응답용 DTO로 감쌉니다. + +### Redis + +#### `com.kri.common.feature.redis.RedisQueueHelper` + +```java +import com.kri.common.feature.redis.RedisQueueHelper; +``` + +- 사용법: 자동 구성 빈 주입 후 `enqueue`, `blockingDequeue` 사용 +- 설명: Redis List 기반 큐 처리 헬퍼입니다. + +### HTTP/JSON/Excel + +#### `com.kri.common.feature.http.ExternalApiClient` + +```java +import com.kri.common.feature.http.ExternalApiClient; +``` + +- 사용법: `new ExternalApiClient()` 또는 커스텀 `HttpClient`로 생성 +- 설명: 문자열 body 기반의 경량 HTTP 클라이언트입니다. + +#### `com.kri.common.feature.http.ExternalApiResponse` + +```java +import com.kri.common.feature.http.ExternalApiResponse; +``` + +- 사용법: `ExternalApiClient` 응답 객체로 사용 +- 설명: statusCode, headers, body를 묶어 반환합니다. + +#### `com.kri.common.feature.json.JsonUtil` + +```java +import com.kri.common.feature.json.JsonUtil; +``` + +- 사용법: JSON 직렬화/역직렬화/맵 변환 수행 +- 설명: Jackson 보조 유틸입니다. + +#### `com.kri.common.feature.excel.ExcelMapper` + +```java +import com.kri.common.feature.excel.ExcelMapper; +``` + +- 사용법: DTO 리스트나 Map 리스트를 엑셀로 변환 +- 설명: 일반 처리와 대용량 스트리밍 읽기/쓰기를 지원합니다. + +### 날짜/시간/JPA/Enum/유틸 + +- `com.kri.common.feature.datetime.*`: 날짜/시간 처리 유틸과 Jackson 어노테이션 +- `com.kri.common.feature.jpa.*`: JPA 베이스 엔티티와 enum converter +- `com.kri.common.feature.enums.*`: 코드값 기반 enum 인터페이스와 유틸 +- `com.kri.common.feature.cache.*`: 리스트/맵 캐시 베이스 클래스 +- `com.kri.common.feature.file.FileUtil`: 파일명/확장자 유틸 +- `com.kri.common.feature.util.*`: 문자열, 숫자, UUID 보조 유틸 + +--- + +## yml로 설정하는 기능 + +### 전체 예시 ```yaml -spring: - application: - name: example-service - -server: - port: 8080 - -logging: - file: - path: logs - level: - root: INFO - com.kri: DEBUG - kri: auth: jwt: - # HS256 기준 UTF-8 32바이트 이상 필수 (라이브러리에서 검증) - secret: "서비스별로_반드시_교체하세요_최소_32자리_랜덤키_예시_1234567890" + # JWT 서명용 시크릿. 32바이트 이상 권장 + secret: "32byte-over-secret-value-required" + # 토큰 발급자 식별자 issuer: "kri-it" - security: - public-paths: - - "/v3/api-docs/**" - - "/swagger-ui.html" - - "/swagger-ui/**" - - "/actuator/health" -``` - -3) 로그인(토큰 발급) 샘플 엔드포인트 추가 - -서비스에 아래 두 클래스를 추가해 JWT 발급을 확인합니다. - -``` -// package 예시는 서비스 상황에 맞게 변경하세요. -@org.springframework.stereotype.Service -@lombok.RequiredArgsConstructor -public class AuthService { - private final com.kri.common.auth.jwt.JwtService jwtService; - - public String login(String username) { - var claims = com.kri.common.auth.dto.JwtUserClaimsDto.builder() - .userId(username) - .userTeam("IT") - .userName("홍길동") - .role(1) - .build(); - return jwtService.generateAccessToken(claims); - } -} - -@org.springframework.web.bind.annotation.RestController -@org.springframework.web.bind.annotation.RequestMapping("/auth") -@lombok.RequiredArgsConstructor -class AuthController { - private final AuthService authService; - - @org.springframework.web.bind.annotation.PostMapping("/login") - public java.util.Map login(@org.springframework.web.bind.annotation.RequestParam String username) { - String token = authService.login(username); - return java.util.Map.of("accessToken", token); - } -} -``` - -4) 동작 확인(curl) - -```bash -# 1) 토큰 발급 -curl -X POST "http://localhost:8080/auth/login?username=user1" -# => { "accessToken": "eyJhbGciOiJI..." } - -# 2) Swagger 접근(기본 public-paths 허용) -open http://localhost:8080/swagger-ui/index.html - -# 3) 보호된 API 호출 예시 (서비스 API가 있다고 가정) -TOKEN={발급받은_토큰} -curl -H "Authorization: Bearer $TOKEN" http://localhost:8080/api/secure -``` - -5) 선택: 외부 API Key 사용 시 구현 1개만 추가 - -``` -@org.springframework.stereotype.Component -public class ExampleApiKeyUserClaimsProvider implements com.kri.common.auth.apikey.ApiKeyUserClaimsProvider { - @Override - public java.util.Optional findUserByApiKey(String apiKey) { - if ("DEMO-KEY-1234".equals(apiKey)) { - return java.util.Optional.of( - com.kri.common.auth.dto.JwtUserClaimsDto.builder() - .userId("external") - .userCmpn("outbound") - .userTeam("EXT") - .userName("외부") - .role(9) - .build() - ); - } - return java.util.Optional.empty(); - } -} -``` - -application.yml에 아래를 추가하세요. - -```yaml -kri: - auth: + # Access Token 만료 시간(초) + access-token-validity-seconds: 86400 + # Refresh Token 만료 시간(초) + refresh-token-validity-seconds: 604800 apikey: + # API Key 인증 기능 활성화 enabled: true + # API Key를 읽을 HTTP 헤더명 header-name: "X-API-Key" -``` - -이제 `X-API-Key: DEMO-KEY-1234` 헤더만으로도 인증이 선행되고, JWT 없을 때 대체 인증으로 작동합니다. - ---- - -## 0. 아키텍처 개요 - -이 저장소는 다수의 서비스에서 공통으로 재사용할 수 있는 경량 Starter 형태의 라이브러리를 목표로 합니다. 핵심 원칙은 다음과 같습니다. - -- 최소 의존성: starter가 과도한 런타임 의존성을 강제하지 않도록 compileOnly 위주 구성 (서비스가 필요한 starter를 직접 선언) -- 자가완결형 AutoConfiguration: 기본값으로 바로 동작하지만, Bean 오버라이드와 프로퍼티로 손쉽게 커스터마이즈 가능 -- 분리/응집: 인증/시큐리티/웹/문서화/인프라(redis, scheduling) 등을 느슨히 결합하여 모듈 경계를 유지 - -### 0.1 패키지 레이어와 의존 방향 - -- com.kri.common.auth.jwt: JWT 프로퍼티/DTO/유틸(JwtService) -- com.kri.common.auth.apikey: API Key 프로퍼티/필터/확장 포인트(ApiKeyUserClaimsProvider) -- com.kri.common.security: 공통 보안 자동구성(SecurityFilterChain, 필터 배치 등) -- com.kri.common.web: 공통 예외 처리, Trace 필터, MDC 지원 -- com.kri.common.webmvc: CORS 기본값, Swagger 접근 IP 제어 인터셉터 -- com.kri.common.swagger: OpenAPI/Swagger 기본 설정 및 SecurityScheme 구성 -- com.kri.common.redis: Redis 편의 헬퍼 및 자동 구성 (선택 사용) -- com.kri.common.scheduling: 스케줄링 자동 활성화 (선택 사용) - -권장 의존 방향(순환 금지): - -- auth.jwt, auth.apikey → 다른 모듈에 의존하지 않음(핵심 도메인 유틸) -- security → auth.* 에 의존(필터 순서/체인 구성) -- web, webmvc → spring-web 중심, security에 의존하지 않음 -- swagger → 선택, 나머지에 의존하지 않도록 구성 -- redis, scheduling → 선택, spring-data-redis / scheduling만 전제 - -### 0.2 AutoConfiguration 로딩과 오버라이드 전략 - -자동 구성은 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports로 등록되며, 다음 -순서/특징을 가집니다. - -1) com.kri.common.auth.jwt.JwtAutoConfiguration - -- JwtProperties 바인딩, JwtService, ApiKeyAuthFilter 등 기초 컴포넌트 제공 - -2) com.kri.common.security.KriSecurityAutoConfiguration - -- SecurityFilterChain 기본 구성, @EnableMethodSecurity 활성화, 필터 체인에 ApiKey → JWT 순서로 필터 삽입 -- before = SecurityAutoConfiguration 으로 Spring 기본 보안 자동구성보다 먼저 개입 - -3) com.kri.common.web.CommonWebAutoConfiguration, com.kri.common.webmvc.KriWebMvcAutoConfiguration - -- 공통 예외/로깅, CORS, Swagger 접근 IP 제어 인터셉터 - -4) com.kri.common.swagger.KriSwaggerAutoConfiguration - -- OpenAPI/Swagger 설정, Bearer/JWT + API Key SecurityScheme 등록 - -5) com.kri.common.redis.CommonRedisAutoConfiguration, - com.kri.common.scheduling.CommonSchedulingAutoConfiguration - -- 선택 기능: RedisQueueHelper, @EnableScheduling - -오버라이드 규칙: - -- 동일 타입의 Bean을 서비스에서 정의하면 @ConditionalOnMissingBean에 의해 서비스 정의가 우선 -- 프로퍼티로 on/off 토글(@ConditionalOnProperty) - -### 0.3 Security 필터 체인 흐름(기본값) - -- Stateless 세션, CSRF 비활성화, CORS 기본 허용 -- public-paths는 permitAll, 그 외 anyRequest().authenticated() -- 필터 순서: ApiKeyAuthFilter → JwtAuthenticationFilter → UsernamePasswordAuthenticationFilter - - 외부/파트너용 API Key가 있다면 먼저 인증 세팅, 없으면 Bearer JWT 처리 - -### 0.4 설정 네임스페이스 정리 - -- kri.auth.jwt.*: 시크릿/발급자/만료시간 등 -- kri.auth.apikey.*: 사용 여부/헤더 이름 -- kri.security.*: Security 자동 구성 on/off, public-paths -- kri.swagger.*: 문서화 on/off, 제목/설명/버전/스캔 패키지 -- kri.webmvc.*: CORS, Swagger 접근 IP 제어 -- common.web.enabled: 공통 예외/Trace 필터 on/off -- common.redis.enabled: RedisQueueHelper 사용 여부 -- common.scheduling.enabled: 스케줄링 사용 여부 - -### 0.5 확장 포인트(서비스 구현/대체 지점) - -- ApiKeyUserClaimsProvider: API Key → 사용자 클레임 매핑 구현체 제공 -- SecurityFilterChain: 필요 시 서비스에서 직접 정의하여 전면 대체 가능 -- WebMvcConfigurer: 서비스에서 별도 CORS/인터셉터 전략 추가 가능 -- Swagger GroupedOpenApi: 서비스에서 그룹/패키지 전략 세분화 가능 - -### 0.6 운영 관점 가이드(권장) - -- JWT 시크릿: HS256 기준 UTF-8 32바이트 이상 강제(JwtService.init 검증) — 서비스별 난수 기반 키 사용 -- public-paths 거버넌스: 최소 공개 원칙, 변경 시 보안 리뷰 절차 권장 -- Swagger 접근 제어: 기본 CIDR + 서비스별 추가 CIDR만 설정하도록 유지(운영망 노출 주의) -- 의존성 정책: starter에는 compileOnly를 유지하여 소비자 서비스가 필요한 starter를 명시하도록 함 -- 버전 정책: build.gradle의 commonVer로 일원화, 기능 추가는 마이너/패치 버전 준수(semver) - -이 섹션은 상위 수준에서 구조를 빠르게 이해하고, 서비스 적용 시 확장/대체 지점을 명확히 하기 위해 추가되었습니다. - -## 1. 의존성 추가 - -### 1.1. Gradle 예시 (권장) - -`example-service/build.gradle`: - -```gradle -repositories { - mavenCentral() - - // Gitea 사내 Maven 레지스트리 - def giteaUser = findProperty("giteaUser") ?: "" - def giteaToken = findProperty("giteaToken") ?: "" - - maven { - name = "gitea" - url = uri("https://gitea.kric.com/api/packages/KRi/maven") - credentials { - username = giteaUser - password = giteaToken - } - } -} - -dependencies { - // Spring Boot 기본 의존성 (서비스 쪽에서 직접 선언) - implementation "org.springframework.boot:spring-boot-starter-web" - implementation "org.springframework.boot:spring-boot-starter-security" - implementation "org.springframework.boot:spring-boot-starter-validation" - - // Swagger / OpenAPI UI - implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0" - - // (필요 시) Redis - implementation "org.springframework.boot:spring-boot-starter-data-redis" - - // KriCommon - implementation "com.kri.common:starter:1.0.11" -} -```` - -`~/.gradle/gradle.properties` (또는 프로젝트 `gradle.properties`)에 자격 증명: - -```properties -giteaUser=gitadmin -giteaToken=토큰값_여기에 -``` - -> **주의** -> KriCommon은 `java-library` + `compileOnly` 위주로 구성되어 있어서 -> **웹/시큐리티/Swagger/Redis Starter는 개별 서비스에서 직접 의존성을 추가**해야 합니다. - ---- - -## 2. 자동 구성(AutoConfiguration) 개요 - -KriCommon은 다음 AutoConfiguration 들을 제공합니다. -모두 `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports`에서 자동 등록됩니다. - -| 클래스 | 역할 요약 | -|---------------------------------------------------------------|---------------------------------------------------------------------------------------| -| `com.kri.common.auth.jwt.JwtAutoConfiguration` | `JwtProperties`, `ApiKeyProperties` 바인딩 + `JwtService`, `ApiKeyAuthFilter` 자동 Bean 생성 | -| `com.kri.common.security.KriSecurityAutoConfiguration` | SecurityFilterChain 기본 구성(JWT + API Key 필터) + `@EnableMethodSecurity` | -| `com.kri.common.web.CommonWebAutoConfiguration` | 공통 예외 처리(`ErrorAdvice`), `TraceFilter` 등록 | -| `com.kri.common.web.KriWebMvcAutoConfiguration` | CORS 기본 설정 + Swagger IP 접근 제어 Interceptor 등록 | -| `com.kri.common.swagger.KriSwaggerAutoConfiguration` | OpenAPI/Swagger 기본 설정 + JWT/API-Key SecurityScheme 등록 | -| `com.kri.common.redis.CommonRedisAutoConfiguration` | `StringRedisTemplate`, `RedisQueueHelper` 자동 구성 (`RedisConnectionFactory` 존재 시) | -| `com.kri.common.scheduling.CommonSchedulingAutoConfiguration` | `@EnableScheduling` 자동 활성화 | - -각 AutoConfiguration은 **프로퍼티로 on/off 가능**하며, 필요 시 서비스 쪽에서 Bean을 직접 정의하여 오버라이드 할 수 있습니다. - ---- - -## 3. application.yml 예시 - -`example-service/src/main/resources/application.yml`: - -```yaml -spring: - application: - name: example-service - - datasource: - # (서비스에서 실제 DB 설정) - - # Redis 사용 시 (선택) - data: - redis: - host: localhost - port: 6379 - -server: - port: 8080 - -logging: - file: - path: logs - level: - root: INFO - com.kri: DEBUG - -# =========================== -# KRI 공통 설정 -# =========================== -kri: - auth: - jwt: - secret: "서비스별_실제_시크릿키_32자_이상" - issuer: "kri-it" - access-token-validity-seconds: 86400 # 24시간 - refresh-token-validity-seconds: 604800 # 7일 - apikey: - enabled: true # 외부 API Key 인증 사용 여부 - header-name: "X-API-Key" # API Key 헤더 이름 - + # preload 대상 서비스 코드 + service-code: "example-service" + # 서버 시작 시 API Key 캐시 적재 여부 + preload-on-startup: true + # 내부 관리용 API 노출 여부 + admin-api-enabled: false + admin-allow-ips: + # 내부 관리 API 접근 허용 CIDR + - "127.0.0.1/32" + db: + # API Key 전용 DB 접속 URL + url: "jdbc:mysql://localhost:3306/kri_common" + # API Key 전용 DB 계정 + username: "app" + # API Key 전용 DB 비밀번호 + password: "secret" + # JDBC 드라이버 클래스 + driver-class-name: "com.mysql.cj.jdbc.Driver" + jpa: + # Hibernate SQL 로그 출력 여부 + show-sql: false + # Hibernate SQL 포맷팅 여부 + format-sql: false security: + # 기본 Security 자동구성 활성화 enabled: true - # 인증 없이 허용할 URL 패턴들 (기본값 + 필요시 추가/override) public-paths: + # 인증 없이 허용할 공개 경로 - "/v3/api-docs/**" - - "/swagger-ui.html" - "/swagger-ui/**" - - "/actuator/health" - swagger: + # Swagger/OpenAPI 자동구성 활성화 enabled: true - title: "Example Service API" - description: "Example Service OpenAPI Docs" + # 문서 타이틀 + title: "Example API" + # 문서 설명 + description: "Example API Docs" + # 문서 버전 표시값 version: "v1" - base-package: "com.kri.example.api" - + # Swagger 스캔 대상 base package + base-package: "com.example.api" + allowed-ips: + # Swagger UI / API Docs 접근 허용 IP + - "127.0.0.1" webmvc: + # 공통 MVC 자동구성 활성화 enabled: true ip: - # 기본 CIDR(로컬 + 사내 대역)은 라이브러리 내부에 정의되어 있음 - # 여기서는 *추가* CIDR만 설정 (기본값은 그대로 유지) additional-cidrs: - - "10.10.0.0/16" + # Swagger 접근 허용 CIDR 추가값 - "192.168.0.0/16" - -common: web: - enabled: true # ErrorAdvice + TraceFilter + # 공통 웹 예외/trace 필터 활성화 + enabled: true + mdc: + # handler/service MDC 기록 활성화 + enabled: true redis: - enabled: false # RedisQueueHelper (필요 시 true) + # Redis 보조 기능 활성화 + enabled: true scheduling: - enabled: false # @EnableScheduling (필요 시 true) -``` - ---- - -## 4. 주요 기능 상세 - -### 4.1. JWT 설정 및 DTO (`com.kri.common.auth.jwt`) - -#### 4.1.1. JwtProperties - -``` -@ConfigurationProperties(prefix = "kri.auth.jwt") -public class JwtProperties { - private String secret; // HMAC 시크릿 키 (기본값 존재, 서비스에서 override 권장) - private String issuer = "kri-it"; - private long accessTokenValiditySeconds = 24 * 3600; - private long refreshTokenValiditySeconds = 7 * 24 * 3600; -} -``` - -**프로퍼티 요약** - -| 프로퍼티 | 타입 | 기본값 | 설명 | -|-----------------------------------------------|--------|--------------|----------------------------------------| -| `kri.auth.jwt.secret` | String | (기본값 있음) | HMAC 서명용 시크릿(최소 32자 이상, 서비스별로 꼭 변경 추천) | -| `kri.auth.jwt.issuer` | String | `kri-it` | 토큰 발급자 | -| `kri.auth.jwt.access-token-validity-seconds` | long | 86,400 (24h) | Access Token 만료(초) | -| `kri.auth.jwt.refresh-token-validity-seconds` | long | 604,800 (7일) | Refresh Token 만료(초) | - -#### 4.1.2. JwtUserClaimsDto - -``` -package com.kri.common.auth.jwt; - -import io.swagger.v3.oas.annotations.media.Schema; -import lombok.Builder; -import lombok.Value; - -@Value -@Builder -@Schema(description = "JWT에 담기는 공통 사용자 정보") -public class JwtUserClaimsDto { - - @Schema(description = "사용자 ID (사내 시스템 기준 PK)", example = "user123") - String userId; - - @Schema(description = "사용자 팀/조직명", example = "IT팀") - String userTeam; - - @Schema(description = "사용자 이름", example = "홍길동") - String userName; - - @Schema(description = "권한 레벨 (int)", example = "1") - Integer role; -} -``` - -> `@Schema`가 붙어 있어서, Swagger UI 상에서도 필드 설명이 자연스럽게 노출됩니다. - -#### 4.1.3. JwtService - -주요 메서드: - -``` -public class JwtService { - - // Access Token 생성 (DTO → JWT 문자열) - public String generateAccessToken(JwtUserClaimsDto userClaims); - - // Refresh Token 생성 - public String generateRefreshToken(String userId); - - // 토큰 파싱 & 검증 - public Claims getClaims(String token) throws JwtException; - public JwtUserClaimsDto toUserClaimsDto(String token) throws JwtException; - - // Spring Security Authentication 변환 - public Authentication toAuthentication(JwtUserClaimsDto dto); - public Authentication toAuthentication(String token) throws JwtException; -} -``` - -**로그인 예시** - -``` -@Service -@RequiredArgsConstructor -public class AuthService { - - private final JwtService jwtService; - - public String login(String username, String password) { - // 1) 서비스에서 사용자 검증 (DB 조회 등) - // 2) 검증 성공 시 공통 DTO 구성 - JwtUserClaimsDto claims = JwtUserClaimsDto.builder() - .userId(username) - .userTeam("IT팀") - .userName("홍길동") - .role(1) // 권한 레벨 - .build(); - - // 3) Access Token 발급 - return jwtService.generateAccessToken(claims); - } -} -``` - ---- - -### 4.2. API Key 인증 (`com.kri.common.auth.apikey`) - -#### 4.2.1. ApiKeyProperties - -``` -@ConfigurationProperties(prefix = "kri.auth.apikey") -public class ApiKeyProperties { - private boolean enabled = false; - private String headerName = "X-API-Key"; -} -``` - -**프로퍼티 요약** - -| 프로퍼티 | 타입 | 기본값 | 설명 | -|-------------------------------|---------|-------------|-------------------------| -| `kri.auth.apikey.enabled` | boolean | `false` | API Key 인증 기능 사용 여부 | -| `kri.auth.apikey.header-name` | String | `X-API-Key` | API Key 를 읽을 HTTP 헤더 이름 | - -#### 4.2.2. ApiKeyUserClaimsProvider (서비스 구현 필요) - -``` -public interface ApiKeyUserClaimsProvider { - - /** - * API Key 로 사용자 정보를 조회한다. - * - * @param apiKey 요청 헤더에서 받은 API Key - * @return 유효한 키면 JwtUserClaimsDto, 아니면 Optional.empty() - */ - Optional findUserByApiKey(String apiKey); -} -``` - -**서비스 구현 예시 (`example-service`)** - -``` -@Component -@RequiredArgsConstructor -public class ExampleApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvider { - - @Override - public Optional findUserByApiKey(String apiKey) { - // 1) 사내 외부 파트너용 API Key 테이블 조회 - // 2) 유효하면 JwtUserClaimsDto 로 매핑 - if ("DEMO-KEY-1234".equals(apiKey)) { - return Optional.of( - JwtUserClaimsDto.builder() - .userId("external-partner") - .userTeam("External") - .userName("외부 파트너") - .role(9) - .build() - ); - } - return Optional.empty(); - } -} -``` - -#### 4.2.3. ApiKeyAuthFilter - -`X-API-Key`(또는 설정된 헤더)로부터 API Key를 읽고, -`ApiKeyUserClaimsProvider`를 통해 사용자 정보를 조회한 뒤, `JwtService`를 사용해 `Authentication`을 세팅하는 필터입니다. - -> 이 필터는 `JwtAutoConfiguration` / `KriSecurityAutoConfiguration`를 통해 **자동 Bean 등록**되고, -> `SecurityFilterChain`에서 JWT 필터보다 먼저 동작하도록 설정됩니다. - ---- - -### 4.3. Security 기본 구성 (`com.kri.common.security`) - -#### 4.3.1. KriSecurityProperties - -``` -@ConfigurationProperties(prefix = "kri.security") -public class KriSecurityProperties { - - private boolean enabled = true; - - // 인증 없이 허용할 URL 패턴들 - private List publicPaths = List.of( - "/v3/api-docs/**", - "/swagger-ui.html", - "/swagger-ui/**" - ); -} -``` - -**프로퍼티 요약** - -| 프로퍼티 | 타입 | 기본값 (일부) | 설명 | -|-----------------------------|--------------|------------------|----------------------------| -| `kri.security.enabled` | boolean | `true` | 공통 Security 자동 구성 사용 여부 | -| `kri.security.public-paths` | List | Swagger 관련 패턴 포함 | `permitAll()` 로 열어둘 URL 목록 | - -서비스에서 Swagger 외에 `/actuator/health` 같은 것들도 열고 싶다면: - -```yaml -kri: - security: - public-paths: - - "/v3/api-docs/**" - - "/swagger-ui.html" - - "/swagger-ui/**" - - "/actuator/health" - - "/auth/login" -``` - -#### 4.3.2. KriSecurityAutoConfiguration - -특징: - -* `@AutoConfiguration(before = SecurityAutoConfiguration.class)` -* `@EnableMethodSecurity(jsr250Enabled = true, prePostEnabled = true)` -* `SecurityFilterChain` 기본 구성: - - * `httpBasic().disable()` - * `formLogin().disable()` - * `csrf().disable()` - * `cors(Customizer.withDefaults())` - * `SessionCreationPolicy.STATELESS` - * `public-paths` 는 `permitAll()`, 나머지는 `authenticated()` - * `ApiKeyAuthFilter` → `JwtAuthenticationFilter` 순으로 필터 체인에 추가 - -**메소드 레벨 권한 예시** - -``` -@org.springframework.web.bind.annotation.RestController -@org.springframework.web.bind.annotation.RequestMapping("/api/example") -public class ExampleController { - - // 누구나 접근 가능하게 열고 싶다면: - @jakarta.annotation.security.PermitAll - @org.springframework.web.bind.annotation.GetMapping("/public") - public String publicApi() { - return "ok"; - } - - // 특정 권한 레벨 사용 (예: ROLE_1) - @org.springframework.security.access.prepost.PreAuthorize("hasRole('1')") - @org.springframework.web.bind.annotation.GetMapping("/admin-only") - public String adminOnly() { - return "admin"; - } -} -``` - -> `@PermitAll` / `@PreAuthorize` 사용이 가능하며, -> URL 패턴 기반 예외 처리는 `kri.security.public-paths` 로 관리합니다. - ---- - -### 4.4. Swagger / OpenAPI (`com.kri.common.swagger`) - -#### 4.4.1. KriSwaggerProperties - -``` -@ConfigurationProperties(prefix = "kri.swagger") -public class KriSwaggerProperties { - private boolean enabled = true; - private String title = "KRI API"; - private String description = "KRI Common API Docs"; - private String version = "v1"; - private String basePackage; // 문서화할 base package (null 이면 전체) -} -``` - -#### 4.4.2. KriSwaggerAutoConfiguration - -* `OpenAPI` Bean을 생성하며, `Info(title, description, version)` 설정 -* `GroupedOpenApi` Bean 생성 - - * `group = "kri-api"` - * `basePackage` 가 설정되어 있으면 해당 패키지만 스캔 -* Swagger Security 설정: - - * HTTP Bearer JWT (`BearerAuth`) - * API Key 스키마 (`ApiKeyAuth`) — `kri.auth.apikey.enabled=true` 일 때 등록 - * 전역 `SecurityRequirement` 추가 → Swagger UI "Authorize" 버튼에 노출 - -서비스에서 필요한 것은: - -```gradle -dependencies { - implementation "org.springdoc:springdoc-openapi-starter-webmvc-ui:2.6.0" - implementation "com.kri.common:starter:1.0.11" -} -``` - -그리고 `application.yml`에: - -```yaml -kri: - swagger: + # @Scheduled 사용을 위한 스케줄링 활성화 enabled: true - title: "Example Service API" - description: "example-service OpenAPI Docs" - version: "v1" - base-package: "com.kri.example.api" + error: + expose: + # 에러 응답에 handler 정보 포함 여부 + handler: false + # 에러 응답에 service 정보 포함 여부 + service: false ``` -이렇게 하면 Swagger UI에서 **JWT / API Key 입력 후 전체 API에 공통으로 헤더가 붙는 형태**로 동작합니다. +### 항목별 정리 + +#### `kri.auth.jwt` + +- 대상: JWT 생성/검증 +- 사용 대상 클래스: `JwtAutoConfiguration`, `JwtProperties`, `JwtService` +- 설명: issuer, access/refresh 만료 시간, JWT secret을 제어합니다. + +#### `kri.auth.apikey` + +- 대상: API Key 인증, preload 캐시, 내부 관리용 endpoint +- 사용 대상 클래스: `ApiKeyJpaAutoConfiguration`, `ApiKeyPreloadAutoConfiguration`, `ApiKeyAdminAutoConfiguration` +- 설명: API Key 헤더, preload, admin API 노출, 전용 DB 연결을 제어합니다. + +#### `kri.security` + +- 대상: 기본 Spring Security 필터체인 +- 사용 대상 클래스: `KriSecurityAutoConfiguration`, `KriSecurityProperties` +- 설명: 공개 경로와 JWT/API Key 필터 적용 여부를 제어합니다. + +#### `kri.swagger` + +- 대상: OpenAPI 문서, Swagger 접근 제어 +- 사용 대상 클래스: `KriSwaggerAutoConfiguration`, `KriSwaggerProperties` +- 설명: 문서 메타정보와 스캔 패키지, 허용 IP를 제어합니다. + +#### `kri.web` + +- 대상: 공통 예외 응답, traceId, MDC +- 사용 대상 클래스: `CommonWebAutoConfiguration` +- 설명: `ErrorAdvice`, `TraceFilter`, MDC 관련 구성을 켜고 끕니다. + +#### `kri.webmvc` + +- 대상: CORS, Swagger IP 인터셉터, `RequestUserContext` 처리 +- 사용 대상 클래스: `KriWebMvcAutoConfiguration`, `KriIpAccessProperties` +- 설명: MVC 확장 기능과 CIDR 기반 접근 제어를 등록합니다. + +#### `kri.redis` + +- 대상: Redis 큐 헬퍼 +- 사용 대상 클래스: `CommonRedisAutoConfiguration` +- 설명: Redis 연결 빈이 있을 때 `RedisQueueHelper`를 자동 등록합니다. + +#### `kri.scheduling` + +- 대상: 스케줄링 활성화 +- 사용 대상 클래스: `CommonSchedulingAutoConfiguration` +- 설명: 서비스에서 `@Scheduled`를 사용할 수 있게 합니다. + +#### `kri.error.expose.*` + +- 대상: 에러 응답의 MDC 부가 정보 노출 +- 사용 대상 클래스: `ErrorAdvice` +- 설명: handler, service 정보를 응답에 포함할지 제어합니다. --- -### 4.5. WebMvc + IP 접근 제어 (`com.kri.common.web`) +## 자동 구성에 의해 동작하는 내부 런타임 구성요소 -#### 4.5.1. KriWebMvcAutoConfiguration +아래 패키지는 서비스에서 직접 import해서 쓰기보다는, 자동 구성에 의해 조립되어 동작하는 내부 구현입니다. -``` -@AutoConfiguration -@EnableConfigurationProperties(KriIpAccessProperties.class) -@ConditionalOnProperty(prefix = "kri.webmvc", name = "enabled", havingValue = "true", matchIfMissing = true) -@RequiredArgsConstructor -public class KriWebMvcAutoConfiguration { - - @Bean - @ConditionalOnMissingBean - public IpAccessControlService ipAccessControlService(KriIpAccessProperties props) { - return new IpAccessControlService(props); - } - - @Bean - @ConditionalOnMissingBean - public IpAccessControlInterceptor ipAccessControlInterceptor(IpAccessControlService svc) { - return new IpAccessControlInterceptor(svc); - } - - @Bean - public WebMvcConfigurer kriWebMvcConfigurer(ObjectProvider ipAccessControlInterceptorProvider) { - return new WebMvcConfigurer() { - @Override - public void addCorsMappings(CorsRegistry registry) { - registry.addMapping("/**") - .allowedOriginPatterns("*") - .allowedMethods("GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS") - .allowedHeaders("*") - .allowCredentials(true); - } - - @Override - public void addInterceptors(InterceptorRegistry registry) { - ipAccessControlInterceptorProvider.ifAvailable(interceptor -> - registry.addInterceptor(interceptor) - .order(1) - .addPathPatterns("/swagger-ui/**", "/v3/api-docs/**") - ); - } - }; - } -} -``` - -#### 4.5.2. KriIpAccessProperties & IP 설정 - -``` -@ConfigurationProperties(prefix = "kri.webmvc.ip") -public class KriIpAccessProperties { - - private final List defaultCidrs = List.of( - "127.0.0.1/32", - "::1/128", - "1.235.195.0/24", - "211.254.145.128/25", - "175.45.203.213/32" - ); - - private List additionalCidrs = new ArrayList<>(); - - public List getEffectiveCidrs() { - return Stream.concat(defaultCidrs.stream(), additionalCidrs.stream()) - .distinct() - .collect(Collectors.toList()); - } -} -``` - -**프로퍼티 요약** - -| 프로퍼티 | 타입 | 설명 | -|----------------------------------|--------------|-----------------------------------| -| `kri.webmvc.enabled` | boolean | CORS 및 Swagger IP 제어 자동 구성 on/off | -| `kri.webmvc.ip.additional-cidrs` | List | 기본 CIDR 목록에 *추가*할 CIDR 리스트 | - -예시: - -```yaml -kri: - webmvc: - enabled: true - ip: - additional-cidrs: - - "10.10.0.0/16" - - "192.168.0.0/16" -``` - -> 기본 CIDR(127.0.0.1, ::1, 사내 대역 등)은 라이브러리 안에 고정되어 있고, -> 서비스에서는 **추가 CIDR만** 설정하면 됩니다. - -#### 4.5.3. CommonWebAutoConfiguration - -``` -@org.springframework.boot.autoconfigure.AutoConfiguration -@org.springframework.boot.autoconfigure.condition.ConditionalOnProperty(name = "common.web.enabled", matchIfMissing = true) -public class CommonWebAutoConfiguration { - - @org.springframework.context.annotation.Bean - public com.kri.common.web.ErrorAdvice errorAdvice() { - // 예시 코드: 실제 라이브러리에서는 구현되어 있으므로, 서비스에서는 별도 정의 불필요 - return null; - } - - @org.springframework.context.annotation.Bean - public org.springframework.boot.web.servlet.FilterRegistrationBean traceFilter() { - // 예시 코드: 실제 라이브러리에서는 구현되어 있으므로, 서비스에서는 별도 정의 불필요 - return null; - } -} -``` - -* `ErrorAdvice`: `@RestControllerAdvice` 형태의 글로벌 예외 처리 -* `TraceFilter`: HTTP 요청마다 `X-Request-Id` 및 MDC `traceId` 설정 -* 추가로 MDC 핸들러/Service AOP를 통해 로그에 handler/service 정보 포함 +- `com.kri.common.runtime.auth.apikey` + - `ApiKeyAuthFilter` + - `PreloadedApiKeyUserClaimsProvider` + - `persistence.entity` + - `persistence.repository` +- `com.kri.common.runtime.security` + - `JwtAuthenticationFilter` +- `com.kri.common.runtime.swagger` + - `SwaggerIpFilter` +- `com.kri.common.runtime.web` + - `ErrorAdvice` + - `TraceFilter` + - `MdcHandlerConfig` + - `ServiceMdcAspect` +- `com.kri.common.runtime.webmvc` + - `CodeEnumConverter` + - `IpAccessControlInterceptor` + - `IpAccessControlService` + - `IpUtil` + - `RequestUserContextArgumentResolver` --- -### 4.6. Redis 큐 (`com.kri.common.redis`) +## 자동 노출 endpoint -#### 4.6.1. CommonRedisAutoConfiguration +#### `com.kri.common.endpoint.auth.apikey.ApiKeyAdminController` -``` -@org.springframework.boot.autoconfigure.AutoConfiguration -@org.springframework.boot.autoconfigure.condition.ConditionalOnClass(org.springframework.data.redis.core.RedisTemplate.class) -@org.springframework.boot.autoconfigure.condition.ConditionalOnProperty(prefix = "common.redis", name = "enabled", havingValue = "true") -@org.springframework.boot.autoconfigure.condition.ConditionalOnBean(org.springframework.data.redis.connection.RedisConnectionFactory.class) -public class CommonRedisAutoConfiguration { - - @org.springframework.context.annotation.Bean - @org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean - public org.springframework.data.redis.core.StringRedisTemplate stringRedisTemplate( - org.springframework.data.redis.connection.RedisConnectionFactory cf) { - // 예시 코드: 실제 라이브러리에서는 자동 구성됨 - return new org.springframework.data.redis.core.StringRedisTemplate(cf); - } - - @org.springframework.context.annotation.Bean - @org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean - public com.kri.common.redis.RedisQueueHelper redisQueueHelper( - org.springframework.data.redis.core.StringRedisTemplate rt) { - // 예시 코드: 실제 라이브러리에서는 자동 구성됨 - return new com.kri.common.redis.RedisQueueHelper(rt); - } -} -``` - -**프로퍼티** - -| 프로퍼티 | 타입 | 기본값 | 설명 | -|------------------------|---------|-------|------------------------| -| `common.redis.enabled` | boolean | false | RedisQueueHelper 사용 여부 | - -#### 4.6.2. RedisQueueHelper 사용 예시 - -``` -@Service -@RequiredArgsConstructor -public class ExportQueueService { - - private final RedisQueueHelper redisQueueHelper; - - public void pushJob(String jobJson) { - redisQueueHelper.push("export:jobs", jobJson); - } - - public String popJob() { - return redisQueueHelper.pop("export:jobs"); - } -} -``` +- 노출 조건: `kri.auth.apikey.admin-api-enabled=true` +- 경로: `/internal/apikey/reload`, `/internal/apikey/cache` +- 설명: preload 캐시 재적재와 현재 캐시 조회를 위한 내부 관리용 endpoint입니다. --- -### 4.7. 스케줄링 (`com.kri.common.scheduling`) +## AutoConfiguration 목록 -``` -@AutoConfiguration -@EnableScheduling -@ConditionalOnProperty(prefix = "common.scheduling", name = "enabled", havingValue = "true") -public class CommonSchedulingAutoConfiguration { } -``` +`src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports` -**프로퍼티** - -| 프로퍼티 | 타입 | 기본값 | 설명 | -|-----------------------------|---------|-------|----------------------------| -| `common.scheduling.enabled` | boolean | false | `@EnableScheduling` 활성화 여부 | - -서비스 쪽에서는 단순히: - -```yaml -common: - scheduling: - enabled: true -``` - -만 지정하면, `@Scheduled` 애노테이션을 사용할 수 있습니다. +- `com.kri.common.autoconfigure.auth.jwt.JwtAutoConfiguration` +- `com.kri.common.autoconfigure.auth.apikey.ApiKeyJpaAutoConfiguration` +- `com.kri.common.autoconfigure.auth.apikey.ApiKeyPreloadAutoConfiguration` +- `com.kri.common.autoconfigure.auth.apikey.ApiKeyAdminAutoConfiguration` +- `com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration` +- `com.kri.common.autoconfigure.web.CommonWebAutoConfiguration` +- `com.kri.common.autoconfigure.webmvc.KriWebMvcAutoConfiguration` +- `com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration` +- `com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration` +- `com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration` --- -### 4.8. 로그 설정 (`logback-spring.xml`) +## 검토 메모 -* `app.name` (없으면 기본값 `app`) -* `logging.file.path` (없으면 `logs`) - -을 활용해서 로그 디렉토리와 패턴을 설정합니다. - -`traceId`, `handler`, `service` 등 MDC 정보가 포함된 공통 패턴을 사용하도록 되어 있으며, -서비스에서 별도의 `logback-spring.xml`을 두면 그 설정이 우선합니다. - ---- - -### 4.9. BusinessException 사용 사용 가이드 - -`BusinessException`은 **도메인/업무 에러를 공통 형식으로 표현하기 위한 예외 클래스**입니다. -서비스 코드에서 이 예외만 잘 던져주면, 공통 `ErrorAdvice`가 자동으로 잡아서 **일관된 JSON 응답 + 로그**를 만들어 줍니다. - -#### 4.9.1. 핵심 개념 - -`com.kri.common.web.BusinessException` 주요 필드(개념): - -- `HttpStatus status` : HTTP 상태 코드 (예: 400, 403, 404, 409, 422, 500 등) -- `String code` : 비즈니스 에러 코드 (예: `"USER_NOT_FOUND"`, `"DUPLICATE_ID"`) -- `Map extras` : 추가 정보 (userId, 필드명, 파라미터 등) - -**던지기만 하면** `ErrorAdvice`가 잡아서 `ProblemDetail` 포맷으로 응답을 내려줍니다. - -#### 4.9.2. 기본 사용 패턴 - -* 4.9.2.1. Not Found (404) - -``` -import com.kri.common.web.BusinessException; - -public User getUserOrThrow(String userId) { - return userRepository.findById(userId) - .orElseThrow(() -> - BusinessException.notFound( - "USER_NOT_FOUND", - "해당 사용자를 찾을 수 없습니다." - ).with("userId", userId) // extras에 userId 추가 - ); -} -``` - -- HTTP 상태: 404 -- code: "USER_NOT_FOUND" -- message: "해당 사용자를 찾을 수 없습니다." -- extras: { "userId": "..." } - -* 4.9.2.2. Conflict (409) - -``` -if (userRepository.existsByLoginId(loginId)) { - throw BusinessException.conflict( - "DUPLICATE_LOGIN_ID", - "이미 사용 중인 로그인 ID입니다." - ).with("loginId", loginId); -} -``` - -* 4.9.2.3. Forbidden (403) - -``` -if (!currentUser.canAccess(targetProject)) { - throw BusinessException.forbidden( - "NO_PERMISSION", - "해당 프로젝트에 접근 권한이 없습니다." - ).with("projectId", projectId); -} -``` - -#### 4.9.3. 임의 상태 코드 지정: of(...) - -of(HttpStatus status, String code, String message) 팩토리로 원하는 상태 코드를 직접 지정할 수 있습니다. - -``` -throw BusinessException.of( - HttpStatus.BAD_REQUEST, - "INVALID_PARAMETER", - "요청 파라미터가 잘못되었습니다." -).with("param", "startDate"); - -``` - -추가 정보를 한 번에 넘기고 싶으면: - -``` -Map extras = Map.of( - "param", "startDate", - "reason", "must be before endDate" -); - -throw BusinessException.of( - HttpStatus.UNPROCESSABLE_ENTITY, // 422 - "INVALID_DATE_RANGE", - "날짜 범위가 올바르지 않습니다.", - extras -); -``` - -> 실제 구현에는 of(status, code, message, Map) 시그니처가 존재합니다. - -#### 4.9.4. extras 체이닝: with(...) 활용 - -with(key, value)는 새로운 예외 인스턴스를 리턴하는 체이닝 메서드입니다. - -``` -throw BusinessException.notFound("USER_NOT_FOUND", "사용자를 찾을 수 없습니다.") - .with("userId", userId) - .with("searchType", "INTRANET"); -``` - -* 내부적으로 extras를 복사해 새 인스턴스를 만드는 방식이라, immutable 스타일로 안전하게 체이닝할 수 있습니다. - -#### 4.9.5. Service / Controller에서의 사용 위치 - -Service에서 던지고, Controller는 깔끔하게 유지 - -Service 예시 - -``` -@Service -@RequiredArgsConstructor -public class UserService { - - private final UserRepository userRepository; - - public UserDto getUser(String userId) { - var user = userRepository.findById(userId) - .orElseThrow(() -> BusinessException.notFound( - "USER_NOT_FOUND", - "사용자를 찾을 수 없습니다." - ).with("userId", userId)); - - return UserDto.from(user); - } -} -``` - -Controller 예시 - -``` -@RestController -@RequestMapping("/api/users") -@RequiredArgsConstructor -public class UserController { - - private final UserService userService; - - @GetMapping("/{userId}") - public UserDto getUser(@PathVariable String userId) { - // 여기서는 try/catch 필요 없음 - return userService.getUser(userId); - } -} -``` - -* 비즈니스 예외는 Service 계층에서 던지는 것을 추천 -* Controller는 예외를 그대로 위로 올려보내고, -* ErrorAdvice가 @ExceptionHandler(BusinessException.class)로 처리 - -#### 4.9.6. 실제 응답 JSON 예시 - -``` -throw BusinessException.notFound("USER_NOT_FOUND", "사용자를 찾을 수 없습니다.") - .with("userId", "u-123"); - -``` - -요청 URL이 /api/users/u-123인 경우, 응답은 대략 다음과 같은 형태입니다. - -```json -{ - "type": "about:blank", - "title": "Not Found", - "status": 404, - "detail": "사용자를 찾을 수 없습니다.", - "code": "USER_NOT_FOUND", - "timestamp": "2025-11-17T12:34:56.789Z", - "path": "/api/users/u-123", - "traceId": "abc123...", - "handler": "UserController#getUser", - "service": "UserService#getUser", - "userId": "u-123" -} -``` - -> 이 포맷은 ErrorAdvice에서 공통으로 생성합니다. - -#### 4.9.7. 로그 출력 정책 - -ErrorAdvice 내부 로깅 정책(요약): - -5xx (서버 에러) - -→ ERROR 레벨 + 스택 트레이스 포함 - -400, 403, 404, 409, 422 등 도메인 에러 - -→ WARN 레벨, 스택 트레이스 없이 요약 로그 - -기타 상태코드 - -→ 기본적으로 WARN - -#### 4.9.8. 에러 코드 enum으로 관리하기 (선택) - -서비스에서 에러 코드를 enum으로 관리하면 나중에 유지보수가 쉬워집니다. - -``` -public enum UserErrorCodes { - USER_NOT_FOUND, - DUPLICATE_LOGIN_ID, - PASSWORD_MISMATCH -} - -throw BusinessException.notFound( - UserErrorCodes.USER_NOT_FOUND.name(), - "사용자를 찾을 수 없습니다." - ).with("userId", userId); -``` - -#### 4.9.9. 요약 - -1. 던지는 쪽 (Service) - * BusinessException.notFound("CODE", "메시지") - * BusinessException.conflict("CODE", "메시지") - * BusinessException.forbidden("CODE", "메시지") - * 필요시 of(status, code, message) - * with("key", value)로 추가 정보(extras) 세팅 -2. 받는 쪽 (Controller) - * 별도 try/catch 필요 없음 - * ErrorAdvice가 자동으로 JSON + 로그 처리 -3. 클라이언트/FE 입장 - * 응답은 ProblemDetail 포맷 + code + extras 일관 구조 - * FE에서는 code 기준으로 에러 분기 처리하면 됨 - ---- - -## 5. example-service 적용 요약 - -1. **의존성 추가** - - * Spring Boot Web / Security / Validation / (필요시) Redis / Swagger - * `implementation "com.kri.common:starter:1.0.11"` - -2. **application.yml 구성** - - * `kri.auth.jwt.*` : 시크릿/만료시간 설정 - * `kri.auth.apikey.*` : API Key 사용 여부 및 헤더 이름 - * `kri.security.public-paths` : 로그인/헬스체크/Swagger 등 열어둘 URL 설정 - * `kri.swagger.*` : title/description/base-package 설정 - * `kri.webmvc.ip.additional-cidrs` : Swagger 접근 허용 IP 대역 추가 - * `common.redis.enabled`, `common.scheduling.enabled` 등 필요 시 on - -3. **로그인 엔드포인트 구현** - - * 사용자 검증 후 `JwtUserClaimsDto`를 만들어 `JwtService.generateAccessToken()` 호출 - * Controller에서 JWT를 응답으로 내려줌 - -4. **외부 API Key 사용 시** - - * `ApiKeyUserClaimsProvider` 구현체를 Bean으로 등록 - * `kri.auth.apikey.enabled=true` 설정 - -5. **권한 제어** - - * URL 레벨: `kri.security.public-paths` (기본 + 추가) - * 메소드 레벨: `@PermitAll`, `@PreAuthorize("hasRole('1')")` 등 사용 - ---- - -## 6. 서비스 적용 체크리스트(운영 전 최종 점검) - -- JWT 시크릿이 운영용 난수 32바이트 이상인지, 저장소/CI 로그에 노출되지 않는지 확인 -- `kri.security.public-paths` 최소 공개 원칙 적용 여부 점검(로그인/헬스/문서만 허용 권장) -- Swagger 접근 제어 CIDR 확인(운영망 외부 노출 금지) -- 도메인 예외는 BusinessException으로 일원화되어 있는지, FE와 코드/메시지 합의 완료 -- 필요 시 `ApiKeyUserClaimsProvider` 구현 제공 여부 -- 로그 적재 디렉터리와 로테이션 정책 확인(logback-spring.xml 커스터마이즈 필요 여부) -- 스케줄링/Redis 기능 사용 시 프로퍼티 on 여부 및 인프라 준비 - ---- - -## 7. 문제 해결 가이드(Troubleshooting) - -- 애플리케이션 시작 시 "kri.auth.jwt.secret must be at least 32 bytes" 오류 - - 원인: JWT 시크릿 최소 길이 미달 - - 조치: application.yml의 `kri.auth.jwt.secret`를 UTF-8 32바이트 이상 난수로 교체 - -- 모든 요청이 401 Unauthorized - - 원인1: Authorization 헤더에 Bearer 토큰 미포함 - - 원인2: 토큰 만료/서명 불일치(issuer 불일치 포함) - - 조치: 로그인 API로 토큰 재발급, issuer와 secret 확인, 클럭 드리프트 점검 - -- Swagger 페이지가 접근 불가(403/404) - - 원인: IP 접근 제어 또는 public-paths 미설정 - - 조치: `kri.webmvc.ip.additional-cidrs`에 현재 IP 대역 추가 또는 `kri.security.public-paths`에 Swagger 경로 - 포함 - -- ApiKeyUserClaimsProvider가 동작하지 않음 - - 원인: Bean 미등록 또는 `kri.auth.apikey.enabled=false` - - 조치: 구현체 @Component 등록, 프로퍼티 enabled=true 설정, 헤더 이름 일치 여부 점검 - ---- - -## 8. FAQ - -- Q. API Key와 JWT는 어떻게 같이 쓰나요? - - A. 필터 체인에서 API Key가 먼저 검사되어 인증을 세팅하고, 없거나 실패하면 JWT가 검사됩니다. 외부 파트너는 API Key, 내부/사용자 트래픽은 JWT를 - 권장합니다. - -- Q. ROLE 매핑은 어디서 바꾸나요? - - A. JwtService.toAuthentication(JwtUserClaimsDto) 내부에서 "ROLE_{숫자}"로 생성합니다. 서비스 정책에 맞게 해당 메서드를 - 오버라이드하거나 래핑하십시오. - -- Q. 기본 Security를 전면 교체할 수 있나요? - - A. 서비스에서 SecurityFilterChain Bean을 직접 정의하면, `@ConditionalOnMissingBean` 규칙에 의해 서비스 정의가 우선 - 적용됩니다. - ---- - -## 9. 요구 사양 - -- Java 17+ -- Spring Boot 3.5.x (라이브러리는 Spring Boot BOM 3.5.7 기준) \ No newline at end of file +- `ApiKeyProperties`의 DB 기본값, `JwtProperties`의 secret 기본값은 의도적으로 유지 중입니다. +- 문서 기준 패키지명은 현재 리팩터링 결과인 `autoconfigure / feature / runtime / endpoint`를 따릅니다. +- 컴파일 검증은 `.\gradlew.bat compileJava` 기준으로 통과했습니다. diff --git a/build.gradle b/build.gradle index 2f8821c..a6d2e22 100644 --- a/build.gradle +++ b/build.gradle @@ -4,7 +4,7 @@ plugins { } //버전 변경은 여기서 -def commonVer = "beta.1.0.70" +def commonVer = "beta.1.1.01" group = 'com.kri.common' version = commonVer @@ -13,6 +13,10 @@ java { toolchain { languageVersion = JavaLanguageVersion.of(17) } } +tasks.withType(JavaCompile).configureEach { + options.encoding = 'UTF-8' +} + repositories { mavenCentral() } @@ -30,7 +34,7 @@ dependencies { // JWT api 'io.jsonwebtoken:jjwt-api:0.11.5' - runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5' + runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.12.6' runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5' // Security Core @@ -54,11 +58,10 @@ dependencies { //Json Util implementation 'com.fasterxml.jackson.core:jackson-databind:2.17.0' //Excel Util - implementation 'org.apache.poi:poi-ooxml:5.2.5' + implementation 'org.apache.poi:poi-ooxml:5.4.0' // ConfigurationProperties 메타데이터 annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor' - compileOnly 'org.springframework.boot:spring-boot-autoconfigure' // 자동구성/웹/검증/AOP/Redis는 컴파일만 (전이 방지) compileOnly 'org.springframework.boot:spring-boot-autoconfigure' @@ -90,4 +93,4 @@ publishing { } } } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyAdminAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyAdminAutoConfiguration.java similarity index 71% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyAdminAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyAdminAutoConfiguration.java index 8ad9f41..6b5f0a6 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyAdminAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyAdminAutoConfiguration.java @@ -1,5 +1,6 @@ -package com.kri.common.auth.apikey; +package com.kri.common.autoconfigure.auth.apikey; +import com.kri.common.endpoint.auth.apikey.ApiKeyAdminController; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; @@ -8,7 +9,7 @@ import org.springframework.context.annotation.Import; @AutoConfiguration @ConditionalOnClass(ApiKeyAdminController.class) @ConditionalOnProperty(prefix = "kri.auth.apikey", name = "admin-api-enabled", havingValue = "true") -@Import(ApiKeyAdminController.class) // ✅ 컴포넌트 스캔 없이도 Bean 등록 +@Import(ApiKeyAdminController.class) // 컴포넌트 스캔 없이도 Bean 등록 public class ApiKeyAdminAutoConfiguration { } diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyJpaAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyJpaAutoConfiguration.java similarity index 98% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyJpaAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyJpaAutoConfiguration.java index 354d920..87d08b8 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyJpaAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyJpaAutoConfiguration.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.apikey; +package com.kri.common.autoconfigure.auth.apikey; import com.zaxxer.hikari.HikariDataSource; import jakarta.persistence.EntityManagerFactory; @@ -111,4 +111,4 @@ public class ApiKeyJpaAutoConfiguration { // FactoryBean으로 등록하면 내부에서 EntityManagerFactory들을 찾아 Metamodel을 구성함 return new JpaMetamodelMappingContextFactoryBean(); } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyPreloadAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyPreloadAutoConfiguration.java similarity index 73% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyPreloadAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyPreloadAutoConfiguration.java index 683f9d4..1c23558 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyPreloadAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyPreloadAutoConfiguration.java @@ -1,6 +1,8 @@ -package com.kri.common.auth.apikey; +package com.kri.common.autoconfigure.auth.apikey; -import com.kri.common.auth.persistence.repository.ApiKeyRepository; +import com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider; +import com.kri.common.runtime.auth.apikey.PreloadedApiKeyUserClaimsProvider; +import com.kri.common.runtime.auth.apikey.persistence.repository.ApiKeyRepository; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; @@ -14,7 +16,7 @@ import org.springframework.context.annotation.Bean; public class ApiKeyPreloadAutoConfiguration { @Bean - @ConditionalOnBean(ApiKeyRepository.class) // ✅ apikey JPA 컨텍스트가 repo를 만들었을 때만 + @ConditionalOnBean(ApiKeyRepository.class) @ConditionalOnMissingBean(ApiKeyUserClaimsProvider.class) public PreloadedApiKeyUserClaimsProvider apiKeyUserClaimsProvider( ApiKeyProperties props, diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyProperties.java b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyProperties.java similarity index 97% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyProperties.java rename to src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyProperties.java index 8817d6c..d6cd48f 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyProperties.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/apikey/ApiKeyProperties.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.apikey; +package com.kri.common.autoconfigure.auth.apikey; import java.util.List; import lombok.Getter; diff --git a/src/main/java/com/kri/common/auth/jwt/JwtAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtAutoConfiguration.java similarity index 61% rename from src/main/java/com/kri/common/auth/jwt/JwtAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtAutoConfiguration.java index dd8f719..981fd32 100644 --- a/src/main/java/com/kri/common/auth/jwt/JwtAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtAutoConfiguration.java @@ -1,8 +1,9 @@ -package com.kri.common.auth.jwt; +package com.kri.common.autoconfigure.auth.jwt; -import com.kri.common.auth.apikey.ApiKeyAuthFilter; -import com.kri.common.auth.apikey.ApiKeyProperties; -import com.kri.common.auth.apikey.ApiKeyUserClaimsProvider; +import com.kri.common.runtime.auth.apikey.ApiKeyAuthFilter; +import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; +import com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider; +import com.kri.common.feature.auth.jwt.JwtService; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.context.properties.EnableConfigurationProperties; @@ -19,16 +20,14 @@ public class JwtAutoConfiguration { return new JwtService(properties); } - /** - * ApiKeyUserClaimsProvider 구현체가 존재할 때만 API Key 필터 자동 생성. (실제 필터 체인에 넣는 건 각 서비스의 SecurityConfig 에서 - * addFilterBefore 로 수행) - */ @Bean @ConditionalOnBean(ApiKeyUserClaimsProvider.class) @ConditionalOnMissingBean - public ApiKeyAuthFilter apiKeyAuthFilter(ApiKeyProperties apiKeyProperties, + public ApiKeyAuthFilter apiKeyAuthFilter( + ApiKeyProperties apiKeyProperties, ApiKeyUserClaimsProvider provider, - JwtService jwtService) { + JwtService jwtService + ) { return new ApiKeyAuthFilter(apiKeyProperties, provider, jwtService); } } diff --git a/src/main/java/com/kri/common/auth/jwt/JwtProperties.java b/src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtProperties.java similarity index 94% rename from src/main/java/com/kri/common/auth/jwt/JwtProperties.java rename to src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtProperties.java index ea5cd66..e00c0c9 100644 --- a/src/main/java/com/kri/common/auth/jwt/JwtProperties.java +++ b/src/main/java/com/kri/common/autoconfigure/auth/jwt/JwtProperties.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.jwt; +package com.kri.common.autoconfigure.auth.jwt; import lombok.AllArgsConstructor; import lombok.Getter; @@ -32,4 +32,4 @@ public class JwtProperties { * (선택) Refresh Token 유효 시간(초 단위) */ private long refreshTokenValiditySeconds = 7 * 24 * 3600; // 기본 7일 -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/redis/CommonRedisAutoConfiguration.java similarity index 86% rename from src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/redis/CommonRedisAutoConfiguration.java index a13275a..63b0f31 100644 --- a/src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/redis/CommonRedisAutoConfiguration.java @@ -1,10 +1,11 @@ -package com.kri.common.redis; +package com.kri.common.autoconfigure.redis; +import com.kri.common.feature.redis.RedisQueueHelper; import org.springframework.boot.autoconfigure.AutoConfiguration; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; import org.springframework.context.annotation.Bean; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.RedisTemplate; @@ -12,7 +13,7 @@ import org.springframework.data.redis.core.StringRedisTemplate; @AutoConfiguration @ConditionalOnClass(RedisTemplate.class) -@ConditionalOnProperty(prefix = "common.redis", name = "enabled", havingValue = "true", matchIfMissing = false) +@ConditionalOnExpression("${kri.redis.enabled:false}") @ConditionalOnBean(RedisConnectionFactory.class) public class CommonRedisAutoConfiguration { @@ -28,4 +29,4 @@ public class CommonRedisAutoConfiguration { public RedisQueueHelper redisQueueHelper(StringRedisTemplate rt) { return new RedisQueueHelper(rt); } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/scheduling/CommonSchedulingAutoConfiguration.java similarity index 62% rename from src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/scheduling/CommonSchedulingAutoConfiguration.java index 808fcd3..2d18064 100644 --- a/src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/scheduling/CommonSchedulingAutoConfiguration.java @@ -1,12 +1,12 @@ -package com.kri.common.scheduling; +package com.kri.common.autoconfigure.scheduling; import org.springframework.boot.autoconfigure.AutoConfiguration; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; import org.springframework.scheduling.annotation.EnableScheduling; @AutoConfiguration @EnableScheduling -@ConditionalOnProperty(prefix = "common.scheduling", name = "enabled", havingValue = "true", matchIfMissing = false) +@ConditionalOnExpression("${kri.scheduling.enabled:false}") public class CommonSchedulingAutoConfiguration { -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/security/KriSecurityAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/security/KriSecurityAutoConfiguration.java similarity index 92% rename from src/main/java/com/kri/common/security/KriSecurityAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/security/KriSecurityAutoConfiguration.java index 64062c5..c05b3c3 100644 --- a/src/main/java/com/kri/common/security/KriSecurityAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/security/KriSecurityAutoConfiguration.java @@ -1,8 +1,9 @@ -package com.kri.common.security; +package com.kri.common.autoconfigure.security; -import com.kri.common.auth.apikey.ApiKeyAuthFilter; -import com.kri.common.auth.jwt.JwtProperties; -import com.kri.common.auth.jwt.JwtService; +import com.kri.common.runtime.auth.apikey.ApiKeyAuthFilter; +import com.kri.common.autoconfigure.auth.jwt.JwtProperties; +import com.kri.common.feature.auth.jwt.JwtService; +import com.kri.common.runtime.security.JwtAuthenticationFilter; import lombok.RequiredArgsConstructor; import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.autoconfigure.AutoConfiguration; @@ -83,4 +84,4 @@ public class KriSecurityAutoConfiguration { return http.build(); } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/security/KriSecurityProperties.java b/src/main/java/com/kri/common/autoconfigure/security/KriSecurityProperties.java similarity index 92% rename from src/main/java/com/kri/common/security/KriSecurityProperties.java rename to src/main/java/com/kri/common/autoconfigure/security/KriSecurityProperties.java index 0184e85..9b64bcf 100644 --- a/src/main/java/com/kri/common/security/KriSecurityProperties.java +++ b/src/main/java/com/kri/common/autoconfigure/security/KriSecurityProperties.java @@ -1,4 +1,4 @@ -package com.kri.common.security; +package com.kri.common.autoconfigure.security; import java.util.List; import lombok.Getter; diff --git a/src/main/java/com/kri/common/swagger/KriSwaggerAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerAutoConfiguration.java similarity index 85% rename from src/main/java/com/kri/common/swagger/KriSwaggerAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerAutoConfiguration.java index 8c353e7..1370fc2 100644 --- a/src/main/java/com/kri/common/swagger/KriSwaggerAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerAutoConfiguration.java @@ -1,6 +1,7 @@ -package com.kri.common.swagger; +package com.kri.common.autoconfigure.swagger; -import com.kri.common.auth.apikey.ApiKeyProperties; +import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; +import com.kri.common.runtime.swagger.SwaggerIpFilter; import io.swagger.v3.oas.models.Components; import io.swagger.v3.oas.models.OpenAPI; import io.swagger.v3.oas.models.info.Info; @@ -24,13 +25,12 @@ import org.springframework.context.annotation.Bean; public class KriSwaggerAutoConfiguration { private final KriSwaggerProperties properties; - private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽어오기 위해 + private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽기용 @Bean @ConditionalOnMissingBean public OpenAPI kriOpenAPI() { - - // 🔐 JWT Bearer + API-Key 스키마 정의 + // JWT Bearer + API Key 스키마 정의 Components components = new Components() .addSecuritySchemes("BearerAuth", new SecurityScheme() @@ -41,9 +41,9 @@ public class KriSwaggerAutoConfiguration { new SecurityScheme() .type(SecurityScheme.Type.APIKEY) .in(SecurityScheme.In.HEADER) - .name(apiKeyProperties.getHeaderName())); // 예: X-API-Key + .name(apiKeyProperties.getHeaderName())); // 예: X-API-Key - // 🔐 기본적으로 두 보안 스키마를 전역에 적용 + // 두 보안 스키마를 기본 보안 요구사항으로 등록 SecurityRequirement securityRequirement = new SecurityRequirement() .addList("BearerAuth") .addList("ApiKeyAuth"); @@ -54,8 +54,7 @@ public class KriSwaggerAutoConfiguration { .info(new Info() .title(properties.getTitle()) .description(properties.getDescription()) - .version(properties.getVersion()) - ); + .version(properties.getVersion())); } @Bean(name = "kriGroupedOpenApi") @@ -67,10 +66,7 @@ public class KriSwaggerAutoConfiguration { String base = properties.getBasePackage(); if (base != null && !base.isBlank()) { - builder.packagesToScan( - base, - "com.kri.common.auth.apikey" - ); + builder.packagesToScan(base, "com.kri.common.feature.auth.apikey"); } return builder.build(); @@ -86,4 +82,4 @@ public class KriSwaggerAutoConfiguration { registrationBean.setOrder(1); return registrationBean; } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/swagger/KriSwaggerProperties.java b/src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerProperties.java similarity index 72% rename from src/main/java/com/kri/common/swagger/KriSwaggerProperties.java rename to src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerProperties.java index e2230b9..e56a360 100644 --- a/src/main/java/com/kri/common/swagger/KriSwaggerProperties.java +++ b/src/main/java/com/kri/common/autoconfigure/swagger/KriSwaggerProperties.java @@ -1,4 +1,4 @@ -package com.kri.common.swagger; +package com.kri.common.autoconfigure.swagger; import lombok.Getter; import lombok.Setter; @@ -19,12 +19,12 @@ public class KriSwaggerProperties { private String version = "v1"; /** - * 문서화할 base package (null 이면 전체) + * 臾몄꽌?뷀븷 base package (null ?대㈃ ?꾩껜) */ private String basePackage; /** - * Swagger 접근 허용 IP 목록 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1은 기본 허용) + * Swagger ?묎렐 ?덉슜 IP 紐⑸줉 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1?€ 湲곕낯 ?덉슜) */ private List allowedIps = new ArrayList<>(); } diff --git a/src/main/java/com/kri/common/autoconfigure/web/CommonWebAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/web/CommonWebAutoConfiguration.java new file mode 100644 index 0000000..c03074e --- /dev/null +++ b/src/main/java/com/kri/common/autoconfigure/web/CommonWebAutoConfiguration.java @@ -0,0 +1,39 @@ +package com.kri.common.autoconfigure.web; + +import com.kri.common.runtime.web.ErrorAdvice; +import com.kri.common.runtime.web.MdcHandlerConfig; +import com.kri.common.runtime.web.ServiceMdcAspect; +import com.kri.common.runtime.web.TraceFilter; +import org.aspectj.lang.annotation.Aspect; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; +import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; +import org.springframework.boot.web.servlet.FilterRegistrationBean; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Import; +import org.springframework.core.Ordered; + +@AutoConfiguration +@ConditionalOnExpression("${kri.web.enabled:true}") +@Import(MdcHandlerConfig.class) +public class CommonWebAutoConfiguration { + + @Bean + public ErrorAdvice errorAdvice() { + return new ErrorAdvice(); + } + + @Bean + public FilterRegistrationBean traceFilter() { + var reg = new FilterRegistrationBean<>(new TraceFilter()); + reg.setOrder(Ordered.HIGHEST_PRECEDENCE); + return reg; + } + + @Bean + @ConditionalOnClass(Aspect.class) + @ConditionalOnExpression("${kri.web.mdc.enabled:true}") + public ServiceMdcAspect serviceMdcAspect() { + return new ServiceMdcAspect(); + } +} diff --git a/src/main/java/com/kri/common/webmvc/KriIpAccessProperties.java b/src/main/java/com/kri/common/autoconfigure/webmvc/KriIpAccessProperties.java similarity index 96% rename from src/main/java/com/kri/common/webmvc/KriIpAccessProperties.java rename to src/main/java/com/kri/common/autoconfigure/webmvc/KriIpAccessProperties.java index 081bf74..f9d00b4 100644 --- a/src/main/java/com/kri/common/webmvc/KriIpAccessProperties.java +++ b/src/main/java/com/kri/common/autoconfigure/webmvc/KriIpAccessProperties.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc; +package com.kri.common.autoconfigure.webmvc; import java.util.ArrayList; import java.util.List; diff --git a/src/main/java/com/kri/common/webmvc/KriWebMvcAutoConfiguration.java b/src/main/java/com/kri/common/autoconfigure/webmvc/KriWebMvcAutoConfiguration.java similarity index 87% rename from src/main/java/com/kri/common/webmvc/KriWebMvcAutoConfiguration.java rename to src/main/java/com/kri/common/autoconfigure/webmvc/KriWebMvcAutoConfiguration.java index 81f3976..0509e0b 100644 --- a/src/main/java/com/kri/common/webmvc/KriWebMvcAutoConfiguration.java +++ b/src/main/java/com/kri/common/autoconfigure/webmvc/KriWebMvcAutoConfiguration.java @@ -1,6 +1,9 @@ -package com.kri.common.webmvc; +package com.kri.common.autoconfigure.webmvc; -import com.kri.common.auth.jwt.JwtService; +import com.kri.common.feature.auth.jwt.JwtService; +import com.kri.common.runtime.webmvc.IpAccessControlInterceptor; +import com.kri.common.runtime.webmvc.IpAccessControlService; +import com.kri.common.runtime.webmvc.RequestUserContextArgumentResolver; import lombok.RequiredArgsConstructor; import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.autoconfigure.AutoConfiguration; @@ -15,7 +18,7 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @AutoConfiguration @EnableConfigurationProperties(KriIpAccessProperties.class) -@ConditionalOnProperty(name = "common.webmvc.enabled", matchIfMissing = true) +@ConditionalOnProperty(name = "kri.webmvc.enabled", matchIfMissing = true) @RequiredArgsConstructor public class KriWebMvcAutoConfiguration { @@ -81,8 +84,8 @@ public class KriWebMvcAutoConfiguration { @Override public void addFormatters(org.springframework.format.FormatterRegistry registry) { - registry.addConverterFactory(new com.kri.common.webmvc.CodeEnumConverter()); + registry.addConverterFactory(new com.kri.common.runtime.webmvc.CodeEnumConverter()); } }; } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyAdminController.java b/src/main/java/com/kri/common/endpoint/auth/apikey/ApiKeyAdminController.java similarity index 88% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyAdminController.java rename to src/main/java/com/kri/common/endpoint/auth/apikey/ApiKeyAdminController.java index 9689021..3008d2f 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyAdminController.java +++ b/src/main/java/com/kri/common/endpoint/auth/apikey/ApiKeyAdminController.java @@ -1,6 +1,8 @@ -package com.kri.common.auth.apikey; +package com.kri.common.endpoint.auth.apikey; -import com.kri.common.auth.dto.JwtUserClaimsDto; +import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; +import com.kri.common.runtime.auth.apikey.PreloadedApiKeyUserClaimsProvider; import jakarta.servlet.http.HttpServletRequest; import java.util.List; import java.util.Map; @@ -36,7 +38,7 @@ public class ApiKeyAdminController { } /** - * 현재 캐시 상태(키는 마스킹) + * 현재 메모리에 적재된 API Key 캐시를 확인합니다. */ @GetMapping("/cache") public List cache(HttpServletRequest req) { diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyUserClaimsProvider.java b/src/main/java/com/kri/common/feature/auth/apikey/ApiKeyUserClaimsProvider.java similarity index 84% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyUserClaimsProvider.java rename to src/main/java/com/kri/common/feature/auth/apikey/ApiKeyUserClaimsProvider.java index 4317899..b0884a2 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyUserClaimsProvider.java +++ b/src/main/java/com/kri/common/feature/auth/apikey/ApiKeyUserClaimsProvider.java @@ -1,6 +1,6 @@ -package com.kri.common.auth.apikey; +package com.kri.common.feature.auth.apikey; -import com.kri.common.auth.dto.JwtUserClaimsDto; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; import java.util.Optional; /** diff --git a/src/main/java/com/kri/common/auth/dto/JwtUserClaimsDto.java b/src/main/java/com/kri/common/feature/auth/dto/JwtUserClaimsDto.java similarity index 92% rename from src/main/java/com/kri/common/auth/dto/JwtUserClaimsDto.java rename to src/main/java/com/kri/common/feature/auth/dto/JwtUserClaimsDto.java index 20bc5b7..c33a111 100644 --- a/src/main/java/com/kri/common/auth/dto/JwtUserClaimsDto.java +++ b/src/main/java/com/kri/common/feature/auth/dto/JwtUserClaimsDto.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.dto; +package com.kri.common.feature.auth.dto; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Builder; @@ -26,4 +26,4 @@ public class JwtUserClaimsDto { @Schema(description = "권한 코드") Integer userRole; -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/auth/jwt/JwtService.java b/src/main/java/com/kri/common/feature/auth/jwt/JwtService.java similarity index 64% rename from src/main/java/com/kri/common/auth/jwt/JwtService.java rename to src/main/java/com/kri/common/feature/auth/jwt/JwtService.java index 4780529..2ade2ac 100644 --- a/src/main/java/com/kri/common/auth/jwt/JwtService.java +++ b/src/main/java/com/kri/common/feature/auth/jwt/JwtService.java @@ -1,6 +1,7 @@ -package com.kri.common.auth.jwt; +package com.kri.common.feature.auth.jwt; -import com.kri.common.auth.dto.JwtUserClaimsDto; +import com.kri.common.autoconfigure.auth.jwt.JwtProperties; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; import io.jsonwebtoken.Claims; import io.jsonwebtoken.Jws; import io.jsonwebtoken.JwtException; @@ -44,10 +45,6 @@ public class JwtService { this.key = Keys.hmacShaKeyFor(secret.getBytes(StandardCharsets.UTF_8)); } - // ====================================================== - // 내부 공통 빌더 - // ====================================================== - private String buildToken(Map claims, String subject, long validitySeconds) { Date now = new Date(); Date expiry = new Date(now.getTime() + validitySeconds * 1000); @@ -64,7 +61,6 @@ public class JwtService { private Map buildClaims(JwtUserClaimsDto dto) { Map claims = new HashMap<>(); - // 필요한 항목만 골라서 claim에 넣어줌 claims.put("userId", dto.getUserId()); claims.put("userCmpn", dto.getUserCmpn()); claims.put("userTeam", dto.getUserTeam()); @@ -73,41 +69,15 @@ public class JwtService { return claims; } - // ====================================================== - // 토큰 생성 (DTO 기반) - // ====================================================== - - /** - * JwtUserClaimsDto 기반 Access Token 생성 - subject = userId - claims: userId, userCmpn, userTeam, - * userName, role - */ public String generateAccessToken(JwtUserClaimsDto userClaims) { Map claims = buildClaims(userClaims); - return buildToken( - claims, - userClaims.getUserId(), - properties.getAccessTokenValiditySeconds() - ); + return buildToken(claims, userClaims.getUserId(), properties.getAccessTokenValiditySeconds()); } - /** - * Refresh Token은 보통 userId만 넣고 심플하게 사용 - */ public String generateRefreshToken(String userId) { - return buildToken( - Collections.emptyMap(), - userId, - properties.getRefreshTokenValiditySeconds() - ); + return buildToken(Collections.emptyMap(), userId, properties.getRefreshTokenValiditySeconds()); } - // ====================================================== - // 토큰 파싱 - // ====================================================== - - /** - * 토큰 파싱 + 서명/만료 검증 - */ public Jws parseToken(String token) throws JwtException { return Jwts.parserBuilder() .requireIssuer(properties.getIssuer()) @@ -116,18 +86,11 @@ public class JwtService { .parseClaimsJws(token); } - /** - * 토큰에서 Claims만 추출 (검증 포함) - */ public Claims getClaims(String token) throws JwtException { return parseToken(token).getBody(); } - /** - * Claims → JwtUserClaimsDto 변환 - */ public JwtUserClaimsDto toUserClaimsDto(Claims claims) { - // userId는 subject와 별도 claim 둘 다에서 시도 String userId = claims.get("userId", String.class); if (userId == null) { userId = claims.getSubject(); @@ -136,8 +99,6 @@ public class JwtService { String userCmpn = claims.get("userCmpn", String.class); String userTeam = claims.get("userTeam", String.class); String userName = claims.get("userName", String.class); - - // 숫자는 Integer / Long 등으로 들어올 수 있으니 Number로 받았다가 intValue() Number roleNumber = claims.get("role", Number.class); Integer userRole = roleNumber != null ? roleNumber.intValue() : null; @@ -150,43 +111,26 @@ public class JwtService { .build(); } - /** - * 토큰 → JwtUserClaimsDto 바로 추출 - */ public JwtUserClaimsDto toUserClaimsDto(String token) throws JwtException { Claims claims = getClaims(token); return toUserClaimsDto(claims); } - // ====================================================== - // Authentication 변환 (Spring Security 연동용) - // ====================================================== - - /** - * DTO → Spring Security Authentication 변환 여기서는 간단하게 "ROLE_{role값}" 형태로 Authority를 구성. ex) role = - * 1 → "ROLE_1" 실제 프로젝트에서 0/1/2 같은 값에 대한 의미 매핑이 명확하다면, 이 메서드 안의 매핑 로직만 교체해서 쓰면 됨. - */ public Authentication toAuthentication(JwtUserClaimsDto dto) { String principal = dto.getUserId(); List authorities = new ArrayList<>(); if (dto.getUserRole() != null) { - String authority = "ROLE_" + dto.getUserRole(); - authorities.add(new SimpleGrantedAuthority(authority)); + authorities.add(new SimpleGrantedAuthority("ROLE_" + dto.getUserRole())); } UsernamePasswordAuthenticationToken auth = new UsernamePasswordAuthenticationToken(principal, null, authorities); - - auth.setDetails(dto); // 핵심: claims를 details에 보관 + auth.setDetails(dto); return auth; } - /** - * 토큰 → Authentication 변환 (JWT 파싱 + DTO 변환까지 한 번에) - */ public Authentication toAuthentication(String token) throws JwtException { - JwtUserClaimsDto dto = toUserClaimsDto(token); - return toAuthentication(dto); + return toAuthentication(toUserClaimsDto(token)); } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/cache/AbstractListCache.java b/src/main/java/com/kri/common/feature/cache/AbstractListCache.java similarity index 97% rename from src/main/java/com/kri/common/cache/AbstractListCache.java rename to src/main/java/com/kri/common/feature/cache/AbstractListCache.java index 42edc38..1bc1bbc 100644 --- a/src/main/java/com/kri/common/cache/AbstractListCache.java +++ b/src/main/java/com/kri/common/feature/cache/AbstractListCache.java @@ -1,4 +1,4 @@ -package com.kri.common.cache; +package com.kri.common.feature.cache; import java.util.ArrayList; import java.util.Collection; @@ -81,7 +81,7 @@ public abstract class AbstractListCache { lock.writeLock().lock(); try { ArrayList next = new ArrayList<>(this.list); - int i = Math.max(0, Math.min(index, next.size())); // 0 ~ size로 보정 + int i = Math.max(0, Math.min(index, next.size())); // 0 ~ size濡?蹂댁젙 next.addAll(i, new ArrayList<>(items)); this.list = List.copyOf(next); } finally { @@ -105,7 +105,7 @@ public abstract class AbstractListCache { try { ArrayList next = new ArrayList<>(this.list); - int i = Math.max(0, Math.min(index, next.size())); // 0 ~ size로 보정 + int i = Math.max(0, Math.min(index, next.size())); // 0 ~ size濡?蹂댁젙 next.add(i, item); this.list = List.copyOf(next); } finally { diff --git a/src/main/java/com/kri/common/cache/AbstractMapCache.java b/src/main/java/com/kri/common/feature/cache/AbstractMapCache.java similarity index 98% rename from src/main/java/com/kri/common/cache/AbstractMapCache.java rename to src/main/java/com/kri/common/feature/cache/AbstractMapCache.java index 4fe683a..a11a9f9 100644 --- a/src/main/java/com/kri/common/cache/AbstractMapCache.java +++ b/src/main/java/com/kri/common/feature/cache/AbstractMapCache.java @@ -1,4 +1,4 @@ -package com.kri.common.cache; +package com.kri.common.feature.cache; import java.util.HashMap; import java.util.Map; @@ -116,4 +116,3 @@ public abstract class AbstractMapCache { return null; } } - diff --git a/src/main/java/com/kri/common/datetime/DateTimeUtil.java b/src/main/java/com/kri/common/feature/datetime/DateTimeUtil.java similarity index 99% rename from src/main/java/com/kri/common/datetime/DateTimeUtil.java rename to src/main/java/com/kri/common/feature/datetime/DateTimeUtil.java index 4dd365b..8a2dcab 100644 --- a/src/main/java/com/kri/common/datetime/DateTimeUtil.java +++ b/src/main/java/com/kri/common/feature/datetime/DateTimeUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.datetime; +package com.kri.common.feature.datetime; import java.time.Instant; import java.time.LocalDate; diff --git a/src/main/java/com/kri/common/datetime/LenientLocalDateTime.java b/src/main/java/com/kri/common/feature/datetime/LenientLocalDateTime.java similarity index 95% rename from src/main/java/com/kri/common/datetime/LenientLocalDateTime.java rename to src/main/java/com/kri/common/feature/datetime/LenientLocalDateTime.java index 06868ef..80b0077 100644 --- a/src/main/java/com/kri/common/datetime/LenientLocalDateTime.java +++ b/src/main/java/com/kri/common/feature/datetime/LenientLocalDateTime.java @@ -1,4 +1,4 @@ -package com.kri.common.datetime; +package com.kri.common.feature.datetime; import com.fasterxml.jackson.annotation.JacksonAnnotationsInside; import com.fasterxml.jackson.databind.annotation.JsonDeserialize; diff --git a/src/main/java/com/kri/common/datetime/LenientLocalDateTimeDeserializer.java b/src/main/java/com/kri/common/feature/datetime/LenientLocalDateTimeDeserializer.java similarity index 98% rename from src/main/java/com/kri/common/datetime/LenientLocalDateTimeDeserializer.java rename to src/main/java/com/kri/common/feature/datetime/LenientLocalDateTimeDeserializer.java index 011af4d..755137f 100644 --- a/src/main/java/com/kri/common/datetime/LenientLocalDateTimeDeserializer.java +++ b/src/main/java/com/kri/common/feature/datetime/LenientLocalDateTimeDeserializer.java @@ -1,4 +1,4 @@ -package com.kri.common.datetime; +package com.kri.common.feature.datetime; import com.fasterxml.jackson.core.JsonParser; import com.fasterxml.jackson.databind.BeanProperty; @@ -90,4 +90,4 @@ public class LenientLocalDateTimeDeserializer extends JsonDeserializer { diff --git a/src/main/java/com/kri/common/enums/CodeEnumUtils.java b/src/main/java/com/kri/common/feature/enums/CodeEnumUtils.java similarity index 92% rename from src/main/java/com/kri/common/enums/CodeEnumUtils.java rename to src/main/java/com/kri/common/feature/enums/CodeEnumUtils.java index 9245e23..7162f44 100644 --- a/src/main/java/com/kri/common/enums/CodeEnumUtils.java +++ b/src/main/java/com/kri/common/feature/enums/CodeEnumUtils.java @@ -1,4 +1,4 @@ -package com.kri.common.enums; +package com.kri.common.feature.enums; public final class CodeEnumUtils { diff --git a/src/main/java/com/kri/common/excel/ExcelColumn.java b/src/main/java/com/kri/common/feature/excel/ExcelColumn.java similarity index 91% rename from src/main/java/com/kri/common/excel/ExcelColumn.java rename to src/main/java/com/kri/common/feature/excel/ExcelColumn.java index 4f412bc..422c898 100644 --- a/src/main/java/com/kri/common/excel/ExcelColumn.java +++ b/src/main/java/com/kri/common/feature/excel/ExcelColumn.java @@ -1,4 +1,4 @@ -package com.kri.common.excel; +package com.kri.common.feature.excel; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; diff --git a/src/main/java/com/kri/common/excel/ExcelMapper.java b/src/main/java/com/kri/common/feature/excel/ExcelMapper.java similarity index 99% rename from src/main/java/com/kri/common/excel/ExcelMapper.java rename to src/main/java/com/kri/common/feature/excel/ExcelMapper.java index c5eecff..9956626 100644 --- a/src/main/java/com/kri/common/excel/ExcelMapper.java +++ b/src/main/java/com/kri/common/feature/excel/ExcelMapper.java @@ -1,4 +1,4 @@ -package com.kri.common.excel; +package com.kri.common.feature.excel; import java.io.IOException; import java.io.InputStream; @@ -1455,4 +1455,4 @@ public final class ExcelMapper { } } } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/excel/ExcelUtil.java b/src/main/java/com/kri/common/feature/excel/ExcelUtil.java similarity index 95% rename from src/main/java/com/kri/common/excel/ExcelUtil.java rename to src/main/java/com/kri/common/feature/excel/ExcelUtil.java index 73e5296..82a9306 100644 --- a/src/main/java/com/kri/common/excel/ExcelUtil.java +++ b/src/main/java/com/kri/common/feature/excel/ExcelUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.excel; +package com.kri.common.feature.excel; import org.apache.poi.ss.usermodel.Cell; import org.apache.poi.ss.usermodel.DateUtil; @@ -32,4 +32,4 @@ public final class ExcelUtil { default -> null; // ERROR, _NONE 등 나머지 타입 }; } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/file/FileUtil.java b/src/main/java/com/kri/common/feature/file/FileUtil.java similarity index 97% rename from src/main/java/com/kri/common/file/FileUtil.java rename to src/main/java/com/kri/common/feature/file/FileUtil.java index 66a4645..0a75c6d 100644 --- a/src/main/java/com/kri/common/file/FileUtil.java +++ b/src/main/java/com/kri/common/feature/file/FileUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.file; +package com.kri.common.feature.file; import java.util.regex.Pattern; @@ -56,4 +56,4 @@ public final class FileUtil { } return s; } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/http/ExternalApiClient.java b/src/main/java/com/kri/common/feature/http/ExternalApiClient.java similarity index 98% rename from src/main/java/com/kri/common/http/ExternalApiClient.java rename to src/main/java/com/kri/common/feature/http/ExternalApiClient.java index 178aaf5..265331b 100644 --- a/src/main/java/com/kri/common/http/ExternalApiClient.java +++ b/src/main/java/com/kri/common/feature/http/ExternalApiClient.java @@ -1,4 +1,4 @@ -package com.kri.common.http; +package com.kri.common.feature.http; import java.io.IOException; import java.net.URI; @@ -99,4 +99,4 @@ public class ExternalApiClient { throw new RuntimeException("External API 호출 중 오류가 발생했습니다: " + e.getMessage(), e); } } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/http/ExternalApiResponse.java b/src/main/java/com/kri/common/feature/http/ExternalApiResponse.java similarity index 95% rename from src/main/java/com/kri/common/http/ExternalApiResponse.java rename to src/main/java/com/kri/common/feature/http/ExternalApiResponse.java index d05a674..dc21f77 100644 --- a/src/main/java/com/kri/common/http/ExternalApiResponse.java +++ b/src/main/java/com/kri/common/feature/http/ExternalApiResponse.java @@ -1,4 +1,4 @@ -package com.kri.common.http; +package com.kri.common.feature.http; import java.net.http.HttpHeaders; import java.util.List; @@ -34,4 +34,4 @@ public class ExternalApiResponse { public String getBody() { return body; } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/jpa/AbstractCodeEnumConverter.java b/src/main/java/com/kri/common/feature/jpa/AbstractCodeEnumConverter.java similarity index 80% rename from src/main/java/com/kri/common/jpa/AbstractCodeEnumConverter.java rename to src/main/java/com/kri/common/feature/jpa/AbstractCodeEnumConverter.java index cc32d7a..7068757 100644 --- a/src/main/java/com/kri/common/jpa/AbstractCodeEnumConverter.java +++ b/src/main/java/com/kri/common/feature/jpa/AbstractCodeEnumConverter.java @@ -1,7 +1,7 @@ -package com.kri.common.jpa; +package com.kri.common.feature.jpa; -import com.kri.common.enums.CodeEnum; -import com.kri.common.enums.CodeEnumUtils; +import com.kri.common.feature.enums.CodeEnum; +import com.kri.common.feature.enums.CodeEnumUtils; import jakarta.persistence.AttributeConverter; public abstract class AbstractCodeEnumConverter< diff --git a/src/main/java/com/kri/common/jpa/BaseUuidEntity.java b/src/main/java/com/kri/common/feature/jpa/BaseUuidEntity.java similarity index 96% rename from src/main/java/com/kri/common/jpa/BaseUuidEntity.java rename to src/main/java/com/kri/common/feature/jpa/BaseUuidEntity.java index 7f3930e..4296939 100644 --- a/src/main/java/com/kri/common/jpa/BaseUuidEntity.java +++ b/src/main/java/com/kri/common/feature/jpa/BaseUuidEntity.java @@ -1,4 +1,4 @@ -package com.kri.common.jpa; +package com.kri.common.feature.jpa; import jakarta.persistence.MappedSuperclass; import jakarta.persistence.PrePersist; diff --git a/src/main/java/com/kri/common/json/JsonUtil.java b/src/main/java/com/kri/common/feature/json/JsonUtil.java similarity index 99% rename from src/main/java/com/kri/common/json/JsonUtil.java rename to src/main/java/com/kri/common/feature/json/JsonUtil.java index 8777d84..14ada8b 100644 --- a/src/main/java/com/kri/common/json/JsonUtil.java +++ b/src/main/java/com/kri/common/feature/json/JsonUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.json; +package com.kri.common.feature.json; import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.core.type.TypeReference; diff --git a/src/main/java/com/kri/common/redis/RedisQueueHelper.java b/src/main/java/com/kri/common/feature/redis/RedisQueueHelper.java similarity index 92% rename from src/main/java/com/kri/common/redis/RedisQueueHelper.java rename to src/main/java/com/kri/common/feature/redis/RedisQueueHelper.java index cd80d78..b92cef5 100644 --- a/src/main/java/com/kri/common/redis/RedisQueueHelper.java +++ b/src/main/java/com/kri/common/feature/redis/RedisQueueHelper.java @@ -1,4 +1,4 @@ -package com.kri.common.redis; +package com.kri.common.feature.redis; import java.time.Duration; import org.springframework.data.redis.core.StringRedisTemplate; diff --git a/src/main/java/com/kri/common/util/CommonUtil.java b/src/main/java/com/kri/common/feature/util/CommonUtil.java similarity index 83% rename from src/main/java/com/kri/common/util/CommonUtil.java rename to src/main/java/com/kri/common/feature/util/CommonUtil.java index 6f1d086..ada4c48 100644 --- a/src/main/java/com/kri/common/util/CommonUtil.java +++ b/src/main/java/com/kri/common/feature/util/CommonUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.util; +package com.kri.common.feature.util; import java.util.UUID; diff --git a/src/main/java/com/kri/common/util/NumericUtil.java b/src/main/java/com/kri/common/feature/util/NumericUtil.java similarity index 95% rename from src/main/java/com/kri/common/util/NumericUtil.java rename to src/main/java/com/kri/common/feature/util/NumericUtil.java index 4c57f9e..ff40fed 100644 --- a/src/main/java/com/kri/common/util/NumericUtil.java +++ b/src/main/java/com/kri/common/feature/util/NumericUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.util; +package com.kri.common.feature.util; public final class NumericUtil { diff --git a/src/main/java/com/kri/common/util/StringUtil.java b/src/main/java/com/kri/common/feature/util/StringUtil.java similarity index 93% rename from src/main/java/com/kri/common/util/StringUtil.java rename to src/main/java/com/kri/common/feature/util/StringUtil.java index 11a4c4d..f42a2ba 100644 --- a/src/main/java/com/kri/common/util/StringUtil.java +++ b/src/main/java/com/kri/common/feature/util/StringUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.util; +package com.kri.common.feature.util; public final class StringUtil { @@ -19,4 +19,4 @@ public final class StringUtil { public static boolean hasText(String s) { return s != null && !s.isBlank(); } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/web/BusinessException.java b/src/main/java/com/kri/common/feature/web/BusinessException.java similarity index 99% rename from src/main/java/com/kri/common/web/BusinessException.java rename to src/main/java/com/kri/common/feature/web/BusinessException.java index c195bb1..e2ac0f1 100644 --- a/src/main/java/com/kri/common/web/BusinessException.java +++ b/src/main/java/com/kri/common/feature/web/BusinessException.java @@ -1,4 +1,4 @@ -package com.kri.common.web; +package com.kri.common.feature.web; import java.util.Collections; import java.util.HashMap; diff --git a/src/main/java/com/kri/common/webmvc/RequestUserContext.java b/src/main/java/com/kri/common/feature/web/RequestUserContext.java similarity index 73% rename from src/main/java/com/kri/common/webmvc/RequestUserContext.java rename to src/main/java/com/kri/common/feature/web/RequestUserContext.java index 438a6c3..38f6d58 100644 --- a/src/main/java/com/kri/common/webmvc/RequestUserContext.java +++ b/src/main/java/com/kri/common/feature/web/RequestUserContext.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc; +package com.kri.common.feature.web; import lombok.Builder; import lombok.Value; @@ -13,7 +13,7 @@ public class RequestUserContext { String userName; Integer userRole; - String clientIp; // IpUtil 에서 가져온 값 + String clientIp; // IpUtil ?먯꽌 媛€?몄삩 媛? public boolean isAuthenticated() { return userId != null; diff --git a/src/main/java/com/kri/common/webmvc/page/PageRequestDto.java b/src/main/java/com/kri/common/feature/web/page/PageRequestDto.java similarity index 93% rename from src/main/java/com/kri/common/webmvc/page/PageRequestDto.java rename to src/main/java/com/kri/common/feature/web/page/PageRequestDto.java index 25f1695..5b9f8a4 100644 --- a/src/main/java/com/kri/common/webmvc/page/PageRequestDto.java +++ b/src/main/java/com/kri/common/feature/web/page/PageRequestDto.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc.page; +package com.kri.common.feature.web.page; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Getter; diff --git a/src/main/java/com/kri/common/webmvc/page/PageResponseDto.java b/src/main/java/com/kri/common/feature/web/page/PageResponseDto.java similarity index 95% rename from src/main/java/com/kri/common/webmvc/page/PageResponseDto.java rename to src/main/java/com/kri/common/feature/web/page/PageResponseDto.java index 960a43a..2532840 100644 --- a/src/main/java/com/kri/common/webmvc/page/PageResponseDto.java +++ b/src/main/java/com/kri/common/feature/web/page/PageResponseDto.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc.page; +package com.kri.common.feature.web.page; import java.util.List; import lombok.Builder; diff --git a/src/main/java/com/kri/common/webmvc/page/Pageables.java b/src/main/java/com/kri/common/feature/web/page/Pageables.java similarity index 98% rename from src/main/java/com/kri/common/webmvc/page/Pageables.java rename to src/main/java/com/kri/common/feature/web/page/Pageables.java index e4db793..9c0ad1b 100644 --- a/src/main/java/com/kri/common/webmvc/page/Pageables.java +++ b/src/main/java/com/kri/common/feature/web/page/Pageables.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc.page; +package com.kri.common.feature.web.page; import java.beans.Introspector; diff --git a/src/main/java/com/kri/common/auth/apikey/ApiKeyAuthFilter.java b/src/main/java/com/kri/common/runtime/auth/apikey/ApiKeyAuthFilter.java similarity index 64% rename from src/main/java/com/kri/common/auth/apikey/ApiKeyAuthFilter.java rename to src/main/java/com/kri/common/runtime/auth/apikey/ApiKeyAuthFilter.java index 83cbb8a..308cb2d 100644 --- a/src/main/java/com/kri/common/auth/apikey/ApiKeyAuthFilter.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/ApiKeyAuthFilter.java @@ -1,6 +1,8 @@ -package com.kri.common.auth.apikey; +package com.kri.common.runtime.auth.apikey; -import com.kri.common.auth.jwt.JwtService; +import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; +import com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider; +import com.kri.common.feature.auth.jwt.JwtService; import jakarta.servlet.FilterChain; import jakarta.servlet.ServletException; import jakarta.servlet.http.HttpServletRequest; @@ -12,10 +14,6 @@ import org.springframework.security.core.context.SecurityContextHolder; import org.springframework.util.StringUtils; import org.springframework.web.filter.OncePerRequestFilter; -/** - * X-API-Key (또는 설정된 헤더) 기반 API Key 인증 필터. - API Key를 검증하는 로직은 ApiKeyUserClaimsProvider 구현체에 위임. - - * 유효하면 JwtUserClaimsDto → Authentication 으로 변환해서 SecurityContext에 세팅. - */ @RequiredArgsConstructor public class ApiKeyAuthFilter extends OncePerRequestFilter { @@ -24,26 +22,22 @@ public class ApiKeyAuthFilter extends OncePerRequestFilter { private final JwtService jwtService; @Override - protected void doFilterInternal(HttpServletRequest request, + protected void doFilterInternal( + HttpServletRequest request, HttpServletResponse response, - FilterChain filterChain) - throws ServletException, IOException { - - // API Key 기능이 꺼져 있으면 아무 것도 안 함 + FilterChain filterChain + ) throws ServletException, IOException { if (!apiKeyProperties.isEnabled()) { filterChain.doFilter(request, response); return; } - // 이미 다른 방식(JWT 등)으로 인증되어 있으면 패스 if (SecurityContextHolder.getContext().getAuthentication() != null) { filterChain.doFilter(request, response); return; } - String headerName = apiKeyProperties.getHeaderName(); - String apiKey = request.getHeader(headerName); - + String apiKey = request.getHeader(apiKeyProperties.getHeaderName()); if (StringUtils.hasText(apiKey)) { apiKeyUserClaimsProvider.findUserByApiKey(apiKey).ifPresent(dto -> { Authentication auth = jwtService.toAuthentication(dto); @@ -53,4 +47,4 @@ public class ApiKeyAuthFilter extends OncePerRequestFilter { filterChain.doFilter(request, response); } -} \ No newline at end of file +} diff --git a/src/main/java/com/kri/common/auth/apikey/PreloadedApiKeyUserClaimsProvider.java b/src/main/java/com/kri/common/runtime/auth/apikey/PreloadedApiKeyUserClaimsProvider.java similarity index 61% rename from src/main/java/com/kri/common/auth/apikey/PreloadedApiKeyUserClaimsProvider.java rename to src/main/java/com/kri/common/runtime/auth/apikey/PreloadedApiKeyUserClaimsProvider.java index ea0cbff..4f217ab 100644 --- a/src/main/java/com/kri/common/auth/apikey/PreloadedApiKeyUserClaimsProvider.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/PreloadedApiKeyUserClaimsProvider.java @@ -1,8 +1,10 @@ -package com.kri.common.auth.apikey; +package com.kri.common.runtime.auth.apikey; -import com.kri.common.auth.dto.JwtUserClaimsDto; -import com.kri.common.auth.persistence.entity.TApiKeyEntity; -import com.kri.common.auth.persistence.repository.ApiKeyRepository; +import com.kri.common.autoconfigure.auth.apikey.ApiKeyProperties; +import com.kri.common.feature.auth.apikey.ApiKeyUserClaimsProvider; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; +import com.kri.common.runtime.auth.apikey.persistence.entity.TApiKeyEntity; +import com.kri.common.runtime.auth.apikey.persistence.repository.ApiKeyRepository; import java.util.Collections; import java.util.Map; import java.util.Optional; @@ -12,16 +14,10 @@ import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.util.StringUtils; - -public class PreloadedApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvider, - ApplicationRunner { +public class PreloadedApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvider, ApplicationRunner { private final ApiKeyProperties props; private final ApiKeyRepository repo; - - /** - * 캐시를 통째로 교체(swap)하기 위한 AtomicReference - */ private final AtomicReference> cacheRef = new AtomicReference<>(Collections.emptyMap()); @@ -30,9 +26,6 @@ public class PreloadedApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvid this.repo = repo; } - /** - * 런타임에는 DB 조회 금지: 캐시만 조회 - */ @Override public Optional findUserByApiKey(String apiKey) { if (!StringUtils.hasText(apiKey)) { @@ -41,40 +34,29 @@ public class PreloadedApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvid return Optional.ofNullable(cacheRef.get().get(apiKey)); } - /** - * 기동 시 preload - */ @Override public void run(ApplicationArguments args) { - if (!props.isEnabled()) { - return; - } - if (!props.isPreloadOnStartup()) { + if (!props.isEnabled() || !props.isPreloadOnStartup()) { return; } reloadFromDb(); } - /** - * 운영용: DB에서 다시 읽어 캐시 전체 교체 - */ public synchronized int reloadFromDb() { if (!StringUtils.hasText(props.getServiceCode())) { - // serviceCode 없으면 preload 불가 → 안전하게 빈 캐시 cacheRef.set(Collections.emptyMap()); return 0; } var list = repo.findActiveKeysForService(props.getServiceCode()); - Map next = new ConcurrentHashMap<>(Math.max(16, list.size())); - for (TApiKeyEntity e : list) { - next.put(e.getApiKey(), JwtUserClaimsDto.builder() - .userId(e.getUserId()) - .userCmpn(e.getUserCmpn()) - .userTeam(e.getUserTeam()) - .userName(e.getUserName()) - .userRole(e.getUserRole()) + for (TApiKeyEntity entity : list) { + next.put(entity.getApiKey(), JwtUserClaimsDto.builder() + .userId(entity.getUserId()) + .userCmpn(entity.getUserCmpn()) + .userTeam(entity.getUserTeam()) + .userName(entity.getUserName()) + .userRole(entity.getUserRole()) .build()); } @@ -82,9 +64,6 @@ public class PreloadedApiKeyUserClaimsProvider implements ApiKeyUserClaimsProvid return next.size(); } - /** - * Admin 조회용(마스킹은 컨트롤러에서) - */ public Map snapshot() { return cacheRef.get(); } diff --git a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyEntity.java b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyEntity.java similarity index 93% rename from src/main/java/com/kri/common/auth/persistence/entity/TApiKeyEntity.java rename to src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyEntity.java index fc64dd4..8b5c399 100644 --- a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyEntity.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyEntity.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.persistence.entity; +package com.kri.common.runtime.auth.apikey.persistence.entity; import jakarta.persistence.Column; import jakarta.persistence.Entity; @@ -44,7 +44,7 @@ public class TApiKeyEntity { @Column(name = "user_role", nullable = false) private Integer userRole; - /*기본 정보 외*/ + /* 기본 정보 외 */ @Column(name = "user_json") @JdbcTypeCode(SqlTypes.JSON) private Map userJson; @@ -55,5 +55,4 @@ public class TApiKeyEntity { @Column(name = "reg_dt", nullable = false) @ColumnDefault("CURRENT_TIMESTAMP") private LocalDateTime regDt; - -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntity.java b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntity.java similarity index 87% rename from src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntity.java rename to src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntity.java index 323e143..dc56819 100644 --- a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntity.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntity.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.persistence.entity; +package com.kri.common.runtime.auth.apikey.persistence.entity; import jakarta.persistence.EmbeddedId; import jakarta.persistence.Entity; diff --git a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntityId.java b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntityId.java similarity index 94% rename from src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntityId.java rename to src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntityId.java index 45beb77..65d23b6 100644 --- a/src/main/java/com/kri/common/auth/persistence/entity/TApiKeyServiceMapEntityId.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/entity/TApiKeyServiceMapEntityId.java @@ -1,4 +1,4 @@ -package com.kri.common.auth.persistence.entity; +package com.kri.common.runtime.auth.apikey.persistence.entity; import jakarta.persistence.Column; import jakarta.persistence.Embeddable; diff --git a/src/main/java/com/kri/common/auth/persistence/repository/ApiKeyRepository.java b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/repository/ApiKeyRepository.java similarity index 82% rename from src/main/java/com/kri/common/auth/persistence/repository/ApiKeyRepository.java rename to src/main/java/com/kri/common/runtime/auth/apikey/persistence/repository/ApiKeyRepository.java index 04fcd47..c3aafec 100644 --- a/src/main/java/com/kri/common/auth/persistence/repository/ApiKeyRepository.java +++ b/src/main/java/com/kri/common/runtime/auth/apikey/persistence/repository/ApiKeyRepository.java @@ -1,6 +1,6 @@ -package com.kri.common.auth.persistence.repository; +package com.kri.common.runtime.auth.apikey.persistence.repository; -import com.kri.common.auth.persistence.entity.TApiKeyEntity; +import com.kri.common.runtime.auth.apikey.persistence.entity.TApiKeyEntity; import java.util.List; import org.springframework.data.jpa.repository.JpaRepository; import org.springframework.data.jpa.repository.Query; @@ -18,4 +18,4 @@ public interface ApiKeyRepository extends JpaRepository { where a.status = 1 and m.id.serviceCode = :serviceCode """) List findActiveKeysForService(@Param("serviceCode") String serviceCode); -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/security/JwtAuthenticationFilter.java b/src/main/java/com/kri/common/runtime/security/JwtAuthenticationFilter.java similarity index 95% rename from src/main/java/com/kri/common/security/JwtAuthenticationFilter.java rename to src/main/java/com/kri/common/runtime/security/JwtAuthenticationFilter.java index c64e25a..28a1fd9 100644 --- a/src/main/java/com/kri/common/security/JwtAuthenticationFilter.java +++ b/src/main/java/com/kri/common/runtime/security/JwtAuthenticationFilter.java @@ -1,6 +1,6 @@ -package com.kri.common.security; +package com.kri.common.runtime.security; -import com.kri.common.auth.jwt.JwtService; +import com.kri.common.feature.auth.jwt.JwtService; import io.jsonwebtoken.JwtException; import jakarta.servlet.FilterChain; import jakarta.servlet.ServletException; diff --git a/src/main/java/com/kri/common/swagger/SwaggerIpFilter.java b/src/main/java/com/kri/common/runtime/swagger/SwaggerIpFilter.java similarity index 98% rename from src/main/java/com/kri/common/swagger/SwaggerIpFilter.java rename to src/main/java/com/kri/common/runtime/swagger/SwaggerIpFilter.java index 9ef5d12..bc04f4e 100644 --- a/src/main/java/com/kri/common/swagger/SwaggerIpFilter.java +++ b/src/main/java/com/kri/common/runtime/swagger/SwaggerIpFilter.java @@ -1,4 +1,4 @@ -package com.kri.common.swagger; +package com.kri.common.runtime.swagger; import jakarta.servlet.Filter; import jakarta.servlet.FilterChain; @@ -128,4 +128,4 @@ public class SwaggerIpFilter implements Filter { return ip; } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/web/ErrorAdvice.java b/src/main/java/com/kri/common/runtime/web/ErrorAdvice.java similarity index 98% rename from src/main/java/com/kri/common/web/ErrorAdvice.java rename to src/main/java/com/kri/common/runtime/web/ErrorAdvice.java index 2f1e296..0359dfe 100644 --- a/src/main/java/com/kri/common/web/ErrorAdvice.java +++ b/src/main/java/com/kri/common/runtime/web/ErrorAdvice.java @@ -1,5 +1,6 @@ -package com.kri.common.web; +package com.kri.common.runtime.web; +import com.kri.common.feature.web.BusinessException; import jakarta.servlet.http.HttpServletRequest; import jakarta.validation.ConstraintViolationException; import java.time.Instant; @@ -33,9 +34,9 @@ public class ErrorAdvice { private static final Logger log = LoggerFactory.getLogger(ErrorAdvice.class); // 기본값은 모두 false → 외부 응답엔 노출 안 함 - @Value("${common.error.expose.handler:false}") + @Value("${kri.error.expose.handler:false}") private boolean exposeHandler; - @Value("${common.error.expose.service:false}") + @Value("${kri.error.expose.service:false}") private boolean exposeService; private static String resolveSupportedMethods(HttpRequestMethodNotSupportedException e) { diff --git a/src/main/java/com/kri/common/web/MdcHandlerConfig.java b/src/main/java/com/kri/common/runtime/web/MdcHandlerConfig.java similarity index 83% rename from src/main/java/com/kri/common/web/MdcHandlerConfig.java rename to src/main/java/com/kri/common/runtime/web/MdcHandlerConfig.java index cdb0e5d..7ca5bad 100644 --- a/src/main/java/com/kri/common/web/MdcHandlerConfig.java +++ b/src/main/java/com/kri/common/runtime/web/MdcHandlerConfig.java @@ -1,13 +1,17 @@ -package com.kri.common.web; +package com.kri.common.runtime.web; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import org.slf4j.MDC; +import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression; +import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Bean; import org.springframework.web.method.HandlerMethod; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; +@Configuration(proxyBeanMethods = false) +@ConditionalOnExpression("${kri.web.mdc.enabled:true}") public class MdcHandlerConfig { @Bean diff --git a/src/main/java/com/kri/common/web/ServiceMdcAspect.java b/src/main/java/com/kri/common/runtime/web/ServiceMdcAspect.java similarity index 90% rename from src/main/java/com/kri/common/web/ServiceMdcAspect.java rename to src/main/java/com/kri/common/runtime/web/ServiceMdcAspect.java index cd693b0..02e2913 100644 --- a/src/main/java/com/kri/common/web/ServiceMdcAspect.java +++ b/src/main/java/com/kri/common/runtime/web/ServiceMdcAspect.java @@ -1,13 +1,11 @@ -package com.kri.common.web; +package com.kri.common.runtime.web; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.slf4j.MDC; -import org.springframework.stereotype.Component; @Aspect -@Component public class ServiceMdcAspect { @Around("within(@org.springframework.stereotype.Service *)") diff --git a/src/main/java/com/kri/common/web/TraceFilter.java b/src/main/java/com/kri/common/runtime/web/TraceFilter.java similarity index 90% rename from src/main/java/com/kri/common/web/TraceFilter.java rename to src/main/java/com/kri/common/runtime/web/TraceFilter.java index 617abb0..0817cac 100644 --- a/src/main/java/com/kri/common/web/TraceFilter.java +++ b/src/main/java/com/kri/common/runtime/web/TraceFilter.java @@ -1,4 +1,4 @@ -package com.kri.common.web; +package com.kri.common.runtime.web; import jakarta.servlet.Filter; import jakarta.servlet.FilterChain; @@ -28,7 +28,7 @@ public class TraceFilter implements Filter { } try (MDC.MDCCloseable ignored = MDC.putCloseable(MDC_KEY, id)) { - httpRes.setHeader(REQ_HEADER, id); // 응답에도 echo + httpRes.setHeader(REQ_HEADER, id); // ?묐떟?먮룄 echo chain.doFilter(req, res); } } diff --git a/src/main/java/com/kri/common/webmvc/CodeEnumConverter.java b/src/main/java/com/kri/common/runtime/webmvc/CodeEnumConverter.java similarity index 83% rename from src/main/java/com/kri/common/webmvc/CodeEnumConverter.java rename to src/main/java/com/kri/common/runtime/webmvc/CodeEnumConverter.java index 78d7647..4ed2bff 100644 --- a/src/main/java/com/kri/common/webmvc/CodeEnumConverter.java +++ b/src/main/java/com/kri/common/runtime/webmvc/CodeEnumConverter.java @@ -1,6 +1,6 @@ -package com.kri.common.webmvc; +package com.kri.common.runtime.webmvc; -import com.kri.common.enums.CodeEnum; +import com.kri.common.feature.enums.CodeEnum; import org.springframework.core.convert.converter.Converter; import org.springframework.core.convert.converter.ConverterFactory; @@ -16,7 +16,7 @@ public class CodeEnumConverter implements ConverterFactory { return null; } - // 1) enum name으로 먼저 시도 (EMAIL, SMS 등) + // 1) enum name 먼저 비교합니다. (EMAIL, SMS 등) if (targetType.isEnum()) { for (T e : targetType.getEnumConstants()) { if (((Enum) e).name().equalsIgnoreCase(source)) { @@ -25,7 +25,7 @@ public class CodeEnumConverter implements ConverterFactory { } } - // 2) code로 시도 ("11" 등) + // 2) code 값도 비교합니다. ("11" 등) for (T e : targetType.getEnumConstants()) { Object code = e.getCode(); if (code != null && source.equals(String.valueOf(code))) { diff --git a/src/main/java/com/kri/common/webmvc/IpAccessControlInterceptor.java b/src/main/java/com/kri/common/runtime/webmvc/IpAccessControlInterceptor.java similarity index 94% rename from src/main/java/com/kri/common/webmvc/IpAccessControlInterceptor.java rename to src/main/java/com/kri/common/runtime/webmvc/IpAccessControlInterceptor.java index 6fc71c3..244ca3c 100644 --- a/src/main/java/com/kri/common/webmvc/IpAccessControlInterceptor.java +++ b/src/main/java/com/kri/common/runtime/webmvc/IpAccessControlInterceptor.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc; +package com.kri.common.runtime.webmvc; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; diff --git a/src/main/java/com/kri/common/webmvc/IpAccessControlService.java b/src/main/java/com/kri/common/runtime/webmvc/IpAccessControlService.java similarity index 82% rename from src/main/java/com/kri/common/webmvc/IpAccessControlService.java rename to src/main/java/com/kri/common/runtime/webmvc/IpAccessControlService.java index 52ab44b..fa6cbaa 100644 --- a/src/main/java/com/kri/common/webmvc/IpAccessControlService.java +++ b/src/main/java/com/kri/common/runtime/webmvc/IpAccessControlService.java @@ -1,5 +1,6 @@ -package com.kri.common.webmvc; +package com.kri.common.runtime.webmvc; +import com.kri.common.autoconfigure.webmvc.KriIpAccessProperties; import java.util.List; import lombok.RequiredArgsConstructor; import org.springframework.security.web.util.matcher.IpAddressMatcher; diff --git a/src/main/java/com/kri/common/webmvc/IpUtil.java b/src/main/java/com/kri/common/runtime/webmvc/IpUtil.java similarity index 94% rename from src/main/java/com/kri/common/webmvc/IpUtil.java rename to src/main/java/com/kri/common/runtime/webmvc/IpUtil.java index 4fdd99b..b5023a0 100644 --- a/src/main/java/com/kri/common/webmvc/IpUtil.java +++ b/src/main/java/com/kri/common/runtime/webmvc/IpUtil.java @@ -1,4 +1,4 @@ -package com.kri.common.webmvc; +package com.kri.common.runtime.webmvc; import jakarta.servlet.http.HttpServletRequest; @@ -24,4 +24,4 @@ public final class IpUtil { // 3. 최후 fallback return request.getRemoteAddr(); } -} +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/webmvc/RequestUserContextArgumentResolver.java b/src/main/java/com/kri/common/runtime/webmvc/RequestUserContextArgumentResolver.java similarity index 76% rename from src/main/java/com/kri/common/webmvc/RequestUserContextArgumentResolver.java rename to src/main/java/com/kri/common/runtime/webmvc/RequestUserContextArgumentResolver.java index 6d4fa67..4a59b54 100644 --- a/src/main/java/com/kri/common/webmvc/RequestUserContextArgumentResolver.java +++ b/src/main/java/com/kri/common/runtime/webmvc/RequestUserContextArgumentResolver.java @@ -1,7 +1,8 @@ -package com.kri.common.webmvc; +package com.kri.common.runtime.webmvc; -import com.kri.common.auth.dto.JwtUserClaimsDto; -import com.kri.common.auth.jwt.JwtService; +import com.kri.common.feature.auth.dto.JwtUserClaimsDto; +import com.kri.common.feature.auth.jwt.JwtService; +import com.kri.common.feature.web.RequestUserContext; import io.jsonwebtoken.JwtException; import jakarta.servlet.http.HttpServletRequest; import lombok.RequiredArgsConstructor; @@ -32,12 +33,9 @@ public class RequestUserContextArgumentResolver implements HandlerMethodArgument @Nullable WebDataBinderFactory binderFactory ) { HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class); - String clientIp = request != null ? IpUtil.getClientIp(request) : null; JwtUserClaimsDto claims = null; - - // 1) SecurityContext 에 이미 JwtUserClaimsDto 가 principal 로 들어있는 경우 Authentication auth = SecurityContextHolder.getContext().getAuthentication(); if (auth != null) { Object principal = auth.getPrincipal(); @@ -51,25 +49,18 @@ public class RequestUserContextArgumentResolver implements HandlerMethodArgument } } - // 2) 현재 공통 JwtService 는 principal 을 userId(String) 로 쓰고 있으니까, - // 필요하면 Authorization 헤더에서 직접 토큰 파싱 if (claims == null && request != null) { String authHeader = request.getHeader("Authorization"); if (authHeader != null && authHeader.startsWith("Bearer ")) { - String token = authHeader.substring(7); try { - claims = jwtService.toUserClaimsDto(token); - } catch (JwtException ex) { - // 토큰 이상하면 그냥 anonymous 로 둠 + claims = jwtService.toUserClaimsDto(authHeader.substring(7)); + } catch (JwtException ignored) { } } } if (claims == null) { - // 비인증 상태: IP만 채운 빈 컨텍스트 - return RequestUserContext.builder() - .clientIp(clientIp) - .build(); + return RequestUserContext.builder().clientIp(clientIp).build(); } return RequestUserContext.builder() diff --git a/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java b/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java deleted file mode 100644 index a971952..0000000 --- a/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java +++ /dev/null @@ -1,24 +0,0 @@ -package com.kri.common.web; - -import org.springframework.boot.autoconfigure.AutoConfiguration; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.web.servlet.FilterRegistrationBean; -import org.springframework.context.annotation.Bean; -import org.springframework.core.Ordered; - -@AutoConfiguration -@ConditionalOnProperty(name = "common.web.enabled", matchIfMissing = true) -public class CommonWebAutoConfiguration { - - @Bean - public ErrorAdvice errorAdvice() { - return new ErrorAdvice(); - } - - @Bean - public FilterRegistrationBean traceFilter() { - var reg = new FilterRegistrationBean<>(new TraceFilter()); - reg.setOrder(Ordered.HIGHEST_PRECEDENCE); - return reg; - } -} diff --git a/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports index 9197816..e25a724 100644 --- a/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports +++ b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -1,11 +1,11 @@ -com.kri.common.auth.jwt.JwtAutoConfiguration -com.kri.common.auth.apikey.ApiKeyJpaAutoConfiguration -com.kri.common.auth.apikey.ApiKeyPreloadAutoConfiguration -com.kri.common.auth.apikey.ApiKeyAdminAutoConfiguration +com.kri.common.autoconfigure.auth.jwt.JwtAutoConfiguration +com.kri.common.autoconfigure.auth.apikey.ApiKeyJpaAutoConfiguration +com.kri.common.autoconfigure.auth.apikey.ApiKeyPreloadAutoConfiguration +com.kri.common.autoconfigure.auth.apikey.ApiKeyAdminAutoConfiguration -com.kri.common.security.KriSecurityAutoConfiguration -com.kri.common.web.CommonWebAutoConfiguration -com.kri.common.webmvc.KriWebMvcAutoConfiguration -com.kri.common.swagger.KriSwaggerAutoConfiguration -com.kri.common.redis.CommonRedisAutoConfiguration -com.kri.common.scheduling.CommonSchedulingAutoConfiguration +com.kri.common.autoconfigure.security.KriSecurityAutoConfiguration +com.kri.common.autoconfigure.web.CommonWebAutoConfiguration +com.kri.common.autoconfigure.webmvc.KriWebMvcAutoConfiguration +com.kri.common.autoconfigure.swagger.KriSwaggerAutoConfiguration +com.kri.common.autoconfigure.redis.CommonRedisAutoConfiguration +com.kri.common.autoconfigure.scheduling.CommonSchedulingAutoConfiguration