参考官网地址 https://baomidou.com/pages/981406/
快速开始mybatis包
com.baomidou
mybatis-plus-boot-starter
3.4.2
com.baomidou
mybatis-plus-generator
3.5.1
freemarker引擎模板
org.freemarker
freemarker
2.3.31
java代码
package com.unicom.sh.content;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import lombok.extern.slf4j.Slf4j;
import java.util.Collections;
@Slf4j
public class Demo {
public static void main(String[] args) {
// 生产文件的项目相对位置
StringBuffer projectPath = new StringBuffer();
// 获取系统路径
String systemPath = System.getProperty("user.dir");
// 将反斜杠全部替换为双斜杠 并拼接项目路径
projectPath.append(systemPath.replaceAll("\\", "//")).append("//src//main");
System.out.println(projectPath);
FastAutoGenerator.create("jdbc:mysql://127.0.0.1:3306/content?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=Asia/Shanghai", "root", "123456")
.globalConfig(builder -> {
builder
.author("admin") // 设置作者
.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir(projectPath + "//java"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.unicom.sh") // 设置父包名
.moduleName("content") // 设置父包模块名
.entity("domain.entity")
.controller("controller") // Controller 包名 默认值:controller
.other("other") // 自定义文件包名 输出自定义文件时所用到的包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, projectPath + "//resources//mapper")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("ability_photo_202001"); // 设置需要生成的表名
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
.execute();
}
}
自定义模板
1 加依赖
Velocity引擎模板
org.apache.velocity velocity-engine-core 2.2
test包
org.springframework.boot spring-boot-starter-test 2.5.10 test junit junit 4.12 test
lombok包
org.projectlombok lombok 1.18.22 true
糊涂工具包
cn.hutool
hutool-core
5.7.20
Swagger依赖包
io.springfox
springfox-swagger2
2.9.2
com.github.xiaoymin
swagger-bootstrap-ui
1.9.6
2 工具类
TODO是大家要改的，如果有特殊需求，可以自定义修改
package com.unicom.sh.content;
import cn.hutool.core.date.DateUtil;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.*;
@Slf4j
@SpringBootTest
public class MpGenerator {
// TODO 要生成的表，多个逗号分开。过滤表前缀（没有就不用写）。包名。模块名
String[] tableArray = {"cm_common_traffic_info"};
String[] tablePrefixArray = {"cm_"};
String packageName = "com.unicom.sh";
String moduleName = "content";
// TODO 数据源信息
String url = "jdbc:mysql://127.0.0.1:3306/content?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=Asia/Shanghai";
String userName = "root";
String password = "123456";
@Test
void test2() {
log.info("==========================准备生成文件...==========================");
for (String tableName : tableArray) {
test4(tableName);
}
log.info("==========================文件生成完成！！！==========================");
}
void test4(String tableName) {
// 生产文件的项目相对位置
StringBuffer projectPath = new StringBuffer();
// 获取系统路径
String systemPath = System.getProperty("user.dir");
// 将反斜杠全部替换为双斜杠 并拼接项目路径
projectPath.append(systemPath.replaceAll("\\", "//")).append("//src//main");
// 1 配置数据源
DataSourceConfig dataSourceConfig = new DataSourceConfig.Builder(url, userName, password).build();
AutoGenerator generator = new AutoGenerator(dataSourceConfig);
// 2 全局配置
GlobalConfig globalConfig = new GlobalConfig.Builder()
.fileOverride() // 覆盖已生成文件
.disableOpenDir() // 禁止打开输出目录 默认值:true
.outputDir(projectPath + "//java") // 指定输出目录 /opt/baomidou/ 默认值: windows:D:// linux or mac : /tmp
.author("admin") // TODO 作者名 默认值:作者
.enableSwagger() // 开启 swagger 模式 默认值:false
// .enableKotlin() // 开启 kotlin 模式 默认值:false
// .dateType(DateType.TIME_PACK) // 时间策略 DateType.ONLY_DATE 默认值: DateType.TIME_PACK
// .commentDate("yyyy-MM-dd") // 注释日期 默认值: yyyy-MM-dd
.build();
generator.global(globalConfig);
// 3 包配置
// 3.1 自定义包名
PackageConfig.Builder packageConfig = new PackageConfig.Builder()
.parent(packageName) // 父包名 默认值:com.baomidou
.moduleName(moduleName) // 父包模块名 默认值:无
.entity("domain.entity") // Entity 包名 默认值:entity
.service("service") // Service 包名 默认值:service
.serviceImpl("service.impl") // Service Impl 包名 默认值:service.impl
.mapper("mapper") // Mapper 包名 默认值:mapper
.xml("mapper.xml") // Mapper XML 包名 默认值:mapper.xml
.controller("controller"); // Controller 包名 默认值:controller
// .other("domain.dto") // 自定义文件包名 输出自定义文件时所用到的包名
// 3.2 自定义路径，多种情况自行添加 pathInfo.put
Map pathInfo = new HashMap<>();
pathInfo.put(OutputFile.mapperXml, projectPath + "//resources//mapper"); // 单独配置xml路径，可覆盖全局配置。
// pathInfo.put(OutputFile.entity, projectPath + "//resources//mapper");
packageConfig.pathInfo(pathInfo);
generator.packageInfo(packageConfig.build());
// 4 自定义模板配置，配置模板路径
TemplateConfig templateConfig = new TemplateConfig.Builder()
.disable(TemplateType.ENTITY) // 禁用模板 TemplateType.ENTITY
.entity("/templates/entity.java")// 设置实体模板路径(JAVA) /templates/entity.java
.service("/templates/service.java")
.serviceImpl("/templates/serviceImpl.java")
.mapper("/templates/mapper.java")
.mapperXml("/templates/mapper.xml")
.controller("/templates/controller.java")
.build();
generator.template(templateConfig);
// 6 设置自定义属性
Map map = new HashMap<>();
setAttr(tableName, dataSourceConfig, map, tablePrefixArray);
generator.injection(injectionConfig().customMap(map).build());
// 7 配置策略，策略非常多，如有其他需求，请参考官网
// 7.1 添加表、表名过滤、字段过滤
StrategyConfig.Builder strategyConfig = new StrategyConfig.Builder()
.addInclude(tableName) // 设置需要生成的表名，多个逗号分开
.addTablePrefix(tablePrefixArray); // 过滤表前缀，多个逗号分开
// .addFieldSuffix("_202201", "202001"); // 过滤表后缀
// 7.2 格式化文件名称，以下都是默认值
// 7.3 Entity 策略配置，如果有需要，mapper、service、controller都可以配置
strategyConfig
.entityBuilder().formatFileName("%sEntity")
.addSuperEntityColumns("id", "create_by", "create_time", "update_by", "update_time", "delete_flag") // 基于数据库字段，忽略某个字段，【好像不管用】
.mapperBuilder().formatMapperFileName("%sMapper").formatXmlFileName("%sMapper")
.serviceBuilder().formatServiceFileName("I%sService")
.controllerBuilder().formatFileName("%sController");
// 策略非常多，所以将.build()放到最后
generator.strategy(strategyConfig.build());
// 8 执行
generator.execute();
}
private InjectionConfig.Builder injectionConfig() {
// 测试自定义输出文件之前注入操作，该操作在执行生成代码前 debug 查看
return new InjectionConfig.Builder().beforeOutputFile((tableInfo, objectMap) -> {
System.out.println("------------------tableInfo: " + tableInfo.getEntityName() + " objectMap: " + objectMap.size());
});
}
private void setAttr(String tableName, DataSourceConfig dataSourceConfig, Map map, String[] tablePrefixArray) {
List> columns = new ArrayList<>();
// 获取表信息sql
String tableSql = "select table_name , table_comment from information_schema.tables " +
"where table_schema = (select database()) and table_name = '" + tableName + "'";
// 获取字段信息sql
String columnSql = "select column_name , data_type , column_comment from information_schema.columns " +
"where table_name = '" + tableName + "' and table_schema = (select database()) and column_name != 'id_new'";
// 利用现有的dataSourceConfig来获取数据库连接，查询表字段及备注等信息
try (Connection conn = dataSourceConfig.getConn();
PreparedStatement psTable = conn.prepareStatement(tableSql);
ResultSet rsTable = psTable.executeQuery();
PreparedStatement ps = conn.prepareStatement(columnSql);
ResultSet rs = ps.executeQuery();
) {
if (rsTable.next()) {
String table_name = rsTable.getString("table_name");
map.put("tableName", table_name);
map.put("comment", rsTable.getString("table_comment"));
// 过滤表前缀
if (tablePrefixArray.length > 0) {
for (String s : tablePrefixArray) {
table_name = table_name.replaceAll(s, "");
}
}
// 类名 大驼峰
map.put("upperClassName", StrUtil.upperFirst(StrUtil.toCamelCase(table_name)));
// 对象名 小驼峰
map.put("lowerClassName", StrUtil.toCamelCase(table_name));
}
while (rs.next()) {
Map columnMap = new HashMap<>();
// 列名字、数据类型、java属性名字、java属性类型、备注
columnMap.put("column_name", rs.getString("column_name"));
columnMap.put("data_type", rs.getString("data_type"));
columnMap.put("javaLowerAttrName", StrUtil.toCamelCase(rs.getString("column_name")));
columnMap.put("javaAttrType", columnTypeToJavaType(rs.getString("data_type")));
columnMap.put("column_comment", rs.getString("column_comment"));
columns.add(columnMap);
}
} catch (Exception e) {
log.info("----------sql执行出错");
e.printStackTrace();
}
map.put("columns", columns);
map.put("datetime", DateUtil.now());
map.put("packageName", packageName);
map.put("moduleName", moduleName);
}
private String columnTypeToJavaType(String columnType) {
if (StrUtil.isNotEmpty(columnType)) {
if (Arrays.asList(COLUMN_TYPE_STR).contains(columnType)) {
return TYPE_STRING;
}
if (Arrays.asList(COLUMN_TYPE_TEXT).contains(columnType)) {
return TYPE_STRING;
}
if (Arrays.asList(COLUMN_TYPE_TIME).contains(columnType)) {
return TYPE_DATE;
}
if (Arrays.asList(COLUMN_TYPE_NUMBER).contains(columnType)) {
return TYPE_INTEGER;
}
if (Arrays.asList(COLUMN_TYPE_BIGINT).contains(columnType)) {
return TYPE_LONG;
}
if (Arrays.asList(COLUMN_TYPE_FLOAT).contains(columnType)) {
return TYPE_DOUBLE;
}
if (Arrays.asList(COLUMN_TYPE_DOUBLE).contains(columnType)) {
return TYPE_DOUBLE;
}
if (Arrays.asList(COLUMN_TYPE_DECIMAL).contains(columnType)) {
return TYPE_BIGDECIMAL;
}
}
return null;
}
public static final String[] COLUMN_TYPE_STR = {"char", "varchar", "nvarchar", "varchar2"};
public static final String[] COLUMN_TYPE_TEXT = {"tinytext", "text", "mediumtext", "longtext"};
public static final String[] COLUMN_TYPE_TIME = {"datetime", "time", "date", "timestamp"};
public static final String[] COLUMN_TYPE_NUMBER = {"tinyint", "smallint", "mediumint", "int", "number", "integer", "bit"};
public static final String[] COLUMN_TYPE_BIGINT = {"bigint"};
public static final String[] COLUMN_TYPE_FLOAT = {"float"};
public static final String[] COLUMN_TYPE_DOUBLE = {"double"};
public static final String[] COLUMN_TYPE_DECIMAL = {"decimal"};
public static final String TYPE_STRING = "String";
public static final String TYPE_INTEGER = "Integer";
public static final String TYPE_LONG = "Long";
public static final String TYPE_DOUBLE = "Double";
public static final String TYPE_BIGDECIMAL = "BigDecimal";
public static final String TYPE_DATE = "Date";
}
3 模板
entity.java.vm
package ${packageName}.${moduleName}.domain.entity;
#set($list=["id","createBy","createTime", "updateBy", "updateTime", "deleteFlag"])
import com.baidu.sh.content.config.BaseEntity;
import lombok.Data;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.Date;
import com.baomidou.mybatisplus.annotation.TableName;
@Data
@TableName("${tableName}")
@ApiModel(value = "${comment}", description = "${comment}对象 ${lowerClassName}")
public class ${upperClassName}Entity extends BaseEntity {
#foreach ($column in $columns)
## 排除父类字段
#if($list.contains($column.javaLowerAttrName))
#else
@ApiModelProperty(value = "$column.column_comment")
private $column.javaAttrType $column.javaLowerAttrName;
#end
#end
}
mapper.java.vm
package ${packageName}.${moduleName}.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import ${packageName}.${moduleName}.domain.entity.${upperClassName}Entity;
import org.apache.ibatis.annotations.Mapper;
@Mapper
public interface ${upperClassName}Mapper extends BaseMapper<${upperClassName}Entity> {
}
mapper.xml.vm
#foreach($column in $columns) #end
service.java.vm
package ${packageName}.${moduleName}.service;
import com.baomidou.mybatisplus.extension.service.IService;
import ${packageName}.${moduleName}.domain.entity.${upperClassName}Entity;
public interface I${upperClassName}Service extends IService<${upperClassName}Entity> {
}
serviceImpl.java.vm
package ${packageName}.${moduleName}.service.impl;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import ${packageName}.${moduleName}.domain.entity.${upperClassName}Entity;
import ${packageName}.${moduleName}.mapper.${upperClassName}Mapper;
import ${packageName}.${moduleName}.service.I${upperClassName}Service;
import org.springframework.stereotype.Service;
@Service
public class ${upperClassName}ServiceImpl extends ServiceImpl<${upperClassName}Mapper, ${upperClassName}Entity> implements I${upperClassName}Service {
}
controller.java.vm
package ${packageName}.${moduleName}.controller;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import ${packageName}.${moduleName}.domain.entity.${upperClassName}Entity;
import ${packageName}.${moduleName}.service.I${upperClassName}Service;
import ${packageName}.${moduleName}.util.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
@Slf4j
@RestController
@RequestMapping("/${lowerClassName}")
@Api(value = "${lowerClassName}", tags = "${comment}管理模块")
public class ${upperClassName}Controller {
@Autowired
private I${upperClassName}Service ${lowerClassName}Service;
@ApiOperation(value = "分页查询", notes = "分页查询")
@GetMapping("/page")
public Result get${upperClassName}Page(Page page, ${upperClassName}Entity ${lowerClassName}Entity) {
return Result.ok(${lowerClassName}Service.page(page, Wrappers.query(${lowerClassName}Entity)));
}
@ApiOperation(value = "通过id查询", notes = "通过id查询")
@GetMapping("/{id}")
public Result getById(@PathVariable("id") Integer id) {
return Result.ok(${lowerClassName}Service.getById(id));
}
@ApiOperation(value = "新增${comment}", notes = "新增${comment}")
@PostMapping
public Result save(@RequestBody ${upperClassName}Entity ${lowerClassName}Entity) {
return Result.ok(${lowerClassName}Service.save(${lowerClassName}Entity));
}
@ApiOperation(value = "修改${comment}", notes = "修改${comment}")
@PutMapping
public Result updateById(@RequestBody ${upperClassName}Entity ${lowerClassName}Entity) {
return Result.ok(${lowerClassName}Service.updateById(${lowerClassName}Entity));
}
@ApiOperation(value = "通过id删除${comment}", notes = "通过id删除${comment}")
@DeleteMapping("/{id}")
public Result removeById(@PathVariable Integer id) {
return Result.ok(${lowerClassName}Service.removeById(id));
}
}
