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일
|
||||
}
|
||||
Reference in New Issue
Block a user