我是靠谱客的博主 辛勤路人，最近开发中收集的这篇文章主要介绍springboot整合Mybatis Generator+PageHelper使用记录POM jar依赖MBG配置文件自定义注释生成器主方法生产器的入口MyBatis配置类PageHelper的使用工具类，觉得挺不错的，现在分享给大家，希望可以做个参考。
概述
POM jar依赖
<!--MyBatis分页插件-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.2.10</version>
</dependency>
<!--集成druid连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.10</version>
</dependency>
<!-- MyBatis 生成器 -->
<dependency>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-core</artifactId>
<version>1.3.3</version>
</dependency>
<!--Mysql数据库驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.15</version>
</dependency>
<!--Swagger-UI API文档生产工具-->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.7.0</version>
</dependency>
MBG配置文件
在resources目录下创建
Generator配置文件:generatorConfig.xml 注意生产代码的目录
详细配置可参考 https://blog.csdn.net/isea533/article/details/42102297
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--导入配置属性-->
<properties resource="generator.properties"/>
<!--defaultModelType属性 定义了MBG如何生产实体类
flat:该模型为每一张表只生成一个实体类。这个实体类包含表中的所有字段 -->
<!-- targetRuntime:此属性用于指定生成的代码的运行时环境
不生成和Example查询有关的内容 targetRuntime="MyBatis3Simple"-->
<context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat">
<!--sql字段分割符 如select * from `user info` -->
<property name="beginningDelimiter" value="`"/>
<property name="endingDelimiter" value="`"/>
<property name="javaFileEncoding" value="UTF-8"/>
<!-- 为模型生成序列化方法-->
<plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
<!-- 为生成的Java模型创建一个toString方法 -->
<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
<!--可以自定义生成model的代码注释-->
<commentGenerator type="com.keyou.mbg.CommentGenerator">
<!-- 是否去除自动生成的注释 true：是 ： false:否 -->
<property name="suppressAllComments" value="true"/>
<property name="suppressDate" value="true"/>
<property name="addRemarkComments" value="true"/>
</commentGenerator>
<!--配置数据库连接-->
<jdbcConnection driverClass="${jdbc.driverClass}"
connectionURL="${jdbc.connectionURL}"
userId="${jdbc.userId}"
password="${jdbc.password}">
<!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题-->
<property name="nullCatalogMeansCurrent" value="true"/>
</jdbcConnection>
<!-- javaTypeResolver配置用来指定JDBC类型和Java类型如何转换
设置为true，那么一定会使用java.math.BigDecimal-->
<!-- <javaTypeResolver >
<property name="forceBigDecimals" value="true" />
</javaTypeResolver>-->
<!--指定生成model的路径-->
<javaModelGenerator targetPackage="com.keyou.mbg.model" targetProject="srcmainjava"/>
<!--指定生成mapper.xml的路径-->
<sqlMapGenerator targetPackage="com.keyou.mbg.mapper" targetProject="srcmainresources"/>
<!--指定生成mapper接口的的路径
type指定生产映射是xml还是注解以及xml和注解的混合形式-->
<javaClientGenerator type="XMLMAPPER" targetPackage="com.keyou.mbg.mapper"
targetProject="srcmainjava"/>
<!--生成全部表tableName设为%
identity:当设置为true时,该列会被标记为identity列， 并且<selectKey>元素会被插入在insert后面。-->
<table tableName="pms_brand">
<generatedKey column="id" sqlStatement="MySql" identity="true"/>
</table>
</context>
</generatorConfiguration>
JDBC配置文件generator.properties
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=root
工程配置文件减application.yml
server:
port: 8080
spring:
datasource:
url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
username: root
password: root
#指定mapper映射文件扫描
mybatis:
mapper-locations:
- classpath:mapper/*.xml
- classpath*:com/**/mapper/*.xml
自定义注释生成器
MBG自带的注解生产看不懂只能手动重写DefaultCommentGenerator 来的比较实际
详细请参考:https://segmentfault.com/a/1190000016525887
/**
* 自定义注释生成器
* 给实体类的字段添加swagger注解
*/
public class CommentGenerator extends DefaultCommentGenerator {
private boolean addRemarkComments = false;
private static final String EXAMPLE_SUFFIX="Example";
private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";
/**
* 设置用户配置的参数
*/
@Override
public void addConfigurationProperties(Properties properties) {
super.addConfigurationProperties(properties);
this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));
}
/**
* 给字段添加注释
*/
@Override
public void addFieldComment(Field field, IntrospectedTable introspectedTable,
IntrospectedColumn introspectedColumn) {
String remarks = introspectedColumn.getRemarks();
//根据参数和备注信息判断是否添加备注信息
if(addRemarkComments&& StringUtility.stringHasValue(remarks)){
//
addFieldJavaDoc(field, remarks);
//数据库中特殊字符需要转义
if(remarks.contains(""")){
remarks = remarks.replace(""","'");
}
//给model的字段添加swagger注解
field.addJavaDocLine("@ApiModelProperty(value = ""+remarks+"")");
}
}
/**
* 给model的字段添加注释
*/
private void addFieldJavaDoc(Field field, String remarks) {
//文档注释开始
field.addJavaDocLine("/**");
//获取数据库字段的备注信息
String[] remarkLines = remarks.split(System.getProperty("line.separator"));
for(String remarkLine:remarkLines){
field.addJavaDocLine(" * "+remarkLine);
}
addJavadocTag(field, false);
field.addJavaDocLine(" */");
}
@Override
public void addJavaFileComment(CompilationUnit compilationUnit) {
super.addJavaFileComment(compilationUnit);
//只在model中添加swagger注解类的导入
if(!compilationUnit.isJavaInterface()&&!compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)){
compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));
}
}
}
主方法生产器的入口
/**
* @author ding
* @version V1.0
* @date 2019/10/30 17:02
*/
public class Generator {
public static void main(String[] args) throws Exception {
//MBG 执行过程中的警告信息
List<String> warnings = new ArrayList<String>();
//当生成的代码重复时，覆盖原代码
boolean overwrite = true;
//读取我们的 MBG 配置文件
InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");
ConfigurationParser cp = new ConfigurationParser(warnings);
Configuration config = cp.parseConfiguration(is);
is.close();
DefaultShellCallback callback = new DefaultShellCallback(overwrite);
//创建 MBG
MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
//执行生成代码
myBatisGenerator.generate(null);
//输出警告信息
for (String warning : warnings) {
System.out.println(warning);
}
}
}
MyBatis配置类
**也可以直接在启动类上加
@MapperScan("com.keyou.mbg.mapper")**
@Configuration
@MapperScan("com.keyou.mbg.mapper")
public class MyBatisConfig {
}
注意项目的目录结构和配置文件注解扫描的包路径
PageHelper的使用
pagehelper的工作原理简单了解一下,使用的是本地线程中的一块存储区域使用startPage()参数存进去,在执行sql语句是利用了mybatis提供的拦截器，取得ThreadLocal的值，重新拼装分页SQL，完成分页
**注意事项**:在使用过程中分页参数设置和查询方法的调用中间尽量不要有其他操作,避免本地线程发生变化影响分页使用
PageHelper.startPage(pageNum, pageSize);
//之后进行查询操作将自动进行分页
List<PmsBrand> brandList = brandMapper.selectByExample(new PmsBrandExample());
//通过构造PageInfo对象获取分页信息，如当前页码，总页数，总条数
PageInfo<PmsBrand> pageInfo = new PageInfo<PmsBrand>(list);
工具类
/**
* 分页数据封装类
* Created by macro on 2019/4/19.
*/
public class CommonPage<T> {
// 当前页
private Integer pageNum;
//每页显示条数
private Integer pageSize;
//总页数
private Integer totalPage;
//总记录数
private Long total;
//查询数据
private List<T> list;
/**
* 将PageHelper分页后的list转为分页信息
*/
public static <T> CommonPage<T> restPage(List<T> list) {
CommonPage<T> result = new CommonPage<T>();
PageInfo<T> pageInfo = new PageInfo<T>(list);
result.setTotalPage(pageInfo.getPages());
result.setPageNum(pageInfo.getPageNum());
result.setPageSize(pageInfo.getPageSize());
result.setTotal(pageInfo.getTotal());
result.setList(pageInfo.getList());
return result;
}
/**
* 将SpringData分页后的list转为分页信息
*/
public static <T> CommonPage<T> restPage(Page<T> pageInfo) {
CommonPage<T> result = new CommonPage<T>();
result.setTotalPage(pageInfo.getPages());
result.setPageNum(pageInfo.getPageNum());
result.setPageSize(pageInfo.getStartRow());
result.setTotal(pageInfo.getTotal());
result.setList(pageInfo.getResult());
return result;
}
}
使用PageHelper记得配置数据库方言,记录到这里.
最后
以上就是辛勤路人为你收集整理的springboot整合Mybatis Generator+PageHelper使用记录POM jar依赖MBG配置文件自定义注释生成器主方法生产器的入口MyBatis配置类PageHelper的使用工具类的全部内容，希望文章能够帮你解决springboot整合Mybatis Generator+PageHelper使用记录POM jar依赖MBG配置文件自定义注释生成器主方法生产器的入口MyBatis配置类PageHelper的使用工具类所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供，作为学习参考使用，或来自网络收集整理，版权属于原作者所有。
发表评论 取消回复