SpringBoot中整合MyBatis-Plus的方法示例

2023-07-16 22:03:04 78

MyBatis框架相信大家都用过，虽然MyBatis可以直接在xml中通过SQL语句操作数据库，很是灵活。但正其操作都要通过SQL语句进行，就必须写大量的xml文件，很是麻烦。于是MyBatis-Plus应运而生，作为MyBatis的增强工具，更是为我们开发效率得到了质的飞跃。

一、简介

1、MyBatis

MyBatis是一款优秀的持久层框架，它支持自定义SQL、存储过程以及高级映射。MyBatis免除了几乎所有的JDBC代码以及设置参数和获取结果集的工作。MyBatis可以通过简单的XML或注解来配置和映射原始类型、接口和JavaPOJO（PlainOldJavaObjects，普通老式Java对象）为数据库中的记录。

官方文档：
https://mybatis.org/mybatis-3/zh/index.html

2、MyBatis-Plus

MyBatis-Plus（简称MP）是一个MyBatis的增强工具，在MyBatis的基础上只做增强不做改变，为简化开发、提高效率而生。

官方文档：
https://mybatis.plus/guide/

二、开发前戏

1、引入MyBatis-Plus

在pom.xml文件中引入MyBatis-Plus所需依赖



com.baomidou
mybatis-plus-boot-starter
3.3.1



com.baomidou
mybatis-plus-generator
3.3.1.tmp



org.freemarker
freemarker



mysql
mysql-connector-java
runtime

freemarker作为MyBatis-Plus自动生成代码时作为模板使用，还可选用velocity作为模板


org.apache.velocity
velocity-engine-core
2.2

本次我们选用freemarker作为模板

2、配置信息

在application.yml文件中，配置mybatis-plus的信息

#mybatis配置
mybatis-plus:
#xml文件路径
mapper-locations:classpath:mapper/*.xml
#实体类路径
type-aliases-package:com.zyxx.sbm.entity
configuration:
#驼峰转换
map-underscore-to-camel-case:true
#是否开启缓存
cache-enabled:false
#打印sql
log-impl:org.apache.ibatis.logging.stdout.StdOutImpl
#全局配置
global-config:
#数据库字段驼峰下划线转换
db-column-underline:true
#id自增类型(数据库id自增)
id-type:0

我们主要配置了：

xml文件的存放位置
实体类的存放位置
开启驼峰转换原则
开启缓存
打印sql日志
id自增策略，有多种策略，如下：

/**
*数据库ID自增
*/
AUTO(0),
/**
*该类型为未设置主键类型(注解里等于跟随全局,全局里约等于INPUT)
*/
NONE(1),
/**
*用户输入ID
*该类型可以通过自己注册自动填充插件进行填充
*/
INPUT(2),

/*以下3种类型、只有当插入对象ID为空，才自动填充。*/
/**
*分配ID(主键类型为number或string）,
*默认实现类{@linkcom.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
*
*@since3.3.0
*/
ASSIGN_ID(3),
/**
*分配UUID(主键类型为string)
*默认实现类{@linkcom.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
*/
ASSIGN_UUID(4);

MyBatis-Plus默认的是推特的“雪花算法”，但是这样生成的主键id会比较长，本次我们选择数据库自增策略

我们还需要在项目启动类加上

@MapperScan("com.zyxx.sbm.mapper")
@ComponentScan(basePackages={"com.zyxx"})

扫描我们mapper包下面的文件，有时你会发现不在启动类当前包下面的文件无法扫描，于是加上第二个注解，扫描其他文件

3、自动生成代码类

importcom.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
importcom.baomidou.mybatisplus.generator.AutoGenerator;
importcom.baomidou.mybatisplus.generator.InjectionConfig;
importcom.baomidou.mybatisplus.generator.config.*;
importcom.baomidou.mybatisplus.generator.config.po.TableInfo;
importcom.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
importcom.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
importorg.apache.commons.lang3.StringUtils;

importjava.util.ArrayList;
importjava.util.List;
importjava.util.Scanner;

