MyBatis-Plus的使用

• 一、MyBatis-Plus的简介
• 二、特性
• 三、快速入门使用
• • 3.1 建库建表
  • 3.2 创建项目
  • 3.3 引入相关依赖
  • 3.4 数据源配置
  • 3.5 User实体类、dao接口（必须继承BaseMapper接口）、主启动类扫描dao层
  • 3.6 增加
  • 3.7 修改
  • 3.8 删除
  • 3.9 查询
• 四、mp的一些功能
• • 4.1 mp自动填充功能
  • • 4.1.1 注解填充字段
    • 4.1.2 自定义实现类MyMetaObjectHandler
    • 4.1.3 注意事项
    • 4.1.4效果
  • 4.2 条件构造器
  • 4.3 分页查询
  • • 4.3.1 创建一个配置类
    • 4.3.2 测试
  • 4.4 代码生成
  • • 4.4.1 创建springboot项目
    • 4.4.2 添加一些依赖
    • 4.4.3 编写配置
    • 4.4.4 运行配置类
    • 4.4.5 查看接口效果

MyBatis-Plus官网：https://mp.baomidou.com/
以下内容，总结于MyBatis-Plus官网。

一、MyBatis-Plus的简介

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

愿景
我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

二、特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 强大的 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

三、快速入门使用

3.1 建库建表

