org.dromara.hutool.db.ds.DSPool Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.db.ds;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.lang.Singleton;
import org.dromara.hutool.core.map.MapUtil;
import org.dromara.hutool.core.map.concurrent.SafeConcurrentHashMap;
import org.dromara.hutool.core.text.StrUtil;
import org.dromara.hutool.db.config.ConfigParser;
import org.dromara.hutool.db.config.DbConfig;
import org.dromara.hutool.db.config.SettingConfigParser;
import org.dromara.hutool.log.LogUtil;
import java.io.Closeable;
import java.util.Collection;
import java.util.Map;
/**
* 数据源池，用于支持多数据源。
* 在指定Setting中配置多个数据源时，通过分组（group）区分
* 每次获得一个数据源则缓存在pool中，确保数据源保持单例状态。
*
* @author Looly
* @since 6.0.0
*/
public class DSPool implements Closeable {
/**
* 获取单例池对象
*
* @return 数据源池
*/
public static DSPool getInstance() {
return Singleton.get(DSPool.class.getName(), DSPool::new);
}
private final ConfigParser configParser;
/**
* 数据源池
*/
private final Map pool;
/**
* 连接工厂
*/
private DSFactory factory;
/**
* 构造，通过SPI方式自动获取用户引入的连接池，使用classpath:db.setting
*/
public DSPool() {
this(null);
}
/**
* 构造，通过SPI方式自动获取用户引入的连接池
*
* @param configParser 数据库配置解析器
*/
public DSPool(final ConfigParser configParser) {
this(configParser, null);
}
/**
* 构造
*
* @param configParser 数据库配置解析器
* @param factory 数据源工厂，用于创建数据源，{@code null}表示使用SPI自动获取
*/
public DSPool(final ConfigParser configParser, final DSFactory factory) {
this.configParser = null != configParser ? configParser : SettingConfigParser.of();
this.factory = null != factory ? factory : DSUtil.getDefaultDsFactory();
this.pool = new SafeConcurrentHashMap<>();
}
/**
* 获取配置解析器
*
* @return ConfigParser
*/
public ConfigParser getConfigParser() {
return this.configParser;
}
/**
* 获取数据源名称，用于识别当前使用连接池类型
*
* @return 数据源名称
*/
public String getDataSourceName() {
return this.factory.getDataSourceName();
}
/**
* 设置自定义的{@link DSFactory}
*
* @param factory {@link DSFactory}
* @return this
*/
public DSPool setFactory(final DSFactory factory) {
this.factory = factory;
LogUtil.debug("Custom use [{}] DataSource.", factory.getDataSourceName());
return this;
}
/**
* 获取指定分组的数据源，单例获取
*
* @param group 分组，{@code null}表示默认分组
* @return 数据源
*/
public DSWrapper getDataSource(String group) {
if (group == null) {
group = StrUtil.EMPTY;
}
// 如果已经存在已有数据源（连接池）直接返回
return pool.computeIfAbsent(group, this::createDSWrapper);
}
/**
* 关闭指定数据源
*
* @param group 分组
* @return this
*/
public DSPool closeDataSource(String group) {
if (group == null) {
group = StrUtil.EMPTY;
}
// 此处线程安全，任意线程进入一旦remove完成，后续线程调用remove后都为null
final DSWrapper removed = pool.remove(group);
if (null != removed) {
IoUtil.closeQuietly(removed);
}
return this;
}
@Override
public void close() {
final Map pool = this.pool;
if (MapUtil.isNotEmpty(pool)) {
// 此处线程安全，多线程调用可能多次调用clear，不影响
final Collection values = pool.values();
pool.clear();
for (final DSWrapper ds : values) {
ds.close();
}
}
}
/**
* 创建数据源，对于不同连接池名称的的差异做兼容，如用户配置user和username都表示用户名
*
* @param group 分组，{@code null}表示默认分组
* @return {@link DSWrapper} 数据源包装
*/
private DSWrapper createDSWrapper(final String group) {
final DbConfig dbConfig = this.configParser.parse(StrUtil.toStringOrEmpty(group));
return DSWrapper.wrap(factory.createDataSource(dbConfig), dbConfig);
}
}