介绍

  MyBatis-Plus（简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。只做增强不做改变的意思是：MP不会影响原生的 MyBatis 功能，使用了 MP ，也可以用原生的 MyBatis 写法，它在 MyBatis 的基础上做了增强，提供了很多强大好用的方法。

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。

• 损耗小：启动即会自动注入基本 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. 准备一张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

2. 其对应的数据库脚本如下：

use mp;
DROP TABLE IF EXISTS user;

CREATE TABLE user
(
    id BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT(11) NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    manager_id BIGINT(20) DEFAULT NULL COMMENT '领导',
    PRIMARY KEY (id),
    CONSTRAINT manager_fk FOREIGN KEY(manager_id) REFERENCES user(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', 1),
(5, 'Billie', 24, 'test5@baomidou.com', 2);

3. 使用 Spring Initializer 快速初始化一个 Spring Boot 工程

4. 添加依赖

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

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

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

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

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

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

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mp?characterEncoding=utf8&useSSL=false&serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=root

logging.level.root=warn
logging.level.com.cd.mybatisplus.mapper=trace
logging.pattern.console=%p%m%n

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

@SpringBootApplication
@MapperScan("com.cd.mybatisplus.mapper")
public class MybatisplusApplication {

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

}

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

@Data
public class User {
    @TableId(type = IdType.AUTO) //设置id自增，否则id不会自增
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Long managerId;
}

8. 编写 Mapper 包下的 UserMapper 接口

public interface UserMapper  extends BaseMapper<User> {
}

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

提示：UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件

@SpringBootTest
class MybatisplusApplicationTests {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));

        //条件删除
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "mp").eq("age", 25);
        userMapper.delete(wrapper);
        //条件删除
        //Map<String, Object> map = new HashMap<>();
        //map.put("name", "mp");
        //map.put("age", 25);
        //userMapper.deleteByMap(map);

        //插入
        User user = new User();
        user.setId(6L);
        user.setName("mp");
        user.setAge(25);
        user.setEmail("test6@baomidou.com");
        int rows = userMapper.insert(user);

        //查询
        List<User> userList = userMapper.selectList(null);
        userList.forEach(System.out::println);
    }
}

10. 控制台输出：

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(id=6, name=mp, age=25, email=test6@baomidou.com)

小结：

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

2. 从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

3. 但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧！