cn.hutool.db.ds

Class DSFactory

java.lang.Object

cn.hutool.db.ds.DSFactory

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable

Direct Known Subclasses:

AbstractDSFactory

public abstract class DSFactory
extends Object
implements Closeable, Serializable

抽象数据源工厂类
通过实现getDataSource(String) 方法实现数据源的获取
如果DataSource 的实现是数据库连接池库，应该在getDataSource调用时创建数据源并缓存

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dataSourceName 数据源名
static String[]	KEY_ALIAS_DRIVER 别名字段名：驱动名
static String[]	KEY_ALIAS_PASSWORD 别名字段名：密码
static String[]	KEY_ALIAS_URL 别名字段名：URL
static String[]	KEY_ALIAS_USER 别名字段名：用户名
static String[]	KEY_CONN_PROPS 某些数据库需要的特殊配置项需要的配置项

Constructor Summary

Constructors

Constructor and Description
DSFactory(String dataSourceName) 构造

Method Summary

Modifier and Type	Method and Description
void	close() 关闭默认数据源（空组）
abstract void	close(String group) 关闭对应数据源
static DSFactory	create(Setting setting) 创建数据源实现工厂 此方法通过“试错”方式查找引入项目的连接池库，按照优先级寻找，一旦寻找到则创建对应的数据源工厂 连接池优先级：Hikari > Druid > Tomcat > Dbcp > C3p0 > Hutool Pooled
abstract void	destroy() 销毁工厂类，关闭所有数据源
static DataSource	get() 获得数据源 使用默认配置文件的无分组配置
static DataSource	get(String group) 获得数据源
DataSource	getDataSource() 获得默认数据源
abstract DataSource	getDataSource(String group) 获得分组对应数据源
static DSFactory	setCurrentDSFactory(DSFactory dsFactory) 设置全局的数据源工厂 在项目中存在多个连接池库的情况下，我们希望使用低优先级的库时使用此方法自定义之 重新定义全局的数据源工厂此方法可在以下两种情况下调用： 1.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_CONN_PROPS

public static final String[] KEY_CONN_PROPS

某些数据库需要的特殊配置项需要的配置项

KEY_ALIAS_URL

public static final String[] KEY_ALIAS_URL

别名字段名：URL

KEY_ALIAS_DRIVER

public static final String[] KEY_ALIAS_DRIVER

别名字段名：驱动名

KEY_ALIAS_USER

public static final String[] KEY_ALIAS_USER

别名字段名：用户名

KEY_ALIAS_PASSWORD

public static final String[] KEY_ALIAS_PASSWORD

别名字段名：密码

dataSourceName

protected final String dataSourceName

数据源名

Constructor Detail

DSFactory

public DSFactory(String dataSourceName)

构造

Parameters:

dataSourceName - 数据源名称

Method Detail

getDataSource

public DataSource getDataSource()

获得默认数据源

Returns:

数据源

getDataSource

public abstract DataSource getDataSource(String group)

获得分组对应数据源

Parameters:

group - 分组名

Returns:

数据源

close

public void close()

关闭默认数据源（空组）

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public abstract void close(String group)

关闭对应数据源

Parameters:

group - 分组

destroy

public abstract void destroy()

销毁工厂类，关闭所有数据源

get

public static DataSource get()

获得数据源
使用默认配置文件的无分组配置

Returns:

数据源

get

public static DataSource get(String group)

获得数据源

Parameters:

group - 配置文件中对应的分组

Returns:

数据源

setCurrentDSFactory

public static DSFactory setCurrentDSFactory(DSFactory dsFactory)

设置全局的数据源工厂
在项目中存在多个连接池库的情况下，我们希望使用低优先级的库时使用此方法自定义之
重新定义全局的数据源工厂此方法可在以下两种情况下调用：

 1. 在get方法调用前调用此方法来自定义全局的数据源工厂
 2. 替换已存在的全局数据源工厂，当已存在时会自动关闭
 

Parameters:

dsFactory - 数据源工厂

Returns:

自定义的数据源工厂

create

public static DSFactory create(Setting setting)

创建数据源实现工厂
此方法通过“试错”方式查找引入项目的连接池库，按照优先级寻找，一旦寻找到则创建对应的数据源工厂
连接池优先级：Hikari > Druid > Tomcat > Dbcp > C3p0 > Hutool Pooled

Parameters:

setting - 数据库配置项

Returns:

日志实现类