MyBatis Plus 代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
代码生成器采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
官网地址
https://mp.baomidou.com/guide/generator.html
添加依赖
添加 模板引擎 依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎
<!-- 代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!-- 模板引擎依赖-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<!-- MySQL驱动包 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.6</version>
</dependency>
代码生成工具类
// 设置代码输出路径
String projectPath ="D:\\code\\ideaworkspace3\\miaosha\\shop-test\\mybatis-autogenerator";
@Test
public void testGenerator2() {
//1. 全局配置
GlobalConfig config = new GlobalConfig();
config.setActiveRecord(true) //是否支持AR模式,说就是一个实体类继承Model类,可以实现最基本的CRUD
.setAuthor("dashixin") //作者
.setOutputDir(projectPath+"\\src\\main\\java") //生成路径
.setFileOverride(true)//是否文件覆盖,如果多次
.setServiceName("I%sService") //设置生成的service接口名首字母前加I,%s表示模块名称
// .setEntityName("Emp") // 设置实体类的名字
.setIdType(IdType.AUTO) //主键策略
.setOpen(false) // 是否打开输出目录
// .setSwagger2(true) // 开启 swagger2 模式
.setBaseColumnList(true) // 是否生成<sql>片段
.setBaseResultMap(true); // 是否在xml中生成<resultMap>标签
//2. 数据源配置
DataSourceConfig dsConfig = new DataSourceConfig();
dsConfig.setDbType(DbType.MYSQL)
.setUrl("jdbc:mysql://localhost:3306/1911_mysql")
.setDriverName("com.mysql.jdbc.Driver")
.setUsername("root")
.setPassword("root");
//3.策略配置
StrategyConfig stConfig = new StrategyConfig();
stConfig.setCapitalMode(true) // 全局大写命名
.setNaming(NamingStrategy.underline_to_camel) // 数据库表映射到实体的命名策略
.setTablePrefix("t_")
.setInclude("t_user"); //生成的表
//4.包名策略
PackageConfig pkConfig = new PackageConfig();
pkConfig.setParent("com.qf")//父包名
.setController("controller")
.setEntity("entity")
.setService("service")
.setMapper("mapper")
.setXml("mapper");
//5.整合配置
AutoGenerator ag = new AutoGenerator().setGlobalConfig(config)
.setDataSource(dsConfig)
.setStrategy(stConfig)
.setPackageInfo(pkConfig);
ag.execute();
}
最终效果
自定义数据类型转换
MyBatisPlus映射器默认会把data类型映射成 java.time.LocalDate,所以我们需要转成java.util.Data。
//2. 数据源配置
DataSourceConfig dsConfig = new DataSourceConfig();
dsConfig.setDbType(DbType.MYSQL)
.setUrl("jdbc:mysql://localhost:3306/1911_mysql")
.setDriverName("com.mysql.jdbc.Driver")
.setUsername("root")
.setPassword("root")
.setTypeConvert(new MySqlTypeConvert(){ // 自定义数据库表字段类型转换
@Override
public IColumnType processTypeConvert(GlobalConfig globalConfig, String fieldType) {
System.out.println(fieldType);
if ( fieldType.toLowerCase().contains( "datetime" ) ) {
return DbColumnType.DATE;
}else if(fieldType.toLowerCase().contains( "date" ) ){
return DbColumnType.DATE;
}
return super.processTypeConvert(globalConfig, fieldType);
}
});
自定义Mapper文件输出位置
Mapper.xml文件默认是输出到/src/main/java下面,但是我们在开发中一般都是在src/main/resources/mapper/下面,所以我们需要设置自定义输出路径。
// 自定义输出配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
}
};
// Mapper.xml文件的模板
String templatePath = "/templates/mapper.xml.vm";
List<FileOutConfig> focList = new ArrayList<>();
// 设置Mapper.xml输出自定义路劲
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
return projectPath+"\\src\\main\\resources\\mapper\\"
+ tableInfo.getEntityName() + "Mapper"+StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
// 配置模板配置
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);// Mapepr.xml已经指定了输出位置,这里设置是取消默认的输出位置
//5.整合配置
AutoGenerator ag = new AutoGenerator().setGlobalConfig(config)
.setDataSource(dsConfig)
.setStrategy(stConfig)
.setPackageInfo(pkConfig)
.setTemplate(templateConfig)
.setCfg(cfg);
ag.execute();
自定义模板
创建模板
新建Controller模板文件 src\main\resources\templates\comtroller.java.vm
package ${package.Controller};
#if(${restControllerStyle})
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
#else
import org.springframework.stereotype.Controller;
#end
#if(${superControllerClassPackage})
import ${superControllerClassPackage};
#end
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.GetMapping;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;
/**
*
* @author ${author}
* @since ${date}
*/
#if(${restControllerStyle})
@RestController
#else
@Controller
#end
@RequestMapping("#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;
/**
* 跳转列表页面
* @param request
* @param model
* @return
*/
@RequestMapping(method= RequestMethod.GET,value = {"/${table.entityPath}Index"})
public String index(HttpServletRequest request, Model model) {
return "${table.entityPath}ListIndex";
}
/**
* 分页查询数据
*
* @return
*/
@ResponseBody
@GetMapping("/get${entity}PageList")
public Map<String, Object> get${entity}PageList(Page<${entity}> page,${entity} ${table.entityPath}) {
Map<String,Object> result = new HashMap<String,Object>();
try {
i${entity}Service.page(page);
} catch (Exception e) {
logger.error("get${entity}List -=- {}",e.toString());
}
return result;
}
/**
* 跳转添加页面
* @param request
* @param response
* @param model
* @return
*/
@RequestMapping(method=RequestMethod.GET,value="/${table.entityPath}Add")
public String ${table.entityPath}Add(HttpServletRequest request,HttpServletResponse response,Model model) {
try {
}catch (Exception ex){
logger.error("${table.entityPath}Add -=- {}",ex.toString());
}
return "${table.entityPath}Add";
}
/**
* 跳转修改页面
* @param request
* @param id 实体ID
* @return
*/
@RequestMapping(method=RequestMethod.GET,value="/${table.entityPath}Update")
public String ${table.entityPath}Update(HttpServletRequest request,Long id) {
try {
${entity} ${table.entityPath} = i${entity}Service.getById(id);
request.setAttribute("${table.entityPath}",${table.entityPath});
}catch (Exception ex){
logger.error("${table.entityPath}Update -=- {}",ex.toString());
}
return "${table.entityPath}Upd";
}
/**
* 保存和修改公用的
* @param ${table.entityPath} 传递的实体
* @return 0 失败 1 成功
*/
@ResponseBody
@RequestMapping(method=RequestMethod.POST,value="/${table.entityPath}Save")
public int ${table.entityPath}Save(${entity} ${table.entityPath}) {
int count = 0;
try {
count = i${entity}Service.saveOrUpdate(${table.entityPath}) ? 1 : 0;
} catch (Exception e) {
logger.error("${table.entityPath}Save -=- {}",e.toString());
}
return count;
}
/**
* 根据id删除对象
* @param id 实体ID
* @return 0 失败 1 成功
*/
@ResponseBody
@RequestMapping(method= RequestMethod.POST,value="/${table.entityPath}Delete")
public int ${table.entityPath}Delete(Long id){
int count = 0;
try {
count = i${entity}Service.removeById(id) ? 1 : 0;
}catch (Exception e){
logger.error("${table.entityPath}Delete -=- {}",e.toString());
}
return count;
}
/**
* 批量删除对象
* @param item 实体集合ID
* @return 0 失败 1 成功
*/
@ResponseBody
@RequestMapping(method= RequestMethod.POST,value="/${table.entityPath}BatchDelete")
public int deleteBatchIds(String item){
int count = 0;
try {
}catch (Exception e){
logger.error("${table.entityPath}BatchDelete -=- {}",e.toString());
}
return count;
}
}
设置自定义模板
String templateControllerPath = "/templates/comtroller.java.vm";
// 配置模板配置
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setXml(null);// Mapepr.xml已经指定了输出位置,这里设置是取消默认的输出位置
templateConfig.setController(templateControllerPath); // 设置自定义Controller模板路径