mybatis-源码解析-DataSource（如何获取数据库源）

最新推荐文章于 2023-08-30 08:51:42 发布
最新推荐文章于 2023-08-30 08:51:42 发布
阅读量3k 收藏 2
点赞数 2
分类专栏： mybatis
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qqzhengwei/article/details/112321741
版权

1、Mybatis是如何获取数据源的？

在https://mybatis.org/mybatis-3/zh/configuration.html#environments mybatis官方 文档里面，根据xml配置可以查看到

<environments default="development">
  <environment id="development">
    <transactionManager type="JDBC">
      <property name="..." value="..."/>
    </transactionManager>
    <dataSource type="POOLED">
      <property name="driver" value="${driver}"/>
      <property name="url" value="${url}"/>
      <property name="username" value="${username}"/>
      <property name="password" value="${password}"/>
    </dataSource>
  </environment>
</environments>

数据源配置主要包含在environments，dataSource即为数据源，通过代码查看谁解析了dataSource，那么数据源就被谁拥有；

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream)

XMLConfigBuilder.parse

private boolean parsed;为XMLConfigBuilder成员变量

上面方法使用的parser在XMLConfigBuilder构造函数的时候进行初始化


XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties)

//
public XMLConfigBuilder(InputStream inputStream, String environment, Properties props) {
    this(new XPathParser(inputStream, true, props, new XMLMapperEntityResolver()), environment, props);
}

private XMLConfigBuilder(XPathParser parser, String environment, Properties props) {
    super(new Configuration());
    ErrorContext.instance().resource("SQL Mapper Configuration");
    this.configuration.setVariables(props);
    this.parsed = false;
    this.environment = environment;
    this.parser = parser;//
}

XMLConfigBuilder类属性
private boolean parsed;//实现为XPathParser
private final XPathParser parser;
private String environment;

parser.evalNode("/configuration");

String value = parser.evalNode("/configuration");

<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>            
            <dataSource type="POOLED">
                <property name="driver" value="${driver}"/>                
                <property name="url" value="${url}"/>                
                <property name="username" value="${username}"/>                
                <property name="password" value="${password}"/>                
            </dataSource>
        </environment>
    </environments>
    <mappers>
        <mapper resource="com/wolf/dao/SysParamMapper.xml"/>        
    </mappers>
</configuration>

通过此其实就看到把整个mybatis-config.xml给解析出来了。

由于我们这里只研究dataSource到底被谁解析和持有，通过上述xml配置可以发现dataSource在environments里面。所以看看具体解析代码parseConfiguration方法

environmentsElement方法解析

  • 看看context内容是什么？

<environments default="development">
    <environment id="development">
        <transactionManager type="JDBC"/>        
        <dataSource type="POOLED">
            <property name="driver" value="${driver}"/>            
            <property name="url" value="${url}"/>            
            <property name="username" value="${username}"/>            
            <property name="password" value="${password}"/>            
        </dataSource>
    </environment>
</environments>
其实就是我们environmentsElement需要解析的environments配置信息

  • child内容

<environment id="development">
    <transactionManager type="JDBC"/>    
    <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>        
        <property name="url" value="${url}"/>        
        <property name="username" value="${username}"/>        
        <property name="password" value="${password}"/>        
    </dataSource>
</environment>
这里就是就是对environments下面的子标签进行遍历循环处理

  • isSpecifiedEnvironment(id)这个方法在干什么
这个方法就是判断environments的default配置和要解析的environment的id是否相等，如果相等了，就需要去解析默认的环境（environment ）
private boolean isSpecifiedEnvironment(String id) {
  if (environment == null) {
    throw new BuilderException("No environment specified.");
  } else if (id == null) {
    throw new BuilderException("Environment requires an id attribute.");
  } else if (environment.equals(id)) {
    return true;
  }
  return false;
}
  • TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));解析transactionManager然后生成txFactory
private TransactionFactory transactionManagerElement(XNode context) throws Exception {
  if (context != null) {
    String type = context.getStringAttribute("type");//去拿到 <transactionManager type="JDBC"/>标签的type属性
    Properties props = context.getChildrenAsProperties();//这里把xml标签转化为Properties
    //通过配置，我只设置了JDBC，通过这块代码
    //resolveClass(type)这个应该会返回一个Class，然后getDeclaredConstructor调用无参构造函数newInstance()然后实例化他
    //那么JDBC对应的Class是什么呢。【JDBC-org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory】下面源码
    TransactionFactory factory = (TransactionFactory) resolveClass(type).getDeclaredConstructor().newInstance();
    factory.setProperties(props);//将transactionManager 的子标签信息设置到TransactionFactory中，后面需要时，在使用
    return factory;
  }
  throw new BuilderException("Environment declaration requires a TransactionFactory.");
}
  • resolveClass(type)这个方法搞了些什么呢？
