spring boot mybatis plus自动生成代码器（完整工程）

ゝ一世哀愁。 2023-02-17 05:28 18阅读 0赞

mybatis plus可以使用模板完成代码的自动生成，再创建新的项目时，更新数据库表时，都可以直接使用代码生成器直接生成新的代码。

具体实现步骤如下：  
第一步：引入代码生成器依赖的jar包

<dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-logging</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.3.2</version>
            </dependency>
            
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>3.3.2</version>
            </dependency>
            
            <dependency>
                <groupId>org.freemarker</groupId>
                <artifactId>freemarker</artifactId>
                <version>2.3.28</version>
            </dependency>
            
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>
            
            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.21</version>
            </dependency>
            
            <dependency>
                <groupId>io.shardingjdbc</groupId>
                <artifactId>sharding-jdbc-core</artifactId>
                <version>2.0.3</version>
            </dependency>
    
            <dependency>
                <groupId>com.lmax</groupId>
                <artifactId>disruptor</artifactId>
                <version>3.4.2</version>
            </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>

第二步：编写代码生成器

import com.baomidou.mybatisplus.annotation.IdType;
    import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
    import com.baomidou.mybatisplus.generator.AutoGenerator;
    import com.baomidou.mybatisplus.generator.InjectionConfig;
    import com.baomidou.mybatisplus.generator.config.*;
    import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
    import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
    import lombok.Data;
    
    import java.io.File;
    import java.io.FileInputStream;
    import java.io.IOException;
    import java.io.InputStream;
    import java.util.Properties;
    import java.util.Scanner;
    
    @Data
    public class CodeGenerator { 
    
        /** * 配置文件名 */
        private final static String APP_PROPERTY = "application-dev.properties";
        private String projectPath = System.getProperty("user.dir");
        /** * 公共包路径 */
        private String parentPackage = "com.geexek.www";
        /** * 模块名 */
        private String module = "geexekscore";
    
        /** * 自定义模板位置 */
        private String templatePath = "templates/mp/";
        private String controllerTemplate = templatePath + "controller.java";
        private String serviceTemplate = templatePath + "service.java";
        private String serviceImplTemplate = templatePath + "serviceImpl.java";
        private String mapperTemplate = templatePath + "mapper.java";
    
    
        public static void main(String[] args) { 
            //全局配置
            CodeGenerator codeGenerator = new CodeGenerator();
            codeGenerator.execute();
        }
    
        /** * <p> * 读取控制台内容 * </p> */
        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 (ipt != null && !ipt.trim().isEmpty()) { 
                    return ipt;
                }
            }
            throw new MybatisPlusException("请输入正确的" + tip + "！");
        }
    
    
        public void execute() { 
            // 代码生成器
            AutoGenerator mpg = new AutoGenerator();
    
            /** * 全局配置 */
            GlobalConfig gc = new GlobalConfig();
            //生成文件输出目录
            gc.setOutputDir(projectPath + "/src/main/java");
            //每个文件注释部分的创建者
            gc.setAuthor("sunyuhua");
            //是否打开输出目录
            gc.setOpen(false);
            //开启 ActiveRecord 模式
            gc.setActiveRecord(true);
            //指定生成的主键的ID类型
            gc.setIdType(IdType.AUTO);
            //各层文件名称方式，例如： %sService 生成 UserService
            gc.setServiceName("%sService");
            //开启 BaseResultMap
            gc.setBaseResultMap(true);
            //开启 baseColumnList
            gc.setBaseColumnList(true);
            //是否覆盖已有文件
            gc.setFileOverride(true);
            //实体属性 Swagger2 注解,开启 swagger2 模式
            gc.setSwagger2(true);
            //全局 相关配置
            mpg.setGlobalConfig(gc);
    
            /** * 数据源配置 */
    
            mpg.setDataSource(dataSourceConfig());
    
            /** * 包配置 */
            PackageConfig pc = new PackageConfig();
            //父包名。如果为空，将下面子包名必须写全部， 否则就只需写子包名
            pc.setParent(parentPackage);
            //父包模块名
            pc.setModuleName(module);
            mpg.setPackageInfo(pc);
    
    
            /** * 自定义配置 */
            InjectionConfig cfg = new InjectionConfig() { 
                @Override
                public void initMap() { 
                    // to do nothing
                }
            };
            mpg.setCfg(cfg);
    
            /** * 配置模板 */
            TemplateConfig templateConfig = new TemplateConfig();
            // 配置自定义输出模板
            //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
            templateConfig.setXml(null);
            templateConfig.setService(serviceTemplate);
            templateConfig.setServiceImpl(serviceImplTemplate);
            templateConfig.setMapper(mapperTemplate);
            templateConfig.setController(controllerTemplate);
            mpg.setTemplate(templateConfig);
    
            /** * 策略配置 */
            StrategyConfig strategy = new StrategyConfig();
            //数据库表映射到实体的命名策略,将下划线转驼峰命名
            strategy.setNaming(NamingStrategy.underline_to_camel);
            //数据库表字段映射到实体的命名策略,下划线转驼峰命名
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
            //【实体】是否为lombok模型（默认 false),lombok模型更为简单
            strategy.setEntityLombokModel(true);
            //生成 <code>@RestController</code> 控制器,即为controller层的注解@RestController
            strategy.setRestControllerStyle(true);
            // 公共父类
            //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
            strategy.setSuperEntityColumns("id");
            //将数据库表中的gk_开头的前缀去掉
            strategy.setTablePrefix("gk_");
            //设置生成模式，表名之间用逗号分隔
            strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
            //驼峰转连字符,
            // <code>@RequestMapping("/managerUserActionHistory")</code> -> <code>@RequestMapping("/manager-user-action-history")</code>
            strategy.setControllerMappingHyphenStyle(true);
            mpg.setStrategy(strategy);
    
            /** * 设置模板引擎 */
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    
        /** * 设置DataSource * @return */
        private static DataSourceConfig dataSourceConfig() { 
            DataSourceConfig dsc = new DataSourceConfig();
            String resourcePath = System.getProperty("user.dir") + "/src/main/resources/" + APP_PROPERTY;
            try { 
                InputStream inStream = new FileInputStream(new File(resourcePath));
                Properties prop = new Properties();
                prop.load(inStream);
                dsc.setUrl(prop.getProperty("spring.datasource.url"));
                dsc.setDriverName(prop.getProperty("spring.datasource.driver-class-name"));
                dsc.setUsername(prop.getProperty("spring.datasource.username"));
                dsc.setPassword(prop.getProperty("spring.datasource.password"));
            } catch (IOException e) { 
                e.printStackTrace();
            }
            return dsc;
        }
    
    }

第三步：整理模板，编辑好模板  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70]  
第四步：运行代码，输入表名，执行代码生成器

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70 1]  
第五步：查看生成的代码  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70 2]

完整工程下载地址：

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200612235034763.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200612234412654.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200612235219972.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3N1bnl1aHVhX2tleWJvYXJk,size_16,color_FFFFFF,t_70