SpringBoot集成Mybatis-Plus

标签：Plus SpringBoot private static Mybatis new id gc String

简介

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

因此，mybatis-plus包含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 操作智能分析阻断，也可自定义拦截规则，预防误操作

添加依赖

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

添加配置

# Mybatis-plus配置
mybatis-plus:
  global-config:
    db-config:
      # 全局逻辑删除字段值，或在实体字段加上注解@TableLogic  都会当做逻辑删除字段，优先按照注解来判断
      logic-delete-field: delFlag
      logic-delete-value: 2  # 逻辑已删除值
      logic-not-delete-value: 0 # 逻辑未删除值
  # 配置mapper的扫描，找到所有的mapper.xml映射文件
  mapper-locations: classpath*:mapper/**/*Mapper.xml
  configuration:
    # 使全局的映射器启用或禁用缓存
    cache-enabled: true
    # 允许JDBC 支持自动生成主键
    use-generated-keys: true
    # 指定 MyBatis 所用日志的具体实现
    log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl
    # 配置默认的执行器.SIMPLE就是普通执行器;REUSE执行器会重用预处理语句(prepared statements);BATCH执行器将重用语句并执行批量更新
    default-executor-type: reuse
    # 使用驼峰命名法转换字段
    map-underscore-to-camel-case: true
  # 搜索指定包别名
  type-aliases-package: com.cn.**.domain

生成主键策略

全局id生成策略

mybatis-plus:
  global-config:
    db-config:
      #主键类型(auto:"自增id"，assign_id:"全局唯一id(雪花算法,Long或者String类型)"，assign_uuid:"全局唯一id(无中划线的uuid)",input:"自行设置id,默认null",none:"不设置主键id")
      id-type: assign_id

局部id生成策略

使用@TableId注解配置id生成类型

@TableId(type = IdType.AUTO)
private Long id;

注意事项：

同时配置了这两种策略时，局部字段的ID生成策略优先级高于全局的id生成策略
使用雪花算法生成ID后，再次切换为主键自增的ID生成策略后会导致起始序列过大(没有重置起始序列值)
另外如果原先指定了@TableId(type = IdType.AUTO)，然后去除这部分代码，会发生Tuncate操作(即清空表并重置ID起始值)

分页插件使用

/**
 * Mybatis-plus配置类
 */
@EnableTransactionManagement
@Configuration
// 根据实际情况修改扫描包路径规则
@MapperScan(basePackages = "com.cn.**.mapper)
public class MybatisPlusConfig {

    /**
     * 旧版本配置(已过时)
     */
    /*@Bean
    public PaginationInterceptor paginationInterceptor(){
        return new PaginationInterceptor();
    }*/

    /**
     * Mybatis-Plus 3.5.1新版分页插件API（推荐）
     */
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        //乐观锁
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        //分页锁
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
        return interceptor;
    }
}

条件构造器使用

mybatis-plus中有查询条件构造器QueryWrapper，可以在对常见的CRUD条件进行一些常见的构造，真实API在AbstractWrapper类中(采用了工厂模式进行顶层API设计)。

可以封装sql对象，包括where条件，order by排序，select哪些字段等等查询包装类，可以封装多数查询条件，泛型指定返回的实体类。

public class Test{
    /**
     *  条件构造器使用
     */
    @DeleteMapping("/delete")
    public void delUser(){
        // 1. 根据ID删除
        userMapper.deleteById(6);
        userMapper.deleteBatchIds(Collections.singleton(7));
        // 2. 根据map中的参数作为条件删除
        Map<String, Object> map = new HashMap<>();
        map.put("name", "testIdType");
        map.put("id", 7);
        userMapper.deleteByMap(map);
        // 3. 条件构造器为参数的进行删除
        // 3.1 普通条件构造器(注意不要添加<>，Entity转Object会报错)
        QueryWrapper wrapper = new QueryWrapper();
        wrapper.eq("id",6);
        userMapper.delete(wrapper);
        // 3.2 lmbda表达式条件构造器
        LambdaQueryWrapper<User> lambdaQuery = Wrappers.lambdaQuery();
        lambdaQuery.eq(User::getId, 7).or().eq(User::getName, "testIdType");
        userMapper.delete(lambdaQuery);
    }
}

代码生成器使用

说明：freemarker是作为代码生成器的模板依赖，必须存在；而knife4j是兼容生成的代码带Swagger注释

引入依赖

