mybatis-plus详解

1.mybatis-plus的简介

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

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

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错 【JDK1.8 的新特性】
• 支持主键自动生成：支持多达 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

2.mybatis-plus快速入门

2.1创建一个数据库(bazu2)和表(user)

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)
);
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'),
(5, 'Billie', 24, 'test5@baomidou.com');

不断往该表中添加新的字段。标准的一张表包含：version[乐观锁]gmt_createtime,gmt_updatetime,这些都是阿里的标准

逻辑删除: (增加一个字段 isdeleted) 修改工作，到删除时应用。

2.2创建一个mybatis-plus工程

<!--引入mybatis-plus的依赖 不要再引入mybatis的依赖 因为这两者之间可能存在冲突。-->
<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.0</version>
        </dependency>

#数据源的配置
#数据源的配置
spring.datasource.druid.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.druid.url=jdbc:mysql://localhost:3306/bazu2?serverTimezone=Asia/Shanghai&characterEncoding=utf8
spring.datasource.druid.username=root
spring.datasource.druid.password=283003

logging.level.com.aaa.dao=debug

#逻辑已删除值（默认为1）
mybatis-plus.global-config.db-config.logic-delete-value=0
#逻辑未删除值（默认为0）
mybatis-plus.global-config.db-config.logic-not-delete-value=1

2.3.创建实体类以及dao接口，接口必须继承BaseMapper接口

接口创建

package com.aaa.dao;

import com.aaa.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
public interface UserDao extends BaseMapper<User> {
}

实体类创建

package com.aaa.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.sun.tracing.dtrace.ArgsAttributes;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.apache.ibatis.annotations.AutomapConstructor;

import java.util.Date;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
 //AUTO自动增长。如果使用这种方式，必须数据库该列为自增
 //ASSIGN_ID:适合long和string类型
 //NONE和INPUT要求客户必须输入id.
@TableId(type = IdType.AUTO)
 private long id;
 private String name;
 private Integer age;
 private String email;
 @TableField(fill = FieldFill.INSERT)
 private Date gmtCreated;
 @TableField(fill = FieldFill.INSERT_UPDATE)
 private Date gmtUpdated;
 @TableLogic
 private int isdeleted;
}

2.4在主启动类上添加一个dao接口的扫描

package com.aaa;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan(basePackages = "com.aaa.dao")
public class AaaApplication {

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

}

2.5测试结果

查询所有

 @Test
    void contextLoads() {
        //wrapper:条件封装类。------null占位符
        //查询所有
        List list = userDao.selectList(null);
        System.out.println(list);
    }

如下图展示：

条件查询

@Test
    public void select(){
        User user = new User();
        user.setName("飞");
        //1.根据id查询
       /* User user = userDao.selectById(1l);
        System.out.println(user);*/
     //2.根据查询多条记录wrapper-子类有queryWrapper
        //条件有where = like in between
        QueryWrapper wrapper = new QueryWrapper();
        //比较查询
        //wrapper.eq("name","帅飞");
        //查询想要的字段
        //wrapper.select("name","age");\
        //StringUtils类开发包。isNotEmpty进行非空判断在
       /* if (StringUtils.isNotEmpty(user.getName())){
            wrapper.like("name","飞");
        }*/
        if (user.getAge()!=null){
            System.out.println("88888888");
                wrapper.between("age",10,25);
        }
        List list = userDao.selectList(wrapper);
        System.out.println(list);
    }

删除

逻辑删除: (增加一个字段 isdeleted) 修改工作：

 @Test
    public void delete(){
        //这个删除就是直接删除了，如果想实现逻辑删除则需要给数据库表中增加一个新的列isDeleted
       userDao.deleteById(7l);

    }

逻辑列上添加

@TableLogic  //默认1为删除  0为未删除
private int isdeleted;
    
#逻辑已删除值（默认为1）
mybatis-plus.global-config.db-config.logic-delete-value=0
#逻辑未删除值（默认为0）
mybatis-plus.global-config.db-config.logic-not-delete-value=1

分页查询

package com.aaa.handler;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 分页的插件
 */
@Configuration
public class MybatisPlusConfig {

    // 最新版
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }

}
 
@Test
    public void selectByPage(){
        Page<User> page=new Page<>(1,5);
        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());
    }

3.mybatis-plus的代码生成器

package com.aaa;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
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.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import org.apache.commons.lang3.StringUtils;

import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;

public class CodeGenerator {


   /*是否选择控制器输入，否就注掉
   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) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        //获取工程的根目录
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("毛飞");
        gc.setOpen(false); //是否生成代码后打开本地目录
        gc.setSwagger2(true); //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);
            gc.setMapperName("%sDao");
            gc.setServiceName("%sService");
        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/bazu2?serverTimezone=Asia/Shanghai&useUnicode=true&useSSL=false&characterEncoding=utf8");
        // dsc.setSchemaName("public");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("283003");
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
//        pc.setModuleName("aaa");
        pc.setParent("com.aaa");
        pc.setMapper("dao");

        ;//设置父包   com.ykq.aaa.controler dao service entity
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        String templatePath = "/templates/mapper.xml.vm";
        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/"
                        + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();

        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();

        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);//controller是否使用restful风格

        mpg.setStrategy(strategy);
        mpg.execute();
    }


    //xml映射文件 生成时放入resources/mapper

}