mybatisplus自动生成
一，pom依赖
<!-- MP 核心库 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.2.0</version>
</dependency>
<!-- 模板引擎 -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.1</version>
</dependency></code></pre></div><p><b>二，<a href="https://link.zhihu.com/?target=http%3A//mybatisplusconfig.java/" class=" wrap external" target="_blank" rel="nofollow noreferrer" data-za-detail-view-id="1043">mybatisplusConfig.java</a></b></p><div class="highlight"><pre><code class="language-text">@Configuration
@MapperScan("com.qiao.itmc.mapper")
public class MybatisPlusConfig {
/*
* 分页插件，自动识别数据库类型
* 多租户，请参考官网【插件扩展】
/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
@Bean("sqlSessionFactory")
@Primary
public SqlSessionFactory sqlSessionFactory(@Autowired @Qualifier("dataSource") DataSource dataSource) throws Exception {
MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource);
sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources("classpath:mapper/*.xml"));
return sqlSessionFactoryBean.getObject();
}
}
注：sqlSessionFactory必须配置，不然找不到baseMapper中的方法。
注：自动生成Mapper,service,controller的类，其中用到的模板放在最后package com.qiao.itmc.config;
import java.util.*;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
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.NamingStrategy;
public class CodeGenerator {
// 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
/**
* <p>
* 读取控制台内容
* </p>
*/
public static String scanner(String tip) {
Scanner scanner = new Scanner(system.in - 这个网站可出售。 - 最佳的System 来源和相关信息。);
StringBuilder help = new StringBuilder();
help.append("请输入" + tip + "：");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotEmpty(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "！");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 选择 freemarker 引擎，默认 Veloctiy
//mpg.setTemplateEngine(new FreemarkerTemplateEngine());
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir("E://workspace/itmc/src/main/java"); //生成文件的输出目录
gc.setAuthor("qiao"); //作者
gc.setFileOverride(true); //是否覆蓋已有文件 默认值：false
gc.setOpen(false); //是否打开输出目录 默认值:true
// gc.setSwagger2(true); //开启 swagger2 模式 默认false
gc.setBaseColumnList(true); //开启 baseColumnList 默认false
gc.setBaseResultMap(true); //开启 BaseResultMap 默认false
//gc.setEntityName("%sQuery"); //实体命名方式 默认值：null 例如：%sEntity 生成 UserEntity
gc.setMapperName("%sMapper"); //com.qiao.itmc.com 命名方式 默认值：null 例如：%sDao 生成 UserDao
gc.setXmlName("%sMapper"); //Mapper xml 命名方式 默认值：null 例如：%sDao 生成 UserDao.xml
gc.setServiceName("%sService"); //service 命名方式 默认值：null 例如：%sBusiness 生成 UserBusiness
gc.setServiceImplName("%sServiceImpl"); //service impl 命名方式 默认值：null 例如：%sBusinessImpl 生成 UserBusinessImpl
gc.setControllerName("%sController"); //controller 命名方式 默认值：null 例如：%sAction 生成 UserAction
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL); //数据库类型 该类内置了常用的数据库类型【必须】
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/qingcheng?useUnicode=true&characterEncoding=UTF-8&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("******");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// pc.setModuleName(scanner("模块名"));
pc.setParent("com.qiao.itmc");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() { //注入自定义 Map 对象
Map<String, Object> map = new HashMap<String, Object>();
map.put("abc", this.getConfig().getGlobalConfig().getAuthor() + "-mp");
this.setMap(map);
// to do nothing
}
};
List<FileOutConfig> focList = new ArrayList<>();
// 调整 controller 生成目录演示
focList.add(new FileOutConfig("/templates/controller.java.vm") {
@Override
public String outputFile(TableInfo tableInfo) {
//输出的位置
return "E://workspace/itmc/src/main/java/com/qiao/itmc/controller/" + tableInfo.getEntityName() + "Controller.java";
}
});
// 调整 service 生成目录演示
focList.add(new FileOutConfig("/templates/serviceImpl.java.vm") {
@Override
public String outputFile(TableInfo tableInfo) {
//输出的位置
return "E://workspace/itmc/src/main/java/com/qiao/itmc/service/impl/" + tableInfo.getEntityName() + "ServiceImpl.java";
}
});
/*focList.add(new FileOutConfig("/template/list.jsp.vm") {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输入文件名称
return "E://workspace/itmc/src/main/webapp/jsp/"
+ tableInfo.getEntityName() + ".jsp";
}
});*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 策略配置 数据库表配置，通过该配置，可指定需要生成哪些表或者排除哪些表
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel); //表名生成策略
// strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
// strategy.setCapitalMode(true); // 全局大写命名 ORACLE 注意
// strategy.setTablePrefix("prefix"); //表前缀
strategy.setSuperEntityClass("com.qiao.itmc.entity.BaseEntity"); //自定义继承的Entity类全称，带包名
//strategy.setEntityLombokModel(true); //【实体】是否为lombok模型（默认 false
strategy.setRestControllerStyle(true); //生成 @RestController 控制器
strategy.setSuperControllerClass("com.qiao.itmc.Jar.BaseController"); //自定义继承的Controller类全称，带包名
strategy.setInclude(scanner("表名")); //需要包含的表名，允许正则表达式（与exclude二选一配置）
// strategy.setInclude(new String[] { "user" }); // 需要生成的表可以多张表
// strategy.setExclude(new String[]{"test"}); // 排除生成的表
strategy.setControllerMappingHyphenStyle(true); //驼峰转连字符
strategy.setTablePrefix(pc.getModuleName() + "_"); //是否生成实体时，生成字段注解
mpg.setStrategy(strategy);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// 如上任何一个模块如果设置 空 OR Null 将不生成该模块。
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
//templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
mpg.execute();
}
}
四，上面用到的自定义模板
1， controller.java.vm
这个类是生成controller的模板，放在resources下的templates目录下。package ${package.Controller};
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import ${package.Service}.${table.serviceName};
import ${package.Entity}.${entity};
import com.qiao.itmc.util.AjaxResult;
import com.qiao.itmc.Jar.PageParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/${table.entityPath}")
public class ${entity}Controller {
@Autowired
public ${table.serviceName} ${table.entityPath}Service;
/**
* 保存和修改公用的
* @param ${table.entityPath} 传递的实体
* @return Ajaxresult转换结果
*/
@RequestMapping(value="/save${entity}")
public AjaxResult save${entity}(${entity} ${table.entityPath}){
try {
if(${table.entityPath}.getId()!=null){
${table.entityPath}Service.updateById(${table.entityPath});
}else{
${table.entityPath}Service.save(${table.entityPath});
}
return AjaxResult.me();
} catch (Exception e) {
e.printStackTrace();
return AjaxResult.me(false,"保存对象失败！"+e.getMessage());
}
}
/**
* 删除对象信息
* @param id
* @return
*/
@RequestMapping(value="delete/{id}")
public AjaxResult delete${entity}(@PathVariable("id") Long id){
try {
${table.entityPath}Service.removeById(id);
return AjaxResult.me();
} catch (Exception e) {
e.printStackTrace();
return AjaxResult.me(false,"删除对象失败！"+e.getMessage());
}
}
//获取用户
@RequestMapping(value = "find/{id}")
public ${entity} get${entity}(@PathVariable("id")Long id)
{
return ${table.entityPath}Service.getById(id);
}
/**
* 查看所有的员工信息
* @return
*/
@RequestMapping(value = "/list${entity}")
public List<${entity}> list${entity}(){
return ${table.entityPath}Service.list();
}
/**
* 分页查询数据
*
* @param query 查询对象
* @return PageList 分页对象
*/
@RequestMapping(value = "/pageList${entity}")
public Page<${entity}> json${entity}(@RequestBody ${entity} query)
{
Page<${entity}> page = new Page(query.getPage(),query.getRows());
return (Page<${entity}>) ${table.entityPath}Service.page(page);
}
}
2，serviceImpl.java.vm
Service模板，因为继承了自己的baseService,所以需要写，生成默认service不需要写。
package ${package.Service}.impl;
import com.qiao.itmc.Jar.BaseServiceImpl;
import ${package.Entity}.${entity};
import ${package.Mapper}.${table.mapperName};
import ${package.Service}.${table.serviceName};
import org.springframework.stereotype.Service;
/**
- <p>
- 服务实现类
- </p>
- @author qiao
- @since 2019-12-08
*/
@Service
public class ${entity}ServiceImpl extends BaseServiceImpl<${entity}Mapper, ${entity}> implements ${entity}Service {
}
五，用到的类
基础实体类，留给实体类继承
@Setter@Getter
public class BaseEntity implements Serializable {
private transient Integer page;
private transient Integer rows;
}基础service,继承mybatisplus的ServiceImpl类，baseService中可以写一些自己的service层通用方法import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
/**
- 此处可以写通用的Service
- @param <M>
- @param <T>
*/
public class BaseServiceImpl<M extends BaseMapper<T>, T> extends ServiceImpl<M, T> {
}
————————————————
原文地址：https://zhuanlan.zhihu.com/p/97037541