protected <T> Class<? extends T> resolveClass(String alias) {
  if (alias == null) {
    return null;
  }
  try {
    //resolveAlias去拿Class
    return resolveAlias(alias);
  } catch (Exception e) {
    throw new BuilderException("Error resolving class. Cause: " + e, e);
  }
}
protected <T> Class<? extends T> resolveAlias(String alias) {
//由于这个方法在XmlConfigBuilder中，那么typeAliasRegistry为一个属性看看这个属性结构及初始化内容  
return typeAliasRegistry.resolveAlias(alias);
}
  • XmlConfigBuilder.typeAliasRegistry属性
BaseBuilder为抽象类为XmlConfigBuilder的父类

BaseBuilder.typeAliasRegistry

通过初始化方法可以看见哦，typeAliasRegistry=this.configuration.getTypeAliasRegistry()中获取的，那么想，在XmlConfigBuilder类实例化的时候，typeAliasRegistry的内容其实已经就完成了初始化

1、configuration及typeAliasRegistry及typeHandlerRegistry都完成了初始化

2、configuration

在其子类通过new Configuration进行实例化并调用了父类的构造函数；【打住，学习源码的时候不要走远了，上面我们要分析typeAliasRegistry是怎么来的】

OK！！！回归正题，我们看到typeAliasRegistry=this.configuration.getTypeAliasRegistry()中获取的

那么我们这里看到了configuration中typeAliasRegistry的初始化，于是我们就找到了JDBC的class，里面还有很多其他参数，这里仅针对JDBC解析（org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory）

通过调试即可以看到TransactionFactory的最终实例就是JdbcTransactionFactory。【有时候通过调试其实最终知道他是什么，但是他如何来，这个就必须通过上述源码分析得到】

public Configuration() {
    typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class);
    typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class);

    typeAliasRegistry.registerAlias("JNDI", JndiDataSourceFactory.class);
    typeAliasRegistry.registerAlias("POOLED", PooledDataSourceFactory.class);
    typeAliasRegistry.registerAlias("UNPOOLED", UnpooledDataSourceFactory.class);

    typeAliasRegistry.registerAlias("PERPETUAL", PerpetualCache.class);
    typeAliasRegistry.registerAlias("FIFO", FifoCache.class);
    typeAliasRegistry.registerAlias("LRU", LruCache.class);
    typeAliasRegistry.registerAlias("SOFT", SoftCache.class);
    typeAliasRegistry.registerAlias("WEAK", WeakCache.class);

    typeAliasRegistry.registerAlias("DB_VENDOR", VendorDatabaseIdProvider.class);

    typeAliasRegistry.registerAlias("XML", XMLLanguageDriver.class);
    typeAliasRegistry.registerAlias("RAW", RawLanguageDriver.class);

    typeAliasRegistry.registerAlias("SLF4J", Slf4jImpl.class);
    typeAliasRegistry.registerAlias("COMMONS_LOGGING", JakartaCommonsLoggingImpl.class);
    typeAliasRegistry.registerAlias("LOG4J", Log4jImpl.class);
    typeAliasRegistry.registerAlias("LOG4J2", Log4j2Impl.class);
    typeAliasRegistry.registerAlias("JDK_LOGGING", Jdk14LoggingImpl.class);
    typeAliasRegistry.registerAlias("STDOUT_LOGGING", StdOutImpl.class);
    typeAliasRegistry.registerAlias("NO_LOGGING", NoLoggingImpl.class);

    typeAliasRegistry.registerAlias("CGLIB", CglibProxyFactory.class);
    typeAliasRegistry.registerAlias("JAVASSIST", JavassistProxyFactory.class);

    languageRegistry.setDefaultDriverClass(XMLLanguageDriver.class);
    languageRegistry.register(RawLanguageDriver.class);
}

==========【思路在回到：environmentsElement方法解析】

上面中间插了很多步骤，其实就是为了分析上述代码中TransactionFactory是如何来的。

  • 然后在看看dataSource是如何解析的？

分析dataSource跟分析TransactionFactory一样的道理；通过调试最终得到了PooledDataSourceFactory实例；（因为xml中dataSource配置的是<dataSource type="POOLED">）

