30分钟精通mybatis-plus插件开发

mybatis-plus项目地址：https://github.com/baomidou/mybatis-plus

mybatis-plus使用实例地址：https://github.com/baomidou/mybatis-plus-samples

mybatis-plus使用文档地址：https://mybatis.plus/

简介

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

特性

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

损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作

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

支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错

支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库

支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题

支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动

支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作

支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）

支持关键词自动转义：支持数据库关键词（order、key......）自动转义，还可自定义关键词

内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用

内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询

内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询

内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作

内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

框架结构

弄清楚了mybatis-plus的诸多好处之后，那么下面就来开始我们的代码吧。

快速开始

首先新建一个maven工程并在pom中加入相关的依赖。

        
            org.springframework.boot
            spring-boot-starter-web
        
        
            mysql
            mysql-connector-java
        
        
            com.baomidou
            mybatis-plus-boot-starter
            3.1.0
        
        
            org.projectlombok
            lombok
            1.18.6
        

    

其中lomback是方便我们写实体类的时候少写一些代码。

创建一张user用户表

CREATE TABLE `user` (
  `id` int(12) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `age` int(4) DEFAULT NULL,
  `email` varchar(255) DEFAULT NULL,
  `phone` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

插入两条测试数据

INSERT INTO `user` VALUES (1, '张三', 18, '[email protected]', '123');
INSERT INTO `user` VALUES (2, '王五', 20, '[email protected]', '234');

在application.yml中添加相关配置信息

#数据源
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/yifeng?useUnicode=true&characterEncoding=UTF-8&useSSL=true&serverTimezone=UTC
    username: root
    password: root
    driverClassName: com.mysql.cj.jdbc.Driver

启动类上面添加mapper扫描器

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

新建UserMapper继承BaseMapper，新建User实体类

public interface UserMapper extends BaseMapper{
}

@Data
@Builder
public class User {
    private Integer id;

    private String name;

    private Integer age;

    private String email;

    private String phone;
}

新建UserController

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;
    @RequestMapping("/user")
    public Object getUser(){
        List yfUser = userMapper.selectList(null);
        return yfUser;
    }
}

这里调用了BaseMapper的自带方法，selectList查询用户列表并返回List集合。

在浏览器端输入localhost:8080/user，就能看到这是已经正确的返回了所有的user。

至此，第一个mybatis-plus的程序我们就已经完成了，下面我们将探讨一些更高级的用法，使我们在项目中开发更简便。

BaseMapper深入解析：

打开BaseMapper的源码

/**
 * Mapper 继承该接口后，无需编写 mapper.xml 文件，即可获得CRUD功能
 * 
这个 Mapper 支持 id 泛型
 *
 * @author hubin
 * @since 2016-01-23
 */
public interface BaseMapper extends Mapper {

    /**
     * 插入一条记录
     *
     * @param entity 实体对象
     */
    int insert(T entity);

    /**
     * 根据 ID 删除
     *
     * @param id 主键ID
     */
    int deleteById(Serializable id);

    /**
     * 根据 columnMap 条件，删除记录
     *
     * @param columnMap 表字段 map 对象
     */
    int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

    /**
     * 根据 entity 条件，删除记录
     *
     * @param wrapper 实体对象封装操作类（可以为 null）
     */
    int delete(@Param(Constants.WRAPPER) Wrapper wrapper);

    /**
     * 删除（根据ID 批量删除）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);

    /**
     * 根据 ID 修改
     *
     * @param entity 实体对象
     */
    int updateById(@Param(Constants.ENTITY) T entity);

    /**
     * 根据 whereEntity 条件，更新记录
     *
     * @param entity        实体对象 (set 条件值,可以为 null)
     * @param updateWrapper 实体对象封装操作类（可以为 null,里面的 entity 用于生成 where 语句）
     */
    int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);

    /**
     * 根据 ID 查询
     *
     * @param id 主键ID
     */
    T selectById(Serializable id);

    /**
     * 查询（根据ID 批量查询）
     *
     * @param idList 主键ID列表(不能为 null 以及 empty)
     */
    List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);

    /**
     * 查询（根据 columnMap 条件）
     *
     * @param columnMap 表字段 map 对象
     */
    List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

    /**
     * 根据 entity 条件，查询一条记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 Wrapper 条件，查询总记录数
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 entity 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List> selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);

    /**
     * 根据 Wrapper 条件，查询全部记录
     * 
注意： 只返回第一个字段的值
     *
     * @param queryWrapper 实体对象封装操作类（可以为 null）
     */
    List