Mybatis 作为一个 ORM 框架,本身支持多种 dataSource
的接入,dataSource
亦可以使用线程池。mybatis 中有自带的 线程池,也可以使用 druid 等之类的第三方线程池。
王子/公主 请看配置文件
<!--环境配置-->
<environments default="development">
<!--开发环境-->
<environment id="development">
<!--事务管理器-->
<transactionManager type="JDBC"/>
<!--数据源-->
<dataSource type="POOLED">
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url"
value="jdbc:mysql://localhost:3306/oa_test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
这里配置的 pooled 就是代表使用了 jdbc 提供的默认线程池。
那默认的线程池是怎么样的呢?
一、分析源码
先保留这个疑问,让我们一起来看一下 mybatis 中的xml解析器吧。
private void parseConfiguration(XNode root) {
try {
// issue #117 read properties first
propertiesElement(root.evalNode("properties"));
Properties settings = settingsAsProperties(root.evalNode("settings"));
loadCustomVfs(settings);
loadCustomLogImpl(settings);
typeAliasesElement(root.evalNode("typeAliases"));
pluginElement(root.evalNode("plugins"));
objectFactoryElement(root.evalNode("objectFactory"));
objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));
reflectorFactoryElement(root.evalNode("reflectorFactory"));
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
environmentsElement(root.evalNode("environments"));
databaseIdProviderElement(root.evalNode("databaseIdProvider"));
typeHandlerElement(root.evalNode("typeHandlers"));
mapperElement(root.evalNode("mappers"));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}
这么东西我们可以不用全看,根据
DataSource
的位置 只需要看 environmentsElement 即可。
private void environmentsElement(XNode context) throws Exception {
if (context != null) {
if (environment == null) {
// 如果不配置则选择默认的。
environment = context.getStringAttribute("default");
}
for (XNode child : context.getChildren()) {
String id = child.getStringAttribute("id");
if (isSpecifiedEnvironment(id)) {
// 这里是事务管理,不是本章的重点,可以参考其他文章。
TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
// 这里就是解析 dataSource 的重头戏了。
DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
DataSource dataSource = dsFactory.getDataSource();
Environment.Builder environmentBuilder = new Environment.Builder(id)
.transactionFactory(txFactory)
.dataSource(dataSource);
configuration.setEnvironment(environmentBuilder.build());
break;
}
}
}
}
重点看 dataSourceElement、与getDataSource
方法
private DataSourceFactory dataSourceElement(XNode context) throws Exception {
if (context != null) {
// 获取头部配置的 type
String type = context.getStringAttribute("type");
// 这里是获取其他配置项,例如 url、username、password等,如果是线程池的话还会有线程数量等。
Properties props = context.getChildrenAsProperties();
// 这里是根据 type 去获取 DataSourceFactory 的对象。下面详细介绍这个过程。
DataSourceFactory factory = (DataSourceFactory) resolveClass(type).getDeclaredConstructor().newInstance();
factory.setProperties(props);
return factory;
}
throw new BuilderException("Environment declaration requires a DataSourceFactory.");
}
配置文件的格式,遗忘的可以看一下这里~
<dataSource type="POOLED"> <property name="driver" value="com.mysql.cj.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/oa_test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai"/> <property name="username" value="root"/> <property name="password" value="root"/> </dataSource>
resolveClass 的思路大概是 先查询 输入的 alias(即Datasource 的id ) 是否是一个别名,然后取到其 Class 对象。
protected <T> Class<? extends T> resolveClass(String alias) {
if (alias == null) {
return null;
}
try {
return resolveAlias(alias);
} catch (Exception e) {
throw new BuilderException("Error resolving class. Cause: " + e, e);
}
}
----
protected <T> Class<? extends T> resolveAlias(String alias) {
return typeAliasRegistry.resolveAlias(alias);
}
------
public <T> Class<T> resolveAlias(String string) {
try {
if (string == null) {
return null;
}
String key = string.toLowerCase(Locale.ENGLISH);
Class<T> value;
if (typeAliases.containsKey(key)) {
/*typeAliases 是一个储存了所有 <typeAliases> 标签里面内容的 mapping 。即别名
*例如
*<typeAliases>
* <!--设置druid数据库连接池别名-->
* <typeAlias type="com.learn.mybatis.firstday.druidwapper.DruidTransactionFactory" alias="druid"/>
* </typeAliases>
*
*
*/
value = (Class<T>) typeAliases.get(key);
} else {
value = (Class<T>) Resources.classForName(string);
}
return value;
} catch (ClassNotFoundException e) {
throw new TypeException("Could not resolve type alias '" + string + "'. Cause: " + e, e);
}
}
注意:
看完了这里 的源码,那我们就明白了,它源码规定了 id 的两种写法
- 使用别名 + 配置别名
- 直接配置 类的全类名
<typeAliases>
<=================================================>
<!--设置druid数据库连接池别名-->
<typeAlias type="com.learn.mybatis.firstday.druidwapper.DruidTransactionFactory" alias="druid"/>
<=================================================>
</typeAliases>
<!--环境配置-->
<environments default="development">
<!--开发环境-->
<environment id="development">
<!--事务管理器-->
<transactionManager type="JDBC"/>
<!--数据源-->
<=================================================>
<dataSource type="druid"><!--使用自己的Driud工厂-->
<=================================================>
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url"
value="jdbc:mysql://localhost:3306/oa_test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<!--环境配置-->
<environments default="development">
<!--开发环境-->
<environment id="development">
<!--事务管理器-->
<transactionManager type="JDBC"/>
<!--数据源-->
<=================================================>
<dataSource type="com.learn.mybatis.firstday.druidwapper.DruidTransactionFactory"><!--使用自己的Driud工厂-->
<=================================================>
<property name="driver" value="com.mysql.cj.jdbc.Driver"/>
<property name="url"
value="jdbc:mysql://localhost:3306/oa_test?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
二、看完了该怎么怎么填写配置,那我们就应该开始着手书写配置类了。
前面埋了一个小坑,什么是 mybatis 中默认的连接池?
现在是解疑答惑时间。由上面的源码分析,我们知道,想要自定义数据源连接池,那就必须 实现DataSourceFactory
这个接口。
DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
DataSource dataSource = dsFactory.getDataSource();
DataSource是由 DataSourceFactory创建出来的,那么 DataSourceFactory 是什么呢?打开idea,我们可以看到
使用 IDEA 自带的分析得出依赖关系。
这里的 PooledDataSourceFactory 就是 mybatis 默认pooled 对应连接池 对应的工厂类!!!
解惑成功!!!
那我们就照葫芦画瓢,写一个 DataSourceFactory 的实现类,然后将它配置进 mybatis 中!
public class DruidTransactionFactory implements DataSourceFactory {
private DruidDataSource dataSource;
@Override
public void setProperties(Properties props) {
props.setProperty("driverClassName", props.getProperty("driver"));
try {
dataSource = (DruidDataSource) DruidDataSourceFactory.createDataSource(props);
} catch (Exception e) {
e.printStackTrace();
throw new RuntimeException("we cant config druid");
}
}
@Override
public DataSource getDataSource() {
return dataSource;
}
}
恭喜你走到了最后一步!!!此时你应该已经配置成功@!
三、碎碎念念
为什么 SpringBoot 中都是使用 yml 配置文件直接进行 mybatis 的配置了,我们这里还是以 mybatis-config.xml 文件进行分析?因为 本质上是一样的,只是形式不一样。看下面 springboot 中对 druid 的配置。
# 数据源配置
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driverClassName: com.mysql.cj.jdbc.Driver
而且使用了 druid 提供的 starter ,DataSourceFactory 接口 的实现类都已经帮我们写好了
<!-- 阿里数据库连接池 -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
</dependency>