代码生成器

在代码生成之前，首先进行配置，MP提供了大量的自定义设置，生成的代码完全能够满足各类型的需求，如果你发现配置不能满足你的需求，欢迎提交issue和pull-request，有兴趣的也可以查看源码进行了解。

默认配置，懒人直达电梯

参数说明

参数相关的配置，详见源码

主键策略选择

MP支持以下4中主键策略，可根据需求自行选用：

值描述
IdType.AUTO数据库ID自增
IdType.INPUT用户输入ID
IdType.ID_WORKER全局唯一ID，内容为空自动填充（默认配置）
IdType.UUID全局唯一ID，内容为空自动填充

AUTO、INPUT和UUID大家都应该能够明白，这里主要讲一下ID_WORKER。首先得感谢开源项目Sequence，感谢作者李景枫。

什么是Sequence？简单来说就是一个分布式高效有序ID生产黑科技工具，思路主要是来源于Twitter-Snowflake算法。这里不详细讲解Sequence，有兴趣的朋友请点此去了解Sequence。

MP在Sequence的基础上进行部分优化，用于产生全局唯一ID，好的东西希望推广给大家，所以我们将ID_WORDER设置为默认配置。

表及字段命名策略选择

在MP中，我们建议数据库表名 和 表字段名采用驼峰命名方式， 如果采用下划线命名方式 请开启全局下划线开关，如果表名字段名命名方式不一致请注解指定，我们建议最好保持一致。

这么做的原因是为了避免在对应实体类时产生的性能损耗，这样字段不用做映射就能直接和实体类对应。当然如果项目里不用考虑这点性能损耗，那么你采用下滑线也是没问题的，只需要在生成代码时配置dbColumnUnderline属性就可以。

如何生成代码

方式一、代码生成

注意！模板引擎根据您的具体情况选择，自定义模板引擎请继承类 com.baomidou.mybatisplus.generator.engine.AbstractTemplateEngine

  1. <!-- 模板引擎 -->
  2. <dependency>
  3.     <groupId>org.apache.velocity</groupId>
  4.     <artifactId>velocity-engine-core</artifactId>
  5.     <version>最新版本</version>
  6. </dependency>
  8. <!-- 模板引擎，需要指定 mpg.setTemplateEngine(new FreemarkerTemplateEngine()); -->
  9. <dependency>
  10.     <groupId>org.freemarker</groupId>
  11.     <artifactId>freemarker</artifactId>
  12.     <version>最新版本</version>
  13. </dependency>
  15. <!-- MP 核心库 -->
  16. <dependency>
  17.     <groupId>com.baomidou</groupId>
  18.     <artifactId>mybatis-plus</artifactId>
  19.     <version>最新版本</version>
  20. </dependency>