实例就是这么来的？

  • 【在思路在回到：environmentsElement方法解析】

    上述中找到了TransactionFactory和DataSourceFactory如何来的。DataSource是通过DataSourceFactory中获取的来的
  • 抽丝剥茧，我要看看dataSource是如何通过DataSourceFactory拿来的。

通过调试发现DataSourceFactory的实例为PooledDataSourceFactory

先看看PooledDataSourceFactory类的构成

继承UnpooledDataSourceFactory，

PooledDataSourceFactory类属性

UnpooledDataSourceFactory类属性

  • 【在思路在回到：environmentsElement方法解析--environmentBuilder如何构造】

学习到此我们在看看下面代码

Environment.Builder environmentBuilder = new Environment.Builder(id)
    .transactionFactory(txFactory)
    .dataSource(dataSource);

1、可以看到这个是一个建造者模式，那他建造了什么。

看看Evironment源码呢？

public final class Environment {
  private final String id;
  private final TransactionFactory transactionFactory;
  private final DataSource dataSource;

  public Environment(String id, TransactionFactory transactionFactory, DataSource dataSource) {
    if (id == null) {
      throw new IllegalArgumentException("Parameter 'id' must not be null");
    }
    if (transactionFactory == null) {
      throw new IllegalArgumentException("Parameter 'transactionFactory' must not be null");
    }
    this.id = id;
    if (dataSource == null) {
      throw new IllegalArgumentException("Parameter 'dataSource' must not be null");
    }
    this.transactionFactory = transactionFactory;
    this.dataSource = dataSource;
  }

  public static class Builder {
    private final String id;
    private TransactionFactory transactionFactory;
    private DataSource dataSource;


    public Builder transactionFactory(TransactionFactory transactionFactory) {
      this.transactionFactory = transactionFactory;
      return this;
    }

    public Builder dataSource(DataSource dataSource) {
      this.dataSource = dataSource;
      return this;
    }
    public Environment build() {
      return new Environment(this.id, this.transactionFactory, this.dataSource);
    }

  }

}

1、Builder为Environment的内部类
2、Builder与Environment拥有相同的实例
3、Builder每次追加以后都会返回自己的实例，有点像StringBuilder或者StringBuffer
4、在最终Builder.build的时候，才会去构造Environment

这里通过内部类Builder建造了Envrionment对象；

最后将构造的Environment设置到configuration对象的属性中

configuration.setEnvironment(environmentBuilder.build());

到此为止DataSource解析完毕；

最终

org.apache.ibatis.session.SqlSessionFactoryBuilder.build(InputStream inputStream)
  》org.apache.ibatis.builder.xml.XMLConfigBuilder.parse()
    》org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration(parser.evalNode("/configuration"))
	  》org.apache.ibatis.builder.xml.XMLConfigBuilder.environmentsElement(root.evalNode("environments"))
	    》org.apache.ibatis.builder.xml.XMLConfigBuilder.dataSourceElement(child.evalNode("dataSource"))
	      》org.apache.ibatis.builder.xml.XMLConfigBuilder.configuration.setEnvironment(environmentBuilder.build())
		####new XMLConfigBuilder().configuration.setEnvironment(Environment)####

看到了设置的执行步骤！

总结：

1、class XMLConfigBuilder extends BaseBuilder

1、configuration对象被BaseBuilder持有

2、Configuration持有Environment

3、Environment类属性

（1）持有mybatis-config.xml中environment的标签配置信息

（2）持有TransactionFactory实例（<transactionManager type="JDBC"/>-->PooledDataSourceFactory）

（3）持有dataSource实例（<dataSource type="POOLED">--JdbcTransactionFactory）

到此为止！！！整个解析过去就是对mybatis-config.xml配置的标签进行解析，解析后通过一系列对象进行封装和处理；

 

