快速上手 MyBatis-Plus 开发

快速上手 MyBatis-Plus 开发

1. MyBatis-Plus 概述

MyBatis Plus 是一款基于 MyBatis 数据持久化的国产开源框架，其核心功能就是简化 MyBatis 的开发，MyBatis-Plus 可以节省开发者大量的时间，所有的 CRUD 操作都可以自动化实现。

官方网站：https://baomidou.com/

1. 只做增强不做改变，引入它不会对现有工程产生影响；

2. 只需要简单配置，即可快速进行单表 CRUD 操作，从而节省大量时间；

3. 具有丰富的功能，代码生成、自动分页、逻辑删除、自动填充等功能一应俱全；

2. 快速入门

MyBatis-Plus (opens new window)(简称MP)是一个MyBatis (opens new window)的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。

MyBatis-Plus 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求。

我们将通过一个简单的 Demo 来引入 MyBatis-Plus 的强大功能。

初始化工程

1、创建一张 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 和 Data 脚本如下：

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

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

2、创建 SpringBoot 的空白项目，导入 MyBatis Plus 依赖；

说明：如果在【关系型数据库】中没有【MyBatis Plus Framework】这一选项，则需要手动地在 pom.xml 文件中引入 MyBatis Plus 的依赖。

<!-- springmvc -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- mybatis-plus 是自己开发的，并非官方的 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version>
</dependency>
<!-- mysql数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.46</version>
</dependency>
</dependency>
<!-- lombok -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

3、在 application.yml 中配置数据源；

spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost/user?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456

4、传统方式：Entity → Repository[连接 mybatis，配置 mapper.xml 文件] → service → controller，使用了 mybatis-plus 之后

实体类 Entity-User

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor

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

持久层 mapper 接口

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.trainingl.entity.User;
import org.springframework.stereotype.Repository;

// 在对应的Mapper上面继承基本的类 BaseMapper
@Repository  //持久层注解
public interface UserMapper extends BaseMapper<User> {
    //所有的CRUD操作都已经编写好了
    //你不需要像MyBatis时那样配置一大堆文件
}

注意：这里省略了 Service 层和 Controller 层，直接进行 MyBatis-Plus 框架的测试。

5、需要在主启动类上去扫描 repository 包下所有的接口；

@SpringBootApplication
//扫描 com.trainingl.repository 包下的所有接口并启动时完成自动注入
@MapperScan("com.trainingl.repository")
public class MybatisPlusApplication {

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

}

6、在测试类中进行测试

@SpringBootTest
class MybatisPlusApplicationTests {
    //继承了BaseMapper，所有的方法都来自于父类
    //我们也可以编写自己的扩展方法
    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads() {
        //参数是一个 wrapper，条件构造器，这里我们查询所有用户
        List<User> users = userMapper.selectList(null);
        for (User user:users) {
            System.out.println(user);
        }
    }

}

7、控制台打印输出结果

MyBatis Plus 是对 MyBatis 的封装，自动完成 SQL 语句的执行以及结果集的映射，BaseMapper 接口提供了很多方法，开发者可以直接调用，而不需要自己手动地定义 SQL 以及完成结果集到 Java 程序的映射。

3. 配置日志

我们调用的 API 封装的所有 SQL 现在是不可见的，我们希望知道底层它是怎么执行的，所以需要在 application.yml 中配置日志打印。

# 配置数据源
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost/user?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456
# 配置日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

4. 数据源配置出现的问题

如果使用的是 mysql 驱动是 5.x 版本

<!-- mysql数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.46</version>
</dependency>

配置数据源时，驱动不同 com.mysql.jdbc.Driver

# 配置数据源
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost/user?useUnicode=true&characterEncoding=UTF-8
    username: root
    password: 123456

如果使用的是 mysql 驱动是 8.x 版本

<!-- mysql数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.25</version>
</dependency>

配置数据源时，驱动 com.mysql.cj.jdbc.Driver，而且需要增加时区的配置 serverTimezone=GMT%2B8

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

如果 mysql 版本没有配置正确，启动程序时就会出现异常！