SpringBoot集成MySQL - MyBatis-Plus方式

SpringBoot集成MySQL - MyBatis-Plus方式

MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。MyBatis-Plus 在国内也有很多的用户,本文主要介绍 MyBatis-Plus 和 SpringBoot 的集成。

数据准备

在 MySQL 数据库中创建一个 springbootdata 数据库

创建一张 User 表,其表结构如下:

id name age email
1 Jone 18 test1@baomidou.com
2 Jack 20 test2@baomidou.com
3 Tom 28 test3@baomidou.com
4 Sandy 21 test4@baomidou.com
5 Billie 24 test5@baomidou.com

其对应的数据库 Schema 脚本如下:

DROP TABLE IF EXISTS user;

CREATE TABLE user
(
    id BIGINT(20) NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

其对应的数据库 Data 脚本如下:

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

在 iDEA 中创建工程

使用 Spring Initializer 快速初始化,添加下图的依赖:

将 pom.xml 中原有的 MyBatis 改成:

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.1</version>
</dependency>

编写配置

application.properties 配置文件中添加 MySQL 的相关配置

# MySQL Configuration
spring.datasource.url=jdbc:mysql://localhost:3306/springbootdata?serverTimezone=UTC
spring.datasource.username=root
spring.datasource.password=root#admin

编码

创建一个实体类软件包 com.syuez.mybatisplus.entity

编写实体类 User.java(此处使用了 Lombok 简化代码)

@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

创建一个 Mapper 包 com.syuez.mybatisplus.mapper

编写 Mapper 包下的 UserMapper接口

public interface UserMapper extends BaseMapper<User> {

}

在 Spring Boot 启动类中添加 @MapperScan 注解,扫描 Mapper 文件夹

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.syuez.mybatisplus.mapper")
public class MybatisPlusApplication {

    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }
}

测试

添加测试类,进行功能测试:

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

import com.syuez.mybatisplus.Entity.User;
import com.syuez.mybatisplus.Mapper.UserMapper;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        List<User> userList = userMapper.selectList(null);
        assertEquals(5, userList.size());
        userList.forEach(System.out::println);
    }
}

测试成功:

但是有个小问题,在 iDEA中, userMapper 使用 @Autowired 注解会提示"无法自动装配,找不到 UserMapper 类型的 Bean"。

这是因为 MyBatis 自己处理了 Mapper Bean 的生成。

  1. MyBatis 根据 @MapperScan 的包路径找到所有符合条件的 Mapper
  2. 获取 Spring Bean 管理方面的 Bean,通过代码直接把 Mapper 注入进去
  3. 这时候 Autowired 就能够使用了

至于为什么 Autowired 报错,这是因为 IDEA 没有处理 @MapperScan 这个注解,没有去扫描 mapper 是否是一个合格的 bean。

可以使用 @Resource 替换 @Autowired 解决,@Autowired与@Resource的区别:

  1. @Autowired与@Resource都可以用来装配bean. 都可以写在字段上,或写在setter方法上。
  2. @Autowired默认按类型装配(这个注解是属业spring的),默认情况下必须要求依赖对象必须存在,如果要允许null值,可以设置它的required属性为false,如:@Autowired(required=false)
  3. @Resource 是JDK1.6支持的注解,默认按照名称进行装配。名称可以通过name属性进行指定,如果没有指定name属性,当注解写在字段上时,默认取字段名,按照名称查找。如果注解写在setter方法上默认取属性名进行装配,当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是,如果name属性一旦指定,就只会按照名称进行装配。

参考资料:

SpringBoot集成MySQL - MyBatis-Plus方式 | Java 全栈知识体系 (pdai.tech)

springboot整合mybatis mapper注入时报错could not autowire,几种解决方案 - 掘金 (juejin.cn)

2021.1 版 IDEA 使用 @MapperScan ,出现 Could not autowire - SegmentFault 思否

Java开发中用到的,lombok是什么? - 知乎 (zhihu.com)

快速开始 | MyBatis-Plus (baomidou.com)