13. Mybatis 整合Spring boot 2

绝地灬酷狼 2024-04-17 14:58 85阅读 0赞

SpringBoot 框架是目前java 领域最火的框架之一, Mybatis 也提供了与它整合的子项目. 项目地址: https://github.com/mybatis/spring-boot-starter

## 1. 整合核心配置 ##

### 1.1 引入依赖 ###

*  引入Mybatis提供了与springboot 整合的适配器包
 *  引入Mybatis的核心包, 虽然适配器包会级联引入Mybatis包, 但是笔者还是习惯于单独引入, 指定其版本号
 *  引入Mybatis分页插件包, 此插件包并非官方提供的

<dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.0.1</version>
    </dependency>
    
    
    <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>${mybatis.version}</version>
    </dependency>
    
     
    <dependency>
        <groupId>com.github.miemiedev</groupId>
        <artifactId>mybatis-paginator</artifactId>
        <version>1.2.17</version>
    </dependency>

### 1.2 配置 ###

*  Mybatis 提供的与springboot 整合的插件中, 支持直接在application.yml 文件中进行配置
 *  application.yml 中支持很多配置,但笔者只习惯于配置以下三个属性
    
     *  指定Mybatis 核心配置文件, 插件等核心配置可在Mybatis核心配置文件中配置
     *  指定sql映射文件, 支持通配符,可解决Mybatis原生不支持sql映射文件的弊端
     *  指定包的别名, 将为该包及其子包下的所有类创建别名, 别名默认为类简单名称首字母小写. 需要注意的是不同包下相同类名会导致别名冲突, 可使用@Alias 解决冲突

