MyBatis-Plus 入门实例

一、MyBatis-Plus 简介

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

1.1、MyBatis-Plus 特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
• 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

1.2、框架结构

任何能使用 mybatis 进行 crud, 并且支持标准 sql 的数据库

二、创建并初始化数据库

2.1、创建数据库

CREATE DATABASE MP_DATABASE;

2.2、创建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, '张三', 18, '123@qq.com'),
(2, '李四', 20, '1234@qq.com'),
(3, '王二', 28, '12345@qq.com'),
(4, '麻子', 21, '123456@qq.com'),
(5, '小明', 24, '1234567@qq.com');

三、IDEA环境配置

3.1、IDEA项目创建

（1）快速初始化一个 Spring Boot 工程

3.2、项目Maven依赖

<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>
        </dependency>

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

        <!--mysql依赖-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!--lombok用来简化实体类-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

3.3、安装lombok插件

四、入门实例

4.1、项目配置

在 application.properties配置文件中添加MySQL数据库的相关配置：

# 数据库连接配置
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mp_database?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=****

注意：

• 此处url使用了 ?serverTimezone=GMT%2B8后缀，因为8.0版本的jdbc驱动需要添加这个后缀，否则运行测试用例报告如下错误：java.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more
• 此处的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver，在 jdbc 8中 建议使用这个驱动，否则运行测试用例的时候会有WARN信息

4.2、创建启动类

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

@SpringBootApplication
@MapperScan("com.mybatisplus.demo.mapper") //此处为mapper的文件位置
public class DemoApplication {

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

}

4.3、添加实体类

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

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

4.4、添加mapper

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

@Repository
// BaseMapper 所有 Mapper 的父类，提供了通用 Mapper 功能
public interface UserMapper extends BaseMapper<User> {
}

4.5、测试

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

@SpringBootTest
class DemomptestApplicationTests {

    @Autowired 
    private UserMapper userMapper;

    @Test
    public void findAll() {
        List<User> users = userMapper.selectList(null);
        System.out.println(users);
    }
}

注意：

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

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

4.6、配置SQL输出日志

我们可在application.properties中进行配置，便可在控制台中查看Mybatis-Plus时所执行的SQL语句，方便我们理解Mybatis-Plus操作的执行原理。

# 查看Mysql输出日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl