• mybatis-plus代码生成器【逆向工程】搭配Lombok和swagger2


    前言

    • 日常开发中,单表操作的模块文件编写比较重复且耗费时间

    • 如果项目中使用mybatis-plus,则可以尝试其自家的逆向工程工具,快速生成数据库中对应的所有mvc结构文件和实体类,以及mapper.xml文件,降低时间成本

    • 可以配置lombok、swagger、@RestController等常用工具、注解

    • mybatis-plus代码生成器文档



    一、 添加逆向工程所需的相关pom坐标

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <!-- mybatis-plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.4.2</version>
    </dependency>
    <!-- mybatis-plus 代码生成器 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.4.1</version>
    </dependency>
    
    <!-- mybatis-plus 代码生成器默认模板 -->
    <!--<dependency>-->
    <!--    <groupId>org.apache.velocity</groupId>-->
    <!--    <artifactId>velocity-engine-core</artifactId>-->
    <!--    <version>2.2</version>-->
    <!--</dependency>-->
    <dependency>
        <groupId>org.freemarker</groupId>
        <artifactId>freemarker</artifactId>
        <version>2.3.31</version>
    </dependency>
    
    

    二、 在项目中添加AutoGenerator代码生成器入口文件,启动文件即可

    • AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
    public class CodeGenerator {
    
        /**
         * <p>
         * 读取控制台内容
         * </p>
         */
        public static String scanner(String tip) {
            Scanner scanner = new Scanner(System.in);
            System.out.println("请输入" + tip + ":");
            if (scanner.hasNext()) {
                String ipt = scanner.next();
                if (StringUtils.isNotBlank(ipt)) {
                    return ipt;
                }
            }
            throw new MybatisPlusException("请输入正确的" + tip + "!");
        }
    
        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("suhai");
            gc.setBaseResultMap(true);    //xml开启BaseResultMap
            gc.setBaseColumnList(true);   //xml开启BaseColumnList
            gc.setOpen(false);      //代码生成后打开目录
            gc.setSwagger2(true);   // 实体属性 Swagger2 注解
            gc.setServiceName("%sService"); //设置service名称,否则service的接口名称为 "IXXXService",设置后加入I前缀
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:mysql://localhost:3306/数据库名称?useUnicode=true&useSSL=false&characterEncoding=utf8");
            // dsc.setSchemaName("public");
            dsc.setDriverName("com.mysql.cj.jdbc.Driver");
            dsc.setUsername("root");
            dsc.setPassword("数据库密码");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
            //配置包结构模块名,一般为com.xxxx.模块名.pojo,数据库表结构名称前缀也可以一样
            //pc.setModuleName(scanner("模块名"));
            pc.setParent("com.xxxx")
                    .setEntity("pojo")
                    .setMapper("mapper")
                    .setService("service")
                    .setServiceImpl("service.impl")
                    .setController("controller");
            mpg.setPackageInfo(pc);
    
            // 自定义配置
            InjectionConfig cfg = new InjectionConfig() {
                @Override
                public void initMap() {
                    // to do nothing
                }
            };
    
            // 如果模板引擎是 freemarker
            String templatePath = "/templates/mapper.xml.ftl";
            // 如果模板引擎是 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 + "/yeb-generator/src/main/resources/mapper/"
                            + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
                }
            });
            /*
            cfg.setFileCreate(new IFileCreate() {
                @Override
                public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                    // 判断自定义文件夹是否需要创建
                    checkDir("调用默认方法创建的目录,自定义目录用");
                    if (fileType == FileType.MAPPER) {
                        // 已经生成 mapper 文件判断存在,不想重新生成返回 false
                        return !new File(filePath).exists();
                    }
                    // 允许生成模板文件
                    return true;
                }
            });
            */
            cfg.setFileOutConfigList(focList);
            mpg.setCfg(cfg);
    
            // 配置模板
            TemplateConfig templateConfig = new TemplateConfig();
    
            // 配置自定义输出模板
            // 指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
            // templateConfig.setEntity("templates/entity2.java");
            // templateConfig.setService();
            // templateConfig.setController();
    
            templateConfig.setXml(null);
            mpg.setTemplate(templateConfig);
    
            // 策略配置
            StrategyConfig strategy = new StrategyConfig();
            // 数据库表映射到实体的命名策略,underline_to_camel:下划线转驼峰命名 no_change:不做任何改变,原样输出
            strategy.setNaming(NamingStrategy.underline_to_camel);
            // 数据库表字段映射到实体的命名策略,策略同上
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
            // Lombok原型
            strategy.setEntityLombokModel(true);
            // 生成@RestController控制器
            strategy.setRestControllerStyle(true);
            //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
            // 公共父类
            //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
            //strategy.setSuperEntityColumns("id");
            // 指定要生成的表名称,若需要生成所有表,则不需要配置
            strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            // 表前缀
            //strategy.setTablePrefix(pc.getModuleName() + "_");
            strategy.setTablePrefix("t_");  //这里的 "t_" 为数据库表名称前缀,例如:t_admin,主要在生成文件时起去除前缀的作用
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    }
    
    
  • 相关阅读:
    Laravel之路——缓存使用
    Laravel之路——file缓存修改为redis缓存
    PHP之路——Redis安装
    Laravel之路——事务
    Laravel框架——任务调度(cron)
    PHPStorm——配置修改
    Laravel框架——分页
    Laravel框架——Session操作
    Laravel框架——自己写的类找不到
    iwlist/iwconfig/iw命令
  • 原文地址:https://www.cnblogs.com/wuyiz/p/14489273.html
Copyright © 2020-2023  润新知