美文网首页
MyBatis-Plus 的代码生成器

MyBatis-Plus 的代码生成器

作者: 虾米咬小米 | 来源:发表于2020-08-06 09:35 被阅读0次

    AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。


    generator.gif
    
    /**
     * @author zhaopf@mti-sh.cn
     * @Description TODO
     * @createTime 2020年08月05日
     */
    // 执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
    public class CodeGenerator {
    
        /**
         * <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 (StringUtils.isNotEmpty(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 + "/smart-web/src/main/java");
            gc.setAuthor("zpf");
            gc.setOpen(false);
            gc.setSwagger2(true);// 实体属性 Swagger2 注解
            /**
             * 各层文件名称方式,例如: %sAction 生成 UserAction
             * %s 为占位符
             */
            gc.setEntityName("%sEntity");
            mpg.setGlobalConfig(gc);
    
            // 数据源配置
            DataSourceConfig dsc = new DataSourceConfig();
            dsc.setUrl("jdbc:postgresql://10.168.4.225:5431/smart-park?useSSL=false&allowMultiQueries=true");
            // dsc.setSchemaName("public");
            dsc.setDriverName("org.postgresql.Driver");
            dsc.setUsername("postgres");
            dsc.setPassword("abX123ads");
            mpg.setDataSource(dsc);
    
            // 包配置
            PackageConfig pc = new PackageConfig();
    //        pc.setModuleName(scanner("模块名"));
            pc.setParent("com.daoshu.smart");
            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 + "/smart-web/src/main/resources/mapper/" + pc.getModuleName()
                            + "/" + tableInfo.getEntityName().substring(0,tableInfo.getEntityName().length()-6) + "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();
            strategy.setNaming(NamingStrategy.underline_to_camel);
            strategy.setColumnNaming(NamingStrategy.underline_to_camel);
    //        strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
            strategy.setEntityLombokModel(true);
            strategy.setRestControllerStyle(true);
            // 公共父类
    //        strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
            // 写于父类中的公共字段
    //        strategy.setSuperEntityColumns("id");
            strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
            strategy.setControllerMappingHyphenStyle(true);
            //去掉表前缀
            strategy.setTablePrefix("t_");
            mpg.setStrategy(strategy);
            mpg.setTemplateEngine(new FreemarkerTemplateEngine());
            mpg.execute();
        }
    
    }
    

    使用教程

    #添加依赖

    MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖:

    • 添加 代码生成器 依赖

      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>mybatis-plus-generator</artifactId>
          <version>3.3.2</version>
      </dependency>
      
      
    • 添加 模板引擎 依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。

      Velocity(默认):

      <dependency>
          <groupId>org.apache.velocity</groupId>
          <artifactId>velocity-engine-core</artifactId>
          <version>2.2</version>
      </dependency>
      
      

      Freemarker:

      <dependency>
          <groupId>org.freemarker</groupId>
          <artifactId>freemarker</artifactId>
          <version>2.3.30</version>
      </dependency>
      
      

      Beetl:

      <dependency>
          <groupId>com.ibeetl</groupId>
          <artifactId>beetl</artifactId>
          <version>3.1.8.RELEASE</version>
      </dependency>
      
      

      注意!如果您选择了非默认引擎,需要在 AutoGenerator 中 设置模板引擎。

      AutoGenerator generator = new AutoGenerator();
      
      // set freemarker engine
      generator.setTemplateEngine(new FreemarkerTemplateEngine());
      
      // set beetl engine
      generator.setTemplateEngine(new BeetlTemplateEngine());
      
      // set custom engine (reference class is your custom engine class)
      generator.setTemplateEngine(new CustomTemplateEngine());
      
      // other config
      ...
      
      

    #编写配置

    MyBatis-Plus 的代码生成器提供了大量的自定义参数供用户选择,能够满足绝大部分人的使用需求。

    • 配置 GlobalConfig

      GlobalConfig globalConfig = new GlobalConfig();
      globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
      globalConfig.setAuthor("jobob");
      globalConfig.setOpen(false);
      
      
    • 配置 DataSourceConfig

      DataSourceConfig dataSourceConfig = new DataSourceConfig();
      dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
      dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
      dataSourceConfig.setUsername("root");
      dataSourceConfig.setPassword("password");
      
      

    参考:
    官网代码生成器

    mybatisplus自动生成-参数、模板

    相关文章

      网友评论

          本文标题:MyBatis-Plus 的代码生成器

          本文链接:https://www.haomeiwen.com/subject/hsxzrktx.html