260327_01_ENH: 프로젝트 구조 리펙토링 및 README.md 갱신
This commit is contained in:
@@ -0,0 +1,15 @@
|
||||
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;
|
||||
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 등록
|
||||
public class ApiKeyAdminAutoConfiguration {
|
||||
|
||||
}
|
||||
@@ -0,0 +1,114 @@
|
||||
package com.kri.common.autoconfigure.auth.apikey;
|
||||
|
||||
import com.zaxxer.hikari.HikariDataSource;
|
||||
import jakarta.persistence.EntityManagerFactory;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import javax.sql.DataSource;
|
||||
import org.springframework.beans.factory.ObjectProvider;
|
||||
import org.springframework.beans.factory.annotation.Qualifier;
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
|
||||
import org.springframework.data.jpa.repository.config.JpaMetamodelMappingContextFactoryBean;
|
||||
import org.springframework.orm.jpa.JpaTransactionManager;
|
||||
import org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean;
|
||||
import org.springframework.orm.jpa.persistenceunit.PersistenceUnitManager;
|
||||
import org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter;
|
||||
import org.springframework.transaction.PlatformTransactionManager;
|
||||
|
||||
/*
|
||||
* @Primary 절대 금지
|
||||
* 메인 JPA와 완전히 분리
|
||||
*/
|
||||
@AutoConfiguration(
|
||||
afterName = {
|
||||
// 메인 JPA가 있는 서비스에서는 메인 auto-config 이후에 올라와도 되고,
|
||||
// 메인 JPA를 exclude한 서비스에서는 afterName이 무시되어도 동작해야 함.
|
||||
"org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration",
|
||||
"org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration"
|
||||
}
|
||||
)
|
||||
@ConditionalOnClass(name = {
|
||||
"org.springframework.data.jpa.repository.JpaRepository",
|
||||
"jakarta.persistence.EntityManagerFactory",
|
||||
"com.zaxxer.hikari.HikariDataSource"
|
||||
})
|
||||
@ConditionalOnProperty(prefix = "kri.auth.apikey", name = "enabled", havingValue = "true")
|
||||
@EnableJpaRepositories(
|
||||
basePackages = "com.kri.common.auth.persistence.repository",
|
||||
entityManagerFactoryRef = "apiKeyEntityManagerFactory",
|
||||
transactionManagerRef = "apiKeyTransactionManager"
|
||||
)
|
||||
@EnableConfigurationProperties(ApiKeyProperties.class)
|
||||
public class ApiKeyJpaAutoConfiguration {
|
||||
|
||||
@Bean(name = "apiKeyDataSource")
|
||||
public DataSource apiKeyDataSource(ApiKeyProperties props) {
|
||||
var db = props.getDb();
|
||||
HikariDataSource ds = new HikariDataSource();
|
||||
ds.setJdbcUrl(db.getUrl());
|
||||
ds.setUsername(db.getUsername());
|
||||
ds.setPassword(db.getPassword());
|
||||
ds.setDriverClassName(db.getDriverClassName());
|
||||
return ds;
|
||||
}
|
||||
|
||||
/**
|
||||
* ✅ EntityManagerFactoryBuilder에 의존하지 않는 방식 - intranet-extension처럼 HibernateJpaAutoConfiguration을
|
||||
* exclude 해도 동작
|
||||
*/
|
||||
@Bean(name = "apiKeyEntityManagerFactory")
|
||||
public LocalContainerEntityManagerFactoryBean apiKeyEntityManagerFactory(
|
||||
@Qualifier("apiKeyDataSource") DataSource ds,
|
||||
ObjectProvider<PersistenceUnitManager> pumProvider,
|
||||
ApiKeyProperties props
|
||||
) {
|
||||
HibernateJpaVendorAdapter vendorAdapter = new HibernateJpaVendorAdapter();
|
||||
vendorAdapter.setShowSql(props.getJpa().isShowSql());
|
||||
vendorAdapter.setGenerateDdl(false);
|
||||
|
||||
LocalContainerEntityManagerFactoryBean emf = new LocalContainerEntityManagerFactoryBean();
|
||||
emf.setDataSource(ds);
|
||||
emf.setJpaVendorAdapter(vendorAdapter);
|
||||
emf.setPackagesToScan("com.kri.common.auth.persistence.entity");
|
||||
emf.setPersistenceUnitName("apikey");
|
||||
|
||||
PersistenceUnitManager pum = pumProvider.getIfAvailable();
|
||||
if (pum != null) {
|
||||
emf.setPersistenceUnitManager(pum);
|
||||
}
|
||||
|
||||
// 최소 JPA 속성들 (원하면 yml로 확장 가능)
|
||||
Map<String, Object> jpaProps = new HashMap<>();
|
||||
jpaProps.put("hibernate.show_sql", Boolean.toString(props.getJpa().isShowSql()));
|
||||
jpaProps.put("hibernate.format_sql", Boolean.toString(props.getJpa().isFormatSql()));
|
||||
|
||||
emf.setJpaPropertyMap(jpaProps);
|
||||
return emf;
|
||||
}
|
||||
|
||||
@Bean(name = "apiKeyTransactionManager")
|
||||
public PlatformTransactionManager apiKeyTransactionManager(
|
||||
@Qualifier("apiKeyEntityManagerFactory") EntityManagerFactory emf
|
||||
) {
|
||||
return new JpaTransactionManager(emf);
|
||||
}
|
||||
|
||||
/**
|
||||
* ✅ intranet-extension처럼 메인 JPA auto-config를 exclude해서 'jpaMappingContext'가 없을 때만 보완해준다.
|
||||
* <p>
|
||||
* 메인 JPA가 있는 서비스에서는 이미 jpaMappingContext가 있으므로 이 빈은 생성되지 않아 영향이 없다.
|
||||
*/
|
||||
@Bean(name = "jpaMappingContext")
|
||||
@ConditionalOnMissingBean(name = "jpaMappingContext")
|
||||
public JpaMetamodelMappingContextFactoryBean jpaMappingContext(ApplicationContext ctx) {
|
||||
// FactoryBean으로 등록하면 내부에서 EntityManagerFactory들을 찾아 Metamodel을 구성함
|
||||
return new JpaMetamodelMappingContextFactoryBean();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,27 @@
|
||||
package com.kri.common.autoconfigure.auth.apikey;
|
||||
|
||||
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;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
@AutoConfiguration
|
||||
@EnableConfigurationProperties(ApiKeyProperties.class)
|
||||
@ConditionalOnProperty(prefix = "kri.auth.apikey", name = "enabled", havingValue = "true")
|
||||
public class ApiKeyPreloadAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(ApiKeyRepository.class)
|
||||
@ConditionalOnMissingBean(ApiKeyUserClaimsProvider.class)
|
||||
public PreloadedApiKeyUserClaimsProvider apiKeyUserClaimsProvider(
|
||||
ApiKeyProperties props,
|
||||
ApiKeyRepository repo
|
||||
) {
|
||||
return new PreloadedApiKeyUserClaimsProvider(props, repo);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,80 @@
|
||||
package com.kri.common.autoconfigure.auth.apikey;
|
||||
|
||||
import java.util.List;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@ConfigurationProperties(prefix = "kri.auth.apikey")
|
||||
public class ApiKeyProperties {
|
||||
|
||||
/**
|
||||
* API Key 인증 허용 여부
|
||||
*/
|
||||
private boolean enabled = false;
|
||||
|
||||
/**
|
||||
* API Key 를 읽어올 헤더 이름 예: X-API-Key, X-EXTERNAL-KEY 등
|
||||
*/
|
||||
private String headerName = "X-API-Key";
|
||||
|
||||
/**
|
||||
* 이 서비스의 코드 (서비스별 preload 범위 결정)
|
||||
*/
|
||||
private String serviceCode;
|
||||
|
||||
/**
|
||||
* 기동 시 preload 할지
|
||||
*/
|
||||
private boolean preloadOnStartup = false;
|
||||
|
||||
/**
|
||||
* 내부 관리 API(리로드/조회) 노출 여부
|
||||
*/
|
||||
private boolean adminApiEnabled = false;
|
||||
|
||||
/**
|
||||
* 내부 관리 API 접근 허용 IP(CIDR)
|
||||
*/
|
||||
private List<String> adminAllowIps = List.of("127.0.0.1/32");
|
||||
|
||||
/**
|
||||
* apikey 전용 DB 설정(기본값 포함)
|
||||
*/
|
||||
private Db db = new Db();
|
||||
|
||||
/**
|
||||
* apikey 전용 JPA 옵션
|
||||
*/
|
||||
private Jpa jpa = new Jpa();
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
public static class Jpa {
|
||||
|
||||
/**
|
||||
* hibernate.show_sql
|
||||
*/
|
||||
private boolean showSql = false;
|
||||
|
||||
/**
|
||||
* hibernate.format_sql
|
||||
*/
|
||||
private boolean formatSql = false;
|
||||
}
|
||||
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
public static class Db {
|
||||
|
||||
//내부 통신용 url
|
||||
private String url =
|
||||
"jdbc:mysql://db-md87m-kr.vpc-pub-cdb.ntruss.com:3306/kri_common?characterEncoding=UTF-8";
|
||||
private String username = "kriit";
|
||||
private String password = "it#51304";
|
||||
private String driverClassName = "com.mysql.cj.jdbc.Driver";
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
package com.kri.common.autoconfigure.auth.jwt;
|
||||
|
||||
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;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
@Configuration
|
||||
@EnableConfigurationProperties({JwtProperties.class, ApiKeyProperties.class})
|
||||
public class JwtAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public JwtService jwtService(JwtProperties properties) {
|
||||
return new JwtService(properties);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(ApiKeyUserClaimsProvider.class)
|
||||
@ConditionalOnMissingBean
|
||||
public ApiKeyAuthFilter apiKeyAuthFilter(
|
||||
ApiKeyProperties apiKeyProperties,
|
||||
ApiKeyUserClaimsProvider provider,
|
||||
JwtService jwtService
|
||||
) {
|
||||
return new ApiKeyAuthFilter(apiKeyProperties, provider, jwtService);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
package com.kri.common.autoconfigure.auth.jwt;
|
||||
|
||||
import lombok.AllArgsConstructor;
|
||||
import lombok.Getter;
|
||||
import lombok.NoArgsConstructor;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@NoArgsConstructor
|
||||
@AllArgsConstructor
|
||||
@ConfigurationProperties(prefix = "kri.auth.jwt")
|
||||
public class JwtProperties {
|
||||
|
||||
/**
|
||||
* HMAC 서명에 사용할 시크릿 키 (최소 32자 이상 권장)
|
||||
*/
|
||||
private String secret = "K0r2@#R2s2@rch#!nt2rn@t!0n@l#!T$T2@M";
|
||||
|
||||
/**
|
||||
* 토큰 발급자(issuer)
|
||||
*/
|
||||
private String issuer = "kri-it";
|
||||
|
||||
/**
|
||||
* Access Token 유효 시간(초 단위)
|
||||
*/
|
||||
private long accessTokenValiditySeconds = 24 * 3600; // 기본 24시간
|
||||
|
||||
/**
|
||||
* (선택) Refresh Token 유효 시간(초 단위)
|
||||
*/
|
||||
private long refreshTokenValiditySeconds = 7 * 24 * 3600; // 기본 7일
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
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.context.annotation.Bean;
|
||||
import org.springframework.data.redis.connection.RedisConnectionFactory;
|
||||
import org.springframework.data.redis.core.RedisTemplate;
|
||||
import org.springframework.data.redis.core.StringRedisTemplate;
|
||||
|
||||
@AutoConfiguration
|
||||
@ConditionalOnClass(RedisTemplate.class)
|
||||
@ConditionalOnExpression("${kri.redis.enabled:false}")
|
||||
@ConditionalOnBean(RedisConnectionFactory.class)
|
||||
public class CommonRedisAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public StringRedisTemplate stringRedisTemplate(
|
||||
org.springframework.data.redis.connection.RedisConnectionFactory cf) {
|
||||
return new StringRedisTemplate(cf);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public RedisQueueHelper redisQueueHelper(StringRedisTemplate rt) {
|
||||
return new RedisQueueHelper(rt);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
package com.kri.common.autoconfigure.scheduling;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
|
||||
import org.springframework.scheduling.annotation.EnableScheduling;
|
||||
|
||||
@AutoConfiguration
|
||||
@EnableScheduling
|
||||
@ConditionalOnExpression("${kri.scheduling.enabled:false}")
|
||||
public class CommonSchedulingAutoConfiguration {
|
||||
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
package com.kri.common.autoconfigure.security;
|
||||
|
||||
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;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.security.config.Customizer;
|
||||
import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity;
|
||||
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
|
||||
import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer;
|
||||
import org.springframework.security.config.http.SessionCreationPolicy;
|
||||
import org.springframework.security.web.SecurityFilterChain;
|
||||
import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter;
|
||||
|
||||
@AutoConfiguration(before = SecurityAutoConfiguration.class)
|
||||
@EnableConfigurationProperties({KriSecurityProperties.class, JwtProperties.class})
|
||||
@ConditionalOnProperty(prefix = "kri.security", name = "enabled", havingValue = "true", matchIfMissing = true)
|
||||
@EnableMethodSecurity(
|
||||
jsr250Enabled = true,
|
||||
prePostEnabled = true
|
||||
)
|
||||
@RequiredArgsConstructor
|
||||
public class KriSecurityAutoConfiguration {
|
||||
|
||||
private final KriSecurityProperties securityProperties;
|
||||
private final JwtProperties jwtProperties;
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public JwtService jwtService(JwtProperties properties) {
|
||||
return new JwtService(properties);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public JwtAuthenticationFilter jwtAuthenticationFilter(JwtService jwtService) {
|
||||
return new JwtAuthenticationFilter(jwtService);
|
||||
}
|
||||
|
||||
/**
|
||||
* 서비스에서 SecurityFilterChain 을 따로 정의하지 않으면 이 기본 Security 구성이 적용된다.
|
||||
*/
|
||||
@SuppressWarnings("SpringJavaInjectionPointsAutowiringInspection")
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(SecurityFilterChain.class)
|
||||
public SecurityFilterChain kriSecurityFilterChain(
|
||||
HttpSecurity http,
|
||||
ObjectProvider<ApiKeyAuthFilter> apiKeyAuthFilterProvider,
|
||||
JwtAuthenticationFilter jwtAuthenticationFilter
|
||||
) throws Exception {
|
||||
|
||||
http
|
||||
.httpBasic(AbstractHttpConfigurer::disable)
|
||||
.csrf(AbstractHttpConfigurer::disable)
|
||||
.cors(Customizer.withDefaults())
|
||||
.sessionManagement(session ->
|
||||
session.sessionCreationPolicy(SessionCreationPolicy.STATELESS)
|
||||
)
|
||||
.authorizeHttpRequests(auth -> {
|
||||
// ✅ yaml에서 정의한 public-paths 전부 permitAll
|
||||
if (securityProperties.getPublicPaths() != null && !securityProperties.getPublicPaths()
|
||||
.isEmpty()) {
|
||||
auth.requestMatchers(securityProperties.getPublicPaths().toArray(String[]::new))
|
||||
.permitAll();
|
||||
}
|
||||
// ✅ 나머지는 전부 인증 필요
|
||||
auth.anyRequest().authenticated();
|
||||
});
|
||||
|
||||
// ✅ API Key 필터가 존재하면 먼저 태움
|
||||
apiKeyAuthFilterProvider.ifAvailable(filter ->
|
||||
http.addFilterBefore(filter, UsernamePasswordAuthenticationFilter.class)
|
||||
);
|
||||
// ✅ 그 다음 JWT 필터
|
||||
http.addFilterBefore(jwtAuthenticationFilter, UsernamePasswordAuthenticationFilter.class);
|
||||
|
||||
return http.build();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
package com.kri.common.autoconfigure.security;
|
||||
|
||||
import java.util.List;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@ConfigurationProperties(prefix = "kri.security")
|
||||
public class KriSecurityProperties {
|
||||
|
||||
/**
|
||||
* 이 자동구성 사용 여부
|
||||
*/
|
||||
private boolean enabled = true;
|
||||
|
||||
/**
|
||||
* 인증 없이 허용할 URL 패턴들 서비스에서 application.yml로 오버라이드
|
||||
*/
|
||||
private List<String> publicPaths = List.of(
|
||||
"/v3/api-docs/**",
|
||||
"/swagger-ui.html",
|
||||
"/swagger-ui/**"
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
package com.kri.common.autoconfigure.swagger;
|
||||
|
||||
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;
|
||||
import io.swagger.v3.oas.models.security.SecurityRequirement;
|
||||
import io.swagger.v3.oas.models.security.SecurityScheme;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import org.springdoc.core.models.GroupedOpenApi;
|
||||
import org.springframework.boot.autoconfigure.AutoConfiguration;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.boot.web.servlet.FilterRegistrationBean;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
|
||||
@AutoConfiguration
|
||||
@EnableConfigurationProperties(KriSwaggerProperties.class)
|
||||
@ConditionalOnClass({OpenAPI.class, GroupedOpenApi.class})
|
||||
@ConditionalOnProperty(prefix = "kri.swagger", name = "enabled", havingValue = "true", matchIfMissing = true)
|
||||
@RequiredArgsConstructor
|
||||
public class KriSwaggerAutoConfiguration {
|
||||
|
||||
private final KriSwaggerProperties properties;
|
||||
private final ApiKeyProperties apiKeyProperties; // apikey.header-name 읽기용
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public OpenAPI kriOpenAPI() {
|
||||
// JWT Bearer + API Key 스키마 정의
|
||||
Components components = new Components()
|
||||
.addSecuritySchemes("BearerAuth",
|
||||
new SecurityScheme()
|
||||
.type(SecurityScheme.Type.HTTP)
|
||||
.scheme("bearer")
|
||||
.bearerFormat("JWT"))
|
||||
.addSecuritySchemes("ApiKeyAuth",
|
||||
new SecurityScheme()
|
||||
.type(SecurityScheme.Type.APIKEY)
|
||||
.in(SecurityScheme.In.HEADER)
|
||||
.name(apiKeyProperties.getHeaderName())); // 예: X-API-Key
|
||||
|
||||
// 두 보안 스키마를 기본 보안 요구사항으로 등록
|
||||
SecurityRequirement securityRequirement = new SecurityRequirement()
|
||||
.addList("BearerAuth")
|
||||
.addList("ApiKeyAuth");
|
||||
|
||||
return new OpenAPI()
|
||||
.components(components)
|
||||
.addSecurityItem(securityRequirement)
|
||||
.info(new Info()
|
||||
.title(properties.getTitle())
|
||||
.description(properties.getDescription())
|
||||
.version(properties.getVersion()));
|
||||
}
|
||||
|
||||
@Bean(name = "kriGroupedOpenApi")
|
||||
@ConditionalOnMissingBean(name = "kriGroupedOpenApi")
|
||||
public GroupedOpenApi kriGroupedOpenApi() {
|
||||
GroupedOpenApi.Builder builder = GroupedOpenApi.builder()
|
||||
.group("kri-api")
|
||||
.pathsToMatch("/api/**", "/internal/**");
|
||||
|
||||
String base = properties.getBasePackage();
|
||||
if (base != null && !base.isBlank()) {
|
||||
builder.packagesToScan(base, "com.kri.common.feature.auth.apikey");
|
||||
}
|
||||
|
||||
return builder.build();
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean(name = "swaggerIpFilter")
|
||||
public FilterRegistrationBean<SwaggerIpFilter> swaggerIpFilter() {
|
||||
FilterRegistrationBean<SwaggerIpFilter> registrationBean = new FilterRegistrationBean<>();
|
||||
registrationBean.setFilter(new SwaggerIpFilter(properties.getAllowedIps()));
|
||||
registrationBean.addUrlPatterns("/swagger-ui/*", "/v3/api-docs/*", "/swagger-ui.html");
|
||||
registrationBean.setName("swaggerIpFilter");
|
||||
registrationBean.setOrder(1);
|
||||
return registrationBean;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
package com.kri.common.autoconfigure.swagger;
|
||||
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@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";
|
||||
|
||||
/**
|
||||
* 臾몄꽌?뷀븷 base package (null ?대㈃ ?꾩껜)
|
||||
*/
|
||||
private String basePackage;
|
||||
|
||||
/**
|
||||
* Swagger ?묎렐 ?덉슜 IP 紐⑸줉 (127.0.0.1, localhost, 0:0:0:0:0:0:0:1? 湲곕낯 ?덉슜)
|
||||
*/
|
||||
private List<String> allowedIps = new ArrayList<>();
|
||||
}
|
||||
@@ -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> 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();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
package com.kri.common.autoconfigure.webmvc;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.stream.Collectors;
|
||||
import java.util.stream.Stream;
|
||||
import lombok.Getter;
|
||||
import lombok.Setter;
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
@Getter
|
||||
@Setter
|
||||
@ConfigurationProperties(prefix = "kri.webmvc.ip")
|
||||
public class KriIpAccessProperties {
|
||||
|
||||
/**
|
||||
* 공통에서 고정으로 들고 갈 기본 CIDR 들 → setter 없음 (외부에서 못 바꿈)
|
||||
*/
|
||||
private final List<String> defaultCidrs = List.of(
|
||||
"127.0.0.1/32", // 로컬 IPv4
|
||||
"::1/128", // 로컬 IPv6
|
||||
"10.10.13.0/24", //석오 내부망
|
||||
"211.254.145.128/25" //석오 내부망 외부 IP
|
||||
);
|
||||
|
||||
/**
|
||||
* 서비스에서 추가로 넣고 싶은 CIDR 목록 application.yml / properties 로 바인딩되는 리스트
|
||||
* <p>
|
||||
* 예) kri.webmvc.ip.additional-cidrs[0]=10.10.0.0/16
|
||||
*/
|
||||
private List<String> additionalCidrs = new ArrayList<>();
|
||||
|
||||
/**
|
||||
* 기본 + 추가를 합친 최종 목록
|
||||
*/
|
||||
public List<String> getEffectiveCidrs() {
|
||||
return Stream.concat(defaultCidrs.stream(), additionalCidrs.stream())
|
||||
.distinct()
|
||||
.collect(Collectors.toList());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
package com.kri.common.autoconfigure.webmvc;
|
||||
|
||||
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;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.web.servlet.config.annotation.CorsRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
|
||||
|
||||
@AutoConfiguration
|
||||
@EnableConfigurationProperties(KriIpAccessProperties.class)
|
||||
@ConditionalOnProperty(name = "kri.webmvc.enabled", matchIfMissing = true)
|
||||
@RequiredArgsConstructor
|
||||
public class KriWebMvcAutoConfiguration {
|
||||
|
||||
private final KriIpAccessProperties ipProps; // 생성자 주입 (RequiredArgsConstructor)
|
||||
// 선택 주입: 있으면 쓰고, 없으면 안 씀
|
||||
private final ObjectProvider<IpAccessControlInterceptor> ipAccessControlInterceptorProvider;
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public IpAccessControlService ipAccessControlService(KriIpAccessProperties ipProps) {
|
||||
return new IpAccessControlService(ipProps);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public IpAccessControlInterceptor ipAccessControlInterceptor(IpAccessControlService service) {
|
||||
return new IpAccessControlInterceptor(service);
|
||||
}
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(JwtService.class)// JwtService 있을 때만 동작
|
||||
@ConditionalOnMissingBean
|
||||
public RequestUserContextArgumentResolver requestUserContextArgumentResolver(
|
||||
JwtService jwtService
|
||||
) {
|
||||
return new RequestUserContextArgumentResolver(jwtService);
|
||||
}
|
||||
|
||||
/**
|
||||
* 실제로 WebMvc 설정을 하는 WebMvcConfigurer Bean
|
||||
*/
|
||||
@Bean
|
||||
public WebMvcConfigurer kriCommonWebMvcConfigurer(
|
||||
KriIpAccessProperties properties,
|
||||
ObjectProvider<IpAccessControlInterceptor> ipAccessControlInterceptorProvider,
|
||||
ObjectProvider<RequestUserContextArgumentResolver> requestUserContextArgumentResolverProvider
|
||||
) {
|
||||
return new WebMvcConfigurer() {
|
||||
@Override
|
||||
public void addCorsMappings(CorsRegistry registry) {
|
||||
// 기본 CORS – 필요하면 나중에 조정
|
||||
registry.addMapping("/**")
|
||||
.allowedOriginPatterns("*")
|
||||
.allowedMethods("*")
|
||||
.allowedHeaders("*")
|
||||
.allowCredentials(true);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addInterceptors(InterceptorRegistry registry) {
|
||||
ipAccessControlInterceptorProvider.ifAvailable(interceptor ->
|
||||
registry.addInterceptor(interceptor)
|
||||
.order(1)
|
||||
.addPathPatterns("/swagger-ui/**", "/v3/api-docs/**")
|
||||
);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addArgumentResolvers(
|
||||
java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver> resolvers) {
|
||||
requestUserContextArgumentResolverProvider.ifAvailable(resolvers::add);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void addFormatters(org.springframework.format.FormatterRegistry registry) {
|
||||
registry.addConverterFactory(new com.kri.common.runtime.webmvc.CodeEnumConverter());
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user