org.dromara.hutool.db.ThreadLocalConnection 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;
import org.dromara.hutool.core.io.IoUtil;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;
/**
* 线程相关的数据库连接持有器
* 此对象为单例类，用于存储线程相关的Connection对象。
* 在多数据源情况下，由于数据源的不同，连接对象也不同，因此获取连接时需要DataSource关联获取
*
* @author looly
*
*/
public enum ThreadLocalConnection {
/**
* 单例
*/
INSTANCE;
private final ThreadLocal threadLocal = new ThreadLocal<>();
/**
* 获取数据源对应的数据库连接
*
* @param ds 数据源
* @return Connection
* @throws SQLException SQL异常
*/
public Connection get(final DataSource ds) throws SQLException {
GroupedConnection groupedConnection = threadLocal.get();
if (null == groupedConnection) {
groupedConnection = new GroupedConnection();
threadLocal.set(groupedConnection);
}
return groupedConnection.get(ds);
}
/**
* 关闭数据库，并从线程池中移除
*
* @param ds 数据源
* @since 4.1.7
*/
public void close(final DataSource ds) {
final GroupedConnection groupedConnection = threadLocal.get();
if (null != groupedConnection) {
groupedConnection.close(ds);
if (groupedConnection.isEmpty()) {
// 当所有分组都没有持有的连接时，移除这个分组连接
threadLocal.remove();
}
}
}
/**
* 分组连接，根据不同的分组获取对应的连接，用于多数据源情况
*
* @author Looly
*/
public static class GroupedConnection {
/** 连接的Map，考虑到大部分情况是单数据库，故此处初始大小1 */
private final Map connMap = new HashMap<>(1, 1);
/**
* 获取连接，如果获取的连接为空或者已被关闭，重新创建连接
*
* @param ds 数据源
* @return Connection
* @throws SQLException SQL异常
*/
public Connection get(final DataSource ds) throws SQLException {
Connection conn = connMap.get(ds);
if (null == conn || conn.isClosed()) {
conn = ds.getConnection();
connMap.put(ds, conn);
}
return conn;
}
/**
* 关闭并移除Connection
* 如果处于事务中，则不进行任何操作
*
* @param ds 数据源
* @return this
*/
public GroupedConnection close(final DataSource ds) {
final Connection conn = connMap.get(ds);
if (null != conn) {
try {
if (!conn.getAutoCommit()) {
// 非自动提交事务的连接，不做关闭（可能处于事务中）
return this;
}
} catch (final SQLException e) {
// ignore
}
connMap.remove(ds);
IoUtil.closeQuietly(conn);
}
return this;
}
/**
* 持有的连接是否为空
*
* @return 持有的连接是否为空
* @since 4.6.4
*/
public boolean isEmpty() {
return connMap.isEmpty();
}
}
}