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 注入攻击

框架结构

 

好了官网的简介完了，附上github地址：Mybatis-plus的GIthub

代码生成器

       代码生成器，又被叫做逆向工程，MyBatis官方为了推广，自己也写了一个，我之前也使用这个，功能也是非常强大，强大以为支持自定义配置，那么问题来了，我该怎么配置才合理呢，所以，有人把所有的配置项都弄成中文的，还有人开发了生成插件，这些在我以往的博文中都看看到。MyBatis-Plus的代码生成器到底怎么样，这我就不评判了，我就这样说，用用看吧。

在MyBatis-Plus的官网文档中，有将代码生成器的问题，有配置详解，也有项目示例代码，复制来就可用。

功能列表：

• [✔] 自动生成model类

• [✔] 自动生成dao接口

• [✔] 自动生成xml文件

• [✔] 自动生成service接口

• [✔] 自动生成service实现类

• [✔] model支持Builder模式

• [✔] 支持swagger2

• [✔] 支持生成数据库字段常量

• [✔] 支持生成Kotlin代码

• [] ......

1、安装

1.添加依赖

无论SSM项目还是SpringBoot项目，在原来基础上添加以下依赖

        org.projectlombok
        lombok
        true
    
    
        com.baomidou
        mybatis-plus-boot-starter
        3.1.0
   

 

2.添加包扫描

springboot项目

在启动类上使用注解扫描mapper包（dao层）(Spring Boot项目)

@MapperScan("com.xxx.xxxx.mapper")

 

springMvc项目

• 配置 MapperScan

 

• 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

 

3.警告

WARNING

引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

 

 

2、Mybatis-plus的配置

在application.yml中添加数据源

# DataSource Config
spring:
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
    username: root
    password:

# Logger Config
logging:
  level:
    com.mybatisplus.demo03: debug

#MP所支持的application.yml设置 具体参考官方文档https://jobob.gitee.io/mp3doc/中设置部分
mybatis-plus:
#  config-location: classpath:mybatis/mybatis-config.xml #如果需要使用原生mybatis设置文件，则这里需要指明具体路径
#  mapper-locations: classpath:/mybatis/mapper/*DAO.xml #在resource目录下的写法
#  mapper-locations: classpath:/com/mpspringboot/mapper/xml/*Mapper.xml #在src/main/java下的写法(同时配置POM文件中source属性)
#  mapper-locations: classpath*:/mybatis/mapper/*DAO.xml #Maven多项目模块下使用classpath*写法
#  type-aliases-package: com.XX.entity #设置类名别名扫描位置，设置后可使用类名替代全限定类名，多个package用逗号或者分号分隔
#  type-aliases-super-type: java.lang.Object #请和typeAliasesPackage一起使用，设置后仅会扫描路径下以该类作为父类的域对象 。
#  type-handlers-package: com.XX.handler #设置类型转换类所在的包位置
#  type-enums-package: com.XX.enums #枚举字段扫描，支持实体的枚举字段
#  check-config-location: false #启动时是否检查 MyBatis XML 文件的存在，默认不检查。
#  executor-type: simple #通过该属性可指定 MyBatis 的执行器，默认值为SIMPLE，MyBatis 的执行器总共有三种：
#                         ExecutorType.SIMPLE：该执行器类型不做特殊的事情，为每个语句的执行创建一个新的预处理语句（PreparedStatement）
#                         ExecutorType.REUSE：该执行器类型会复用预处理语句（PreparedStatement）
#                         ExecutorType.BATCH：该执行器类型会批量执行所有的更新语句
#  configuration-properties: classpath:mybatis/config.properties #指定外部化 MyBatis Properties 配置，通过该配置可以抽离配置，实现不同环境的配置部署。

  #MyBatis-Plus 全局策略配置
  global-config:
    refresh: true #启动后，修改Target中的XML即可更新对应Mapper的逻辑，用于调试；生产中不要启动
#    sql-parser-cache: true #是否缓存 Sql 解析，默认不缓存。
#    sql-session: com.xxx.SqlSession #单例重用 SqlSession
#    sql-session-factory: com.xxx.SqlSessionFactory #

    #全局配置中关于DB的设置
    db-config:
      db-type: MYSQL #数据库类型
      capital-mode: true #是否开启大写命名，开启后生成SQL语句都为大写；默认不开启。