mybatis:
      config-location: classpath:config/mybatis-config.xml
      mapper-locations: classpath:mappers/*Mapper.xml
      type-aliases-package: org.zongf.learn.mybatis3.sboot.pojo

### 1.3 mybatis 核心配置 ###

*  由application.yml 文件中不支持所有Mybatis 的核心配置属性, 如自定义插件, 所以需要创建Mybatis核心配置文件
 *  笔者也习惯于创建Mybatis核心配置文件, 感觉这种配置会更清晰.

<?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>
        <plugins>
            
            <plugin interceptor="com.github.miemiedev.mybatis.paginator.OffsetLimitInterceptor">
                <property name="dialectClass" value="com.github.miemiedev.mybatis.paginator.dialect.MySQLDialect"/>
            </plugin>
        </plugins>
    </configuration>

### 1.4 Mapepr 接口 ###

mapper 接口需要使用@Mapper 注解修饰, 这样会在Spring 容器中创建一个实例.

@Mapper
    public interface EmployeeMapper { 
    }

## 2. 完整实例 ##

### 2.1 项目包结构 ###

对于项目包结构设计, 可谓是仁者见仁智者见智. 对于资源文件目录规划, 笔者习惯于使用这样的包结构:

*  config: 存放所有的配置文件, 如mybatis 核心配置文件
 *  mappers: mybatis 所有映射文件
 *  static: 静态资源文件
 *  template: 目标文件, html, ftl等

src/main/java
    
    src/main/resources:
        config: 
            mybatis-config.xml            
        mappers: 
            xxxMapper.xml               
        static:
            xxx.js
            xxx.css
        template:
            xxxx.html
        application.yml

### 2.2 spring boot 核心配置文件 ###

配置文件名: application.yml

server:
      port: 8081
    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/learn-mybatis3?serverTimezone=UTC&characterEncoding=utf8&useUnicode=true&useSSL=false
        username: root
        password: root
        driver-class-name: com.mysql.cj.jdbc.Driver
      mvc:
        view:
          prefix: /
          suffix: .html
      thymeleaf:
        cache: false
        prefix: classpath:/templates
      servlet:
        multipart:
          max-file-size: 10MB
          max-request-size: 100MB
      resources:
        static-locations: ["classpath:/static/"]
    mybatis:
      config-location: classpath:config/mybatis-config.xml
      mapper-locations: classpath:mappers/*Mapper.xml
      type-aliases-package: org.zongf.learn.mybatis3.sboot.pojo

### 2.3 Mybatis 核心配置文件 ###

配置文件名: mybatis-config.xml

### 2.4 sql映射文件 ###

<?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="org.zongf.learn.mybatis3.sboot.mapper.EmployeeMapper">
    
        
        <sql id="columns_all">
            id, name, sex, age, entryDate
        </sql>
    
        
        <insert id="save" useGeneratedKeys="true" keyProperty="id">
            insert into t_employee(<include refid="columns_all" />)
            values (null, #{name}, #{sex}, #{age}, #{entryDate})
        </insert>
    
        
        <delete id="delete">
            delete from t_employee where id = #{id}
        </delete>
    
        
        <update id="update">
            update t_employee
            set id = #{id}, name = #{name}, sex=#{sex}, entryDate =#{entryDate}
            where id = #{id}
        </update>
    
        
        <select id="findById" resultType="EmployeePO" >
            select <include refid="columns_all" />
            from t_employee
            where id = #{id}
        </select>
    
        
        <select id="queryByPager" resultType="EmployeePO">
            select <include refid="columns_all" />
            from t_employee emp
        </select>
    
        
        <delete id="clear">
            truncate table t_employee
        </delete>
    </mapper>

### 2.5 mapper 接口 ###

接口需要使用@Mapper 修饰

@Mapper
    public interface EmployeeMapper { 
    
        // 保存
        boolean save(EmployeePO employeePO);
    
        // 删除
        boolean delete(Long id);
    
        // 修改
        long update(EmployeePO employeePO);
    
        // 通过id查询
        EmployeePO findById(Long id);
    
        // 分页查询
        PageList<EmployeePO> queryByPager(PageBounds pageBounds);
    
        // 清空表
        void clear();
    }

### 2.6 数据库实体类PO ###

public class EmployeePO implements Serializable { 
    
        private static final long serialVersionUID = -2164461308545729638L;
    
        private Long id;
    
        private String name;
    
        private Integer age;
    
        private String sex;
    
        private LocalDate entryDate;
        
        // 省略setter/getter 
    }

### 2.7 建表sql ###

CREATE TABLE `t_employee` (
      `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键ID, 自增',
      `name` varchar(120) DEFAULT NULL COMMENT '姓名',
      `sex` varchar(45) DEFAULT NULL COMMENT '性别',
      `age` int(11) DEFAULT NULL COMMENT '年龄',
      `entryDate` dateDEFAULT NULL COMMENT '入职日期',
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

## 3. 项目测试 ##

*  springboot 在启动时, 会扫描所有@Maper 修饰的类, 并向spring 容器中注册实例. 所以可以通过自动注入直接获取Mapper 对象
 *  springboot 在启动时, 会自动向spring 容器中注入一个sqlSession 实例, 所以可以直接获取SqlSession 对象进行操作

### 3.1 自动注入Mapper ###

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class EmployeeMapperTest { 
    
        @Autowired
        private EmployeeMapper employeeMapper;
    
        // 清空表
        @Test
        public void clear(){ 
            this.employeeMapper.clear();
        }
    
        // 测试保存方法
        @Test
        public void save(){ 
    
            for (int i = 1; i <= 10; i++) { 
                EmployeePO employeePO = new EmployeePO("lisa_" + i, 20, "W", LocalDate.of(2018, 05, i));
    
                boolean flag = employeeMapper.save(employeePO);
    
                // 校验是否保存成功
                Assert.assertEquals(true, flag);
    
                // 校验是否回填id
                Assert.assertNotNull(employeePO.getId());
            }
        }
    
        // 测试删除方法
        @Test
        public void delete(){ 
            boolean flag = employeeMapper.delete(9L);
            Assert.assertEquals(true, flag);
        }
    
        // 测试查询方法
        @Test
        public void findById(){ 
            EmployeePO employeePO = employeeMapper.findById(1L);
            Assert.assertNotNull(employeePO);
        }
    
        // 测试更新方法
        @Test
        public void update(){ 
    
            EmployeePO employeePO = employeeMapper.findById(1L);
    
            employeePO.setName(employeePO.getId() + "_" + employeePO.getName());
    
            long flag = employeeMapper.update(employeePO);
    
            Assert.assertEquals(1L, flag);
        }
    
        // 测试分页查询
        @Test
        public void queryByPager(){ 
    
            // 设置分页页码和每页条数
            PageBounds pageBounds = new PageBounds(1, 5);
    
            // 分页查询
            PageList<EmployeePO> pager = this.employeeMapper.queryByPager(pageBounds);
    
            // 获取分页器
            Paginator paginator = pager.getPaginator();
    
            Assert.assertEquals(2, paginator.getTotalPages());
            Assert.assertEquals(5, pager.size());
        }
    }

### 2.2 使用SqlSession ###

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class SqlSessionTest { 
    
        @Autowired
        private SqlSession sqlSession;
    
    
        @Test
        public void test(){ 
            EmployeePO employeePO = sqlSession.selectOne("org.zongf.learn.mybatis3.sboot.mapper.EmployeeMapper.findById", 1);
            Assert.assertNotNull(employeePO);
        }
    
        @Test
        public void test2(){ 
            EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class);
    
            EmployeePO employeePO = mapper.findById(1L);
    
            Assert.assertNotNull(employeePO);
        }
    }