/**
*代码生成器
*
*@AuthorLizhou
*/
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();
//TODO全局配置
GlobalConfiggc=newGlobalConfig();
StringprojectPath=System.getProperty("user.dir");
//生成文件的输出目录【默认D盘根目录】
gc.setOutputDir(projectPath+"/src/main/java");
//作者
gc.setAuthor("lizhou");
//是否打开输出目录
gc.setOpen(false);
//controller命名方式，注意%s会自动填充表实体属性
gc.setControllerName("%sController");
//service命名方式
gc.setServiceName("%sService");
//serviceImpl命名方式
gc.setServiceImplName("%sServiceImpl");
//mapper命名方式
gc.setMapperName("%sMapper");
//xml命名方式
gc.setXmlName("%sMapper");
//开启swagger2模式
gc.setSwagger2(true);
//是否覆盖已有文件
gc.setFileOverride(true);
//是否开启ActiveRecord模式
gc.setActiveRecord(true);
//是否在xml中添加二级缓存配置
gc.setEnableCache(false);
//是否开启BaseResultMap
gc.setBaseResultMap(true);
//XMLcolumList
gc.setBaseColumnList(false);
//全局相关配置
mpg.setGlobalConfig(gc);

//TODO数据源配置
DataSourceConfigdsc=newDataSourceConfig();
dsc.setUrl("jdbc:mysql://127.0.0.1:3306/sbm?useUnicode=true&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC&useSSL=true&characterEncoding=UTF-8");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);

//TODO包配置
PackageConfigpc=newPackageConfig();
//父包名。如果为空，将下面子包名必须写全部，否则就只需写子包名
pc.setParent("com.zyxx.sbm");
//Entity包名
pc.setEntity("entity");
//Service包名
pc.setService("service");
//ServiceImpl包名
pc.setServiceImpl("service.impl");
mpg.setPackageInfo(pc);

//TODO自定义配置
InjectionConfigcfg=newInjectionConfig(){
@Override
publicvoidinitMap(){
//todonothing
}
};
//输出文件配置
ListfocList=newArrayList<>();
focList.add(newFileOutConfig("/templates/mapper.xml.ftl"){
@Override
publicStringoutputFile(TableInfotableInfo){
//自定义输入文件名称
returnprojectPath+"/src/main/resources/mapper/"+tableInfo.getEntityName()+"Mapper.xml";
}
});
//自定义输出文件
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(newTemplateConfig().setXml(null));

//TODO策略配置
StrategyConfigstrategy=newStrategyConfig();
//数据库表映射到实体的命名策略，驼峰原则
strategy.setNaming(NamingStrategy.underline_to_camel);
//字数据库表字段映射到实体的命名策略，驼峰原则
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//实体是否生成serialVersionUID
strategy.setEntitySerialVersionUID(false);
//是否生成实体时，生成字段注解
strategy.setEntityTableFieldAnnotationEnable(true);
//使用lombok
strategy.setEntityLombokModel(true);
//设置逻辑删除键
strategy.setLogicDeleteFieldName("del_flag");
//TODO指定生成的bean的数据库表名
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
//驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
//选择freemarker引擎需要指定如下加，注意pom依赖必须有！
mpg.setTemplateEngine(newFreemarkerTemplateEngine());
mpg.execute();
}
}

我们需要改变的就是：

数据库的连接信息，地址，用户，密码
controller、service、mapper、xml等文件的命名规则
生成文件controller、service、mapper、xml文件的存放位置
数据库与实体类之间的一些策略配置等

三、开发进行中

1、创建数据表

我们创建一个用户信息表user_info

droptableifexistsuser_info;

/*==============================================================*/
/*Table:user_info*/
/*==============================================================*/
createtableuser_info
(
idbigint(20)notnullauto_incrementcomment'主键id',
accountvarchar(32)comment'账号',
passwordvarchar(32)comment'密码',
namevarchar(32)comment'姓名',
phonevarchar(11)comment'电话',
avatarvarchar(255)comment'头像',
sextinyint(1)comment'性别（0--未知1--男2--女）',
create_timedatetimecomment'创建时间',
create_userbigint(20)comment'创建人',
statustinyint(1)default0comment'状态（0--正常1--冻结）',
del_flagtinyint(1)default0comment'删除状态（0，正常，1已删除）',
primarykey(id)
)
type=InnoDB;

