MyBatisPlus初使用

一、引言

今天来写一下在项目中使用MybatisPlus，还是有点小坑的，本来参考官网的官方示例。如果Mybatis用的不是很熟，还是建议不要使用MybatisPlus。

MybatisPlus官网：http://mp.baomidou.com/guide/quick-start.html

二、MybatisPlus使用准备

在使用MybatisPlus之前，需要创建好测试的数据库：mybatis_plus

1、创建并初始化数据库

数据库 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)
);

数据脚本如下：

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');

这样就在Mqsql中，创建了一个mybatis_plus数据库，库中有张user表。

三、创建 SpringBoot 工程

使用 IDEA 快速初始化一个 Spring Boot 工程，版本使用：2.2.1.RELEASE

1、添加项目依赖

在项目中使用Lombok可以减少很多重复代码的书写，不懂可以参考下文。

Lombok介绍

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>org.junit.vintage</groupId>
                <artifactId>junit-vintage-engine</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

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

    <!--mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <!--lombok用来简化实体类-->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

注意：引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

2、idea中安装lombok插件

3、application.properties配置文件

在 application.properties 配置文件中添加 MySQL 数据库的相关配置，注意此处mysql5 和mysql8 有点不一样。

（1）、mysql5

# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=123456

（2）、mysql8以上（spring boot 2.1）

// 注意：driver和url的变化
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

注意：

1、Mysql 8中的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了Mysql 8.0版本的 jdbc 驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is
unrecognized or represents more

2、Mysql 8中的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息。

4、编写代码

（1）、编写主启动类

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 接口文件夹，
注意：扫描的包名根据自己项目情况修改

@SpringBootApplication
@MapperScan("com.scorpios.mybatisplus.mapper")
public class MybatisPlusApplication {
     public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication .class,args);
    }
}

（2）、编写实体

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

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

（3）、mapper接口文件

创建包 mapper 编写Mapper 接口：UserMapper.java

public interface UserMapper extends BaseMapper<User> {
    
}

5、测试

添加测试类，进行功能测试：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MybatisPlusApplicationTests {
​
    @Autowired
    private UserMapper userMapper;
​
    @Test
    public void testSelectList() {
        System.out.println(("--- selectAll method test ---"));
        // UserMapper 中的 selectList() 方法的参数为 MP 内置
        // 的条件封装器 Wrapper, 所以不填写就是无任何条件
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }
}

注意：

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行，为了避免报错，可以在 dao 层 的接口上添加 @Repository 注解。

控制台输出：

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

通过以上几个简单的步骤，就可以实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写

6、配置sql输出日志

如果想查看每次sql具体的输出日志，可以在配置文件中加入如下配置：

# mybatis日志
mybatis-plus.configuration.log-impl =
org.apache.ibatis.logging.stdout.StdOutImpl