#      table-prefix: sys #生成的SQL会在表名上增加此前缀
      table-underline: true #生成的SQL语句中，表名是否自动加入驼峰转下划线（如SystemUser=>system_user）
      field-strategy: NOT_NULL #字段更新插入策略  0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
#                               IGNORED：所有字段都更新和插入
#                               NOT_NULL：只更新和插入非NULL值
#                               NOT_EMPTY：只更新和插入非NULL值且非空字符串
#                               DEFAULT：默认NOT_NULL
      id-type: UUID #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
#                               AUTO(0)：MP自动决定
#                               NONE(1)：生成语句插入null，需要数据库自增时可以使用
#                               INPUT(2)：根据用户输入值
#                               ID_WORKER(3)：全局唯一ID (数字类型唯一ID)
#                               UUID(4)：全局唯一ID UUID
#                               ID_WORKER_STR(5)：全局唯一ID (字符型类型唯一ID)
      column-like: false #逻辑删除字段表示未删除的值
      logic-delete-value: 1 #逻辑删除字段表示删除的值
      logic-not-delete-value: 0 #逻辑删除字段表示未删除的值


  #一部分对原生MyBatis所支持的配置，我建议使用config-location加mybatis-config.xml实现比较清晰，不要在这里使用
#  configuration:
#    mapUnderscoreToCamelCase: true #默认true，是否开启自动驼峰命名规则（camel case）映射，即从经典数据库列名 A_COLUMN 到经典 Java 属性名 aColumn 的类似映射。
#    aggressive-lazy-loading: true #当设置为 true 的时候，懒加载的对象可能被任何懒属性全部加载，否则，每个属性都按需加载。需要和 lazyLoadingEnabled 一起使用。
#    auto-mapping-unknown-column-behavior: none #MyBatis 自动映射策略，通过该配置可指定 MyBatis 是否并且如何来自动映射数据表字段与对象的属性，总共有 3 种可选值：
#                                               AutoMappingBehavior.NONE：不启用自动映射
#                                               AutoMappingBehavior.PARTIAL：只对非嵌套的 resultMap 进行自动映射
#                                               AutoMappingBehavior.FULL：对所有的 resultMap 都进行自动映射
#    auto-mapping-behavior: partial #MyBatis 自动映射时未知列或未知属性处理策略，通过该配置可指定 MyBatis 在自动映射过程中遇到未知列或者未知属性时如何处理，总共有 3 种可选值：
#                                  AutoMappingUnknownColumnBehavior.NONE：不做任何处理 (默认值)
#                                  AutoMappingUnknownColumnBehavior.WARNING：以日志的形式打印相关警告信息
#                                  AutoMappingUnknownColumnBehavior.FAILING：当作映射失败处理，并抛出异常和详细信息
#    cache-enabled: true #全局地开启或关闭配置文件中的所有映射器已经配置的任何缓存，默认为 true。
#    call-setters-on-nulls: false #指定当结果集中值为 null 的时候是否调用映射对象的 Setter（Map 对象时为 put）方法，通常运用于有 Map.keySet() 依赖或 null 值初始化的情况。
#                                  通俗的讲，即 MyBatis 在使用 resultMap 来映射查询结果中的列，如果查询结果中包含空值的列，则 MyBatis 在映射的时候，不会映射这个字段，这就导致在调用到该字段的时候由于没有映射，取不到而报空指针异常。
#                                  当您遇到类似的情况，请针对该属性进行相关配置以解决以上问题。
#                                  WARNING
#                                  基本类型（int、boolean 等）是不能设置成 null 的。
#    configuration-factory: com.xxx.SampleConfigurationFactory #指定一个提供 Configuration 实例的工厂类。
                                    #该工厂生产的实例将用来加载已经被反序列化对象的懒加载属性值，其必须包含一个签名方法static Configuration getConfiguration()。（从 3.2.3 版本开始）

 

 

或者