altertableuser_infocomment'用户信息表';

2、生成代码

我们利用刚刚创建的自动生成代码类，生成关于user_info数据表的controller、service、mapper、xml、entity等文件

生成方法：

运行自动生成代码类中的main方法
在控制台输入表名user_info

生成的文件就自动放在我们配置的包下面

3、代码鉴赏

UserInfo.java文件

importcom.baomidou.mybatisplus.annotation.*;
importcom.baomidou.mybatisplus.extension.activerecord.Model;
importcom.zyxx.common.annotation.Dict;
importio.swagger.annotations.ApiModel;
importio.swagger.annotations.ApiModelProperty;
importlombok.Data;
importlombok.EqualsAndHashCode;
importlombok.experimental.Accessors;

importjava.io.Serializable;

/**
*
*用户信息表
*
*
*@authorlizhou
*@since2020-07-06
*/
@Data
@EqualsAndHashCode(callSuper=false)
@Accessors(chain=true)
@TableName("sys_user_info")
@ApiModel(value="SysUserInfo对象",description="用户信息表")
publicclassUserInfoextendsModel{

@ApiModelProperty(value="ID")
@TableId(value="id",type=IdType.AUTO)
privateLongid;

@ApiModelProperty(value="登录账号")
@TableField("account")
privateStringaccount;

@ApiModelProperty(value="登录密码")
@TableField("password")
privateStringpassword;

@ApiModelProperty(value="姓名")
@TableField("name")
privateStringname;

@ApiModelProperty(value="电话")
@TableField("phone")
privateStringphone;

@ApiModelProperty(value="头像")
@TableField("avatar")
privateStringavatar;

@ApiModelProperty(value="性别（0--未知1--男2--女）")
@TableField("sex")
privateIntegersex;

@ApiModelProperty(value="状态（0--正常1--冻结）")
@TableField("status")
privateIntegerstatus;

@ApiModelProperty(value="创建时间")
@TableField("create_time")
privateStringcreateTime;

@ApiModelProperty(value="创建人")
@TableField("create_user")
privateLongcreateUser;

@ApiModelProperty(value="删除状态（0--未删除1--已删除）")
@TableField("del_flag")
@TableLogic
privateIntegerdelFlag;

@Override
protectedSerializablepkVal(){
returnthis.id;
}
}

@TableName(“sys_user_info”)，标注表名
Model，继承了Model抽象类，并实现了序列化
@ApiModelProperty(value=“ID”)，注释，这是在自动生成代码类中配置了//开启swagger2模式gc.setSwagger2(true);才会生成的
@TableId(value=“id”,type=IdType.AUTO)，表明了主键自增策略
@TableField(“account”)，标注了数据库中对应的字段
@TableLogic，逻辑删除字段，表示我们在调用删除方法时，数据库并不会物理删除，而是被改变状态，查询的时候，默认不查询已被删除的数据，可以配置逻辑删除值，默认0未删除，1已删除
pkVal()，方法用于插入返回自增id

UserInfoMapper.java文件

importcom.baomidou.mybatisplus.core.mapper.BaseMapper; importcom.zyxx.sbm.entity.UserInfo; /** *

*用户信息表Mapper接口 *

* *@authorlizhou *@since2020-07-06 */ publicinterfaceUserInfoMapperextendsBaseMapper{ }

继承了BaseMapper抽象类，使得有了CRUD的基本方法

UserInfoMapper.xml文件

namespace，命名空间，指明这个xml文件属于哪一个mapper文件
BaseResultMap，结果集，我们可以定义不同的结果集，来返回我们所需要的数据

UserInfoService.java文件

importcom.baomidou.mybatisplus.extension.service.IService; importcom.zyxx.common.utils.LayTableResult; importcom.zyxx.common.utils.ResponseResult; importcom.zyxx.sbm.entity.UserInfo; /** *

*用户信息表服务类 *

* *@authorlizhou *@since2020-07-06 */ publicinterfaceUserInfoServiceextendsIService{ }

继承了IService接口，使得有了CRUD的方法
相比mapper，还有了批量操作的方法

UserInfoServiceImpl.java文件

