mybatisplus代码生成器:
第一步引包:
<!--MyBatis Plus 依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!--MyBatis Plus 代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>${mybatis-plus.version}</version>
</dependency>
<!--Velocity模板引擎-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>${velocity.version}</version>
</dependency>
因为我这里模板引擎用的是velocity所以后面对controller,service,serviceimpl代码生成用的模板就是xxx.vm的。
这里是我的几个模板文件,可以给大家借鉴下:
package ${package.Controller};
#if(${restControllerStyle})
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RestController;
#else
import org.springframework.stereotype.Controller;
#end
#if(${superControllerClassPackage})
import ${superControllerClassPackage};
#end
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import com.xnpool.common.api.CommonPage;
import com.xnpool.common.api.CommonResult;
import com.xnpool.common.validation.Create;
import com.xnpool.common.validation.Update;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* <p>
* ${table.comment} 前端控制器
* </p>
* @author ${author}
* @since ${date}
*/
@Api(tags = "${table.comment}管理")
#if(${restControllerStyle})
@RestController
#else
@Controller
#end
@RequestMapping("/a#if(${package.ModuleName})/${package.ModuleName}#end/#if(${controllerMappingHyphenStyle})${controllerMappingHyphen}#else${table.entityPath}#end")
#if(${superControllerClass})
public class ${table.controllerName} extends ${superControllerClass} {
#else
public class ${table.controllerName} {
#end
private final Logger logger = LoggerFactory.getLogger(${table.controllerName}.class);
@Autowired
public ${table.serviceName} i${entity}Service;
@ApiOperation("添加${table.comment}")
@RequestMapping(value = "/create", method = RequestMethod.POST)
public CommonResult<String> create(@RequestBody @Validated(Create.class)${entity} ${table.entityPath}) {
CommonResult<String> result=i${entity}Service.create(${table.entityPath});
return result;
}
@ApiOperation("修改${table.comment}")
@RequestMapping(value = "/update", method = RequestMethod.POST)
public CommonResult<String> update${entity}(@RequestBody @Validated(Update.class)${entity} ${table.entityPath}) {
CommonResult<String> success = i${entity}Service.update${entity}(${table.entityPath});
return success;
}
@ApiOperation("根据ID获取${table.comment}详情")
@RequestMapping(value = "/detail/{id}", method = RequestMethod.GET)
public CommonResult<${entity}> getItem(@PathVariable Integer id) {
${entity} ${table.entityPath} = i${entity}Service.getById(id);
return CommonResult.success(${table.entityPath});
}
@ApiOperation("根据ID删除${table.comment}")
@RequestMapping(value = "/delete/{id}", method = RequestMethod.POST)
public CommonResult<String> delete(@PathVariable Integer id) {
boolean success = i${entity}Service.removeById(id);
if (success) {
return CommonResult.success("删除成功");
} else {
return CommonResult.failed();
}
}
@ApiOperation("分页查询${table.comment}")
@RequestMapping(value = "/page", method = RequestMethod.POST)
public CommonResult<CommonPage<${entity}>> doPage(@RequestBody ${entity}PageQuery query) {
Page<${entity}> ${table.entityPath}Page = i${entity}Service.doPage(query);
return CommonResult.success(CommonPage.restPage(${table.entityPath}Page));
}
}
package ${package.Service};
import ${package.Entity}.${entity};
import ${superServiceClassPackage};
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xnpool.common.api.CommonResult;
/**
* <p>
* $!{table.comment} 服务类
* </p>
*
* @author ${author}
* @since ${date}
*/
public interface ${table.serviceName} extends ${superServiceClass}<${entity}> {
CommonResult<String> create(${entity} ${table.entityPath});
CommonResult<String> update${entity}(${entity} ${table.entityPath});
Page<${entity}> doPage(${entity}PageQuery query);
}
package ${package.ServiceImpl};
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import ${superServiceImplClassPackage};
import org.springframework.stereotype.Service;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.transaction.annotation.Transactional;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xnpool.common.api.CommonResult;
/**
* <p>
* $!{table.comment} 服务实现类
* </p>
*
* @author ${author}
* @since ${date}
*/
@Service
@Transactional
public class ${table.serviceImplName} extends ${superServiceImplClass}<${table.mapperName}, ${entity}> implements ${table.serviceName} {
@Autowired
private ${table.mapperName} ${table.entityPath}Mapper;
@Override
public CommonResult<String> create(${entity} ${table.entityPath}) {
int insert = ${table.entityPath}Mapper.insert(${table.entityPath});
return CommonResult.success("增加${table.comment}成功");
}
@Override
public CommonResult<String> update${entity}(${entity} ${table.entityPath}) {
int id = ${table.entityPath}Mapper.update(${table.entityPath}, new UpdateWrapper<${entity}>().eq("id", ${table.entityPath}.getId()));
return CommonResult.success("修改${table.comment}成功");
}
@Override
public Page<${entity}> doPage(${entity}PageQuery query) {
Page<${entity}> page = new Page<>(query.getPageNum(),query.getPageSize());
QueryWrapper<${entity}> wrapper = new QueryWrapper<${entity}>();
LambdaQueryWrapper<${entity}> lambda = wrapper.lambda();
return page(page,wrapper);
}
}
第二步写代码生成器的生成代码MyBatisPlusGenerator文件。 可以直接执行main方法,根据提示输入生成代码所有模块,和表名:
package com.xnpool.admin.generator;
import cn.hutool.core.util.StrUtil;
import cn.hutool.setting.dialect.Props;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
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.LikeTable;
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 com.baomidou.mybatisplus.generator.engine.VelocityTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
/**
* MyBatisPlus代码生成器
* Created by macro on 2020/8/20.
*/
public class MyBatisPlusGenerator {
public static void main(String[] args) {
String projectPath = System.getProperty("user.dir");
projectPath=projectPath+"\\finance";//admin子模块,enterprise,finance
String moduleName = scanner("模块名");
String[] tableNames = scanner("表名,多个英文逗号分割").split(",");
// 代码生成器
AutoGenerator autoGenerator = new AutoGenerator();
autoGenerator.setGlobalConfig(initGlobalConfig(projectPath));
autoGenerator.setDataSource(initDataSourceConfig());
autoGenerator.setPackageInfo(initPackageConfig(moduleName));
autoGenerator.setCfg(initInjectionConfig(projectPath, moduleName));
autoGenerator.setTemplate(initTemplateConfig());
autoGenerator.setStrategy(initStrategyConfig(tableNames));
autoGenerator.setTemplateEngine(new VelocityTemplateEngine());
//autoGenerator.setTemplateEngine(new FreemarkerTemplateEngine());
autoGenerator.execute();
}
/**
* 读取控制台内容信息
*/
private static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
System.out.println(("请输入" + tip + ":"));
if (scanner.hasNext()) {
String next = scanner.next();
if (StrUtil.isNotEmpty(next)) {
return next;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
/**
* 初始化全局配置
*/
private static GlobalConfig initGlobalConfig(String projectPath) {
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setOutputDir(projectPath + "/src/main/java");
globalConfig.setAuthor("heqiwen");
globalConfig.setOpen(false);
globalConfig.setSwagger2(true);
globalConfig.setBaseResultMap(true);
globalConfig.setFileOverride(true);
globalConfig.setDateType(DateType.ONLY_DATE);
globalConfig.setEntityName("%s");
globalConfig.setMapperName("%sMapper");
globalConfig.setXmlName("%sMapper");
globalConfig.setServiceName("%sService");
globalConfig.setServiceImplName("%sServiceImpl");
globalConfig.setControllerName("%sController");
return globalConfig;
}
/**
* 初始化数据源配置
*/
private static DataSourceConfig initDataSourceConfig() {
Props props = new Props("generator.properties");
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl(props.getStr("dataSource.url"));
dataSourceConfig.setDriverName(props.getStr("dataSource.driverName"));
dataSourceConfig.setUsername(props.getStr("dataSource.username"));
dataSourceConfig.setPassword(props.getStr("dataSource.password"));
return dataSourceConfig;
}
/**
* 初始化包配置
*/
private static PackageConfig initPackageConfig(String moduleName) {
Props props = new Props("generator.properties");
PackageConfig packageConfig = new PackageConfig();
packageConfig.setModuleName(moduleName);
packageConfig.setParent(props.getStr("package.base"));
packageConfig.setEntity("model");
return packageConfig;
}
/**
* 初始化模板配置
*/
private static TemplateConfig initTemplateConfig() {
TemplateConfig templateConfig = new TemplateConfig();
//可以对controller、service、entity模板进行配置
templateConfig.setController("templates/my_controller.java");
templateConfig.setService("/templates/my_service.java");
templateConfig.setServiceImpl("/templates/my_serviceImpl.java");
//mapper.xml模板需单独配置
templateConfig.setXml(null);
return templateConfig;
}
/**
* 初始化策略配置
*/
private static StrategyConfig initStrategyConfig(String[] tableNames) {
StrategyConfig strategyConfig = new StrategyConfig();
strategyConfig.setNaming(NamingStrategy.underline_to_camel);
strategyConfig.setColumnNaming(NamingStrategy.underline_to_camel);
strategyConfig.setEntityLombokModel(true);
strategyConfig.setRestControllerStyle(true);
//当表名中带*号时可以启用通配符模式
if (tableNames.length == 1 && tableNames[0].contains("*")) {
String[] likeStr = tableNames[0].split("_");
String likePrefix = likeStr[0] + "_";
strategyConfig.setLikeTable(new LikeTable(likePrefix));
} else {
strategyConfig.setInclude(tableNames);
}
return strategyConfig;
}
/**
* 初始化自定义配置
*/
private static InjectionConfig initInjectionConfig(String projectPath, String moduleName) {
// 自定义配置
InjectionConfig injectionConfig = new InjectionConfig() {
@Override
public void initMap() {
// 可用于自定义属性
}
};
// 模板引擎是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;
}
});
injectionConfig.setFileOutConfigList(focList);
return injectionConfig;
}
}
因为代码中有连接数据库的属性。我的属性文件generator.properties是:
dataSource.url=jdbc:mysql://localhost:3306/enterprise_wallet?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
dataSource.driverName=com.mysql.cj.jdbc.Driver
dataSource.username=root
dataSource.password=123456
package.base=com.xnpool.finance.modules
#package.base=com.xnpool.admin.modules
#package.base=com.xnpool.finance.modules
=====================================================================================以上已经完成了=============================================
在输入表名时,如果是oracle数据库,表名就一定在大写。 目前我发现mybatisplus无法对视图自动生成代码
如果在引包是模块引擎是freemarker的话
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
那么就在对应模板文件中写xxx.ftl的文件模板。如:
package ${package.Controller};
import org.springframework.web.bind.annotation.*;
import org.springframework.validation.annotation.Validated;
import org.springframework.beans.factory.annotation.Autowired;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
<#if restControllerStyle>
import org.springframework.web.bind.annotation.RestController;
<#else>
import org.springframework.stereotype.Controller;
</#if>
<#if superControllerClassPackage??>
import ${superControllerClassPackage};
</#if>
import com.qianda.mall.common.validation.Create;
import com.qianda.mall.common.validation.Update;
import com.macro.mall.common.api.CommonResult;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
import java.util.Optional;
/**
* <p>
* ${table.comment!} 前端控制器
* </p>
*
* @author ${author}
* @since ${date}
*/
<#if restControllerStyle>
@RestController
<#else>
@Controller
</#if>
@RequestMapping("/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
@Api(tags = "${table.comment!}")
<#if kotlin>
class ${table.controllerName}<#if superControllerClass??> : ${superControllerClass}()</#if>
<#else>
<#if superControllerClass??>
public class ${table.controllerName} extends ${superControllerClass} {
<#else>
public class ${table.controllerName} {
</#if>
@Autowired
private ${table.serviceName} ${table.serviceName?uncap_first};
@ApiOperation("新增${table.comment!}信息")
@PostMapping
public CommonResult post(@RequestBody @Validated(Create.class) ${entity} ${entity?uncap_first}){
return ${table.serviceName?uncap_first}.save(${entity?uncap_first})?CommonResult.success(${entity?uncap_first}):CommonResult.failed();
}
@ApiOperation("修改${table.comment!}信息")
@PutMapping
public CommonResult put(@RequestBody @Validated(Update.class) ${entity} ${entity?uncap_first}){
return ${table.serviceName?uncap_first}.updateById(${entity?uncap_first})?CommonResult.success(${entity?uncap_first}):CommonResult.failed();
}
@ApiOperation("获取${table.comment!}信息")
@GetMapping("/{id}")
public CommonResult get(@PathVariable @ApiParam(value = "主键") Long id){
return Optional.ofNullable(${table.serviceName?uncap_first}.getById(id)).map(CommonResult::success).orElseGet(CommonResult::failed);
}
@ApiOperation("删除${table.comment!}信息")
@DeleteMapping("/{id}")
public CommonResult delete(@PathVariable @ApiParam(value = "主键") Long id){
return ${table.serviceName?uncap_first}.removeById(id)?CommonResult.success(id):CommonResult.failed();
}
}
</#if>