mybatis与spring整合源码分析

最新推荐文章于 2023-01-28 12:07:59 发布
最新推荐文章于 2023-01-28 12:07:59 发布
阅读量208 收藏 1
点赞数
分类专栏： spring源码 文章标签： mybatis spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/pigqhf/article/details/106163869
版权

1.配置applicationContext.xml

	<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
		<property name="driverClassName" value="com.mysql.jdbc.Driver" />
		<property name="url" value="jdbc:mysql://122.152.131.141:3306/school" />
		<property name="username" value="zw121" />
		<property name="password" value="122334" />
	</bean>

	<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="configLocation" value="classpath:mybatis.xml" />
		<property name="mapperLocations">
			<array>
				<!-- 配置单个映射文件 -->
				<!-- <value>classpath:mappers/UserMapper.xml</value> -->
				<!-- 配置多个映射文件使用 * 通配符 -->
				<value>classpath:mappers/*Mapper.xml</value>
			</array>
		</property>
		<!-- 配置别名，使用包扫描 -->
		<property name="typeAliasesPackage" value="com.qhf.pojo"></property>
	</bean>
	
	<!-- 扫描接口文件，其2选1 -->
	<!-- 1.扫描接口文件，只能单个文件 -->
	<!-- 
	<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
		<property name="mapperInterface" value="com.qhf.dao.UserMapper"></property>
		<property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
	</bean>
	 -->
	<!-- 2.扫描包下的接口文件，此方法简便 -->
	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
		<property name="basePackage" value="com.qhf.dao"></property>
	</bean>
  •  主要就是配置 SqlSessionFactoryBean 的初始化 bean 对象
  • 还有 MapperFactoryBean 的初始化 bean 对象，此 bean 针对一个 mapper 接口
  • MapperScannerConfigurer 的初始化 bean 对象，扫描包下的全部接口文件

 

 

 2.SqlSessionFactoryBean

  • 实现接口 FactoryBean 接口，getBean() 方法返回 sqlSessionFactory 工厂类对象。
  • 实现 InitializingBean 接口，则 bean 初始化时会调用此类的 afterPropertiesSet() 方法。
public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> { 
  //...
  @Override
  public void afterPropertiesSet() throws Exception {
    notNull(dataSource, "Property 'dataSource' is required");
    notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");

    this.sqlSessionFactory = buildSqlSessionFactory();
  }

  @Override
  public SqlSessionFactory getObject() throws Exception {
    if (this.sqlSessionFactory == null) {
      afterPropertiesSet();
    }

    return this.sqlSessionFactory;
  }
}
  •  sqlSessionFactory 的初始化实际上就是调用 buildSqlSessionFactory() 方法时初始化的。
protected SqlSessionFactory buildSqlSessionFactory() throws IOException {

    Configuration configuration;

    XMLConfigBuilder xmlConfigBuilder = null;
    if (this.configLocation != null) {
      xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties);
      configuration = xmlConfigBuilder.getConfiguration();
    } else {
      if (LOGGER.isDebugEnabled()) {
        LOGGER.debug("Property 'configLocation' not specified, using default MyBatis Configuration");
      }
      configuration = new Configuration();
      configuration.setVariables(this.configurationProperties);
    }

    if (this.objectFactory != null) {
      configuration.setObjectFactory(this.objectFactory);
    }

    if (this.objectWrapperFactory != null) {
      configuration.setObjectWrapperFactory(this.objectWrapperFactory);
    }

    if (hasLength(this.typeAliasesPackage)) {
      String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage,
          ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
      for (String packageToScan : typeAliasPackageArray) {
        configuration.getTypeAliasRegistry().registerAliases(packageToScan,
                typeAliasesSuperType == null ? Object.class : typeAliasesSuperType);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Scanned package: '" + packageToScan + "' for aliases");
        }
      }
    }

    if (!isEmpty(this.typeAliases)) {
      for (Class<?> typeAlias : this.typeAliases) {
        configuration.getTypeAliasRegistry().registerAlias(typeAlias);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Registered type alias: '" + typeAlias + "'");
        }
      }
    }

    if (!isEmpty(this.plugins)) {
      for (Interceptor plugin : this.plugins) {
        configuration.addInterceptor(plugin);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Registered plugin: '" + plugin + "'");
        }
      }
    }

    if (hasLength(this.typeHandlersPackage)) {
      String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage,
          ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);
      for (String packageToScan : typeHandlersPackageArray) {
        configuration.getTypeHandlerRegistry().register(packageToScan);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Scanned package: '" + packageToScan + "' for type handlers");
        }
      }
    }

    if (!isEmpty(this.typeHandlers)) {
      for (TypeHandler<?> typeHandler : this.typeHandlers) {
        configuration.getTypeHandlerRegistry().register(typeHandler);
        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Registered type handler: '" + typeHandler + "'");
        }
      }
    }

    if (xmlConfigBuilder != null) {
      try {
        xmlConfigBuilder.parse();

        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Parsed configuration file: '" + this.configLocation + "'");
        }
      } catch (Exception ex) {
        throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex);
      } finally {
        ErrorContext.instance().reset();
      }
    }

    if (this.transactionFactory == null) {
      this.transactionFactory = new SpringManagedTransactionFactory();
    }

    configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource));

    if (this.databaseIdProvider != null) {
      try {
        configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
      } catch (SQLException e) {
        throw new NestedIOException("Failed getting a databaseId", e);
      }
    }

    if (!isEmpty(this.mapperLocations)) {
      for (Resource mapperLocation : this.mapperLocations) {
        if (mapperLocation == null) {
          continue;
        }

        try {
          XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(),
              configuration, mapperLocation.toString(), configuration.getSqlFragments());
          xmlMapperBuilder.parse();
        } catch (Exception e) {
          throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e);
        } finally {
          ErrorContext.instance().reset();
        }

        if (LOGGER.isDebugEnabled()) {
          LOGGER.debug("Parsed mapper file: '" + mapperLocation + "'");
        }
      }
    } else {
      if (LOGGER.isDebugEnabled()) {
        LOGGER.debug("Property 'mapperLocations' was not specified or no matching resources found");
      }
    }

    return this.sqlSessionFactoryBuilder.build(configuration);
  }
  • 总体来说：
    • 生成一个 Configuration 对象，此对象是 mybatis 的核心。
    • 把配置的 configLocation（mybatis原始配置文件，整合之后基本不用配置），objectFactory，objectWrapperFactory，typeAliasesPackage（别名，省了configLocation 里别名的配置），typeAliases，plugins，typeHandlersPackage，typeHandlers，transactionFactory，databaseIdProvider，mapperLocations（扫描 xml 映射文件） 初始化和解析。
    • 最后通过 sqlSessionFactoryBuilder.build(configuration) 方法把此 configuration 对象传给了 DefaultSqlSessionFactory 实例对象，其中 DefaultSqlSessionFactory 实现了 SqlSessionFactory 接口，是生产 SqlSession 的工厂。
public class SqlSessionFactoryBuilder {
  //...
  public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }
}


public class DefaultSqlSessionFactory implements SqlSessionFactory {

  private final Configuration configuration;

  public DefaultSqlSessionFactory(Configuration configuration) {
    this.configuration = configuration;
  }
  //...
}
  • 当单独使用 mybatis 时通过 sqlSessionFactory.openSession() 来获取 sqlSession，才能操作数据库。

SqlSession sqlSession = sqlSessionFactory.openSession();
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
//...

  • 当交给 Spring 管理，可以通过下面方式获取 userMapper 对象

UserMapper userMapper = (UserMapper)context.getBean("userMapper");

或

@Autowired

UserMapper userMapper;

  • 先看此配置，是对单个 mapper 接口的 bean 对象的创建。
	<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
		<property name="mapperInterface" value="com.qhf.dao.UserMapper"></property>
		<property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
	</bean>

 

 

3.MapperFactoryBean

  • 配置 MapperFactoryBean 的 bean 时的属性是 mapperInterface，sqlSessionFactory

    <bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
        <property name="mapperInterface" value="com.qhf.dao.UserMapper"></property>
        <property name="sqlSessionFactory" ref="sqlSessionFactory"></property>
    </bean>

  • <property name="sqlSessionFactory" ref="sqlSessionFactory"/>属性初始化时会调用 MapperFactoryBean 从父类 SqlSessionDaoSupport 中继承下来的 setSqlSessionFactory() 方法，并使用 SqlSessionTemplate 对 sqlSessionFactory 进行加工生产 sqlSession（通过动态代理）
  •   public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    if (!this.externalSqlSession) {
      this.sqlSession = new SqlSessionTemplate(sqlSessionFactory);
    }
  }
  • MapperFactoryBean 实现了 InitializingBean 接口，则 bean 初始化时会调用此类的 afterPropertiesSet() 方法，此方法在其父类中。
public abstract class DaoSupport implements InitializingBean {
    @Override
	public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
		// Let abstract subclasses check their configuration.
		checkDaoConfig();

		// Let concrete implementations initialize themselves.
		try {
			initDao();
		}
		catch (Exception ex) {
			throw new BeanInitializationException("Initialization of DAO failed", ex);
		}
	}
}
  • checkDaoConfig() 方法在 DaoSupport 的子类 MapperFactoryBean 中实现。
public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
  @Override
  protected void checkDaoConfig() {
    super.checkDaoConfig(); // notNull(this.sqlSession, "Property 'sqlSessionFactory' or 'sqlSessionTemplate' are required");

    notNull(this.mapperInterface, "Property 'mapperInterface' is required");

    Configuration configuration = getSqlSession().getConfiguration();
    if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) {
      try {
        configuration.addMapper(this.mapperInterface);
      } catch (Exception e) {
        logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", e);
        throw new IllegalArgumentException(e);
      } finally {
        ErrorContext.instance().reset();
      }
    }
  }
}
  • getSession() 方法返回 this.sqlSession，getConfiguration() 返回 Configuration 对象
  • 再检查 Configuration 对象中是否已配置了 <property name="mapperInterface" value="com.qhf.dao.UserMapper"/> 此mapper 接口（因为手动配置，所以还是要检查。重点是 mybatis 中读取映射文件时解析到<mapper namespace="xxx.UserMapper">时会自动进行类型的注册）
  • 如果没有的话便会通过 configuration.addMapper(this.mapperInterface) 方法进行 mapper 接口的注册
  • 回到1中最后的问题：UserMapper userMapper = (UserMapper)context.getBean("userMapper"); 为什么能自动返回了 userMapper 对象？MapperFactoryBean 实现 FactoryBean 接口，重写了其接口方法来获取 mapper 对象。
public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {  
  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }
}

 

 

4.MapperScannerConfigurer

  • 同样是继承 InitializingBean，但是此方法没作用；重点在父接口 BeanDefinitionRegistryPostProcessor，BeanDefinitionRegistryPostProcessor实现了BeanFactoryPostProcessor接口，是Spring框架的BeanDefinitionRegistry的后处理器，用来注册额外的BeanDefinition。postProcessBeanDefinitionRegistry方法会在所有的BeanDefinition已经被加载了，但所有Bean还没有被创建前调用。BeanDefinitionRegistryPostProcessor经常被用来注册BeanFactoryPostProcessor的BeanDefinition。MapperScannerConfigurer 重写了其 postProcessBeanDefinitionRegistry() 方法。
public class MapperScannerConfigurer implements BeanDefinitionRegistryPostProcessor, InitializingBean, ApplicationContextAware, BeanNameAware {
  @Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) {
    if (this.processPropertyPlaceHolders) {
      processPropertyPlaceHolders();
    }

    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
    scanner.setAddToConfig(this.addToConfig);
    scanner.setAnnotationClass(this.annotationClass);
    scanner.setMarkerInterface(this.markerInterface);
    scanner.setSqlSessionFactory(this.sqlSessionFactory);
    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
    scanner.setResourceLoader(this.applicationContext);
    scanner.setBeanNameGenerator(this.nameGenerator);
    scanner.registerFilters();
    scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));
  }
}
  • 后续加上

 

 

 

 

 

琴无续弦
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring整合mybatis源码分析
Jeff的专栏
03-26 449
在解析源码之前，我们需要知道Mybatis如何独立使用简历POJOpublic class User(){    private String name;    private String age;    //省略set get}建立Mapperpublic Integerface UserMapper{    public void insertUser(User user);    publ...
Mybatis整合Spring源码分析
业精于勤，荒于嬉
12-17 495
一、整合配置 POM <!-- mybatis框架 --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.5.3</version> </dependency> <!--mybatis-spring适配器 --> <dependency&gt
MyBatis Spring整合源码解析
qq_37001674的博客
03-20 360
MapperScan源码分析？mapperScan如何生效的？ 在项目中大多数用的都是@MapperScan注解，指定basePackages，扫描mybatis Mapper接口类,另外一种方式是用@Mapper注解，其实这两种方法扫描配置用的是一个地方，只是扫描入口不同。 @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TY...
Spring源码分析总结——Mybatis的整合
可爱滴老唐
03-11 379
该文章基于《Spring源码深度解析》撰写，感谢郝佳老师的奉献 Mybatis与Spring整合 和之前分析的步骤相同，我们先从工厂方法开始分析，对于Mybatis整合的工厂类就是org.mybatis.Spring.SqlSessionFactoryBean 其中有两个值得一提的接口，就是 InitializingBean接口：实现此接口的bean会在初始化时调用器afterProp...
spring与mybatis整合源码分析
duzm200542901104的专栏
12-27 785
1、先spring的看配置文件： bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> property name="mapperLocations" value="classpath*:mybatis/mapper/*Mapper.xml">property> property
Spring整合Mybatis与SpringBoot整合Mybatis原理分析
04-16
**Spring整合Mybatis原理分析** 在Java Web开发中，Spring框架以其强大的依赖注入和面向切面编程能力，成为了事实上的核心框架。Mybatis则是一个轻量级的持久层框架，它简化了数据库操作，提供了直观的SQL映射。将...
MyBatis源码分析.pdf
05-23
MyBatis源码分析 MyBatis是一款流行的Java持久层框架，提供了强大的数据库访问能力，本文将对MyBatis的源码进行深入分析，从而帮助读者更好地理解MyBatis的工作机理。 1. MyBatis入门 MyBatis是一款基于Java的...
Spring与MyBatis整合源码
06-25
4. **Spring2MyBatis源码分析**：这个源码应该包含了整合Spring和MyBatis的完整示例，包括配置文件（如`applicationContext.xml`）、Mapper接口及对应的XML映射文件、Service层的实现以及可能的Controller层代码。...
Spring整合Mybatis源码解析
08-31
Spring整合Mybatis源码解析
Spring Boot+Mybatis图书管理系统源码.zip
05-28
《Spring Boot+Mybatis图书...这个图书管理系统展示了Spring Boot和Mybatis在实际项目中的应用，通过学习和理解这个源码，开发者可以提升对Spring Boot集成Mybatis的实践能力，以及在Web应用开发中的整体架构设计能力。
Spring源码深度解析之spring整合mybatis原理分析（上）
qq_22685435的博客
03-23 725
spring整合mybatis原理分析
properties标签typeAliases标签和package标签讲解--及前文补充
最新发布
weixin_65449886的博客
01-28 820
- package标签是用于指定dao接口所在的包,当指定了之后就不需要在写mapper以及resource或者class了 -->-- 用于指定要配置别名的包，当指定之后，该包下的实体类都会注册别名，并且类名就是别名，不再区分大小写-->--使用typeAliases配置别名，它只能配置domain中类的别名 -->--指定映射配置文件的位置，映射配置文件指的是每个dao独立的配置文件-->--配置事务的类型-->-- 数据库连接池-->--配置 的环境-->--mybatis的主配置文件-->
Mybatis源码分析(七)：配置属性typeAliases和typeAliasesPackage
公众号-老炮说Java
03-06 890
一.typeAliasesPackage源码分析1. spring中的配置<bean id="sqlSessionFactory" class="org.m...
spring_mybatis整合
zhouzhou_98的博客
12-26 127
  在idea上的效果： 具体文件组成：   applicationContext.xml &lt;?xml version="1.0" encoding="UTF-8"?&gt; &lt;beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.springfram...
Mybatis整合Spring -- typeAliasesPackage
热门推荐
爬虫 的博客
07-01 8万+
Mybatis整合SpringintegrationMapperScannerConfigurer  Mybatis整合Spring        根据官方的说法，在ibatis3，也就是Mybatis3问世之前，Spring3的开发工作就已经完成了，所以Spring3中还是没有对Mybatis3的支持。因此由Mybatis社区自己开发了一个Mybatis-Spring用来满足Myba
properties、typeAliases、package标签使用细节
技术积累，技术分享
01-05 432
properties标签的使用细节 我们的properties还可以这样配置 把它配置在configuration根标签下的properties里面，然后dataSource里面的property的value使用${外面的property的name}的方式来进行配置，，，，但是很显然如果这么配置纯属吃饱了撑的，那么它的存在时为了什么呢？ 那是因为properties标签不仅可以通过内部直接使用property配置数据库连接的信息，还有很重要的一点就是可以通过resource这个属性引用外部配置文件信息 配
配置多个 type-aliases-package 的问题
小道仙的后宫
09-09 3万+
一般我们最少有两类实体，一个pojo 一个vo。这个时候我们就需要配置多个type-aliases-package 但是就我测试来看，好像并不可以写多个type-aliases-package。但是我们还是需要扫描多个包可以这样做 配置好了，我们在mapper 里面就看简写了。 eg ...
<property name="typeAliasesPackage" value="cn.itcast.core.bean"/>的作用
i晨i曦520
08-01 8808
设置这个 那么在Mapper文件里面就可以直接写对应的类名 而不用写全路径名了
properties,typeAliases,package三个标签使用以及细节
马某人的博客
03-12 1213
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值