Springboot 集成 MybatisPlus Generator 代码生成器（Velocity模板）

素颜马尾好姑娘i 2023-02-20 07:17 14阅读 0赞

### MybatisPlus Generator 代码生成器 ###

*   *  Maven依赖
     *  CURD代码生成器
     *  模板内容

懒得写各种重复的curd代码，从数据库表生成各种Entity、Mapper、Service，值得你拥有，废话不多说上代码

## Maven依赖 ##

<parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.0.5.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>demo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>mybatis-plus-generator</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.7.0</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.7.0</version>
            </dependency>
            
    
            
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity</artifactId>
                <version>1.7</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.1.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.1.0</version>
            </dependency>
    
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
    
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
                <optional>true</optional>
            </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>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>

## CURD代码生成器 ##

package com.example.demo.my;
    
    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.VelocityTemplateEngine;
    
    import java.util.*;
    
    // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
    // 参考官网https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B编写
    //templates下模板均从jar包mybatis-plus-generator里复制出来的一份，修改即可
    public class CodeGenerator { 
    
        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("admin");
            gc.setOpen(false);
    // gc.setActiveRecord(true);//支持AR操作
            gc.setFileOverride(true); //是否覆盖
            gc.setBaseResultMap(true);// 生成 ResultMap
            gc.setBaseColumnList(true);// 生成 columList
            gc.setSwagger2(true);// 是否Swagger2注解
            // 自定义文件命名，注意 %s 会自动填充表实体属性！
    // gc.setEntityName("%sEntity");
    // gc.setMapperName("%sDao");
    // gc.setXmlName("%sMapper");
    // gc.setServiceName("MP%sService");
    // gc.setServiceImplName("%sServiceDiy");
    // gc.setControllerName("%sAction");
    // gc.setSwagger2(true); //实体属性 Swagger2 注解
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/velocity?useUnicode=true&useSSL=false&characterEncoding=utf8");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("ADMIN123");
            mpg.setDataSource(dsc);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
            strategy.setTablePrefix(new String[]{ "t_"});// 此处可以修改为您的表前缀
            strategy.setNaming(NamingStrategy.underline_to_camel);// 数据库表映射到实体的命名策略
    // strategy.setInclude(new String[]{"t_user"}); // 需要生成的表
    // strategy.setEntityBuilderModel(true);
            // 自定义实体父类
            // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
            // 自定义实体，公共字段
            // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
            // 自定义 mapper 父类
            // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
            // 自定义 service 父类
            // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
            // 自定义 service 实现类父类
            // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
            // 自定义 controller 父类
            // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
            // 是否使用Lombok简化代码
            strategy.setEntityLombokModel(true);
            mpg.setStrategy(strategy);
    
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            pc.setParent("com.example.demo");
    // pc.setEntity("");
    // pc.setService("");
    // pc.setServiceImpl("");
    // pc.setMapper("");
    // pc.setXml("");
            mpg.setPackageInfo(pc);
    
            // 配置模板
            TemplateConfig templateConfig = new TemplateConfig();
            //不生成如下类型模板
            templateConfig.setXml(null);
            mpg.setTemplate(templateConfig);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                }
            };
    
    // // 如果模板引擎是 velocity
            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.setTemplateEngine(new VelocityTemplateEngine());//默认模板引擎
            mpg.setCfg(cfg);
            // 执行生成
            mpg.execute();
            //AbstractTemplateEngine自定义模板引擎需要继承
        }
    
    }

## 模板内容 ##

默认情况下不配置模板，会使用mybatis-plus-generator.jar包里的templates默认模板，若要自定义模板  
可以从mybatis-plus-generator.jar里拷贝出来的,在此基础上修改，直接放到当前项目下的templates文件夹下即可。

**Mapper.xml.vm**

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
    <mapper namespace="${package.Mapper}.${table.mapperName}">
    
    #if(${ enableCache})
        
        <cache type="org.mybatis.caches.ehcache.LoggingEhcache"/>
    
    #end
    #if(${ baseResultMap})
        
        <resultMap id="BaseResultMap" type="${package.Entity}.${entity}">
    #foreach($field in ${ table.fields})
    #if(${ field.keyFlag})##生成主键排在第一位
            <id column="${field.name}" property="${field.propertyName}" />
    #end
    #end
    #foreach($field in ${ table.commonFields})##生成公共字段
        <result column="${field.name}" property="${field.propertyName}" />
    #end
    #foreach($field in ${ table.fields})
    #if(!${ field.keyFlag})##生成普通字段
            <result column="${field.name}" property="${field.propertyName}" />
    #end
    #end
        </resultMap>
    
    #end
    #if(${ baseColumnList})
        
        <sql id="Base_Column_List">
    #foreach($field in ${ table.commonFields})
            ${ field.name},
    #end
            ${ table.fieldNames}
        </sql>
    
    #end
    </mapper>

官方[mybatis-plus generator][]

[mybatis-plus generator]: https://mp.baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B