Spring Boot 환경에서 동적 데이터 소스를 설정하고 활용하는 방법을 분석합니다. 해당 기능은 dynamic-datasource-spring-boot-starter 라이브러리를 통해 구현됩니다.
1. 의존성 추가
먼저 Maven 프로젝트에 dynamic-datasource-spring-boot-starter 라이브러리를 추가합니다.
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>dynamic-datasource-spring-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
2. 자동 설정 활성화
src/main/resources/META-INF/spring.factories 파일에 DynamicDataSourceAutoConfiguration을 등록하여 자동 설정을 활성화합니다.
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.baomidou.dynamic.datasource.spring.boot.autoconfigure.DynamicDataSourceAutoConfiguration
3. 주요 설정 클래스 분석
DynamicDataSourceAutoConfiguration.java
이 클래스는 동적 데이터 소스 관련 빈들을 설정합니다. 주요 설정 내용은 다음과 같습니다:
ymlDynamicDataSourceProvider: application.yml 또는 application.properties 파일에 정의된 데이터 소스를 로드하는 Provider를 빈으로 등록합니다.dataSource: 동적 라우팅을 담당하는DynamicRoutingDataSource를 빈으로 등록합니다. 이 빈은 주 데이터 소스, 엄격 모드, 전략, P6spy, Seata 설정 등을 구성합니다.dynamicDatasourceAnnotationAdvisor:@DS어노테이션을 처리하기 위한 AOP Advisor를 설정합니다. 이 Advisor는DynamicDataSourceAnnotationInterceptor를 사용하여 메서드 실행 전후에 데이터 소스 전환을 처리합니다.
// application.yml 에서 설정된 데이터 소스를 로드하는 Provider
@Bean
public DynamicDataSourceProvider ymlDynamicDataSourceProvider() {
return new YmlDynamicDataSourceProvider(properties.getDatasource());
}
// 동적 라우팅을 담당하는 DataSource 빈
@Bean
@ConditionalOnMissingBean
public DataSource dataSource() {
DynamicRoutingDataSource dataSource = new DynamicRoutingDataSource();
dataSource.setPrimary(properties.getPrimary()); // 주 데이터 소스 설정
dataSource.setStrict(properties.getStrict()); // 엄격 모드 설정
dataSource.setStrategy(properties.getStrategy()); // 데이터 소스 선택 전략 설정
dataSource.setP6spy(properties.getP6spy()); // P6spy 통합 설정
dataSource.setSeata(properties.getSeata()); // Seata 통합 설정
return dataSource;
}
// @DS 어노테이션 처리를 위한 AOP Advisor
@Role(BeanDefinition.ROLE_INFRASTRUCTURE)
@Bean
@ConditionalOnProperty(prefix = DynamicDataSourceProperties.PREFIX + ".aop", name = "enabled", havingValue = "true", matchIfMissing = true)
public Advisor dynamicDatasourceAnnotationAdvisor(DsProcessor dsProcessor) {
DynamicDataSourceAnnotationInterceptor interceptor = new DynamicDataSourceAnnotationInterceptor(aopProperties.getAllowedPublicOnly(), dsProcessor);
DynamicDataSourceAnnotationAdvisor advisor = new DynamicDataSourceAnnotationAdvisor(interceptor, DS.class);
advisor.setOrder(aopProperties.getOrder());
return advisor;
}
DynamicRoutingDataSource.java
이 클래스는 여러 데이터 소스를 관리하고, 현재 스레드의 컨텍스트에 따라 적절한 데이터 소스를 선택하여 라우팅하는 핵심 역할을 수행합니다. afterPropertiesSet 메서드에서는 설정된 모든 데이터 소스를 로드하고 초기화합니다.
@Override
public void afterPropertiesSet() throws Exception {
checkEnv(); // 필요한 환경 체크
Map<String, DataSource> dataSources = new HashMap<>(16);
// 모든 DynamicDataSourceProvider로부터 데이터 소스 로드
for (DynamicDataSourceProvider provider : providers) {
dataSources.putAll(provider.loadDataSources());
}
// 로드된 데이터 소스 추가
for (Map.Entry<String, DataSource> dsItem : dataSources.entrySet()) {
addDataSource(dsItem.getKey(), dsItem.getValue());
}
// 주 데이터 소스 존재 여부 및 로깅
if (groupDataSources.containsKey(primary) || dataSourceMap.containsKey(primary)) {
log.info("dynamic-datasource initial loaded [{}] datasource, primary group datasource named [{}]", dataSources.size(), primary);
} else {
log.warn("dynamic-datasource initial loaded [{}] datasource, Please add your primary datasource or check your configuration", dataSources.size());
}
}
4. 사용자 정의 데이터 소스 로딩
DynamicDataSourceLoading.java는 데이터베이스에서 직접 데이터 소스 정보를 조회하여 동적으로 로드하는 사용자 정의 Provider입니다.
@Configuration
public class DynamicDataSourceLoading {
@Autowired
SourceProperties sourceProperties; // 커스텀 설정 프로퍼티
@Bean
public DynamicDataSourceProvider jdbcDynamicDataSourceProvider() {
// AbstractJdbcDataSourceProvider를 상속받아 DB에서 데이터 소스 정보 조회
return new AbstractJdbcDataSourceProvider(sourceProperties.getDriverClassName(), sourceProperties.getUrl(), sourceProperties.getUsername(), sourceProperties.getPassword()) {
@Override
protected Map<String, DataSourceProperty> executeStmt(Statement statement) throws SQLException {
// xy_tenant_source 테이블에서 활성 상태의 데이터 소스 정보를 조회
ResultSet rs = statement.executeQuery("select s.slave, s.username, s.password, s.url_prepend, s.url_append, s.driver_class_name from xy_tenant_source s where s.status = '0' and s.del_flag = '0'");
Map<String, DataSourceProperty> map = new HashMap<String, DataSourceProperty>();
while (rs.next()) {
String name = rs.getString("slave"); // 데이터 소스 이름
String username = rs.getString("username");
String password = rs.getString("password");
// URL 조합 (prepend + append)
String url = rs.getString("url_prepend").concat(StringUtils.trim(rs.getString("url_append")));
String driver = rs.getString("driver_class_name");
DataSourceProperty property = new DataSourceProperty();
property.setUsername(username);
property.setPassword(password);
property.setUrl(url);
property.setDriverClassName(driver);
map.put(name, property); // 맵에 데이터 소스 정보 저장
}
return map;
}
};
}
}
5. 데이터 소스 관리 유틸리티
DSUtils.java는 동적 데이터 소스를 추가, 삭제, 조회하는 유틸리티 메서드를 제공합니다.
public class DSUtils {
protected static Logger logger = LoggerFactory.getLogger(DSUtils.class);
/**
* 동적 데이터 소스 추가
* @param source 추가할 데이터 소스 정보 (Source 객체)
*/
public static void addDs(Source source) {
try {
DefaultDataSourceCreator dataSourceCreator = SpringUtils.getBean(DefaultDataSourceCreator.class);
DataSourceProperty dataSourceProperty = new DataSourceProperty();
BeanUtils.copyProperties(source, dataSourceProperty); // Source 객체를 DataSourceProperty로 복사
DataSource dataSource = SpringUtils.getBean(DataSource.class); // 현재 라우팅 DataSource 빈 가져오기
DynamicRoutingDataSource ds = (DynamicRoutingDataSource) dataSource;
DataSource createdDataSource = dataSourceCreator.createDataSource(dataSourceProperty); // 새 DataSource 생성
ds.addDataSource(source.getSlave(), createdDataSource); // 데이터 소스 맵에 추가
} catch (Exception e) {
logger.error("데이터 소스 추가 실패", e);
throw new ServiceException("데이터 소스 추가 실패");
}
}
/**
* 동적 데이터 소스 삭제
* @param slave 삭제할 데이터 소스 이름 (키)
*/
public static void delDs(String slave) {
try {
DynamicRoutingDataSource ds = SpringUtils.getBean(DataSource.class);
ds.removeDataSource(slave); // 데이터 소스 맵에서 제거
} catch (Exception e) {
logger.printStackTrace();
throw new ServiceException("데이터 소스 삭제 실패");
}
}
/**
* 현재 등록된 모든 데이터 소스 이름 출력
*/
public static void getDs() {
DynamicRoutingDataSource ds = SpringUtils.getBean(DataSource.class);
ds.getDataSources().keySet().forEach(System.out::println);
}
/**
* 현재 스레드에 설정된 데이터 소스 이름 반환
*/
public static String getNowDsName() {
return DynamicDataSourceContextHolder.peek(); // 컨텍스트에서 현재 데이터 소스 이름 조회
}
}
6. 사용자 정의 AOP Processor
MyDynamicDataSourceConfig.java는 데이터 소스 선택 로직을 커스터마이징하기 위한 DsProcessor 체인을 설정합니다. DsMainExpressionProcessor와 DsIsolateExpressionProcessor는 특정 조건에 따라 데이터 소스를 선택하는 예시입니다.
@Configuration
@AutoConfigureBefore(DynamicDataSourceAutoConfiguration.class) // 동적 데이터 소스 자동 설정 전에 실행
public class MyDynamicDataSourceConfig {
// DsProcessor 체인 설정
@Bean
public DsProcessor dsProcessor() {
DsHeaderProcessor headerProcessor = new DsHeaderProcessor();
DsSessionProcessor sessionProcessor = new DsSessionProcessor();
DsSpelExpressionProcessor spelExpressionProcessor = new DsSpelExpressionProcessor();
DsIsolateExpressionProcessor isolateExpressionProcessor = new DsIsolateExpressionProcessor();
DsMainExpressionProcessor mainExpressionProcessor = new DsMainExpressionProcessor();
// Processor 체인 연결
headerProcessor.setNextProcessor(sessionProcessor);
sessionProcessor.setNextProcessor(spelExpressionProcessor);
spelExpressionProcessor.setNextProcessor(isolateExpressionProcessor);
isolateExpressionProcessor.setNextProcessor(mainExpressionProcessor);
return headerProcessor;
}
// Druid DataSource의 pingMethod 관련 설정 조정
@PostConstruct
public void setProperty() {
System.setProperty("druid.mysql.usePingMethod","false");
}
}
// 특정 조건에 따라 메인 데이터 소스를 선택하는 Processor
@Component
public class DsMainExpressionProcessor extends DsProcessor {
@Override
public boolean matches(String key) {
return key.startsWith("#main"); // "#main"으로 시작하는 경우 매칭
}
@Override
public String doDetermineDatasource(MethodInvocation invocation, String key) {
return TenantConstants.Source.MAIN.getCode(); // 메인 데이터 소스 반환
}
}
// 격리 모드에서 현재 Tenant의 데이터 소스를 선택하는 Processor
@Component
public class DsIsolateExpressionProcessor extends DsProcessor {
@Override
public boolean matches(String key) {
return key.startsWith("#isolate"); // "#isolate"으로 시작하는 경우 매칭
}
@Override
public String doDetermineDatasource(MethodInvocation invocation, String key) {
String sourceName = SecurityUtils.getSourceName(); // 보안 컨텍스트에서 Tenant 소스 이름 가져오기
return StrUtil.isNotEmpty(sourceName) ? sourceName : DSUtils.getNowDsName(); // Tenant 소스 이름이 있으면 반환, 없으면 현재 스레드 데이터 소스 반환
}
}