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,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎
public class MySqlGenerator {
@Test
public void testGenerator2() {
//项目的绝对路径
String projectPath = System.getProperty("user.dir");
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("alan");
//是否打开输出目录
//默认值:true
gc.setOpen(false);
// gc.setEntityName("%s"); //%s 是占位符,表示数据库表明,例如数据库是 user 表,则 %s 表示 user
// gc.setMapperName("%sMapper"); //userMapper.java
// gc.setXmlName("%sMapper");//userMapper.xml
// gc.setServiceName("%sService"); //userService
// gc.setServiceImplName("%sServiceImpl"); //userServiceImpl
// gc.setControllerName("%sController"); //userController
//设置日期
gc.setDateType(ONLY_DATE);
//设置覆盖
gc.setFileOverride(true);
//开启 BaseResultMap
gc.setBaseResultMap(true);
//开启 baseColumnList
gc.setBaseColumnList(true);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://10.6.14.1:3306/db_device_system?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName("mybatisplussamples") //模块名
// .setParent("com.example") //包 com.junjiang
// .setController("controller") //包 com.junjiang.common.controller
// .setEntity("entity") //entity包名
// .setService("service") //service包名
// .setServiceImpl("service.impl") //serviceImpl包名
// .setMapper("mapper") //Mapper接口包名
// .setXml("mapper.xml"); //XML文件包名
pc.setParent("com.alan.generator");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 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/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
//不在mapper文件中生成mapper.xml文件,只在resources中生成
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
//生成表名策略;下划线转驼峰 tb_user -> TbUser
strategy.setNaming(NamingStrategy.underline_to_camel);
//生成列名策略:下划线转驼峰 last_name -> lastName
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//开启lombok
strategy.setEntityLombokModel(true);
//lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setChainModel(true);
//restful api风格控制器
strategy.setRestControllerStyle(true);
//开启RestController
strategy.setRestControllerStyle(true);
//要生成的表名,你要生成那个表的代码就写那个表,多个表可以逗号隔开
strategy.setInclude("tb_device");
//按表前缀生成,
//strategy.setLikeTable(new LikeTable("tb_"));
//驼峰转连字符 比如pms_product -->controller @RequestMapping("/pms/pmsProduct")
strategy.setControllerMappingHyphenStyle(false);
//设置表替换前缀 tb_user -->实体类 User
strategy.setTablePrefix("tb_");
mpg.setStrategy(strategy);
mpg.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模板路径