薇薇
关注
  • 2
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.tar.gz）
02-07
mybatis-3.5.9 源码（mybatis-3-mybatis-3.5.9.tar.gz）
mybatis-plus-dynamic-datasource
07-12
mybatis-plus 与多数据源初体验
MyBatis-Plus入门+MyBatis-Plus文档手册 中文pdf高清版.rar
11-09
mybatis在持久层框架中还是比较火的，一般项目都是基于ssm。虽然mybatis可以直接在xml中通过SQL语句操作数据库，很是灵活。但正其操作都要通过SQL语句进行，就必须写大量的xml文件，很是麻烦。mybatis-plus就很好的解决了这个问题。 MyBatisPlus是一个Mybatis的增强工具，在 Mybatis 的基础上只做增强不做改变，为简化开发、提高效率而生。它主要通过启动时自动注入基本CURD，达到简化操作的目的。 关于mybatis-plus的更多介绍及特性，可以参考本文档，详细的介绍了从入门到提高的一个过程，感兴趣的可以下载了解。 MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增 强不做改变，为简化开发、提高效率而生。 特性：无侵入、损耗小、强大的CRUD操作，支持lambda 形势调用、支持多种数据库，支持主键自动生成、支持ActiveRecord模式，支持自定义全局通用操作、支持关键词自动转义，内置代码生成器、内置分页插件、内置性能分析插件，内置全局拦截插件、内置sql注入剥离器 《MyBatis-Plus入门文档》主要介绍了MyBatis-Plus入门使用，以及关于mybatis-plus的更多介绍及特性，感兴趣的可以下载学习一下
mybatis-plus源码（mybatis-plus-3.5.1.zip）
03-03
mybatis-plus源码（mybatis-plus-3.5.1.zip）
Properties标签、Resource属性及URL属性
qq_45793102的博客
12-27 887
在使用 properties 标签配置时，我们可以采用两种方式指定属性配置。 1、直接给出值 <dataSource type="POOLED"> <!-- 配置连接数据库的4个基本信息 --> <property name="driver" value="com.mysql.cj.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/test"/> <pro
Mybatis数据源
weixin_51992178的博客
09-18 1411
因此，JDBC为我们定义了一个数据源的标准，也就是`DataSource`接口，告诉数据源数据库的连接信息，并将所有的连接全部交给数据源进行集中管理，当需要一个`Connection`对象时，可以向数据源申请，数据源会根据内部机制，合理地分配连接对象给我们。我们的数据源配置信息，存放在了`Transaction`对象中，那么现在我们只需要知道执行器到底是如何执行SQL语句的，我们就知道到底如何创建`Connection`对象了，就需要获取数据库的链接信息了，打开datasource。
Mybatis源码（一）获取数据源
长臂人猿的博客
12-27 1694
Mybatis做为一种半ORM框架（半：需要手动写sql）。ORM（Object Relational Mapping）的技术本质是：ORM框架将对象的值映射到对应数据库类型： 如 String -> varchar。且mybatis分为两种实现方式：基于xml和基于注解，本文为xml。
Mybatis源码解析二：DataSource数据源负责创建连接以及Transaction的事物管理
Fighting_Man的博客
01-08 1059
数据源创建通过数据源工厂指定，工厂类型是在mybatis配置文件中指定的；数据源获取连接是在Executor执行器获取Statement时调用的事务创建也是通过事务工厂指定，同样是在mybatis配置文件中指定的，Transaction在获取到连接后，再进行设置事物的隔离级别以及是否自定提交。
Mybatis如何获取数据源
qq_45621336的博客
05-11 5221
Mybatis如何获取数据源 在mybatis中如何获取数据源==>如何解析以下这些标签的 <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> &l
MyBatis——MyBatis数据源与连接池
最新发布
庄小焱
08-30 969
博文主要介绍MyBatis数据源与连接池，更好的理解MyBatis数据源与连接池。
达梦数据库与mybatis-plus
08-30
内含资源： DmJdbcDriver18.jar ...mybatis-3.5.0.jar mybatis-plus-2.0.1.jar mybatis-plus-3.1.0.jar mybatis-plus-annotation-3.1.0.jar mybatis-plus-core-3.1.0.jar mybatis-plus-extension-3.1.0.jar
Spring Boot
LMY0210的博客
11-23 1292
Spring Boot是Spring项目中的一个子工程，与我们所熟知的Spring-framework 同属于spring的产品:其最主要作用就是帮助开发人员快速的构建庞大的spring项目，并且尽可能的减少一切xml配置，做到开箱即用，迅速上手，让开发人员关注业务而非配置。主要特点:设计目的： 用来简化 Spring 应用的初始搭建以及开发过程。从最根本上来讲，Spring Boot 就是一些库的集合，它能够被任意项目所使用。它使用 “习惯优于配置”的理念让你的项目快速运行起来。
手敲Mybatis(三)-DataSource的解析创建和使用
dfBeautifulLive的博客
10-11 1667
Environment类：环境类，mybatis的提供数据库连接的环境，Environment类主要是通过xml的用户配置数据库环境信息再映射到此对象中使用，可配置多个数据库环境，根据环境id区分，除此之外还有事务的工厂对象，数据库的数据源等等。XMLConfigBuilder类：添加数据库环境解析方法，来解析xml中的配置，获取dataSource配置信息，获取事务信息，并解析生成对应的事务工厂和数据源对象。单元测试结果如下，得到数据库数据。在单元测试类里添加如下内容。
mybatis中执行SQL操作，判断数据源的方法
pengquanyao的专栏
04-02 1311
在 MyBatis 中，可以通过 SqlSession 接口来执行 Mapper 操作，每个 SqlSession 对象都与一个特定的数据源关联。因此，可以在 SqlSession 对象上设置断点并检查 SqlSession 对象的一些属性来确定正在执行哪个数据源的操作。
Spring多数据源配置和动态切换
铃萌的博客
01-24 489
平常我们工作有时会有读写分离，或者业务数据在不同的数据库的情况，如果在一个项目里操作，就需要配置多个数据源，并进行动态的切换了。 服务框架：spring + mybatis + druid 多数据源的配置有两种方式： 第一种是基于配置来实现：将数据源的配置一摸一样的配置多个，这种情况下，就需要将不同的业务拆分到不同的包下了，数据源配置中指定扫描不同的包。 <!-- ========= A数据源配置 ======== --> <bean id="dataSourceA" class
springboot引入了mybatis-spring-boot-starter不配置数据库参数报错
zixuanyankai的博客
04-20 2611
一、报错 2022-04-20 14:06:45.453 WARN 34556 --- [main] o.m.s.mapper.ClassPathMapperScanner : No MyBatis mapper was found in '[module.log]' package. Please check your configuration. 2022-04-20 14:06:47.286 WARN 34556 --- [main] onfigReactiveWebServerAppl
MyBatis Plus动态数据源
qq_44802667的博客
02-27 2697
MyBatis Plus动态多数据源配置
Mybatis-Plus 中使用@DS注解动态选择数据源源码分析
热门推荐
labulaka24的博客
07-24 1万+
Mybatis-Plus使用@DS注解源码剖析
获取mybatis-plus-dynamic-datasource中的多数据源实例
07-22
在 mybatis-plus-dynamic-datasource 中获取多数据源实例的方法如下： 1. 导入相关依赖： ```xml <dependency> <groupId>com.baomidou</groupId> <artifactId>dynamic-datasource-spring-boot-starter</artifactId> <version>2.5.3</version> </dependency> ``` 2. 在 application.yml 或 application.properties 中配置数据源信息，例如： ```yaml spring: datasource: dynamic: primary: ds1 # 设置默认数据源 datasource: ds1: url: jdbc:mysql://localhost:3306/db1 username: root password: 123456 ds2: url: jdbc:mysql://localhost:3306/db2 username: root password: 123456 ``` 3. 创建一个继承自 AbstractRoutingDataSource 的类，用于动态切换数据源： ```java public class DynamicRoutingDataSource extends AbstractRoutingDataSource { @Override protected Object determineCurrentLookupKey() { return DynamicDataSourceContextHolder.getDataSourceKey(); } } ``` 4. 创建一个数据源上下文持有者类，用于设置和获取当前线程使用的数据源： ```java public class DynamicDataSourceContextHolder { private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>(); public static void setDataSourceKey(String dataSourceKey) { CONTEXT_HOLDER.set(dataSourceKey); } public static String getDataSourceKey() { return CONTEXT_HOLDER.get(); } public static void clearDataSourceKey() { CONTEXT_HOLDER.remove(); } } ``` 5. 配置数据源切换策略和数据源 bean： ```java @Configuration public class DataSourceConfig { @Bean @ConfigurationProperties(prefix = "spring.datasource.dynamic") public DataSourceProperties dataSourceProperties() { return new DataSourceProperties(); } @Bean public DataSource dataSource(DataSourceProperties properties) { Map<String, DataSource> dataSourceMap = new HashMap<>(); dataSourceMap.put("ds1", properties.getDataSource("ds1")); dataSourceMap.put("ds2", properties.getDataSource("ds2")); // 设置默认数据源 DynamicRoutingDataSource dataSource = new DynamicRoutingDataSource(); dataSource.setDefaultTargetDataSource(dataSourceMap.get(properties.getPrimary())); dataSource.setTargetDataSources(dataSourceMap); return dataSource; } @Bean public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception { MybatisSqlSessionFactoryBean sessionFactoryBean = new MybatisSqlSessionFactoryBean(); sessionFactoryBean.setDataSource(dataSource); return sessionFactoryBean.getObject(); } @Bean public PlatformTransactionManager transactionManager(DataSource dataSource) { return new DataSourceTransactionManager(dataSource); } } ``` 现在，你可以通过注入 DataSource 类型的 bean 来获取多数据源实例，例如： ```java @Autowired private DataSource dataSource; ``` 然后，你就可以使用这个数据源实例来执行数据库操作了。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值