MyBatis整合SpringBoot-2.2.2 源码学习

已于 2024-02-29 23:21:27 修改
阅读量391 收藏 8
点赞数 3
分类专栏： 一、源码 文章标签： java mybatis springboot
于 2024-02-21 21:48:03 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_51140510/article/details/136221317
版权
本文详细介绍了如何在SpringBoot项目中通过GITEE仓库搭建Mybatis环境，包括创建Maven工程、配置数据库连接、实体类、mapper接口、XML映射文件，以及MybatisAutoConfiguration在整合过程中的作用。
摘要由CSDN通过智能技术生成

持续更新…

一、环境搭建

1、仓库地址

GITEE仓库地址

2、搭建步骤

准备工作：IDEA-2021、maven-3.3.9、JDK-8

①、pom.xml

创建普通的 maven 工程，修改 pom.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.micozone</groupId>
    <artifactId>mybatis-spring-boot-starter-2.2.2</artifactId>
    <version>1.0.0</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <!--Spring Web 依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.7.7</version>
        </dependency>

        <!--mybatis 整合 springboot 依赖-->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.2</version>
        </dependency>

        <!--mysql 驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.28</version>
        </dependency>

    </dependencies>

    <build>
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
        </resources>
    </build>

</project>

②、建表、entity、mapper

建库：mybatis，建表：mybatis_table

