引言
代码生成器模板 mybatis-plus + Freemarker + lombok模板引擎
代码生成操作步骤
- 引入依赖
- 添加配置
- ftl文件
- 编写配置类
配置类编写内容
- new 代码生成器AutoGenerator
- 全局配置GlobalConfig
- 数据源配置DataSourceConfig
- 包配置PackageConfig
- 模板配置TemplateConfig
- 策略配置StrategyConfig
- 切面配置InjectionConfig(可不要,配置额外输出文件。如:SpringCloud的Feign接口)
- FreeMarker引擎配置
-
execute执行
相关依赖
<dependencies>
<!--Lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!--MySql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.21</version>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.2</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.31</version> <!-- 根据您的项目需求调整版本号 -->
</dependency>
<!--mybatis-plus-generator 代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
</dependencies>
FreeMarker模板介绍
对象 | 属性/方法 | 作用 | 用法 |
package | package.Entity | 获取包名 | package ${package.Entity}; |
package.Mapper | 获取Mapper包名 | package ${package.Mapper}; | |
package.Controller | ${package.Controller} | ||
table | table.importPackages | ||
table.comment | 表描述 | ${table.comment!} | |
table.convert | |||
table.name | 表名 | ${table.name} | |
table.mapperName | mapper名称 | ${table.mapperName} | |
table.controllerName | ${table.controllerName} | ||
table.fields | 表字段list | ${table.fields} | |
superMapperClass | mapper父类 | ${superMapperClass} | |
superMapperClassPackage | mapper父类包 | import ${superMapperClassPackage} | |
entity | 实体类名 | ${entity} | |
date | 日期 | ${date} | |
author | 作者 | ${author} | |
field | field.comment | 字段描述 | ${field.comment} |
field.keyFlag | |||
field.keyIdentityFlag | |||
field.name | 字段名 | ${field.name} | |
field.convert | |||
field.propertyType | 字段属性 | ||
field.capitalName | |||
field.propertyName | 字段属性名 |
语句 | 条件 | 用法 |
if | 为类,要加?? | <#if superControllerClass??> public class ${table.controllerName} extends ${superControllerClass} { <#else> |
为Boolean值 | <#if kotlin> interface ${table.mapperName} : ${superMapperClass}<${entity}> <#else> | |
字符串 | <#if (logicDeleteFieldName!"") == field.name> @TableLogic </#if> | |
数字类型 | <#if field_index==0> "${field.propertyName}=" + ${field.propertyName} + <#else> | |
assign | 定义变量 | <#assign getprefix="get"/> // 定义 ${getprefix} // 使用 |
list | 遍历list | <#list table.fields as field> <#if field_index==0> "${field.propertyName}=" + ${field.propertyName} + <#else> ", ${field.propertyName}=" + ${field.propertyName} + </#if> </#list> |
名称 | 介绍 | 用例 |
upper_case | 转大写 | ${field.name?upper_case} |
length | 字符串长度 | <#if field.comment!?length gt 0> /** * ${field.comment} */ </#if> |
gt | 大于 | <#if field.comment!?length gt 0> /** * ${field.comment} */ </#if> |
uncap_first | 首字母小写 | private ${table.serviceName} ${table.serviceName?uncap_first}; |
cap_first | 首字母大写 |
ftl配置文件
mapper.java.ftl
<#assign className = table.mapperName>
package ${package.Mapper};
import ${package.Entity}.${entity};
import org.apache.ibatis.annotations.*;
import java.math.BigInteger;
@Mapper
public interface ${className} {
// 根据ID查询操作
@Select("SELECT * FROM ${table.name} WHERE ${table.name}_id = <#noparse>#{</#noparse>${table.name}Id<#noparse>}</#noparse> AND is_deleted=0")
${entity} getById(BigInteger ${table.name}Id);
// 根据ID提取操作
@Select("SELECT * FROM ${table.name} WHERE ${table.name}_id = <#noparse>#{</#noparse>${table.name}Id<#noparse>}</#noparse>")
${entity} extractById(BigInteger ${table.name}Id);
// 插入操作
Integer insert(${entity} ${table.name});
// 更新操作
Integer update(${entity} ${table.name});
// 删除操作
@Update("UPDATE ${table.name} SET update_time = <#noparse>#{</#noparse>updateTime<#noparse>}</#noparse> , is_deleted = 1 WHERE ${table.name}_id = <#noparse>#{</#noparse>${table.name}Id<#noparse>}</#noparse>")
Integer delete(@Param("updateTime") Integer updateTime, @Param("${table.name}Id") BigInteger ${table.name}Id);
}
mapper.xml.ftl
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="${package.Mapper}.${table.mapperName}">
<insert id="insert"
useGeneratedKeys="true"
keyProperty="id"
parameterType="${package.Entity}.${entity}">
insert into ${table.name}(
<#list table.fields as field>
<#if field.keyFlag == true>
<#else>
<#if field.name == "is_deleted">
is_deleted <#if field_has_next>,</#if>
<#else>
<#if field.propertyType == "String">
<if test=" ${field.propertyName} != null and ${field.propertyName} != ''"> `${field.name}` <#if field_has_next>,</#if></if>
<#else>
<if test=" ${field.propertyName} != null"> `${field.name}` <#if field_has_next>,</#if></if>
</#if>
</#if>
</#if>
</#list>
)values(
<#list table.fields as field>
<#if field.keyFlag == true>
<#else>
<#if field.name == "is_deleted">
<#noparse>#{</#noparse>isDeleted<#noparse>}</#noparse> <#if field_has_next>,</#if>
<#else>
<#if field.propertyType == "String">
<if test="${field.propertyName} != null and ${field.propertyName}!= ''"><#noparse>#{</#noparse>${field.propertyName}<#noparse>}</#noparse><#if field_has_next>,</#if></if>
<#else>
<if test="${field.propertyName} != null"><#noparse>#{</#noparse>${field.propertyName}<#noparse>}</#noparse><#if field_has_next>,</#if></if>
</#if>
</#if>
</#if>
</#list>
)
</insert>
<!-- 更新操作 -->
<update id="update" parameterType="${package.Entity}.${entity}">
UPDATE ${table.name}
<set>
<#list table.fields as field>
<#if field.keyFlag == true>
`${table.name}_id` = <#noparse>#{</#noparse>${table.name}Id<#noparse>}</#noparse>,
<#else>
<#if field.propertyType == "String">
<if test="${field.propertyName} != null and ${field.propertyName} != ''">
`${field.name}` = <#noparse>#{</#noparse> ${field.propertyName} <#noparse>}</#noparse>,
</if>
<#else>
<if test="${field.propertyName} != null">
`${field.name}` = <#noparse>#{</#noparse> ${field.propertyName} <#noparse>}</#noparse>,
</if>
</#if>
</#if>
</#list>
</set>
WHERE `${table.name}_id` = <#noparse>#{</#noparse>${table.name}Id<#noparse>}</#noparse>
</update>
</mapper>
entity.java.ftl
package ${package.Entity};
import lombok.Data;
import lombok.experimental.Accessors;
@Data
@Accessors(chain = true)
public class ${entity} {
<#list table.fields as field>
//${field.comment}
private ${field.propertyType} ${field.propertyName};
</#list>
}
代码生成类
package com.camp.gen.config;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* 代码生成器
*
* @author
* @since
*/
public class CodeGenerator {
/**
* 执行代码生成 main 方法
*
* @param args
*/
public static void main(String[] args) {
CodeGenerator.autoGenerator();
}
/**
* 代码生成设置
*/
public static void autoGenerator(){
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("xxxx");
gc.setOpen(false);
gc.setIdType(IdType.ID_WORKER);
gc.setBaseResultMap(true);
gc.setBaseColumnList(true);
gc.setServiceName("%sService");
gc.setFileOverride(false);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(false);
mpg.setGlobalConfig(gc);
//数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/practice?useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=UTC");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("password");
mpg.setDataSource(dsc);
//包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.practice");
pc.setModuleName("module");
pc.setController("controller");
pc.setService("service");
pc.setServiceImpl("service.impl");
pc.setEntity("entity");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setMapper("/templates/mapper.java");
templateConfig.setXml("/templates/mapper.xml");
// templateConfig.setEntity()
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);
strategy.setEntityTableFieldAnnotationEnable(true);
// 可是输入多个表
strategy.setInclude("special_subject");
strategy.setInclude("homestay");
strategy.setInclude("homestay_special_subject_relation");
strategy.setInclude("label");
strategy.setInclude("homestay_label_relation");
strategy.setInclude("guest_room");
strategy.setInclude("guest_room_label_relation");
strategy.setInclude("facilities");
strategy.setInclude("guest_room_facilities_relation");
// strategy.setTablePrefix("reservation_label_relation");
mpg.setStrategy(strategy);
// 配置额外的输出文件(InjectionConfig可不要这一部分,如果没有额外的输出文件,额外输出文件,如:Spring Cloud的Figen层)
// ======================= ↓ ==============================
String injecPath = "com.practice.app";
InjectionConfig injectionConfig = new MyInjectionConfig(injecPath);
List<FileOutConfig> list = new ArrayList<>();
list.add(new MyFileOutConfig("/templates/appService.java.ftl", projectPath + "/src/main/java" + String.format("/%s/", injecPath.replaceAll("\\.", "/"))));
injectionConfig.setFileOutConfigList(list);
mpg.setCfg(injectionConfig);
// ======================= ↑ ==============================
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
/**
* 定义切面
*/
static class MyInjectionConfig extends InjectionConfig {
/**
* 文件存储的url
*/
private String parentPath;
/**
* 构造器
*
* @param parentPath 文件存储的url 如:com.lingluo.app
*/
public MyInjectionConfig(String parentPath) {
this.parentPath = parentPath;
}
/**
* 设置在ftl文件中要用到的参数 如:templates/appService.java.ftl 文件中 ${cfg.appServiceName}
*/
@Override
public void initMap() {
List<TableInfo> list = this.getConfig().getTableInfoList();
Map<String, Object> map = new HashMap<>(10);
map.put("appService", parentPath);
for (TableInfo tableInfo : list) {
map.put("appServiceName", tableInfo.getEntityName() + "AppService");
}
this.setMap(map);
}
}
/**
* 自定义文件输出目录
*/
static class MyFileOutConfig extends FileOutConfig {
/**
* 完整的文件输出目录
*/
private String filePath;
/**
* 文件输出构造器
*
* @param templatePath 模板url 如:/templates/appService.java.ftl
* @param filePath 完成的文件输出目录 如:C:\Users\luohoujian01\myProject\springboot-project/src/main/java/com/lingluo/app/
*/
public MyFileOutConfig(String templatePath, String filePath) {
super(templatePath);
this.filePath = filePath;
}
// 自定义输出文件目录,完整的输出目录 如:C:\Users\luohoujian01\myProject\springboot-project/src/main/java/com/lingluo/app/AlipayOrdersAppService.java
@Override
public String outputFile(TableInfo tableInfo) {
return filePath + String.format("%sAppService", tableInfo.getEntityName()) + ".java";
}
}
}