现有一张User表，其结构如下。

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

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user`  (
  `id` bigint(20) NOT NULL COMMENT '主键ID',
  `name` varchar(30) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '姓名',
  `age` int(11) NULL DEFAULT NULL COMMENT '年龄',
  `email` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '邮箱',
  `gmt_updated` datetime(0) NULL DEFAULT NULL COMMENT '修改时间',
  `gmt_created` datetime(0) NULL DEFAULT NULL COMMENT '创建时间',
  `is_deleted` tinyint(4) NULL DEFAULT 0 COMMENT '是否删除，0未删除、1已删除',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

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

INSERT INTO `user` VALUES (3, 'Tom', 28, 'test3@baomidou.com', NULL, NULL, 1);
INSERT INTO `user` VALUES (4, 'Sandy', 21, 'test4@baomidou.com', NULL, NULL, 0);
INSERT INTO `user` VALUES (5, 'Billie', 24, 'test5@baomidou.com', NULL, NULL, 0);
INSERT INTO `user` VALUES (1377158342091579394, '李四', 18, '110@qq.com', NULL, NULL, 0);
INSERT INTO `user` VALUES (1377226905372368898, '张三', 18, '110@qq.com', NULL, '2021-03-31 19:50:57', 0);

3.2 创建项目

创建一个SpringBoot项目并配置项目信息。

3.3 引入相关依赖

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </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>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.2</version>
        </dependency>
        <dependency>
            <groupId>commons-lang</groupId>
            <artifactId>commons-lang</artifactId>
            <version>2.5</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.10</version>
        </dependency>
    </dependencies>

3.4 数据源配置

#数据库资源配置
spring.datasource.druid.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.druid.url=jdbc:mysql:///mybatis_plus?useUnicode=true&characterEncoding=UTF8
spring.datasource.druid.username=root
spring.datasource.druid.password=1998

3.5 User实体类、dao接口（必须继承BaseMapper接口）、主启动类扫描dao层

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    private Date gmtCreated;
    private Date gmtUpdated;
    private Integer isDeleted;
}

public interface UserDao extends BaseMapper<User> {
    
}

3.6 增加

/**
     * 添加功能
     *   mp自动提供了一些主键生成策略
     *   默认采用雪花算法。
     *   snwflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID，64byte
     *
     *   其核心思想是：使用41bit作为毫秒数，10bit作为机器ID
     *   （5个bit是数据中心， 北京上海   ，5个bit的机器ID）12bit作为毫秒内的流水号
     *   （意味着每个节点在每毫秒可以产生4096个ID）最后还有一个符号位，永远是0
     */
    @Test
    public void insert(){
        User user = new User();
        user.setName("王五");
        user.setAge(18);
        user.setEmail("110@qq.com");
        userDao.insert(user);
    }

3.7 修改

/**
     * 修改
     */
    @Test
    public void update(){
        User user = new User();
        user.setId(4L);
        user.setName("诸葛亮");
        userDao.updateById(user);
    }

3.8 删除

/**
     * 真实删除
     */
    @Test
    public void delete(){
        userDao.deleteById(4L);
    }

3.9 查询

 @Test
    public void select(){
        //根据ID查询
        User user1 = userDao.selectById(4L);
        System.out.println(user1);
        //查询所有
        List<User> users = userDao.selectList(null);
        System.out.println(users);
    }

四、mp的一些功能

4.1 mp自动填充功能

例如我们实际开发项目时，对用户表新增用户或者修改用户信息的时候，可能需要自动的添加新增时间或者修改的时间，这时候我们就可以运用mp的自动填充功能。

4.1.1 注解填充字段

修改实体类：

4.1.2 自定义实现类MyMetaObjectHandler

@Component
public class MyMetaObjectHandler implements MetaObjectHandler {


    @Override
    public void insertFill(MetaObject metaObject) {
        /*
        起始版本 3.3.0(推荐使用)
        第一列是固定的
        第二个参数为 列名
        第三个是类型
        第四个是参数表示的列的值
         */

        this.strictInsertFill(metaObject, "gmtCreated", Date.class, new Date());
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.strictUpdateFill(metaObject, "gmtUpdated", Date.class,new Date());
    }
}

4.1.3 注意事项

填充原理是直接给entity的属性设置值!!!
注解则是指定该属性在对应情况下必有值,如果无值则入库会是null
MetaObjectHandler提供的默认方法的策略均为:如果属性有值则不覆盖,如果填充值为null则不填充
字段必须声明TableField注解,属性fill选择对应策略,该声明告知Mybatis-Plus需要预留注入SQL字段
填充处理器MyMetaObjectHandler在 Spring Boot 中需要声明@Component或@Bean注入
要想根据注解FieldFill.xxx和字段名以及字段类型来区分必须使用父类的strictInsertFill或者strictUpdateFill方法
不需要根据任何来区分可以使用父类的fillStrategy方法

4.1.4效果

4.2 条件构造器

查询的时候我们可以根据自定义的条件进行查询。这时候需要用到条件构造器。（用法见官网，太多了）

4.3 分页查询

4.3.1 创建一个配置类

@Configuration
public class MybatisPlusConfig {
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//自己的数据库，我的是mysql
        return interceptor;
    }
}

4.3.2 测试

@Test
    public void selectByPage(){
        Page<User> page = new Page<>(1, 2);
        page = userDao.selectPage(page, null);
        System.out.println("当前的页码"+page.getCurrent());
        System.out.println("总页码"+page.getPages());
        System.out.println("总条数"+page.getTotal());
        System.out.println("当前页码的记录"+page.getRecords());
    }

4.4 代码生成

4.4.1 创建springboot项目

4.4.2 添加一些依赖

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.3</version>
        </dependency>
        <dependency>
            <groupId>com.spring4all</groupId>
            <artifactId>swagger-spring-boot-starter</artifactId>
            <version>1.9.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

4.4.3 编写配置

package com.da.autogenerator;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.builder.ConfigBuilder;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.apache.commons.lang3.StringUtils;
import java.io.File;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import java.util.Scanner;

/**
 * @ClassName CodeGenerator
 * @Description TODO
 * @Author whd
 * @Date 2021/3/31 21:49
 */
public class CodeGenerator {

    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + "：");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "！");
    }

    public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        //设置作者
        gc.setAuthor("whd");
        //是否生成代码后打开本地目录
        gc.setOpen(false);
        // 实体属性 Swagger2 注解
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("1998");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        //设置模块名
        pc.setModuleName("demo");
        //设置父包
        //pc.setParent("com.da.autogenerator");
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);

        //实体类是否用lombok
        strategy.setEntityLombokModel(true);
        //controller接口是否使用restful接口
        strategy.setRestControllerStyle(true);

        mpg.setStrategy(strategy);
        customPackagePath(pc,mpg);
        mpg.execute();
    }

    public static void customPackagePath(PackageConfig pc,AutoGenerator mpg) throws NoSuchFieldException, IllegalAccessException {

        String projectPath = System.getProperty("user.dir");
        String mavenPath = "\\src\\main\\java\\";
        String srcPath = projectPath+mavenPath;

        /**
         * packageInfo配置controller、service、serviceImpl、entity、mapper等文件的包路径
         * 这里包路径可以根据实际情况灵活配置
         */
        Map<String,String> packageInfo = new HashMap<>();
        packageInfo.put(ConstVal.CONTROLLER, "com.da.autogenerator.controller");
        packageInfo.put(ConstVal.SERVICE, "com.da.autogenerator.service");
        packageInfo.put(ConstVal.SERVICE_IMPL, "com.da.autogenerator.service.impl");
        packageInfo.put(ConstVal.ENTITY, "com.da.autogenerator.entity");
        packageInfo.put(ConstVal.MAPPER, "com.da.autogenerator.mapper");

        /**
         * pathInfo配置controller、service、serviceImpl、entity、mapper、mapper.xml等文件的生成路径
         * srcPath也可以更具实际情况灵活配置
         * 后面部分的路径是和上面packageInfo包路径对应的源码文件夹路径
         * 这里你可以选择注释其中某些路径，可忽略生成该类型的文件，例如:注释掉下面pathInfo中Controller的路径，就不会生成Controller文件
         */
        Map pathInfo = new HashMap<>();
        pathInfo.put(ConstVal.CONTROLLER_PATH, srcPath + packageInfo.get(ConstVal.CONTROLLER).replaceAll("\\.", StringPool.BACK_SLASH + File.separator));
        pathInfo.put(ConstVal.SERVICE_PATH, srcPath + packageInfo.get(ConstVal.SERVICE).replaceAll("\\.", StringPool.BACK_SLASH + File.separator));
        pathInfo.put(ConstVal.SERVICE_IMPL_PATH, srcPath + packageInfo.get(ConstVal.SERVICE_IMPL).replaceAll("\\.", StringPool.BACK_SLASH + File.separator));
        pathInfo.put(ConstVal.ENTITY_PATH, srcPath + packageInfo.get(ConstVal.ENTITY).replaceAll("\\.", StringPool.BACK_SLASH + File.separator));
        pathInfo.put(ConstVal.MAPPER_PATH, srcPath + packageInfo.get(ConstVal.MAPPER).replaceAll("\\.", StringPool.BACK_SLASH + File.separator));
        pathInfo.put(ConstVal.XML_PATH, projectPath+"\\src\\main\\resources\\mapper\\");
        pc.setPathInfo(pathInfo);

        /**
         * 创建configBuilder对象，传入必要的参数
         * 将以上的定义的包路径packageInfo配置到赋值到configBuilder对象的packageInfo属性上
         * 因为packageInfo是私有成员变量，也没有提交提供公共的方法，所以使用反射注入
         * 为啥要这么干，看源码去吧
         */
        ConfigBuilder configBuilder = new ConfigBuilder(mpg.getPackageInfo(), mpg.getDataSource(), mpg.getStrategy(), mpg.getTemplate(), mpg.getGlobalConfig());
        Field packageInfoField = configBuilder.getClass().getDeclaredField("packageInfo");
        packageInfoField.setAccessible(true);
        packageInfoField.set(configBuilder,packageInfo);

        /**
         * 设置配置对象
         */
        mpg.setConfig(configBuilder);
    }
}

4.4.4 运行配置类

运行前

运行后

4.4.5 查看接口效果

配置步骤请转：https://blog.csdn.net/WHD1998/article/details/115336090?spm=1001.2014.3001.5501

标签：packageInfo,Plus,user,使用,MyBatis,new,NULL,com,public
来源： https://blog.csdn.net/WHD1998/article/details/115357562