Mybatis-plus的使用
MyBatis-Plus(简称 MP)是一个 MyBatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
特性:
- 无侵入:只做增强不做改变,引入它不会对现有工程产生影响,如丝般顺滑
- 损耗小:启动即会自动注入基本 CURD,性能基本无损耗,直接面向对象操作
- 强大的 CRUD 操作:内置通用 Mapper、通用 Service,仅仅通过少量配置即可实现单表大部分 CRUD 操作,更有强大的条件构造器,满足各类使用需求
- 支持 Lambda 形式调用:通过 Lambda 表达式,方便的编写各类查询条件,无需再担心字段写错
- 支持主键自动生成:支持多达 4 种主键策略(内含分布式唯一 ID 生成器 - Sequence),可自由配置,完美解决主键问题
- 支持 ActiveRecord 模式:支持 ActiveRecord 形式调用,实体类只需继承 Model 类即可进行强大的 CRUD 操作
- 支持自定义全局通用操作:支持全局通用方法注入( Write once, use anywhere )
- 内置代码生成器:采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码,支持模板引擎,更有超多自定义配置等您来使用
- 内置分页插件:基于 MyBatis 物理分页,开发者无需关心具体操作,配置好插件之后,写分页等同于普通 List 查询
- 分页插件支持多种数据库:支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库
- 内置性能分析插件:可输出 Sql 语句以及其执行时间,建议开发测试时启用该功能,能快速揪出慢查询
- 内置全局拦截插件:提供全表 delete 、 update 操作智能分析阻断,也可自定义拦截规则,预防误操作
1、mybatis-plus环境搭建
Emp.java
1 | package com.mashibing.bean; |
数据库表sql语句
1 | CREATE TABLE `tbl_emp` ( |
pom.xml
1 |
|
mybatis-config.xml
1 |
|
log4j.properties
1 | # 全局日志配置 |
db.properties
1 | driverClassname=com.mysql.cj.jdbc.Driver |
spring.xml
1 |
|
MyTest.java
1 | package com.mashibing; |
在集成mybatis-plus的时候非常简单,只需要替换mybatis自己的sqlSessionFactoryBean对象即可
1 | <bean id="sqlSessionFactoryBean" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> |
2、简单的CRUD操作
如果我们下面要实现CRUD的基本操作,那么我们该如何实现呢?
在Mybatis中,我们需要编写对应的Dao接口,并在接口中定义相关的方法,然后提供与该接口相同名称的Dao.xml文件,在文件中填写对应的sql语句,才能完成对应的操作
在Mybatis-plus中,我们只需要定义接口,然后继承BaseMapper
EmpDao.java
1 | package com.mashibing.dao; |
1、插入操作
MyTest.java
1 | package com.mashibing; |
当运行上述代码的时候,大家发现报错了,原因在于你写的实体类的名称跟表的名称不匹配,因此在实现的是需要添加@TableName注解,指定具体的表的名称
1 | "emp") ( |
上述代码运行通过之后,大家会发现结果能够正常的进行插入,但是在控制台会打印一个警告信息,说没有@TableId的注解,原因就在于定义实体类的时候并没有声明其中的主键是哪个列,以及使用什么样的主键生成策略,因此,可以在类的属性上添加如下注解,来消除此警告
1 | public class Emp { |
但是大家会发现,我们在写属性的时候,实体类属性名称跟表的属性名称并没有一一对应上,那么为什么会完成对应的操作呢?
其实原因就在于mybatis-plus的全局配置
在进行数据插入的是,如果我们输入的时候用的是全字段,那么sql语句中就会执行如下sql语句:
INSERT INTO tbl_emp ( e_name, job, mgr, hiredate, sal, comm, deptno ) VALUES ( ?, ?, ?, ?, ?, ?, ? )
但是如果我们在插入的时候,将对象中的某些属性值设置为空,那么会是什么效果呢?
1 |
|
INSERT INTO tbl_emp ( e_name, job, mgr ) VALUES ( ?, ?, ? )
大家其实可以看到我们在插入的时候,mybatis-plus会根据我会输入的对象的字段的个数来动态的调整我们的sql语句插入的字段,这是大家需要注意的mybatis-plus比较灵活的地方。
2、更新操作
1 |
|
3、删除操作
1 |
|
4、查询操作
1 |
|
3、Mybatis-plus的相关配置
在mybatis中我们可以在mybatis-config配置文件中可以添加
https://mp.baomidou.com/config/
在此链接中包含了非常多的配置项,用户可以按照自己的需求添加需要的配置,配置方式如下:
spring.xml
1 | <bean id="sqlSessionFactory" class="com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean"> |
通过这个配置文件的配置,大家可以进行回想上述问题的出现,mybatis-plus是如何解决这个问题的呢?
在mybatis-plus中会引入写默认的配置,这个选项的默认配置为true,因此可以完成对应的实现。
我们可以通过如下配置来禁用驼峰标识的操作,如下所示:
1 |
|
1、当添加上述配置之后,大家发现运行过程中报错,
Property ‘configuration’ and ‘configLocation’ can not specified with together
表示这两个标签无法同时使用,因此我们可以选择将configLocation给禁用掉,就是不使用mybatis的配置,此时就能够正常使用了,但是放置属性的时候又报错了,原因就在于我们把驼峰标识给禁用了,重新开启即可。除此之外,我们还可以在属性的上面添加@TableField属性
1 | "e_name") (value = |
2、此时发现日志功能又无法使用了,只需要添加如下配置即可
1 | <bean id="configuration" class="com.baomidou.mybatisplus.core.MybatisConfiguration"> |
3、我们在刚刚插入数据的时候发现每个类可能都需要写主键生成策略,这是比较麻烦的,因此可以选择将主键配置策略设置到全局配置中。
1 | <bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig"> |
4、如果你的表的名字都具备相同的前缀,那么可以设置默认的前缀配置策略,此时的话可以将实体类上的@TableName标签省略不写
1 | <bean id="dbConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig.DbConfig"> |
5、在mybatis-plus中如果需要获取插入的数据的主键的值,那么直接获取即可,原因就在于配置文件中指定了默认的属性为true
4、条件构造器Wrapper(看官网即可)
5、代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
其实在学习mybatis的时候我们就使用过逆向工程,根据我们的数据表来生成的对应的实体类,DAO接口和Mapper映射文件,而MyBatis-plus提供了更加完善的功能,下面来针对两种方式做一个基本的对比
1、MyBatis-plus是根据java代码开生成代码的,而Mybatis是根据XML文件的配置来生成的
2、MyBatis-plus能够生成实体类、Mapper接口、Mapper映射文件,Service层,Controller层,而Mybatis只能生成实体类,Mapper接口,Mapper映射文件
1、操作步骤:
1、添加依赖
添加代码生成器依赖
1 | <dependency> |
添加 模板引擎 依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。
1 | <dependency> |
2、编写生成类
1 | import com.baomidou.mybatisplus.annotation.IdType; |
注意,当通过上述代码实现之后,大家发现可以在Controller层可以直接实现调用,这些调用的实现最核心的功能就在于ServiceImpl类,这个类中自动完成mapper的注入,同时提供了一系列CRUD的方法。
6、插件扩展
MyBatis 允许你在映射语句执行过程中的某一点进行拦截调用。默认情况下,MyBatis 允许使用插件来拦截的方法调用包括:
- Executor (update, query, flushStatements, commit, rollback, getTransaction, close, isClosed)
- ParameterHandler (getParameterObject, setParameters)
- ResultSetHandler (handleResultSets, handleOutputParameters)
- StatementHandler (prepare, parameterize, batch, update, query)
1、分页插件
在spring.xml文件中添加如下配置引入插件
1 | <property name="plugins"> |
编写测试类
1 |
|
2、乐观锁插件
当要更新一条记录的时候,希望这条记录没有被别人更新
乐观锁实现方式:
取出记录时,获取当前version
更新时,带上这个version
执行更新时, set version = newVersion where version = oldVersion
如果version不对,就更新失败
添加配置:
1 | <bean class="com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor"></bean> |
修改实体类添加version字段并在表中添加version字段
编写测试类
1 |
|
3、SQL执行分析插件,避免出现全表更新和删除
1 | <bean class="com.baomidou.mybatisplus.extension.plugins.SqlExplainInterceptor"> |
1 | @Test |
4、非法sql检查插件
1 | <bean class="com.baomidou.mybatisplus.extension.plugins.IllegalSQLInterceptor"> |
1 |
|
7、SQL注入器
全局配置 sqlInjector
用于注入 ISqlInjector
接口的子类,实现自定义方法注入。也就是说我们可以将配置在xml中的文件使用注入的方式注入到全局中,就不需要再编写sql语句
自定义注入器
1 | package com.mashibing.injector; |
添加配置:
1 | <bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig"> |
1 | package com.mashibing.injector; |
1 | package com.mashibing.injector; |
1 | package com.mashibing.dao; |
8、公共字段填充
实现元对象处理器接口:com.baomidou.mybatisplus.core.handlers.MetaObjectHandler
注解填充字段
@TableField(.. fill = FieldFill.INSERT)
生成器策略部分也可以配置!metaobject:元对象,是mybatis提供的一个用于更加方便,更加优雅的访问对象的属性,给对象的属性设置值的一个对象,还会用于包装对象,支持Object,Map,Collection等对象进行包装。本质上metaobject是给对象的属性设置值,最终还是要通过Reflect获取到属性的对应方法的invoker,最终执行。
编写自定义的公共字段填充
1 | package com.mashibing.fill; |
添加到对应的配置中:
1 | <bean id="globalConfig" class="com.baomidou.mybatisplus.core.config.GlobalConfig"> |
测试:
1 |
|