<!-- mybatis-plus代码生成器 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.2</version>
</dependency>
<!-- freemarker模板 -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>
<!-- knife4j依赖 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

代码实现

public class MybatisPlusGenerator {
    private static final AutoGenerator mpg = new AutoGenerator();   //代码生成器
    private static final GlobalConfig gc = new GlobalConfig();      //全局配置
    private static final String Author = "xiaowei";                 //作者
    /**
     * 如果要Swagger Api的自动配置 可以去策略配置那里把我的取消注释就行
     * 如果为ture贼执行tables选中的表名,如果为false戝一次性创建指定数据库的所有表
     */
    private static final Boolean Include = false;       //true则输入数据库你要生成的表名
    private static final String[] tables = {"表名"};    //选的数据库表名
    //填写需要自动填充的字段(创建时间,和更新时间) 需要对应表名
    private static final String TableFillName = "createDate";      //自动填充的注解 可以按自己想要的更改
    private static final String TableFillName1 = "updateDate";
    /**
     * 项目生成根路径
     * 可以使用System.getProperty("user.dir")
     * 获取到你的项目路径
     * 不过建议直接绝对路径好点,因为那方法会有变动随着你项目的变动而变动
     * 数据源配置
     */
    private static final String projectPath = "G:/demo"; //输入你要生成在哪个项目路径
    private static final String URL = "jdbc:mysql://IP地址:3306/数据库名?characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=true";
    private static final String DRIVER_NAME = "com.mysql.cj.jdbc.Driver";   //5.7以下的版本把CJ去掉
    private static final String USER_NAME = "用户名";
    private static final String PASSWORD = "密码";
    //启动
    public static void main(String[] args) {
        {
            //全局设置
            setPropertyConfig();
            //数据源配置
            setDataSourceConfig();
            //策略配置
            setStrategyConfig(Include);
            //包配置
            setPackageConfig();
        }
    }
    //策略配置
    private static void setStrategyConfig(boolean Include) {
        StrategyConfig strategy = new StrategyConfig();
        ArrayList<TableFill> fillArrayList = new ArrayList<>();
        if (Include){
            strategy.setInclude(tables);
        }
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        fillArrayList.add(new TableFill(TableFillName,FieldFill.INSERT_UPDATE));
        fillArrayList.add(new TableFill(TableFillName1,FieldFill.INSERT_UPDATE));
        strategy.setSuperMapperClass("com.baomidou.mybatisplus.core.mapper.BaseMapper");
        // strategy.setSuperEntityColumns("id");
        strategy.setTablePrefix("t_");
        strategy.setTableFillList(fillArrayList);
        mpg.setStrategy(strategy);
    }
    //全局配置
    private static void setPropertyConfig() {
        // String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setMapperName("%sMapper");
        gc.setXmlName("%sMapper");
        gc.setServiceName("I%sService");
        gc.setServiceImplName("I%sServiceImpl");
        gc.setControllerName("%sController");
        gc.setIdType(IdType.AUTO);
        gc.setAuthor(Author);
        gc.setFileOverride(true);
        gc.setOpen(false);
        gc.setEnableCache(false);// XML 二级缓存
        gc.setBaseResultMap(true);// XML ResultMap
        gc.setBaseColumnList(false);// XML columList
        // gc.setSwagger2(true);   //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);
    }
    //数据源配置
    private static void setDataSourceConfig() {
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(URL);
        dsc.setDriverName(DRIVER_NAME);
        dsc.setUsername(USER_NAME);
        dsc.setPassword(PASSWORD);
        mpg.setDataSource(dsc);
    }
    //包配置
    private static void setPackageConfig() {
        PackageConfig pc = new PackageConfig();
        // pc.setModuleName(scanner("模块名"));
        // pc.setParent("com.example.tmall"); // 自定义包路径
        pc.setController("controller"); // 这里是控制器包名，默认 web
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setServiceImpl("service.impl");
        pc.setXml("mapper");
        mpg.setPackageInfo(pc);
        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };

        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 自定义输出配置
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                         + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);
        mpg.setTemplate(new TemplateConfig().setXml(null));
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        mpg.execute();
        // 配置模板
        // TemplateConfig templateConfig = new TemplateConfig();
        // templateConfig.setXml(null);
        // mpg.setTemplate(templateConfig);
    }
}

生成的包结构

标签：Plus,SpringBoot,private,static,Mybatis,new,id,gc,String
From： https://www.cnblogs.com/zhaojinhui/p/16730127.html

简介

功能

无侵入

损耗小