代码生成器

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

特别说明:

自定义模板有哪些可用参数？Github代码生成器 - 图1Gitee代码生成器 - 图2 AbstractTemplateEngine 类中方法 getObjectMap 返回 objectMap 的所有值都可用。

演示效果图：

relationship

  1. // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
  2. public class CodeGenerator {
  4.     /**
  5.      * <p>
  6.      * 读取控制台内容
  7.      * </p>
  8.      */
  9.     public static String scanner(String tip) {
  10.         Scanner scanner = new Scanner(System.in);
  11.         StringBuilder help = new StringBuilder();
  12.         help.append("请输入" + tip + "：");
  13.         System.out.println(help.toString());
  14.         if (scanner.hasNext()) {
  15.             String ipt = scanner.next();
  16.             if (StringUtils.isNotEmpty(ipt)) {
  17.                 return ipt;
  18.             }
  19.         }
  20.         throw new MybatisPlusException("请输入正确的" + tip + "！");
  21.     }
  23.     public static void main(String[] args) {
  24.         // 代码生成器
  25.         AutoGenerator mpg = new AutoGenerator();
  27.         // 全局配置
  28.         GlobalConfig gc = new GlobalConfig();
  29.         String projectPath = System.getProperty("user.dir");
  30.         gc.setOutputDir(projectPath + "/src/main/java");
  31.         gc.setAuthor("jobob");
  32.         gc.setOpen(false);
  33.         // gc.setSwagger2(true); 实体属性 Swagger2 注解
  34.         mpg.setGlobalConfig(gc);
  36.         // 数据源配置
  37.         DataSourceConfig dsc = new DataSourceConfig();
  38.         dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
  39.         // dsc.setSchemaName("public");
  40.         dsc.setDriverName("com.mysql.jdbc.Driver");
  41.         dsc.setUsername("root");
  42.         dsc.setPassword("密码");
  43.         mpg.setDataSource(dsc);
  45.         // 包配置
  46.         PackageConfig pc = new PackageConfig();
  47.         pc.setModuleName(scanner("模块名"));
  48.         pc.setParent("com.baomidou.ant");
  49.         mpg.setPackageInfo(pc);
  51.         // 自定义配置
  52.         InjectionConfig cfg = new InjectionConfig() {
  53.             @Override
  54.             public void initMap() {
  55.                 // to do nothing
  56.             }
  57.         };
  59.         // 如果模板引擎是 freemarker
  60.         String templatePath = "/templates/mapper.xml.ftl";
  61.         // 如果模板引擎是 velocity
  62.         // String templatePath = "/templates/mapper.xml.vm";
  64.         // 自定义输出配置
  65.         List<FileOutConfig> focList = new ArrayList<>();
  66.         // 自定义配置会被优先输出
  67.         focList.add(new FileOutConfig(templatePath) {
  68.             @Override
  69.             public String outputFile(TableInfo tableInfo) {
  70.                 // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
  71.                 return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
  72.                         + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
  73.             }
  74.         });
  75.         /*
  76.         cfg.setFileCreate(new IFileCreate() {
  77.             @Override
  78.             public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
  79.                 // 判断自定义文件夹是否需要创建
  80.                 checkDir("调用默认方法创建的目录");
  81.                 return false;
  82.             }
  83.         });
  84.         */
  85.         cfg.setFileOutConfigList(focList);
  86.         mpg.setCfg(cfg);
  88.         // 配置模板
  89.         TemplateConfig templateConfig = new TemplateConfig();
  91.         // 配置自定义输出模板
  92.         //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
  93.         // templateConfig.setEntity("templates/entity2.java");
  94.         // templateConfig.setService();
  95.         // templateConfig.setController();
  97.         templateConfig.setXml(null);
  98.         mpg.setTemplate(templateConfig);
  100.         // 策略配置
  101.         StrategyConfig strategy = new StrategyConfig();
  102.         strategy.setNaming(NamingStrategy.underline_to_camel);
  103.         strategy.setColumnNaming(NamingStrategy.underline_to_camel);
  104.         strategy.setSuperEntityClass("com.baomidou.ant.common.BaseEntity");
  105.         strategy.setEntityLombokModel(true);
  106.         strategy.setRestControllerStyle(true);
  107.         // 公共父类
  108.         strategy.setSuperControllerClass("com.baomidou.ant.common.BaseController");
  109.         // 写于父类中的公共字段
  110.         strategy.setSuperEntityColumns("id");
  111.         strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
  112.         strategy.setControllerMappingHyphenStyle(true);
  113.         strategy.setTablePrefix(pc.getModuleName() + "_");
  114.         mpg.setStrategy(strategy);
  115.         mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  116.         mpg.execute();
  117.     }
  119. }