mybatis-plus:
  # xml
  mapper-locations: classpath:mapper/*Mapper.xml
  # 实体扫描，多个package用逗号或者分号分隔
  type-aliases-package: com.fengwenyi.mp3demo.model
  configuration:
    # 这个配置会将执行的sql打印出来，在开发或测试的时候可以用
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

 

3、核心功能

1.代码生成器

① 添加依赖

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

  com.baomidou
  mybatis-plus-generator
  最新版本



    org.freemarker
    freemarker
    最新版本

 

② Generator类

public class MysqlGenerator {
    //要生成的表，及输出路径
    static String[] TO_CREATE_TABLES = new String[]{"block", "channel_origin", "channel_target", "order", "tenant", "user", "oauth_user", "oauth_session_key"};
    static String BASE_OUT_PUT_DIR = "src/main/java";
    static String XML_OUT_PUT_DIR = "src/main/resources/mapper";
    static String AUTHOR = "Jelly";
    //配置数据源
    static String DATA_SOURCE_URL = "jdbc:mysql://localhost:3306/qingteng?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=GMT%2B8";
    static String DATA_SOURCE_DRIVER = "com.mysql.cj.jdbc.Driver";
    static String DATA_SOURCE_USER = "root";
    static String DATA_SOURCE_PASSWORD = "123456";
    //生成表的父类
    static String SUPER_CONTROLLER = "com.qingtengcloud.web.v1.base.BaseController";


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

        /**
         * 包配置
         */
        PackageConfig pc = new PackageConfig();
        pc.setParent("com.qingtengcloud"); //父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
        pc.setEntity("bean");
        pc.setController("web.v1");
        pc.setMapper("dao");
        pc.setXml("mapper");
        mpg.setPackageInfo(pc);

        /**
         * 全局配置
         *
         */
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOpen(false);//        否打开输出目录
        gc.setOutputDir(BASE_OUT_PUT_DIR); //生成文件的输出目录
        gc.setFileOverride(false);// 是否覆盖文件
        gc.setActiveRecord(true); //开启 activeRecord
        gc.setEnableCache(false);// xml 二级缓存
        gc.setBaseResultMap(true); //xml resultMap
        gc.setBaseColumnList(true);//xml columList
        gc.setDateType(DateType.SQL_PACK);
        gc.setAuthor(AUTHOR);
        gc.setXmlName("%sMapper");//Mapper xml 命名方式
        gc.setMapperName("%sMapper");//mapper 命名方式
        gc.setServiceName("%sService");//service 命名方式
        gc.setServiceImplName("%sServiceImpl");//service impl 命名方式
        gc.setControllerName("%sController");//controller 命名方式
        mpg.setGlobalConfig(gc);

        /**
         * 数据源配置
         */
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(DATA_SOURCE_URL);
        // dsc.setSchemaName("public");
        dsc.setDriverName(DATA_SOURCE_DRIVER);
        dsc.setUsername(DATA_SOURCE_USER);
        dsc.setPassword(DATA_SOURCE_PASSWORD);
        mpg.setDataSource(dsc);

        /**
         *  自定义配置
         */
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        List focList = new ArrayList<>();
        focList.add(new FileOutConfig("templates/mapper.xml.ftl") {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输入文件名称
                return XML_OUT_PUT_DIR + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null));

        /**
         * 策略配置
         */
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel); //数据库表名映射策略，下划线转驼峰命名
        strategy.setColumnNaming(NamingStrategy.underline_to_camel); //数据库表字段映射到实体的命名策略，下划线转驼峰命名
        strategy.setInclude(TO_CREATE_TABLES);//需要包含的表名，允许正则表达式（与exclude二选一配置）
//        strategy.setExclude(new String[]{"test"}); // 排除生成的表
        strategy.setEntityBuilderModel(true);//是否为构建者模型
        strategy.setEntityLombokModel(true); //是否为lombok模型
        strategy.setSuperControllerClass(SUPER_CONTROLLER);//自定义继承的Controller类全称，带包名
        strategy.setControllerMappingHyphenStyle(true);// Controller中驼峰转连字符
        strategy.setRestControllerStyle(true); //生成 @RestController 控制器
        strategy.setTablePrefix(pc.getModuleName() + "_");//表前缀
        mpg.setStrategy(strategy);
        // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
    }
}

 

