springboot整合mybatis-plus逆向工程的实现
MyBatis-Plus（简称MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。官方文档
代码生成器
AutoGenerator是MyBatis-Plus的代码生成器，通过AutoGenerator可以快速生成Entity、Mapper、MapperXML、Service、Controller等各个模块的代码，极大的提升了开发效率。
mybatis-plus是根据数据库表来生成对应的实体类，首先我们创建数据库表User
| id | name | age | |
|---|---|---|---|
| 1 | Jone | 18 | test1@baomidou.com |
| 2 | Jack | 20 | test2@baomidou.com |
| 3 | Tom | 28 | test3@baomidou.com |
| 4 | Sandy | 21 | test4@baomidou.com |
| 5 | Billie | 24 | test5@baomidou.com |
其对应的数据库Schema脚本如下：
DROPTABLEIFEXISTSuser; CREATETABLEuser ( idBIGINT(20)NOTNULLCOMMENT'主键ID', nameVARCHAR(30)NULLDEFAULTNULLCOMMENT'姓名', ageINT(11)NULLDEFAULTNULLCOMMENT'年龄', emailVARCHAR(50)NULLDEFAULTNULLCOMMENT'邮箱', PRIMARYKEY(id) );
其对应的数据库Data脚本如下：
DELETEFROMuser; INSERTINTOuser(id,name,age,email)VALUES (1,'Jone',18,'test1@baomidou.com'), (2,'Jack',20,'test2@baomidou.com'), (3,'Tom',28,'test3@baomidou.com'), (4,'Sandy',21,'test4@baomidou.com'), (5,'Billie',24,'test5@baomidou.com');
初始化springboot工程
基本依赖如下：
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test mysql mysql-connector-java runtime org.projectlombok lombok true
下面开始引入逆向工程依赖
MyBatis-Plus从3.0.3之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：
com.baomidou mybatis-plus-boot-starter 3.1.1 com.baomidou mybatis-plus-generator 3.1.1
添加模板引擎依赖，MyBatis-Plus支持Velocity（默认）、Freemarker、Beetl，用户可以选择自己熟悉的模板引擎，如果都不满足您的要求，可以采用自定义模板引擎。
Velocity（默认）：
org.apache.velocity velocity-engine-core 2.1
Freemarker：
org.freemarker freemarker 2.3.28
这里我选择Freemarker
注意！如果您选择了非默认引擎，需要在AutoGenerator中设置模板引擎
全部依赖如下：
org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test org.freemarker freemarker 2.3.23 com.baomidou mybatis-plus-boot-starter 3.1.1 com.baomidou mybatis-plus-generator 3.1.1 org.projectlombok lombok true mysql mysql-connector-java runtime
下面开始：创建逆向工程配置类mpconfig
packagecom.jiangfeixiang.mpdemo.mpconfig;
importcom.baomidou.mybatisplus.annotation.DbType;
importcom.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
importcom.baomidou.mybatisplus.core.toolkit.StringPool;
importcom.baomidou.mybatisplus.core.toolkit.StringUtils;
importcom.baomidou.mybatisplus.generator.AutoGenerator;
importcom.baomidou.mybatisplus.generator.InjectionConfig;
importcom.baomidou.mybatisplus.generator.config.*;
importcom.baomidou.mybatisplus.generator.config.converts.MySqlTypeConvert;
importcom.baomidou.mybatisplus.generator.config.po.TableInfo;
importcom.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
importcom.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
importjava.util.*;
/**
*@ProjectName:mybatis-plus
*@Package:com.jiangfeixiang.mybatisplus.mpconfig
*@ClassName:CodeGenerator
*@Author:jiangfeixiang
*@email:1016767658@qq.com
*@Description:代码生成器
*@Date:2019/5/10/001021:41
*/
publicclassCodeGenerator{
/**
*读取控制台内容
*/
publicstaticStringscanner(Stringtip){
Scannerscanner=newScanner(System.in);
StringBuilderhelp=newStringBuilder();
help.append("请输入"+tip+"：");
System.out.println(help.toString());
if(scanner.hasNext()){
Stringipt=scanner.next();
if(StringUtils.isNotEmpty(ipt)){
returnipt;
}
}
thrownewMybatisPlusException("请输入正确的"+tip+"！");
}
publicstaticvoidmain(String[]args){
/**
*代码生成器
*/
AutoGeneratormpg=newAutoGenerator();
/**
*全局配置
*/
GlobalConfigglobalConfig=newGlobalConfig();
//生成文件的输出目录
StringprojectPath=System.getProperty("user.dir");
globalConfig.setOutputDir(projectPath+"/src/main/java");
//Author设置作者
globalConfig.setAuthor("姜飞祥");
//是否覆盖文件
globalConfig.setFileOverride(true);
//生成后打开文件
globalConfig.setOpen(false);
mpg.setGlobalConfig(globalConfig);
/**
*数据源配置
*/
DataSourceConfigdataSourceConfig=newDataSourceConfig();
//数据库类型,默认MYSQL
dataSourceConfig.setDbType(DbType.MYSQL);
//自定义数据类型转换
dataSourceConfig.setTypeConvert(newMySqlTypeConvert());
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mp?characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSL=false");
dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("1234");
mpg.setDataSource(dataSourceConfig);
/**
*包配置
*/
PackageConfigpc=newPackageConfig();
pc.setModuleName(scanner("模块名"));
//父包名。如果为空，将下面子包名必须写全部，否则就只需写子包名
pc.setParent("com.jiangfeixiang.mpdemo");
mpg.setPackageInfo(pc);
/**
*自定义配置
*/
InjectionConfigcfg=newInjectionConfig(){
@Override
publicvoidinitMap(){
//todonothing
}
};
/**
*模板
*/
//如果模板引擎是freemarker
StringtemplatePath="/templates/mapper.xml.ftl";
//如果模板引擎是velocity
//StringtemplatePath="/templates/mapper.xml.vm";
/**
*自定义输出配置
*/
ListfocList=newArrayList<>();
//自定义配置会被优先输出
focList.add(newFileOutConfig(templatePath){
@Override
publicStringoutputFile(TableInfotableInfo){
//自定义输出文件名，如果你Entity设置了前后缀、此处注意xml的名称会跟着发生变化！！
returnprojectPath+"/src/main/resources/mapper/"+pc.getModuleName()
+"/"+tableInfo.getEntityName()+"Mapper"+StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
/**
*配置模板
*/
TemplateConfigtemplateConfig=newTemplateConfig();
//配置自定义输出模板
//指定自定义模板路径，注意不要带上.ftl/.vm,会根据使用的模板引擎自动识别
//templateConfig.setEntity("templates/entity2.java");
//templateConfig.setService();
//templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
/**
*策略配置
*/
StrategyConfigstrategy=newStrategyConfig();
//设置命名格式
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
//实体是否为lombok模型（默认false）
strategy.setEntityLombokModel(true);
//生成@RestController控制器
strategy.setRestControllerStyle(true);
//设置自定义继承的Entity类全称，带包名
//strategy.setSuperEntityClass("com.jiangfeixiang.mpdemo.BaseEntity");
//设置自定义继承的Controller类全称，带包名
//strategy.setSuperControllerClass("com.jiangfeixiang.mpdemo.BaseController");
//设置自定义基础的Entity类，公共字段
strategy.setSuperEntityColumns("id");
//驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
//表名前缀
strategy.setTablePrefix(pc.getModuleName()+"_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(newFreemarkerTemplateEngine());
mpg.execute();
}
}
拆分详解如下：
/**
*读取控制台内容
*/
publicstaticStringscanner(Stringtip){
Scannerscanner=newScanner(System.in);
StringBuilderhelp=newStringBuilder();
help.append("请输入"+tip+"：");
System.out.println(help.toString());
if(scanner.hasNext()){
Stringipt=scanner.next();
if(StringUtils.isNotEmpty(ipt)){
returnipt;
}
}
thrownewMybatisPlusException("请输入正确的"+tip+"！");
}
读取控制台内容无需更改，因为稍后启动main方法只会需要在控制台输入模块名以及数据库表名。官网参考
接下来是main方法，这个也是主程序，逆向工程启动方法。下面看一下配置
AutoGeneratormpg=newAutoGenerator();
代码生成器，所有的配置都需要set进去
全局配置：
GlobalConfigglobalConfig=newGlobalConfig();
//生成文件的输出目录(下面两行无需改动)
StringprojectPath=System.getProperty("user.dir");
globalConfig.setOutputDir(projectPath+"/src/main/java");
//Author设置作者
globalConfig.setAuthor("姜飞祥");
//是否覆盖文件
globalConfig.setFileOverride(true);
//生成后打开文件
globalConfig.setOpen(false);
//set进去代码生成器对象中
mpg.setGlobalConfig(globalConfig);
数据源配置
DataSourceConfigdataSourceConfig=newDataSourceConfig();
//数据库类型,默认MYSQL
dataSourceConfig.setDbType(DbType.MYSQL);
//自定义数据类型转换
dataSourceConfig.setTypeConvert(newMySqlTypeConvert());
//驱动，URL，用户名以及密码配置，这里使用的是mysql5.6版本
dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/mp?characterEncoding=utf-8&serverTimezone=GMT%2B8&useSSL=false");
dataSourceConfig.setDriverName("com.mysql.jdbc.Driver");
dataSourceConfig.setUsername("root");
dataSourceConfig.setPassword("1234");
//set进去代码生成器对象中
mpg.setDataSource(dataSourceConfig);
包配置
PackageConfigpc=newPackageConfig();
//这里的模块名需要在控制台输入的，即生成的代码在哪个包下
pc.setModuleName(scanner("模块名"));
//父包名。如果为空子包名必须写全部，否则就只需写子包名
pc.setParent("com.jiangfeixiang.mpdemo");
//set进去代码生成器对象中
mpg.setPackageInfo(pc);
上面父包名是根据工程路径来的，如下参考：
自定义配置
InjectionConfigcfg=newInjectionConfig(){
@Override
publicvoidinitMap(){
//todonothing
}
};
自定义输出配置
StringtemplatePath="/templates/mapper.xml.ftl"; ListfocList=newArrayList<>(); //自定义配置会被优先输出 focList.add(newFileOutConfig(templatePath){ @Override publicStringoutputFile(TableInfotableInfo){ //自定义输出文件名，如果你Entity设置了前后缀、此处注意xml的名称会跟着发生变化！！ returnprojectPath+"/src/main/resources/mapper/"+pc.getModuleName() +"/"+tableInfo.getEntityName()+"Mapper"+StringPool.DOT_XML; } }); //这块是set到上面自定义配置中 cfg.setFileOutConfigList(focList); //set进去代码生成器对象中 mpg.setCfg(cfg);
最后是策略配置
StrategyConfigstrategy=newStrategyConfig();
//设置命名格式
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
//实体是否为lombok模型（默认false）
strategy.setEntityLombokModel(true);
//生成@RestController控制器
strategy.setRestControllerStyle(true);
//设置自定义继承的Entity类全称，带包名
//strategy.setSuperEntityClass("com.jiangfeixiang.mpdemo.BaseEntity");
//设置自定义继承的Controller类全称，带包名
//strategy.setSuperControllerClass("com.jiangfeixiang.mpdemo.BaseController");
//设置自定义基础的Entity类，公共字段
strategy.setSuperEntityColumns("id");
//驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
//表名前缀
strategy.setTablePrefix(pc.getModuleName()+"_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(newFreemarkerTemplateEngine());
mpg.execute();
以上全部配置好之后直接启动main方法，之后进入控制台
我的模块名是springbootmp，因为我有两张表，输入两个表的名称回车即可生成对应的代码，所生成的代码在模块名springbootmp下
正确执行控制台输出如下
然后看一下模块：
xxxmapper.xml文件是空的：
实体类已经加上@Data注解省略了get/set方法并序列化
@RestController
@RequestMapping("/springbootmp/user")
publicclassUserController{
@Autowired
privateIUserServiceiUserService;
/**
*获取所有User
*@return
*/
@RequestMapping("/getAllUser")
publicListgetAllUser(){
Listlist=iUserService.list();
returnlist;
}
}
项目运行直接报错如下：
引入即可。之后重新运行启动成功控制台如下图：
还有mybatisplus是不是很漂亮。
调用接口测试如下
源码
到此这篇关于springboot整合mybatis-plus逆向工程的实现的文章就介绍到这了,更多相关springbootmybatis-plus逆向工程内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。