更多详细配置，请参考代码生成器配置一文。

使用教程

添加依赖

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

  • 添加 代码生成器 依赖
  1. <dependency>
  2.     <groupId>com.baomidou</groupId>
  3.     <artifactId>mybatis-plus-generator</artifactId>
  4.     <version>latest-version</version>
  5. </dependency>
  • 添加 模板引擎 依赖，MyBatis-Plus 支持 Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。

Velocity（默认）：

  1. <dependency>
  2.     <groupId>org.apache.velocity</groupId>
  3.     <artifactId>velocity-engine-core</artifactId>
  4.     <version>latest-velocity-version</version>
  5. </dependency>

Freemarker：

  1. <dependency>
  2.     <groupId>org.freemarker</groupId>
  3.     <artifactId>freemarker</artifactId>
  4.     <version>latest-freemarker-version</version>
  5. </dependency>

Beetl：

  1. <dependency>
  2.     <groupId>com.ibeetl</groupId>
  3.     <artifactId>beetl</artifactId>
  4.     <version>latest-beetl-version</version>
  5. </dependency>

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

  1. AutoGenerator generator = new AutoGenerator();
  3. // set freemarker engine
  4. generator.setTemplateEngine(new FreemarkerTemplateEngine());
  6. // set beetl engine
  7. generator.setTemplateEngine(new BeetlTemplateEngine());
  9. // set custom engine (reference class is your custom engine class)
  10. generator.setTemplateEngine(new CustomTemplateEngine());
  12. // other config
  13. ...

编写配置

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

  • 配置 GlobalConfig
  1. GlobalConfig globalConfig = new GlobalConfig();
  2. globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
  3. globalConfig.setAuthor("jobob");
  4. globalConfig.setOpen(false);
  • 配置 DataSourceConfig
  1. DataSourceConfig dataSourceConfig = new DataSourceConfig();
  2. dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
  3. dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
  4. dataSourceConfig.setUsername("root");
  5. dataSourceConfig.setPassword("password");

自定义模板引擎

请继承类 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

自定义代码模板

  1. //指定自定义模板路径, 位置：/resources/templates/entity2.java.ftl(或者是.vm)
  2. //注意不要带上.ftl(或者是.vm), 会根据使用的模板引擎自动识别
  3. TemplateConfig templateConfig = new TemplateConfig()
  4.     .setEntity("templates/entity2.java");
  6. AutoGenerator mpg = new AutoGenerator();
  7. //配置自定义模板
  8. mpg.setTemplate(templateConfig);

自定义属性注入

  1. InjectionConfig injectionConfig = new InjectionConfig() {
  2.     //自定义属性注入:abc
  3.     //在.ftl(或者是.vm)模板中，通过${cfg.abc}获取属性
  4.     @Override
  5.     public void initMap() {
  6.         Map<String, Object> map = new HashMap<>();
  7.         map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
  8.         this.setMap(map);
  9.     }
  10. };
  11. AutoGenerator mpg = new AutoGenerator();
  12. //配置自定义属性注入
  13. mpg.setCfg(injectionConfig);
  1. entity2.java.ftl
  2. 自定义属性注入abc=${cfg.abc}
  4. entity2.java.vm
  5. 自定义属性注入abc=$!{cfg.abc}

字段其他信息查询注入

relationship

  1. new DataSourceConfig().setDbQuery(new MySqlQuery() {
  3.     /**
  4.      * 重写父类预留查询自定义字段<br>
  5.      * 这里查询的 SQL 对应父类 tableFieldsSql 的查询字段，默认不能满足你的需求请重写它<br>
  6.      * 模板中调用：  table.fields 获取所有字段信息，
  7.      * 然后循环字段获取 field.customMap 从 MAP 中获取注入字段如下  NULL 或者 PRIVILEGES
  8.      */
  9.     @Override
  10.     public String[] fieldCustom() {
  11.         return new String[]{"NULL", "PRIVILEGES"};
  12.     }
  13. })