Spring Boot整合Mybatis(注解方式和XML方式)

时间：2023-03-09 09:16:20
Spring Boot整合Mybatis(注解方式和XML方式)

其实对我个人而言还是不够熟悉JPA、hibernate，所以觉得这两种框架使用起来好麻烦啊。

一直用的Mybatis作为持久层框架，

JPA(Hibernate)主张所有的SQL都用Java代码生成，

而Mybatis则更主张用原生SQL。

准备

#引入依赖

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>

配置参数

修改application.yml:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/database_name?characterEncoding=utf-8//有的电脑需要加入时区参数zone不然会报错
    username: root
    password: root
    driver-class-name: com.mysql.cj.jdbc.Driver

初始化数据库

-- create database springboot_mybatis charset utf8;

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `username` varchar(255) DEFAULT NULL COMMENT '用户名',
  `password` varchar(255) DEFAULT NULL COMMENT '密码',
  `create_time` datetime DEFAULT NULL COMMENT '创建日期',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8;

注解版

Mybatis提供了一些注解实现快速CRUD，比如：@Select,@Update,@Insert,@Delete

相信你在看这篇文章之前已经用过Mybatis了（比如之前的SSM开发），

所以呢，使用注解方式按照XML方式的SQL写法就好。

写在前面之前在SSM开发时，

会在MapperScannerConfigurer中配置：

<property name="basePackage" value="xxx.mapper"/>用于使用Mybatis的接口代理开发模式（且接口和XML需要名称相同）。

那么在SpringBoot整合Mybatis中也要有对应的配置：

方式一：在每个interface Mapper前添加@Mapper注解

方式二：在Application.java启动类前添加@MapperScan("mapper所在的包名")注解

增删改查操作如下：

创建Entity /entity/User.java

@Data
@ToString
public class User implements Serializable {
    private Long id;
    private String username;
    private String password;
    private Date createTime;
//用lombok插件注解不用再写getter和setter
}
   创建interface /mapper/UserMapperAno.java
public interface UserMapperAno {

    @Select("select * from user")
    @Results({
            @Result(property = "createTime", column = "create_time")
    })
    List<User> findAll();

    @Select("select * from user where id = #{id}")
    @Results({
            @Result(property = "createTime", column = "create_time")
    })
    User findById(Long id);

    @Insert("insert into user(username,password,create_time) values(#{username},#{password},#{createTime})")
    void save(User user);

    @Update("update user set username=#{username},password=#{password} where id=#{id}")
    void update(User user);

    @Delete("delete from user where id=#{id}")
    void delete(Long id);
}

其中@Result注解用于修饰返回结果集，若Entity和数据表字段不一致可以用其修饰

测试

创建测试类 /mapper/UserMapperAnoTest.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
@SpringBootTest
@RunWith(SpringRunner.class)
public class UserMapperAnoTest {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testFindAll() {
        List<User> list = userMapper.findAll();
        list.forEach(user -> {
            logger.info("user={}", user);
        });
    }

    @Test
    public void testFindById(){
        logger.info("user={}", userMapper.findById(1L));
    }

    @Test
    public void testSave(){
        User user = new User();
        user.setUsername("测试");
        user.setPassword("123");
        user.setCreateTime(new Date());
        userMapper.save(user);
        testFindAll();
    }

    @Test
    public void testUpdate() {
        User user = new User();
        user.setId(4L);
        user.setUsername("测试呀");
        userMapper.update(user);
        testFindAll();
    }

    @Test
    public void delete() {
        userMapper.delete(3L);
        testFindAll();
    }
}

小结

以上是常用CRUD操作的Mybatis注解版实现，对于基本的操作，使用注解确实比传统的XML简单好多，虽然也是SQL写在注解中，但是感觉比JPA的方式要简便一些（个人理解）。

XML版

使用Mybatis的XML开发方式应该是我们比较熟悉的，和注解版最大的不同就是Dao层，XML版会自动根据Dao层接口的方法名自动映射到XML中同名id对应的SQL。

修改application.yml

添加如下Mybatis配置属性

1
2
3
4
5
6
7
8
9
 
#mybatis配置
mybatis:
  mapper-locations: classpath:mapper/**/*.xml
  type-aliases-package: cn.tycoding.entity
  configuration:
    # 使用jdbc的getGeneratedKeys 可以获取数据库自增主键值
    use-generated-keys: true
    # 开启驼峰命名转换，如：Table(create_time) -> Entity(createTime)。不需要我们关心怎么进行字段匹配，mybatis会自动识别`大写字母与下划线`
    map-underscore-to-camel-case: true

CRUD

创建interface UserMapperXML.java

1
2
3
4
5
6
7
8
9
10
11
12
 
public interface UserMapperXML {

    List<User> findAll();

    User findById(Long id);

    void save(User user);

    void update(User user);

    void delete(Long id);
}

在resources/下创建/mapper/UserMapperXML.xml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
<?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="cn.tycoding.mapper.UserMapperXML">

    <select id="findAll" resultType="cn.tycoding.entity.User">
        select * from user
    </select>

    <select id="findById" resultType="cn.tycoding.entity.User">
        select * from user where id = #{id}
    </select>

    <insert id="save" parameterType="cn.tycoding.entity.User">
        insert into user(username,password,create_time) values(#{username},#{password},#{createTime}
    </insert>

    <update id="update" parameterType="cn.tycoding.entity.User">
        update user set username=#{username},password=#{password} where id=#{id}
    </update>

    <delete id="delete" parameterType="long">
        delete from user where id=#{id}
    </delete>

</mapper>

测试

创建测试类UserMapperXMLTest.java

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
@SpringBootTest
@RunWith(SpringRunner.class)
public class UserMapperXMLTest {
    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private UserMapperXML userMapperXML;

    @Test
    public void testFindAll() {
        List<User> list = userMapperXML.findAll();
        list.forEach(user -> {
            logger.info("user={}", user);
        });
    }

    @Test
    public void testFindById(){
        logger.info("user={}", userMapperXML.findById(1L));
    }

    @Test
    public void testSave(){
        User user = new User();
        user.setUsername("测试");
        user.setPassword("123");
        user.setCreateTime(new Date());
        userMapperXML.save(user);
        testFindAll();
    }

    @Test
    public void testUpdate() {
        User user = new User();
        user.setId(4L);
        user.setUsername("测试呀");
        userMapperXML.update(user);
        testFindAll();
    }

    @Test
    public void delete() {
        userMapperXML.delete(3L);
        testFindAll();
    }
}

小结

练习了Mybatis注解版和XML版开发模式，更觉得两者配合使用最好，

简单的CRUD操作使用注解完全可以实现；

复杂的查询，比如Mybatis的动态SQL特性在注解中应该很难体现，而在XML中就很容易实现了。

相关文章