importcom.zyxx.sbm.entity.UserInfo; importcom.zyxx.sbm.service.UserInfoService; importorg.springframework.stereotype.Service; importjava.util.List; /** *

*用户信息表服务实现类 *

* *@authorlizhou *@since2020-07-06 */ @Service publicclassUserInfoServiceImplextendsServiceImplimplementsUserInfoService{ }

UserInfoController.java文件

importorg.springframework.stereotype.Controller; importorg.springframework.web.bind.annotation.*; /** *

*用户信息表前端控制器 *

* *@authorlizhou *@since2020-07-06 */ @Controller @RequestMapping("/user-info") publicclassUserInfoController{ }

四、开始使用

1、分页查询

我们在service的实现类中写一个分页查询用户的方法，listUserInfo()

@Override
publicvoidlistUserInfo(Integerpage,Integerlimit,UserInfoUserInfo){
QueryWrapperqueryWrapper=newQueryWrapper<>();
if(StringUtils.isNotBlank(sysUserInfo.getName())){
queryWrapper.like("name",sysUserInfo.getName());
}
queryWrapper.orderByDesc("create_time");
IPageiPage=page(newPage<>(page,limit),queryWrapper);
longtotal=iPage.getTotal();
Listlist=iPage.getRecords();
}

我们传入了查询条件：根据用户名称查询，再根据用户的注册时间倒序排序，最后分页查询

iPage.getTotal()，就得到了总数量，为long型
iPage.getRecords()，就得到了结果集，为List集合

我们还可以使用lambda的方式来写查询条件，例如：

queryWrapper.lambda().eq(SysUserInfo::getName,sysUserInfo.getName());

这样，就能避免写数据库字段的时候写错了

2、分页插件

注意：这时候，我们查询数据，发现分页并没有起作用，我们还需要配置MyBatis-Plus的分页插件

创建MybatisPlusConfig.java文件

packagecom.zyxx.common.mybatis;

importcom.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.transaction.annotation.EnableTransactionManagement;

/**
*mybatis配置
*
*@AuthorLizhou
*/
@EnableTransactionManagement
@Configuration
publicclassMybatisPlusConfig{

/**
*分页插件
*/
@Bean
publicPaginationInterceptorpaginationInterceptor(){
returnnewPaginationInterceptor();
}
}

这时候，我们的分页就正常了，分页默认从1开始，所以不用考虑page=(page-1)*limit才能使用，1-20的数据，就传入1,20，20-40的数据就传入2,20就可以了

其它的增删改查的方法也是使用很方便的，如果涉及到多表联查，我们还是在xml文件中写sql吧

五、总结

无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
损耗小：启动即会自动注入基本CURD，性能基本无损耗，直接面向对象操作
强大的CRUD操作：内置通用Mapper、通用Service，仅仅通过少量配置即可实现单表大部分CRUD操作，更有强大的条件--构造器，满足各类使用需求
支持Lambda形式调用：通过Lambda表达式，方便的编写各类查询条件，无需再担心字段写错
支持主键自动生成：支持多达4种主键策略（内含分布式唯一ID生成器-Sequence），可自由配置，完美解决主键问题
支持ActiveRecord模式：支持ActiveRecord形式调用，实体类只需继承Model类即可进行强大的CRUD操作
支持自定义全局通用操作：支持全局通用方法注入（Writeonce,useanywhere）
内置代码生成器：采用代码或者Maven插件可快速生成Mapper、Model、Service、Controller层代码，支持模板引擎，更--有超多自定义配置等您来使用
内置分页插件：基于MyBatis物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通List查询
分页插件支持多种数据库：支持MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer等多种数据库
内置性能分析插件：可输出Sql语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
内置全局拦截插件：提供全表delete、update操作智能分析阻断，也可自定义拦截规则，预防误操作

到此这篇关于SpringBoot中整合MyBatis-Plus的方法示例的文章就介绍到这了,更多相关SpringBoot中整合MyBatis-Plus内容请搜索毛票票以前的文章或继续浏览下面的相关文章希望大家以后多多支持毛票票！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

SpringBoot中整合MyBatis-Plus的方法示例

热门推荐

随机推荐