org.dromara.hutool.db.ds.DSWrapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hutool-all Show documentation
Hutool是一个优雅而小巧的Java工具类库
There is a newer version: 6.0.0.M3
/*
 * 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.exception.CloneException;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.core.lang.wrapper.SimpleWrapper;
import org.dromara.hutool.db.config.DbConfig;

import javax.sql.DataSource;
import java.io.Closeable;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.SQLException;
import java.sql.SQLFeatureNotSupportedException;
import java.util.logging.Logger;

/**
 * {@link DataSource} 数据源实现包装，通过包装，提供基本功能外的额外功能和参数持有，包括：
 *
 *  * 1. 提供驱动名的持有，用于确定数据库方言
 * 
 *
 * @author looly
 * @since 4.3.2
 */
public class DSWrapper extends SimpleWrapper implements DataSource, Closeable, Cloneable {

	private final DbConfig dbConfig;

	/**
	 * 包装指定的DataSource
	 *
	 * @param ds     原始的DataSource
	 * @param dbConfig 数据库驱动类名
	 * @return DataSourceWrapper
	 */
	public static DSWrapper wrap(final DataSource ds, final DbConfig dbConfig) {
		return new DSWrapper(ds, dbConfig);
	}

	/**
	 * 构造
	 *
	 * @param ds       原始的DataSource
	 * @param dbConfig 数据库配置
	 */
	public DSWrapper(final DataSource ds, final DbConfig dbConfig) {
		super(ds);
		this.dbConfig = dbConfig;
	}

	/**
	 * 获取数据库配置
	 *
	 * @return 数据库配置
	 */
	public DbConfig getDbConfig(){
		return this.dbConfig;
	}

	/**
	 * 获取驱动名
	 *
	 * @return 驱动名
	 */
	public String getDriver() {
		return this.dbConfig.getDriver();
	}

	@Override
	public PrintWriter getLogWriter() throws SQLException {
		return this.raw.getLogWriter();
	}

	@Override
	public void setLogWriter(final PrintWriter out) throws SQLException {
		this.raw.setLogWriter(out);
	}

	@Override
	public void setLoginTimeout(final int seconds) throws SQLException {
		this.raw.setLoginTimeout(seconds);
	}

	@Override
	public int getLoginTimeout() throws SQLException {
		return this.raw.getLoginTimeout();
	}

	@Override
	public Logger getParentLogger() throws SQLFeatureNotSupportedException {
		return this.raw.getParentLogger();
	}

	@Override
	public  T unwrap(final Class iface) throws SQLException {
		return this.raw.unwrap(iface);
	}

	@Override
	public boolean isWrapperFor(final Class iface) throws SQLException {
		return this.raw.isWrapperFor(iface);
	}

	@Override
	public Connection getConnection() throws SQLException {
		return this.raw.getConnection();
	}

	@Override
	public Connection getConnection(final String username, final String password) throws SQLException {
		return this.raw.getConnection(username, password);
	}

	@Override
	public void close() {
		final DataSource ds = this.raw;
		if (ds instanceof AutoCloseable) {
			IoUtil.closeQuietly((AutoCloseable) ds);
		}
	}

	@Override
	public DSWrapper clone() {
		try {
			return (DSWrapper) super.clone();
		} catch (final CloneNotSupportedException e) {
			throw new CloneException(e);
		}
	}
}