mybatis-plus-generator代码生成

2024-01-09 16:04:46

因为官方文档刚开始看没有看懂什么意思，所以感觉官方文档并没有简单易懂；这里总结一下，做个记录；
此处只使用 freemarker 模板，理解这个模板以后，就很好理解了。

一、引入相关依赖

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

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.2</version>
</dependency>
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.31</version>
</dependency>

二、相关配置

1. 配置数据库连接

DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://172.18.111.217:3306/policy-calculator?zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("yunyang");
dsc.setPassword("Fgw_cspire_SZY_2020");

2. 配置全局配置

GlobalConfig gc = new GlobalConfig();
gc.setOutputDir("项目路径/src/main/java");// 配置输出目录
gc.setAuthor("test");                 	// 设置作者
gc.setOpen(false);                      // 是否打开输出目录
gc.setSwagger2(false);                  // 实体属性 Swagger2 注解

3. 包配置

最终生成的包路径为：包名 + 模块名

PackageConfig pc = new PackageConfig();
pc.setParent("com.baomidou.ant");		// 配置包名
pc.setModuleName("zczd.policy");		// 配置模块名称

4. 自定义配置

因为配置好包名以后，系统会将 xml 文件生成到包路径下的 mapper.xml；正常情况下我们不希望将xml文件放到此处，所以这里使用自定义配置，生成 xml 文件。

InjectionConfig cfg = new InjectionConfig() {
    @Override
    public void initMap() {}
};

String templatePath = "/templates/mapper.xml.ftl";		// 使用的模板
List<FileOutConfig> focList = new ArrayList<>();
focList.add(new FileOutConfig(templatePath) {
    @Override
    public String outputFile(TableInfo tableInfo) {
        return "xiangmu lujing /src/main/resources/mapper/" + pc.getModuleName()
                + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
    }
});
cfg.setFileOutConfigList(focList);

5. 模板配置

这里我们并不想生成 controller ，所以将其配置为 null，xml 在自定义配置中生成，所以此处也不需要生成；而其他的不设置，使用默认的模板

// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
// 指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
 templateConfig.setController(null);
 templateConfig.setXml(null);

6. 策略配置

内容较多，详细参考官方文档

StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(false);
// 公共父类
// strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
strategy.setSuperEntityColumns("id");
strategy.setInclude("zczd_policy");
strategy.setControllerMappingHyphenStyle(false);
strategy.setTablePrefix(pc.getModuleName() + "_");

7. 代码生成

AutoGenerator generator = new AutoGenerator();      // 代码生成器
generator.setGlobalConfig(gc);                      // 配置公共配置
generator.setDataSource(dsc);                       // 配置数据源
generator.setPackageInfo(pc);                       // 配置包
generator.setCfg(cfg);                              // 自定义配置
generator.setTemplate(templateConfig);              // 制定输出模板
generator.setStrategy(strategy);					// 配置策略
generator.setTemplateEngine(new FreemarkerTemplateEngine());
generator.execute();

参考官方文档：此处跳转

码农公寓