2.CRUD接口

 

Mapper CRUD 接口

说明:

• 通用 CRUD 封装BaseMapper接口，为 Mybatis-Plus 启动时自动解析实体表关系映射转换为 Mybatis 内部对象注入容器
• 泛型 T 为任意实体对象
• 参数 Serializable 为任意类型主键 Mybatis-Plus 不推荐使用复合主键约定每一张表都有自己的唯一 id 主键
• 对象 Wrapper 为 条件构造器

 

Service CRUD 接口

说明:

• 通用 Service CRUD 封装IService接口，进一步封装 CRUD 采用 get 查询单行 remove 删除 list 查询集合 page 分页 前缀命名方式区分 Mapper 层避免混淆，
• 泛型 T 为任意实体对象
• 建议如果存在自定义通用 Service 方法的可能，请创建自己的 IBaseService 继承 Mybatis-Plus 提供的基类
• 对象 Wrapper 为 条件构造器

 

 

3.条件构造器

 

示例：

public List orderPagingQueryStatus2() {
    QueryWrapper queryWrapper = new QueryWrapper<>();
    queryWrapper.lambda().eq(Order::getStatus, 0).gt(Order::getCreatedAt,"2019-02-25 12:00:00");
    return list(queryWrapper);
}

 

4.分页插件

//Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    /**
     * 分页插件
     */
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

 

示例：

Mapper.java
    /**
     * 包含街区、租客多表查询(注解和xml同时存在的时候，跳过注解)
     * @param page 分页
     * @return
     */
    List orderPagingQuery(Page page, @Param("operateUserId") Long operateUserId);


Service.java
 /**
     * 订单分页查询
     * @param page
     * @return
     */
    Page orderPagingQuery(Page page, Long operate_user_id);


ServiceImpl.java
 /**
     * 订单分页查询
     * @param page
     * @return
     */
    @Override
    public Page orderPagingQuery(Page page, Long operateUserId) {
        return page.setRecords(this.baseMapper.orderPagingQuery(page, operateUserId));
    }
    
Controller.java
 @GetMapping(value = "/orders" )
    public Object orders(@RequestParam(value = "page", defaultValue = "1") Integer pn,
                         @RequestParam(value = "size", defaultValue = "10") Integer pageSize, Principal principal) {
        //获取当前用户的订单,需要另外写
        long operate_user_id = userService.selectUserByMobile(principal.getName()).getId();
        //利用mybatis-plus的分页查询
        Page obt = orderService.orderPagingQuery(new Page<>(pn, pageSize), operate_user_id);
        return new RetResult(obt);
    }    

 

同时可以自定义分页

UserMapper.java

public interface UserMapper{//可以继承或者不继承BaseMapper
    /**
     * 

     * 查询 : 根据state状态查询用户列表，分页显示
     * 注意!!: 如果入参是有多个,需要加注解指定参数名才能在xml中取值
     * 
     *
     * @param page 分页对象,xml中可以从里面进行取值,传递参数 Page 即自动分页,必须放在第一位(你可以继承Page实现自己的分页对象)
     * @param state 状态
     * @return 分页对象
     */
    IPage selectPageVo(Page page, @Param("state") Integer state);
}

UserMapper.xml 等同于编写一个普通 list 查询，mybatis-plus 自动替你分页

    SELECT id,name FROM user WHERE state=#{state}

UserServiceImpl.java 调用分页方法

public IPage selectUserPage(Page page, Integer state) {
    // 不进行 count sql 优化，解决 MP 无法自动优化 SQL 问题，这时候你需要自己查询 count 部分
    // page.setOptimizeCountSql(false);
    // 当 total 为非 0 时(默认为 0),分页插件不会进行 count 查询
    // 要点!! 分页返回的对象与传入的对象是同一个
    return userMapper.selectPageVo(page, state));
}

 

4、小问题

① 使用条件构造器的orderByDesc()等排序功能时会有，idea会报警告，目前无法解决。