+ * 게이트웨이 어플리케이션 클래스 + * Eureka Client 로 설정했기 때문에 Eureka Server 가 먼저 기동되어야 한다. + * + * @author 표준프레임워크센터 jaeyeolkim + * @version 1.0 + * @since 2021/06/30 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2021/06/30 jaeyeolkim 최초 생성 + *+ */ +@EnableDiscoveryClient +@SpringBootApplication +public class ApigatewayApplication { + + public static void main(String[] args) { + SpringApplication.run(ApigatewayApplication.class, args); + } + +} diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/api/MessageSourceApiController.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/api/MessageSourceApiController.java new file mode 100644 index 0000000..70a925c --- /dev/null +++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/api/MessageSourceApiController.java @@ -0,0 +1,43 @@ +package org.egovframe.cloud.apigateway.api; + +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.context.MessageSource; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RestController; + +import java.util.Locale; + +/** + * org.egovframe.cloud.apigateway.api.MessageSourceApiController + *
+ * MessageSource 정상 확인을 위한 컨트롤러 + * + * @author 표준프레임워크센터 jaeyeolkim + * @version 1.0 + * @since 2021/08/10 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2021/08/10 jaeyeolkim 최초 생성 + * 2024/09/24 이백행 컨트리뷰션 이클립스 문제(Problems) 해결 + *+ */ +@Slf4j +@RequiredArgsConstructor +@RestController +public class MessageSourceApiController { + private final MessageSource messageSource; + + @GetMapping("/api/v1/messages/{code}/{lang}") + public String getMessage(@PathVariable String code, @PathVariable String lang) { + Locale locale = "en".equals(lang)? Locale.ENGLISH : Locale.KOREAN; + String message = messageSource.getMessage(code, null, locale); + log.info("code={}, lang={}, message={}", code, lang, message); + return message; + } +} diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/MessageSourceConfig.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/MessageSourceConfig.java new file mode 100644 index 0000000..b070d64 --- /dev/null +++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/MessageSourceConfig.java @@ -0,0 +1,64 @@ +package org.egovframe.cloud.apigateway.config; + +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.MessageSource; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.support.ReloadableResourceBundleMessageSource; +import org.springframework.util.StringUtils; + +import java.nio.charset.StandardCharsets; +import java.nio.file.Path; +import java.nio.file.Paths; + +/** + * org.egovframe.cloud.apigateway.config.MessageSourceConfig + *
+ * Spring MessageSource 설정 + * Message Domain 이 있는 portal-service 에서 messages.properties 를 공유 가능한 외부 위치에 생성한다. + * 각 서비스에서 해당 파일을 통해 다국어를 지원하도록 한다. + * module-common.jar 를 포함하지 않는 서비스에서는 이 configuration을 추가해주어야 한다. + * + * @author 표준프레임워크센터 jaeyeolkim + * @version 1.0 + * @since 2021/08/09 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2021/08/09 jaeyeolkim 최초 생성 + *+ */ +@Slf4j +@Configuration +public class MessageSourceConfig { + + @Value("${messages.directory}") + private String messagesDirectory; + + @Value("${spring.profiles.active:default}") + private String profile; + + @Bean + public MessageSource messageSource() { + ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource(); + final String MESSAGES = "/messages"; + if ("default".equals(profile)) { + Path fileStorageLocation = Paths.get(messagesDirectory).toAbsolutePath().normalize(); + String dbMessages = StringUtils.cleanPath("file://" + fileStorageLocation + MESSAGES); + log.info("DB MessageSource location = {}", dbMessages); + messageSource.setBasenames(dbMessages); + } else { + messageSource.setBasenames(messagesDirectory + MESSAGES); + } + messageSource.getBasenameSet().forEach(s -> log.info("messageSource getBasenameSet={}", s)); + + messageSource.setCacheSeconds(60); // 메세지 파일 변경 감지 간격 + messageSource.setUseCodeAsDefaultMessage(true); // 메세지가 없으면 코드를 메세지로 한다 + messageSource.setDefaultEncoding(StandardCharsets.UTF_8.name()); + return messageSource; + } +} diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/OpenApiDocConfig.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/OpenApiDocConfig.java new file mode 100644 index 0000000..7b674e1 --- /dev/null +++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/OpenApiDocConfig.java @@ -0,0 +1,38 @@ +package org.egovframe.cloud.apigateway.config; + +import org.springdoc.core.GroupedOpenApi; +import org.springdoc.core.SwaggerUiConfigParameters; +import org.springframework.cloud.gateway.route.RouteDefinition; +import org.springframework.cloud.gateway.route.RouteDefinitionLocator; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Lazy; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.Optional; +import java.util.stream.Stream; + +@Configuration +public class OpenApiDocConfig { + + @Bean + @Lazy(false) + public List
+ * 요청 제한(Rate Limiting) 설정 클래스 + * 동일한 IP 또는 경로에 대한 과도한 요청을 제한하기 위한 설정 + * + * @author changwng + * @version 1.0 + * @since 2025/03/19 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2025/03/19 changwng 최초 생성 + *+ */ +@Slf4j +@Configuration +public class RateLimiterConfig { + + /** + * IP 주소 기반 요청 제한을 위한 KeyResolver 빈 + * 클라이언트 IP 주소를 키로 사용하여 요청 제한을 적용 + * + * @return KeyResolver IP 주소 기반 키 리졸버 + */ + // @Bean 주석 처리 - 다중 KeyResolver 빈 문제 해결 + public KeyResolver ipKeyResolver() { + return exchange -> { + String ip = exchange.getRequest().getRemoteAddress().getAddress().getHostAddress(); + log.debug("Request IP: {}", ip); + return Mono.just(ip); + }; + } + + /** + * 요청 경로 기반 요청 제한을 위한 KeyResolver 빈 + * 요청 경로를 키로 사용하여 요청 제한을 적용 + * + * @return KeyResolver 요청 경로 기반 키 리졸버 + */ + // @Bean 주석 처리 - 다중 KeyResolver 빈 문제 해결 + public KeyResolver pathKeyResolver() { + return exchange -> { + String path = exchange.getRequest().getPath().value(); + log.debug("Request Path: {}", path); + return Mono.just(path); + }; + } + + /** + * IP와 경로를 조합한 요청 제한을 위한 KeyResolver 빈 + * IP 주소와 요청 경로를 조합하여 키로 사용함으로써 더 세밀한 요청 제한 적용 가능 + * + * @return KeyResolver IP와 경로 조합 기반 키 리졸버 + */ + @Bean + @Primary // 기본 KeyResolver 빈으로 지정 + public KeyResolver ipAndPathKeyResolver() { + return exchange -> { + String ip = exchange.getRequest().getRemoteAddress().getAddress().getHostAddress(); + String path = exchange.getRequest().getPath().value(); + String key = ip + ":" + path; + log.debug("Request Key: {}", key); + return Mono.just(key); + }; + } +} diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/ReactiveAuthorization.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/ReactiveAuthorization.java new file mode 100644 index 0000000..bc5a2eb --- /dev/null +++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/ReactiveAuthorization.java @@ -0,0 +1,188 @@ +package org.egovframe.cloud.apigateway.config; + +import io.github.resilience4j.circuitbreaker.CircuitBreaker; +import io.github.resilience4j.circuitbreaker.CircuitBreakerConfig; +import io.github.resilience4j.reactor.circuitbreaker.operator.CircuitBreakerOperator; +import io.jsonwebtoken.ExpiredJwtException; +import io.jsonwebtoken.Jwts; +import io.micrometer.core.instrument.MeterRegistry; +import io.micrometer.core.instrument.Timer; +import java.time.Duration; +import java.util.List; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.server.RequestPath; +import org.springframework.http.server.reactive.ServerHttpRequest; +import org.springframework.security.access.AuthorizationServiceException; +import org.springframework.security.authorization.AuthorizationDecision; +import org.springframework.security.authorization.ReactiveAuthorizationManager; +import org.springframework.security.core.Authentication; +import org.springframework.security.web.server.authorization.AuthorizationContext; +import org.springframework.stereotype.Component; +import org.springframework.util.StringUtils; +import org.springframework.web.reactive.function.client.WebClient; +import reactor.core.publisher.Mono; +import reactor.util.retry.Retry; + + +/** + * org.egovframe.cloud.apigateway.config.ReactiveAuthorization + *
+ * Spring Security 에 의해 요청 url에 대한 사용자 인가 서비스를 수행하는 클래스 요청에 대한 사용자의 권한여부 체크하여 true/false 리턴한다 + * + * @author 표준프레임워크센터 jaeyeolkim + * @version 1.0 + * @since 2021/07/19 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2021/07/19 jaeyeolkim 최초 생성 + *+ */ +@Slf4j +@Component +public class ReactiveAuthorization implements ReactiveAuthorizationManager
+ * WebClient 설정 클래스 + * 타임아웃 및 연결 풀 설정을 통해 안정적인 외부 서비스 호출을 지원 + * + * @author IIPBS 개발팀 + * @version 1.0 + * @since 2025/03/19 + * + *
+ * << 개정이력(Modification Information) >> + * + * 수정일 수정자 수정내용 + * ---------- -------- --------------------------- + * 2025/03/19 IIPBS 최초 생성 + *+ */ +@Configuration +public class WebClientConfig { + + /** + * 커넥션 풀 설정을 통해 효율적인 리소스 관리 + * + * @return ConnectionProvider + */ + @Bean + public ConnectionProvider connectionProvider() { + return ConnectionProvider.builder("http-pool") + .maxConnections(500) + .maxIdleTime(Duration.ofSeconds(60)) + .maxLifeTime(Duration.ofSeconds(300)) + .pendingAcquireTimeout(Duration.ofSeconds(30)) + .evictInBackground(Duration.ofSeconds(30)) + .build(); + } + + /** + * 타임아웃 설정이 적용된 HttpClient 빈 생성 + * + * @param connectionProvider 커넥션 풀 설정 + * @return HttpClient + */ + @Bean + public HttpClient httpClient(ConnectionProvider connectionProvider) { + return HttpClient.create(connectionProvider) + .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 5000) + .responseTimeout(Duration.ofSeconds(5)) + .doOnConnected(conn -> + conn.addHandlerLast(new ReadTimeoutHandler(5, TimeUnit.SECONDS)) + .addHandlerLast(new WriteTimeoutHandler(5, TimeUnit.SECONDS))); + } + + /** + * 타임아웃 및 커넥션 풀 설정이 적용된 WebClient.Builder 빈 생성 + * + * @param httpClient 설정된 HttpClient + * @return WebClient.Builder + */ + @Bean + public WebClient.Builder webClientBuilder(HttpClient httpClient) { + return WebClient.builder() + .clientConnector(new ReactorClientHttpConnector(httpClient)) + .codecs(configurer -> configurer.defaultCodecs().maxInMemorySize(2 * 1024 * 1024)); + } +} diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/WebFluxSecurityConfig.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/WebFluxSecurityConfig.java new file mode 100644 index 0000000..c0e8d53 --- /dev/null +++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/config/WebFluxSecurityConfig.java @@ -0,0 +1,67 @@ +package org.egovframe.cloud.apigateway.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; +import org.springframework.security.authorization.ReactiveAuthorizationManager; +import org.springframework.security.config.annotation.web.reactive.EnableWebFluxSecurity; +import org.springframework.security.config.web.server.ServerHttpSecurity; +import org.springframework.security.web.server.SecurityWebFilterChain; +import org.springframework.security.web.server.authentication.HttpStatusServerEntryPoint; +import org.springframework.security.web.server.authorization.AuthorizationContext; + +/** + * org.egovframe.cloud.apigateway.config.WebFluxSecurityConfig + *
+ * Spring Security Config 클래스
+ * ReactiveAuthorizationManager
+ * 에러 발생 시 에러 정보 중 필요한 내용만 반환한다
+ * ErrorCode 에서 status, code, message 세 가지 속성을 의존한다
+ *
+ * @author 표준프레임워크센터 jaeyeolkim
+ * @version 1.0
+ * @since 2021/07/16
+ *
+ *
+ * REST API 요청에 대한 오류 반환값을 정의
+ * ErrorResponse 클래스에서 status, code, message 세 가지 속성을 의존한다
+ * message 는 MessageSource 의 키 값을 정의하여 다국어 처리를 지원한다
+ *
+ * @author 표준프레임워크센터 jaeyeolkim
+ * @version 1.0
+ * @since 2021/07/16
+ *
+ *
+ * 요청 제한(Rate Limiting) 필터
+ * 동일한 경로에 대한 과도한 요청을 제한하기 위한 필터
+ *
+ * @author changwng
+ * @version 1.0
+ * @since 2025/03/19
+ *
+ *
+ * << 개정이력(Modification Information) >>
+ *
+ * 수정일 수정자 수정내용
+ * ---------- -------- ---------------------------
+ * 2021/06/30 jaeyeolkim 최초 생성
+ *
+ */
+@EnableWebFluxSecurity // Spring Security 설정들을 활성화시켜 준다
+public class WebFluxSecurityConfig {
+
+ private final static String[] PERMITALL_ANTPATTERNS = {
+ ReactiveAuthorization.AUTHORIZATION_URI, "/", "/csrf",
+ "/user-service/login", "/?*-service/api/v1/messages/**", "/api/v1/messages/**",
+ "/?*-service/actuator/?*", "/actuator/?*",
+ "/v3/api-docs/**", "/?*-service/v3/api-docs", "**/configuration/*", "/swagger*/**", "/webjars/**"
+ };
+ private final static String USER_JOIN_ANTPATTERNS = "/user-service/api/v1/users";
+
+ /**
+ * WebFlux 스프링 시큐리티 설정
+ *
+ * @see ReactiveAuthorization
+ * @param http
+ * @param check check(Mono
+ * << 개정이력(Modification Information) >>
+ *
+ * 수정일 수정자 수정내용
+ * ---------- -------- ---------------------------
+ * 2021/07/16 jaeyeolkim 최초 생성
+ * 2024/09/24 이백행 컨트리뷰션 이클립스 문제(Problems) 해결
+ *
+ */
+@Slf4j
+//@Configuration
+public class ReactiveExceptionHandlerConfig {
+
+ private final MessageSource messageSource;
+
+ public ReactiveExceptionHandlerConfig(MessageSource messageSource) {
+ this.messageSource = messageSource;
+ }
+
+ /**
+ * 에러 발생 시 에러 정보 중 필요한 내용만 반환한다
+ *
+ * @return
+ */
+// @Bean
+ public ErrorAttributes errorAttributes() {
+ return new DefaultErrorAttributes() {
+ @Override
+ public Map
+ * << 개정이력(Modification Information) >>
+ *
+ * 수정일 수정자 수정내용
+ * ---------- -------- ---------------------------
+ * 2021/07/16 jaeyeolkim 최초 생성
+ *
+ */
+public enum ErrorCode {
+
+ INVALID_INPUT_VALUE(400, "E001", "err.invalid.input.value"), // Bad Request
+ INVALID_TYPE_VALUE(400, "E002", "err.invalid.type.value"), // Bad Request
+ ENTITY_NOT_FOUND(400, "E003", "err.entity.not.found"), // Bad Request
+ UNAUTHORIZED(401, "E004", "err.unauthorized"), // The request requires an user authentication
+ ACCESS_DENIED(403, "E005", "err.access.denied"), // Forbidden, Access is Denied
+ NOT_FOUND(404, "E007", "err.not.found"), // Not found
+ METHOD_NOT_ALLOWED(405, "E008", "err.method.not.allowed"), // 요청 방법이 서버에 의해 알려졌으나, 사용 불가능한 상태
+ UNPROCESSABLE_ENTITY(422, "E009", "err.unprocessable.entity"), // Unprocessable Entity
+ INTERNAL_SERVER_ERROR(500, "E999", "err.internal.server"), // Server Error
+ SERVICE_UNAVAILABLE(503, "E010", "err.service.unavailable") // Service Unavailable
+ ;
+
+
+ private final int status;
+ private final String code;
+ private final String message;
+
+ ErrorCode(final int status, final String code, final String message) {
+ this.status = status;
+ this.code = code;
+ this.message = message;
+ }
+
+ public int getStatus() {
+ return status;
+ }
+
+ public String getCode() {
+ return code;
+ }
+
+ public String getMessage() {
+ return message;
+ }
+
+}
diff --git a/apigateway/src/main/java/org/egovframe/cloud/apigateway/filter/GlobalFilter.java b/apigateway/src/main/java/org/egovframe/cloud/apigateway/filter/GlobalFilter.java
new file mode 100644
index 0000000..7c91e45
--- /dev/null
+++ b/apigateway/src/main/java/org/egovframe/cloud/apigateway/filter/GlobalFilter.java
@@ -0,0 +1,53 @@
+/*
+
+기본필터를 삭제 처리함 （Global Filter）
+package org.egovframe.cloud.apigateway.filter;
+
+import lombok.Data;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.cloud.gateway.filter.GatewayFilter;
+import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
+import org.springframework.http.server.reactive.ServerHttpRequest;
+import org.springframework.http.server.reactive.ServerHttpResponse;
+import org.springframework.stereotype.Component;
+import reactor.core.publisher.Mono;
+
+@Slf4j
+@Component
+public class GlobalFilter extends AbstractGatewayFilterFactory
+ * << 개정이력(Modification Information) >>
+ *
+ * 수정일 수정자 수정내용
+ * ---------- -------- ---------------------------
+ * 2025/03/19 changwng 최초 생성
+ *
+ */
+@Slf4j
+@Component
+public class RateLimitingFilter extends AbstractGatewayFilterFactory