代码生成、示例一

  1. import java.util.HashMap;
  2. import java.util.Map;
  4. import com.baomidou.mybatisplus.generator.AutoGenerator;
  5. import com.baomidou.mybatisplus.generator.InjectionConfig;
  6. import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
  7. import com.baomidou.mybatisplus.generator.config.GlobalConfig;
  8. import com.baomidou.mybatisplus.generator.config.PackageConfig;
  9. import com.baomidou.mybatisplus.generator.config.StrategyConfig;
  10. import com.baomidou.mybatisplus.generator.config.rules.DbType;
  11. import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
  13. /**
  14.  * <p>
  15.  * 代码生成器演示
  16.  * </p>
  17.  */
  18. public class MpGenerator {
  20.     /**
  21.      * <p>
  22.      * MySQL 生成演示
  23.      * </p>
  24.      */
  25.     public static void main(String[] args) {
  26.         AutoGenerator mpg = new AutoGenerator();
  27.     // 选择 freemarker 引擎，默认 Veloctiy
  28.     // mpg.setTemplateEngine(new FreemarkerTemplateEngine());
  30.         // 全局配置
  31.         GlobalConfig gc = new GlobalConfig();
  32.         gc.setOutputDir("D://");
  33.         gc.setFileOverride(true);
  34.         gc.setActiveRecord(true);// 不需要ActiveRecord特性的请改为false
  35.         gc.setEnableCache(false);// XML 二级缓存
  36.         gc.setBaseResultMap(true);// XML ResultMap
  37.         gc.setBaseColumnList(false);// XML columList
  38.     // .setKotlin(true) 是否生成 kotlin 代码
  39.         gc.setAuthor("Yanghu");
  41.         // 自定义文件命名，注意 %s 会自动填充表实体属性！
  42.         // gc.setMapperName("%sDao");
  43.         // gc.setXmlName("%sDao");
  44.         // gc.setServiceName("MP%sService");
  45.         // gc.setServiceImplName("%sServiceDiy");
  46.         // gc.setControllerName("%sAction");
  47.         mpg.setGlobalConfig(gc);
  49.         // 数据源配置
  50.         DataSourceConfig dsc = new DataSourceConfig();
  51.         dsc.setDbType(DbType.MYSQL);
  52.         dsc.setTypeConvert(new MySqlTypeConvert(){
  53.             // 自定义数据库表字段类型转换【可选】
  54.             @Override
  55.             public DbColumnType processTypeConvert(String fieldType) {
  56.                 System.out.println("转换类型：" + fieldType);
  57.         // 注意！！processTypeConvert 存在默认类型转换，如果不是你要的效果请自定义返回、非如下直接返回。
  58.                 return super.processTypeConvert(fieldType);
  59.             }
  60.         });
  61.         dsc.setDriverName("com.mysql.jdbc.Driver");
  62.         dsc.setUsername("root");
  63.         dsc.setPassword("521");
  64.         dsc.setUrl("jdbc:mysql://127.0.0.1:3306/mybatis-plus?characterEncoding=utf8");
  65.         mpg.setDataSource(dsc);
  67.         // 策略配置
  68.         StrategyConfig strategy = new StrategyConfig();
  69.     // strategy.setCapitalMode(true);// 全局大写命名 ORACLE 注意
  70.         strategy.setTablePrefix(new String[] { "tlog_", "tsys_" });// 此处可以修改为您的表前缀
  71.         strategy.setNaming(NamingStrategy.underline_to_camel);// 表名生成策略
  72.         // strategy.setInclude(new String[] { "user" }); // 需要生成的表
  73.         // strategy.setExclude(new String[]{"test"}); // 排除生成的表
  74.         // 自定义实体父类
  75.         // strategy.setSuperEntityClass("com.baomidou.demo.TestEntity");
  76.         // 自定义实体，公共字段
  77.         // strategy.setSuperEntityColumns(new String[] { "test_id", "age" });
  78.         // 自定义 mapper 父类
  79.         // strategy.setSuperMapperClass("com.baomidou.demo.TestMapper");
  80.         // 自定义 service 父类
  81.         // strategy.setSuperServiceClass("com.baomidou.demo.TestService");
  82.         // 自定义 service 实现类父类
  83.         // strategy.setSuperServiceImplClass("com.baomidou.demo.TestServiceImpl");
  84.         // 自定义 controller 父类
  85.         // strategy.setSuperControllerClass("com.baomidou.demo.TestController");
  86.         // 【实体】是否生成字段常量（默认 false）
  87.         // public static final String ID = "test_id";
  88.         // strategy.setEntityColumnConstant(true);
  89.         // 【实体】是否为构建者模型（默认 false）
  90.         // public User setName(String name) {this.name = name; return this;}
  91.         // strategy.setEntityBuilderModel(true);
  92.         mpg.setStrategy(strategy);
  94.         // 包配置
  95.         PackageConfig pc = new PackageConfig();
  96.         pc.setParent("com.baomidou");
  97.         pc.setModuleName("test");
  98.         mpg.setPackageInfo(pc);
  100.         // 注入自定义配置，可以在 VM 中使用 cfg.abc 【可无】
  101.         InjectionConfig cfg = new InjectionConfig() {
  102.             @Override
  103.             public void initMap() {
  104.                 Map<String, Object> map = new HashMap<String, Object>();
  105.                 map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
  106.                 this.setMap(map);
  107.             }
  108.         };
  110.         // 自定义 xxList.jsp 生成
  111.         List<FileOutConfig> focList = new ArrayList<FileOutConfig>();
  112.         focList.add(new FileOutConfig("/template/list.jsp.vm") {
  113.             @Override
  114.             public String outputFile(TableInfo tableInfo) {
  115.                 // 自定义输入文件名称
  116.                 return "D://my_" + tableInfo.getEntityName() + ".jsp";
  117.             }
  118.         });
  119.         cfg.setFileOutConfigList(focList);
  120.         mpg.setCfg(cfg);
  122.     // 调整 xml 生成目录演示
  123.          focList.add(new FileOutConfig("/templates/mapper.xml.vm") {
  124.             @Override
  125.             public String outputFile(TableInfo tableInfo) {
  126.                 return "/develop/code/xml/" + tableInfo.getEntityName() + ".xml";
  127.             }
  128.         });
  129.         cfg.setFileOutConfigList(focList);
  130.         mpg.setCfg(cfg);
  132.         // 关闭默认 xml 生成，调整生成 至 根目录
  133.         TemplateConfig tc = new TemplateConfig();
  134.         tc.setXml(null);
  135.         mpg.setTemplate(tc);
  137.         // 自定义模板配置，可以 copy 源码 mybatis-plus/src/main/resources/templates 下面内容修改，
  138.         // 放置自己项目的 src/main/resources/templates 目录下, 默认名称一下可以不配置，也可以自定义模板名称
  139.         // TemplateConfig tc = new TemplateConfig();
  140.         // tc.setController("...");
  141.         // tc.setEntity("...");
  142.         // tc.setMapper("...");
  143.         // tc.setXml("...");
  144.         // tc.setService("...");
  145.         // tc.setServiceImpl("...");
  146.     // 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
  147.         // mpg.setTemplate(tc);
  149.         // 执行生成
  150.         mpg.execute();
  152.         // 打印注入设置【可无】
  153.         System.err.println(mpg.getCfg().getMap().get("abc"));
  154.     }
  156. }

