代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、> Controller 等各个模块的代码，极大的提升了开发效率。
第一步: 导入关键依赖
<!--代码生成器mybatis-plus-generator-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1</version>
</dependency>
<!--代码生成器模板库freemarker-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>
第二步: 编写代码生成器代码
/**
* 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
*
* @author
*/
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 = "D:\\IdeaProjects\\wxAccountParent\\wx-pc-program";
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("***"); // 作者
gc.setOpen(false); // 生成之后是否打开文件
gc.setFileOverride(true); // 是否覆盖原文件
gc.setEntityName("%sDo"); // 实体类类名 %s 为占位符
gc.setMapperName("I%sMapper"); // Mapper 类名
gc.setXmlName("%sMapper"); // xml文件名
gc.setServiceName("I%sService"); // service接口类型
gc.setServiceImplName("%sServiceImpl"); // service实现类类名
gc.setIdType(IdType.AUTO); // 实体类主键类型 (可以有自增, 生成UUID等)
mpg.setGlobalConfig(gc);
//--------------------------------------------------------------------------------------------
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql:///wxaccount?serverTimezone=Asia/Shanghai");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
//--------------------------------------------------------------------------------------------
// 包配置 这里可以根据自己的习惯来设置
PackageConfig pc = new PackageConfig();
String moduleName = scanner("模块名");
// pc.setModuleName();
pc.setParent("work.wxmx.wxpcprogram");
pc.setController("controller." + moduleName);
pc.setService("service." + moduleName);
pc.setServiceImpl("service.impl." + moduleName);
pc.setMapper("mapper." + moduleName);
pc.setEntity("entity." + moduleName);
mpg.setPackageInfo(pc);
//--------------------------------------------------------------------------------------------
// 自定义配置 默认的xml文件是输出在包mapper.xml下, 不符合个人习惯, 所以这里做了自定义配置 更改xml文件的输出目录
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
}
};
// 如果模板引擎是 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 + "/src/main/resources/mapper/" + moduleName
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
//--------------------------------------------------------------------------------------------
// 关闭默认 xml 生成，调整生成 至 根目录
TemplateConfig tc = new TemplateConfig();
tc.setXml(null);
mpg.setTemplate(tc);
//--------------------------------------------------------------------------------------------
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass(BaseDo.class); // 实体类的公共基类(通常有创建时间, 修改时间, 状态等通用属性)
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
第三步: 执行代码
第四步: 查看运行结果
注意:
使用代码生成器生成的Mapper类没有自动加上 @Mapper 注解, 可以使用 @MapperScan 注解.
参考资源:
[1] https://baomidou.com/guide/generator.html#%E4%BD%BF%E7%94%A8%E6%95%99%E7%A8%8B
[2] https://gitee.com/baomidou/mybatis-plus/issues/IHQBY
[3] https://baomidou.com/config/#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE
