mybatisplus--代码生成器

柔情只为你懂 2022-01-06 03:55 413阅读 0赞

## pom.xml ##

<dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.4.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.freemarker</groupId
                <artifactId>freemarker</artifactId>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.0.3</version>
            </dependency>
    
            
            
           <dependency>
                <groupId>org.mybatis.spring.boot</groupId>
                <artifactId>mybatis-spring-boot-starter</artifactId>
                <version>1.3.2</version>
            </dependency>

--------------------

## mybatisplus 代码生成器 ##

package com.java.common.mybatisPlus;
    
    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.NamingStrategy;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    import org.apache.commons.lang3.StringUtils;
    
    import java.util.ArrayList;
    import java.util.List;
    
    /**
     * <p>
     * 通过junit test 生成代码
     * 演示：自定义代码模板
     * 默认不会覆盖已有文件，如果需要覆盖，配置GlobalConfig.setFileOverride(true)
     * </p>
     *
     * @author admin
     */
    public class CodeGeneration {
        /**
         * 根获取项目路径
         */
        static String projectPath = System.getProperty("user.dir");
        public static void main(String[] args) {
            /** 需要生成单表的名称 */
            String tableNamesInclude = "sys_user";
    
            /** 生成代码存放的路径 */
            String parent = "com.java";
            AutoGenerator mpg = new AutoGenerator();
            //定义模板是  Freemarker
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            // 全局配置
            GlobalConfig gc = new GlobalConfig();
            gc.setOutputDir(projectPath + "/src/main/java");
            gc.setAuthor("szw");
            gc.setOpen(false);
            // XML ResultMap  返回结果
            gc.setBaseResultMap(false);
            // XML columList 通用查询结果列通用结果列
            gc.setBaseColumnList(true);
            //开启 swagger2 模式
            gc.setSwagger2(false);
    
            //默认不覆盖，如果文件存在，将不会再生成，配置true就是覆盖
            gc.setFileOverride(true);
            mpg.setGlobalConfig(gc);
    
            /** 数据源配置 */
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/springboot-test?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&nullCatalogMeansCurrent=true");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("123456");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            //设置包路径
            pc.setParent(parent);
            mpg.setPackageInfo(pc);
    
            // 策略配置  数据库配置
            StrategyConfig strategy = new StrategyConfig();
    
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //开启lombok
            strategy.setEntityLombokModel(true);
            //开启 链式模型
            strategy.setChainModel(true);
    
            //输入单表名称则只生成相应的单表文件
            if (StringUtils.isNotBlank(tableNamesInclude)) {
                strategy.setInclude(tableNamesInclude);
            }
    
            strategy.setControllerMappingHyphenStyle(true);
            strategy.setTablePrefix(pc.getModuleName() + "_");
            strategy.setEntityTableFieldAnnotationEnable(true);
            //生成 @RestController 控制器
            strategy.setRestControllerStyle(true);
            mpg.setStrategy(strategy);
            // 选择 freemarker 引擎需要指定如下加，注意 pom 依赖必须有！
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            configCustomizedCodeTemplate(mpg);
            configInjection(mpg);
            mpg.execute();
    
            System.out.println("代码生成完成");
        }
    
        /**
         * 自定义模板
         *
         * @param mpg
         */
        private static void configCustomizedCodeTemplate(AutoGenerator mpg) {
            //配置 自定义模板
            TemplateConfig templateConfig = new TemplateConfig()
                    //指定Entity生成使用自定义模板
                    .setEntity("templates/MyEntityTemplate.java")
                    //指定Controller生成使用自定义模板
                    .setController("templates/MyControllerTemplate.java")
                    //指定Mapper接口模板
                    .setMapper("templates/MyMapperTemplate.java")
                    .setXml(null)
                    .setService("templates/MyService.java")
                    .setServiceImpl("templates/MyServiceImpl.java");
            mpg.setTemplate(templateConfig);
        }
    
        /**
         * 配置自定义参数/属性
         *
         * @param mpg
         */
        private static void configInjection(AutoGenerator mpg) {
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
    
                }
            };
            List<FileOutConfig> focList = new ArrayList<>();
            focList.add(new FileOutConfig("/templates/MyMapper.xml.ftl") {
                @Override
                public String outputFile(TableInfo tableInfo) {
                    // 指定mapper.xml  模板生成，自定义生成文件到哪个地方
                    return projectPath + "/src/main/resources/mapper/"
                            + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
        }
    }

--------------------

在 上文代码中找到 **configCustomizedCodeTemplate** 方法，进入 **TemplateConfig** 类  
定位过去。找到系统内置模板，这些模板可以拷贝到本地项目中，例如上文代码中  
**templates/MyEntityTemplate.java**，本人配置的模板将在后续贴出。

**TemplateConfig** 这个类是重点类

在mapper.xml的模板中可以读取 **TemplateConfig** 类中的属性进行操作，  
下段代码的语法是  
[FreeMarker模板在线手册][FreeMarker]

<#--field.type   写法 同等 ${ field.type}-->
    <#if field.type?contains("varchar")> and ${ field.propertyName} != ''</#if>

--------------------

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjI2MTc2_size_16_color_FFFFFF_t_70_pic_center]

--------------------

## application.yml ##

spring:
      datasource:
        url: jdbc:mysql://localhost:3306/biji?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&allowMultiQueries=true&useSSL=false&serverTimezone=UTC
        username: root
        password: 123456
        driver-class-name: com.mysql.cj.jdbc.Driver
    
    debug: false
    
    ########## Mybatis 自身配置 ##########
    mybatis-plus:
      # 注意注意
      # 如果是放在src/main/java目录下 classpath:/com/yourpackage/*/mapper/*Mapper.xml
      # 如果是放在resource目录 classpath:/mapper/*Mapper.xml
      mapper-locations: classpath:mapper/*.xml
      #实体扫描，多个package用逗号或者分号分隔
      type-aliases-package: com.mysql.entity
      global-config:
        db-config:
          #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
          field-strategy: not_empty
          #主键类型
          #实体类主键策略有3种（ 注解 > 全局 > 默认 ）
          #AUTO 数据库ID自增
          #INPUT 用户输入ID
          #ID_WORKER 全局唯一ID，Long类型的主键
          #ID_WORKER_STR 字符串全局唯一ID
          #UUID 全局唯一ID，UUID类型的主键
          #NONE 该类型为未设置主键类型
          id-type: auto
          #驼峰下划线转换
          db-column-underline: true
          #表名、是否使用下划线命名，默认数据库表使用下划线命名  true
          table-underline: true
          #刷新mapper 调试神器
          refresh-mapper: true
          #数据库大写下划线转换
          capital-mode: true
    
      configuration:
        #MyBatis 自动映射时未知列或未知属性处理策略，通过该配置可指定 MyBatis 在自动映射过程中遇到未知
        #NONE：不做任何处理 (默认值)
        #WARNING：以日志的形式打印相关警告信息 .
        #FAILING：当作映射失败处理，并抛出异常和详细信息
        auto-mapping-unknown-column-behavior: failing
        #解决 resultMap 为map时值为空不返回的场景
        call-setters-on-nulls: true

[mybatis-plus 自定义代码生成器模板][mybatis-plus]

[FreeMarker]: http://freemarker.foofun.cn/ref_builtins_string.html#ref_builtin_contains
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1MjI2MTc2_size_16_color_FFFFFF_t_70_pic_center]: /images/20211228/6e153de706804a42a1a7b857a3f7499c.png
[mybatis-plus]: https://blog.csdn.net/qq_35226176/article/details/109062845