CREATE TABLE `mybatis_table` (
  `id` bigint NOT NULL AUTO_INCREMENT COMMENT '主键',
  `user_name` varchar(100) DEFAULT NULL,
  `user_age` int DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

MybatisTable 类

package com.micozone.mybatis.entity;

import lombok.Data;

@Data
public class MybatisTable {
    private Long id;
    private String userName;
    private int userAge;
}

MybatisTableMapper 接口

package com.micozone.mybatis.mapper;

public interface MybatisTableMapper {

    @Select("select id,user_name as userName,user_age as userAge from mybatis_table where id = #{arg0} and user_name = #{arg1}")
    MybatisTable selectByIdAndName(Long id, String userName);
    
}

MybatisTableMapper.xml

<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="com.micozone.mybatis.mapper.MybatisTableMapper">

    <resultMap id="baseResultMap" type="mybatisTable">
        <id property="id" column="id" jdbcType="BIGINT"/>
        <result property="userName" column="user_name" jdbcType="VARCHAR"/>
        <result property="userAge" column="user_age" jdbcType="INTEGER"/>
    </resultMap>

    <sql id="Base_Column_List">
        id,user_name,user_age
    </sql>

</mapper>

③、项目配置文件

application.yml

mybatis:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  type-aliases-package: com.micozone.entity

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: password
    url: jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8

④、启动类

App 类

@MapperScan(basePackages = "com.micozone.mapper")
@SpringBootApplication
public class App {

    public static void main(String[] args) {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(App.class, args);
        MybatisTableMapper mapperProxy = applicationContext.getBean(MybatisTableMapper.class);
        System.out.println(mapperProxy.selectByIdAndName(1L, "micozone"));
    }
}

二、MybatisAutoConfiguration

由第一步环境搭建可知，最简单的 Mybatis 整合 SpringBoot 的使用，只需要添加两个依赖即可，既 MyBatis 整合 SpringBoot 的依赖，以及 MySQL 驱动，而 MyBatis 整合 SpringBoot 依赖，主要有三个内部依赖构成，分别为：redis、mybatis-spring、mybatis-spring-boot-autoconfigure。我们在分析 mybatis 整合 spring 的内容时，强调过只需要注入两个 Bean：SqlSessionFactory、SqlSessionTemplate 即可使用 mybatis，其中 SqlSessionTemplate 底层也是 DefaultSqlSession，而 mybatis-spring-boot-autoconfigure 包中有一个类：MybatisAutoConfiguration，该类会自动注入 SqlSessionFactory 和 SqlSessionTemplate。
其中 MybatisAutoConfiguration 还包含注解：@EnableConfigurationProperties(MybatisProperties.class) 通过该注解，我们就可以在 application.yml 文件中配置 mybatis. 开头的内容。
MybatisAutoConfiguration 类

package org.mybatis.spring.boot.autoconfigure;

@org.springframework.context.annotation.Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnSingleCandidate(DataSource.class)
/*
* 一、@EnableConfigurationProperties(MybatisProperties.class)
* 
*/
@EnableConfigurationProperties(MybatisProperties.class)
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean {

  private final MybatisProperties properties;
  private final Interceptor[] interceptors;
  ...

  /*
  * 二、SqlSessionFactory 
  */
  @Bean
  @ConditionalOnMissingBean
  public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
    factory.setDataSource(dataSource);
    factory.setVfs(SpringBootVFS.class);
    if (StringUtils.hasText(this.properties.getConfigLocation())) {
      factory.setConfigLocation(this.resourceLoader.getResource(this.properties.getConfigLocation()));
    }
    applyConfiguration(factory);
    if (this.properties.getConfigurationProperties() != null) {
      factory.setConfigurationProperties(this.properties.getConfigurationProperties());
    }
    if (!ObjectUtils.isEmpty(this.interceptors)) {
      factory.setPlugins(this.interceptors);
    }
    if (this.databaseIdProvider != null) {
      factory.setDatabaseIdProvider(this.databaseIdProvider);
    }
    if (StringUtils.hasLength(this.properties.getTypeAliasesPackage())) {
      factory.setTypeAliasesPackage(this.properties.getTypeAliasesPackage());
    }
    if (this.properties.getTypeAliasesSuperType() != null) {
      factory.setTypeAliasesSuperType(this.properties.getTypeAliasesSuperType());
    }
    if (StringUtils.hasLength(this.properties.getTypeHandlersPackage())) {
      factory.setTypeHandlersPackage(this.properties.getTypeHandlersPackage());
    }
    if (!ObjectUtils.isEmpty(this.typeHandlers)) {
      factory.setTypeHandlers(this.typeHandlers);
    }
    if (!ObjectUtils.isEmpty(this.properties.resolveMapperLocations())) {
      factory.setMapperLocations(this.properties.resolveMapperLocations());
    }
    Set<String> factoryPropertyNames = Stream
        .of(new BeanWrapperImpl(SqlSessionFactoryBean.class).getPropertyDescriptors()).map(PropertyDescriptor::getName)
        .collect(Collectors.toSet());
    Class<? extends LanguageDriver> defaultLanguageDriver = this.properties.getDefaultScriptingLanguageDriver();
    if (factoryPropertyNames.contains("scriptingLanguageDrivers") && !ObjectUtils.isEmpty(this.languageDrivers)) {
      // Need to mybatis-spring 2.0.2+
      factory.setScriptingLanguageDrivers(this.languageDrivers);
      if (defaultLanguageDriver == null && this.languageDrivers.length == 1) {
        defaultLanguageDriver = this.languageDrivers[0].getClass();
      }
    }
    if (factoryPropertyNames.contains("defaultScriptingLanguageDriver")) {
      // Need to mybatis-spring 2.0.2+
      factory.setDefaultScriptingLanguageDriver(defaultLanguageDriver);
    }
    applySqlSessionFactoryBeanCustomizers(factory);
    return factory.getObject();
  }

  /*
  * 三、SqlSessionTemplate 
  */
  @Bean
  @ConditionalOnMissingBean
  public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) {
    ExecutorType executorType = this.properties.getExecutorType();
    if (executorType != null) {
      return new SqlSessionTemplate(sqlSessionFactory, executorType);
    } else {
      return new SqlSessionTemplate(sqlSessionFactory);
    }
  }


  public static class AutoConfiguredMapperScannerRegistrar
      implements BeanFactoryAware, EnvironmentAware, ImportBeanDefinitionRegistrar {

    private BeanFactory beanFactory;
    private Environment environment;

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {

      if (!AutoConfigurationPackages.has(this.beanFactory)) {
        logger.debug("Could not determine auto-configuration package, automatic mapper scanning disabled.");
        return;
      }

      logger.debug("Searching for mappers annotated with @Mapper");

      List<String> packages = AutoConfigurationPackages.get(this.beanFactory);
      if (logger.isDebugEnabled()) {
        packages.forEach(pkg -> logger.debug("Using auto-configuration base package '{}'", pkg));
      }

      BeanDefinitionBuilder builder = BeanDefinitionBuilder.genericBeanDefinition(MapperScannerConfigurer.class);
      builder.addPropertyValue("processPropertyPlaceHolders", true);
      builder.addPropertyValue("annotationClass", Mapper.class);
      builder.addPropertyValue("basePackage", StringUtils.collectionToCommaDelimitedString(packages));
      BeanWrapper beanWrapper = new BeanWrapperImpl(MapperScannerConfigurer.class);
      Set<String> propertyNames = Stream.of(beanWrapper.getPropertyDescriptors()).map(PropertyDescriptor::getName)
          .collect(Collectors.toSet());
      if (propertyNames.contains("lazyInitialization")) {
        // Need to mybatis-spring 2.0.2+
        builder.addPropertyValue("lazyInitialization", "${mybatis.lazy-initialization:false}");
      }
      if (propertyNames.contains("defaultScope")) {
        // Need to mybatis-spring 2.0.6+
        builder.addPropertyValue("defaultScope", "${mybatis.mapper-default-scope:}");
      }

      // for spring-native
      boolean injectSqlSession = environment.getProperty("mybatis.inject-sql-session-on-mapper-scan", Boolean.class,
          Boolean.TRUE);
      if (injectSqlSession && this.beanFactory instanceof ListableBeanFactory) {
        ListableBeanFactory listableBeanFactory = (ListableBeanFactory) this.beanFactory;
        Optional<String> sqlSessionTemplateBeanName = Optional
            .ofNullable(getBeanNameForType(SqlSessionTemplate.class, listableBeanFactory));
        Optional<String> sqlSessionFactoryBeanName = Optional
            .ofNullable(getBeanNameForType(SqlSessionFactory.class, listableBeanFactory));
        if (sqlSessionTemplateBeanName.isPresent() || !sqlSessionFactoryBeanName.isPresent()) {
          builder.addPropertyValue("sqlSessionTemplateBeanName",
              sqlSessionTemplateBeanName.orElse("sqlSessionTemplate"));
        } else {
          builder.addPropertyValue("sqlSessionFactoryBeanName", sqlSessionFactoryBeanName.get());
        }
      }
      builder.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);

      registry.registerBeanDefinition(MapperScannerConfigurer.class.getName(), builder.getBeanDefinition());
    }

    @Override
    public void setBeanFactory(BeanFactory beanFactory) {
      this.beanFactory = beanFactory;
    }

    @Override
    public void setEnvironment(Environment environment) {
      this.environment = environment;
    }

    private String getBeanNameForType(Class<?> type, ListableBeanFactory factory) {
      String[] beanNames = factory.getBeanNamesForType(type);
      return beanNames.length > 0 ? beanNames[0] : null;
    }

  }

  @org.springframework.context.annotation.Configuration
  @Import(AutoConfiguredMapperScannerRegistrar.class)
  @ConditionalOnMissingBean({ MapperFactoryBean.class, MapperScannerConfigurer.class })
  public static class MapperScannerRegistrarNotFoundConfiguration implements InitializingBean {

    @Override
    public void afterPropertiesSet() {
      logger.debug(
          "Not found configuration for registering mapper bean using @MapperScan, MapperFactoryBean and MapperScannerConfigurer.");
    }

  }

}
MicoZone
关注
  • 3
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
springboot-mybatis-0.0.1-SNAPSHOT.jar
04-12
主要用来测试 docker部署springboot的jar包
Mybatis整合springboot原理分析，MybatisAutoConfiguration，AutoConfiguredMapperScannerRegistrar
LeoHan
07-11 3008
本章需要参考之前的两篇博客： Mybatis整合spring原理分析，SqlSessionFactoryBean，MapperScan，MapperScannerRegistrar，MapperScannerConfigurer springboot自动装配原理，底层源码分析，条件注解实现机制 从之前springboot自动装配原理，在资源目录下应该存在META-INF/spring.factories文件，查看mybatis-spring-boot-autoconfigure模块，其下该文件内容如下：
MyBatis 整合SpringBoot 启动源码分析
莫邪
03-22 286
MyBatis 启动源码分析 开启MyBatis 是通过@MapperScan @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE) @Documented @Import(MapperScannerRegistrar.class) @Repeatable(MapperScans.class) public @interface MapperScan { String[] value() default {}; String[]
SpringBoot环境下Mybatis映射器自动注册的原理
m0_71777195的博客
05-17 389
本篇主要讲了映射器自动注册的流程，以及调用映射器接口方法时涉及到的一些流程。我们也提到了一个很重要的概念：MappedStatement。映射文件中的每个sql映射语句都对应一个MappedStatement对象，而通过映射器接口的方法名，我们又能找到唯一的MappedStatement对象，进而执行最终的sql映射语句。
Mybatis2
qq_42980244的博客
08-09 598
目录 一、一对一映射 二、一对多映射 三、多对多 四、动态SQL拼接 1.if标签 2.where标签 3.choose\when\otherwise标签 4.set标签 5.foreach标签 五、批量操作 1.PLSQL块做批量插入（不能返回受影响行数） 2.使用虚表插入，能够返回受影响行数 3.批量删除、修改 六、Mybatis解决jdbc编程的问题 一、...
2021-03-25
weixin_53358262的博客
03-25 281
spring-boot-starter的自动配置原理啥是spring-boot-starter自动配置原理 啥是spring-boot-starter 在我个人看来statrter十分像一个容器，是spring-boot的一个特性 ，更像是spring-boot提供的diy工具。 两者相似之处有很多，但starter为我们提供了额外的功能： 尽可能的自动配置Spring和第三方库。例如：无论是在spring中集成mybatis框架使用或是单纯的使用mybatis框架。我们都少不了需要配置数据源，事务管理
MyBatis-Plus-Example:SpringBoot整合MyBatis-Plus，源码学习，增删改查，Lamdba支持
05-12
MyBatis-Plus-Example Spring Boot 整合 MyBatis Plus 实例，持续更新！！！ 代码生成器 三方框架版本总览 名称 版本 更新时间 Spring Boot 2.4.2 2021.02.02 MyBatis-Plus 3.4.2 2021.02.02 JavaLib 3.4.2 2021.02....
Java开发案例-springboot-01-整合MyBatis-Plus-源代码+文档.rar
最新发布
05-31
Java开发案例-springboot-01-整合MyBatis-Plus-源代码+文档.rar Java开发案例-springboot-01-整合MyBatis-Plus-源代码+文档.rar Java开发案例-springboot-01-整合MyBatis-Plus-源代码+文档.rar Java开发案例-...
spring-boot-starter-mybatis-spring-boot-2.2.2.zip
04-19
这里特别注意的是，版本号应与标题中的`spring-boot-starter-mybatis-spring-boot-2.2.2.zip`一致，以确保兼容性。 2. 配置MyBatis 在`application.properties`或`application.yml`中，我们需要配置数据源和MyBatis...
mybatis-plus-boot-starter-3.1.0.jar
04-13
mybatis-plus-boot-starter.jar 各个版本下载， SpringBoot 集成 MybatisPlus jar 包下载， Mybatis-Plus（简称MP）是一个基于MyBatis的增强工具库，它简化了与数据库的交互操作并提供了一系列增强功能，使开发者...
SpringBoot mybatis-starter解析
Box_clf的博客
04-01 527
主要是协助使用注解来配置SQL语句的。前缀的properties的配置生效。
SpringBoot SpringBoot 基础篇 2 SpringBoot 基础配置 2.2 属性配置
谢谢你们的关注
11-09 338
SpringBoot SpringBoot 基础篇 2 SpringBoot 基础配置 2.2 属性配置
SpringBoot2.7.4整合MyBatis2.2.2
qq_35160479的博客
10-25 1745
SpringBoot2.7.4整合MyBatis2.2.2
springboot源码解析（一）
qq_34548229的博客
01-03 537
springboot源码解析（一） 1、springboot的入口程序 @SpringBootApplication public class StartupApplication { public static void main(String[] args) { SpringApplication.run(StartupApplication.class, args)...
Spring Boot 2.2.2 启动全过程源码分析
wqlove520的博客
04-12 245
Spring Boot 2.2.2 启动全过程源码分析 SpringApplication 实例 run 方法运行过程 /** * 1、要完成Spring容器的启动 * 2、把项目部署到Tomcat */ public static void main(String[] args) { ConfigurableApplicationContext applicationContext =...
MyBatis-2
m0_58414041的博客
05-19 156
MyBatis 是一个优秀的持久层框架，它对 jdbc 的操作数据库的过程进行封装，使开发者只需要关注 SQL 本身，而不需要花费精力去处理例如注册驱动、创建 connection、创建 statement、手动设置参数、结果集检索等 jdbc繁杂的过程代码。
MybatisAutoConfiguration 分析
zhenghuangyu的博客
05-22 6726
MybatisAutoConfiguration 是spring boot 下 mybatis 默认的配置类，只要开启了注释了 @EnableAutoConfiguration 就可以了，spring boot 会默认执行。在spring boot 启动的过程中 @SpringBootApplication 中组合了 EnableAutoConfiguration ，属于spring boot 自...
2、SpringBoot2入门
希望有点用
10-24 206
SpringBoot2入门
2.2 mybatis配置篇-mybatis.xml配置详解
freshbar的博客
08-15 728
文章目录1 配置2 属性（properties）3 设置（settings）4 设置（typeAliases）5 类型处理器（typeHandlers）6 对象工厂objectFactory7 插件（plugins）该功能可以对sql执行的过程中进行拦截调用8 环境配置（environments）8.1 事务管理器（transactionManager）8.2 数据源（dataSource）9 databaseIdProvider（数据库厂商标识）10 映射器（mappers） 1 配置 configur
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

MicoZone

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值