代码生成 点此去了解 、示例二 

  1. new AutoGenerator().setGlobalConfig(
  2.     ...
  3. ).setDataSource(
  4.     ...
  5. ).setStrategy(
  6.     ...
  7. ).setPackageInfo(
  8.     ...
  9. ).setCfg(
  10.     ...
  11. ).setTemplate(
  12.     ...
  13. ).execute();

自定义模板，自定义参数 查看示例 

  1. TemplateConfig templateConfig = new TemplateConfig()
  2.     .setXml("/templates/mapper2.xml");//注意，不需要带上.vm
  3. InjectionConfig injectionConfig = new InjectionConfig() {
  4.     @Override
  5.     public void initMap() {//自定义参数
  6.         Map<String, Object> map = new HashMap<>();
  7.         map.put("abc", "自定义abc的值");
  8.         this.setMap(map);
  9.     }
  10. };
  11. new AutoGenerator()
  12. .setTemplate(templateConfig)//生成器配置自定义模板路径
  13. .setCfg(injectionConfig)//生成器配置自定义参数
  14. .xxx
  1. 模板里面用自定义参数：${cfg.abc} 
  2. --cfg是固定写法, 参考AbstractTemplateEngine.batchOutput()方法;
  3. --abc就是map里put的参数名;

其他方式、 Maven插件生成

待补充（Maven代码生成插件 待完善） http://git.oschina.net/baomidou/mybatisplus-maven-plugin