簡介
什么是MyBatis-Plus还栓?
MyBatis-Plus(以下簡稱MP),為簡化開發(fā)而生维贺。
MP是一個(gè)MyBatis的增強(qiáng)工具域携,在MyBatis的基礎(chǔ)上只做增強(qiáng)不做改變。
MP的特性
- 無侵入:只做增強(qiáng)不做改變晶密,引入它不會(huì)對(duì)現(xiàn)有工程產(chǎn)生影響擒悬,如絲般順滑
- 損耗小:啟動(dòng)即會(huì)自動(dòng)注入基本 CURD,性能基本無損耗稻艰,直接面向?qū)ο蟛僮?/li>
- 強(qiáng)大的 CRUD 操作:內(nèi)置通用 Mapper懂牧、通用 Service,僅僅通過少量配置即可實(shí)現(xiàn)單表大部分 CRUD 操作尊勿,更有強(qiáng)大的條件構(gòu)造器僧凤,滿足各類使用需求
- 支持 Lambda 形式調(diào)用:通過 Lambda 表達(dá)式,方便的編寫各類查詢條件元扔,無需再擔(dān)心字段寫錯(cuò)
- 支持主鍵自動(dòng)生成:支持多達(dá) 4 種主鍵策略(內(nèi)含分布式唯一 ID 生成器 - Sequence)拼弃,可自由配置,完美解決主鍵問題
- 支持 ActiveRecord 模式:支持 ActiveRecord 形式調(diào)用摇展,實(shí)體類只需繼承 Model 類即可進(jìn)行強(qiáng)大的 CRUD 操作
- 支持自定義全局通用操作:支持全局通用方法注入(Write once, use anywhere)
- 內(nèi)置代碼生成器:采用代碼或者 Maven 插件可快速生成 Mapper 、 Model 溺忧、 Service 咏连、 Controller 層代碼,支持模板引擎鲁森,更有超多自定義配置等您來使用
- 內(nèi)置分頁插件:基于 MyBatis 物理分頁祟滴,開發(fā)者無需關(guān)心具體操作,配置好插件之后歌溉,寫分頁等同于普通 List 查詢
- 分頁插件支持多種數(shù)據(jù)庫:支持 MySQL垄懂、MariaDB骑晶、Oracle、DB2草慧、H2桶蛔、HSQL、SQLite漫谷、Postgre仔雷、SQLServer 等多種數(shù)據(jù)庫
- 內(nèi)置性能分析插件:可輸出 Sql 語句以及其執(zhí)行時(shí)間,建議開發(fā)測試時(shí)啟用該功能舔示,能快速揪出慢查詢
- 內(nèi)置全局?jǐn)r截插件:提供全表 delete 碟婆、 update 操作智能分析阻斷,也可自定義攔截規(guī)則惕稻,預(yù)防誤操作
支持?jǐn)?shù)據(jù)庫
- mysql 竖共、 mariadb 、 oracle 俺祠、 db2 公给、 h2 、 hsql 锻煌、 sqlite 妓布、 postgresql 、 sqlserver
- 達(dá)夢(mèng)數(shù)據(jù)庫 宋梧、虛谷數(shù)據(jù)庫 匣沼、人大金倉數(shù)據(jù)庫
快速體驗(yàn)
1、建立數(shù)據(jù)庫mybatis-plus捂龄,導(dǎo)入數(shù)據(jù)释涛。
DROP TABLE IF EXISTS user;
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主鍵ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年齡',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '郵箱',
PRIMARY KEY (id)
);
DELETE FROM user;
INSERT INTO user (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');
2、創(chuàng)建SpringBoot項(xiàng)目倦沧,導(dǎo)入對(duì)應(yīng)的依賴唇撬。
<!--導(dǎo)入mp的依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--
Spring2.x默認(rèn)配置mysql8的驅(qū)動(dòng)
<mysql.version>8.0.19></mysql.version>
8.0以上的驅(qū)動(dòng)需要配置時(shí)區(qū)
-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
3、編寫項(xiàng)目展融。
- 配置數(shù)據(jù)庫連接窖认。
# DataSource Config
spring:
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
username: root
password: 123456
- 編寫實(shí)體類(這里使用了lombok插件)。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
- 編寫mapper接口繼承BaseMapper即可告希。至此所有基本的CRUD都已經(jīng)完成了扑浸。
//使用了MP之后,我們就不用編寫CRUD了燕偶,只需要繼承一個(gè)接口即可
//BaseMapper<T>,泛型T就是表示你要操作的類
@Repository
public interface UserMapper extends BaseMapper<User> {
//這里幾乎內(nèi)置了所有的查詢喝噪,除了十分特殊的查詢之外
//MP,對(duì)于復(fù)雜的SQL依舊要自己編寫
}
4指么、在測試類中測試使用即可酝惧。
@SpringBootTest
class SpringbootMpApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void testMP(){
//參數(shù)Wrapper是一個(gè)復(fù)雜的條件構(gòu)造器
//查詢所有的用戶
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
//70%以上的業(yè)務(wù)都可以在這里自動(dòng)實(shí)現(xiàn)榴鼎,拋開了底層dao層
//這個(gè)時(shí)候你就可以專心的寫Controller了
}
}
BaseMapper
所有的CRUD操作,BaseMapper都已經(jīng)幫我們封裝好了晚唇,我們拿來即用就可以了巫财。
BaseMapper中的所有接口方法如下:
int insert(T var1);
int deleteById(Serializable var1);
int deleteByMap(@Param("cm") Map<String, Object> var1);
int delete(@Param("ew") Wrapper<T> var1);
int deleteBatchIds(@Param("coll") Collection<? extends Serializable> var1);
int updateById(@Param("et") T var1);
int update(@Param("et") T var1, @Param("ew") Wrapper<T> var2);
T selectById(Serializable var1);
List<T> selectBatchIds(@Param("coll") Collection<? extends Serializable> var1);
List<T> selectByMap(@Param("cm") Map<String, Object> var1);
T selectOne(@Param("ew") Wrapper<T> var1);
Integer selectCount(@Param("ew") Wrapper<T> var1);
List<T> selectList(@Param("ew") Wrapper<T> var1);
List<Map<String, Object>> selectMaps(@Param("ew") Wrapper<T> var1);
List<Object> selectObjs(@Param("ew") Wrapper<T> var1);
IPage<T> selectPage(IPage<T> var1, @Param("ew") Wrapper<T> var2);
IPage<Map<String, Object>> selectMapsPage(IPage<T> var1, @Param("ew") Wrapper<T>
T就是我們要操作的數(shù)據(jù)對(duì)象。
另外我們還需要在配置文件中開啟日志功能缺亮。
#配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
插入策略
往數(shù)據(jù)庫中插入一條記錄只需要直接調(diào)用mapper對(duì)象的insert方法進(jìn)行插入即可翁涤。
@Test
void testInsert(){
User user=new User();
user.setName("coding");
user.setAge(18);
user.setEmail("24736743@qq.com");
//插入對(duì)象
int insert=userMapper.insert(user);
//id自動(dòng)回填了,這個(gè)對(duì)象直接使用
//這個(gè)id是什么 1251036873686134785(雪花算法)
System.out.println(user);
}
默認(rèn)情況下萌踱,id會(huì)自動(dòng)回填葵礼,查看控制臺(tái)會(huì)發(fā)現(xiàn)系統(tǒng)自動(dòng)幫我們生成了一串隨機(jī)數(shù)字作為id填入SQL參數(shù)中。
主鍵生成策略
MP中主鍵默認(rèn)生成策略是雪花算法(snowflake)并鸵。
snowflake是Twitter開源的分布式ID生成算法鸳粉,結(jié)果是一個(gè)long型的ID。其核心思想是:使用41bit作為毫秒數(shù)园担,10bit作為機(jī)器的ID(5個(gè)bit是數(shù)據(jù)中心届谈,5個(gè)bit的機(jī)器ID),12bit作為毫秒內(nèi)的流水號(hào)(意味著每個(gè)節(jié)點(diǎn)在每毫秒可以產(chǎn)生4096個(gè)ID)弯汰,最后還有一個(gè)符號(hào)位艰山,永遠(yuǎn)是0。
關(guān)于id生成策略的更多內(nèi)容咏闪,可以參考這篇博客:https://www.cnblogs.com/haoxinyue/p/5208136.html
在MP中曙搬,主要有以下幾種主鍵生成策略,我們可以結(jié)合IdType這個(gè)枚舉類的代碼來分析:
- 自增(需保證數(shù)據(jù)庫中的主鍵字段是自增的)
- 手動(dòng)輸入
- uuid
- 雪花算法
......
public enum IdType {
AUTO(0),// 自增
NONE(1),//不使用策略
INPUT(2),// 手動(dòng)輸入
ID_WORKER(3),//唯一id生成器(默認(rèn))
UUID(4),//uuid
ID_WORKER_STR(5);//唯一id生成器(字符串類型)
}
更新策略
MP在更新對(duì)象時(shí)會(huì)自動(dòng)幫我們匹配動(dòng)態(tài)SQL鸽嫂。測試更新user表中的一條記錄纵装。
@Test
void testUpdate(){
//MP在更新對(duì)象時(shí)自動(dòng)幫我們匹配動(dòng)態(tài)sql
User user=new User();
user.setId(1L);
user.setAge(100);
//更新一個(gè)用戶
//updateById這里面?zhèn)鬟f的是一個(gè)user對(duì)象
userMapper.updateById(user);
}
自動(dòng)填充策略(擴(kuò)展)
在阿里巴巴代碼規(guī)范中,id据某、gmt_create橡娄、gmt_update是每張表中必備的三個(gè)字段。
因此癣籽,我們給user表增加兩個(gè)字段:create_time和update_time挽唉,分別表示創(chuàng)建時(shí)間和修改時(shí)間,然后進(jìn)行測試筷狼。這時(shí)我們發(fā)現(xiàn)這兩個(gè)字段默認(rèn)值被填充為NULL了橱夭。
自動(dòng)更新策略分為兩種級(jí)別:數(shù)據(jù)庫級(jí)別和代碼級(jí)別。
數(shù)據(jù)庫級(jí)別(不建議使用)
1桑逝、設(shè)置create_time和update_time字段的默認(rèn)值為CURRENT_TIMESTAMP
即可。
2俏让、進(jìn)行記錄更新測試楞遏,可以看到這條記錄更新后create_time和update_time的值被設(shè)置為記錄更新的時(shí)間茬暇。
datetime字段設(shè)置默認(rèn)值會(huì)極大的降低數(shù)據(jù)庫的執(zhí)行效率,因此不建議使用這種自動(dòng)更新策略寡喝。
代碼級(jí)別(建議使用)
1糙俗、刪除create_time和update_time字段的默認(rèn)值。
2预鬓、編寫代碼巧骚。
- 編寫實(shí)體類對(duì)應(yīng)的注解。
//時(shí)間的操作(自動(dòng)更新)
@TableField(fill = FieldFill.INSERT) //插入時(shí)更新
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) //插入或更新時(shí)更新
private Date updateTime;
- 編寫元對(duì)象處理器格二。
//自定義元對(duì)象處理器
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {
//插入的策略
@Override
public void insertFill(MetaObject metaObject) {
//設(shè)置當(dāng)前字段的值
//以后只要是插入操作就會(huì)自動(dòng)控制createTime劈彪、updateTime使用new Date()進(jìn)行自動(dòng)填充
this.setFieldValByName("createTime",new Date(),metaObject);
this.setFieldValByName("updateTime",new Date(),metaObject);
}
//更新策略
@Override
public void updateFill(MetaObject metaObject) {
this.setFieldValByName("updateTime",new Date(),metaObject);
}
}
樂觀鎖
什么是樂觀鎖?什么又是悲觀鎖顶猜?
樂觀鎖:非常樂觀沧奴,無論什么操作都不加鎖。樂觀鎖的通常實(shí)現(xiàn)方式是在表中增加一個(gè)樂觀鎖字段(version)即可长窄。當(dāng)要更新一條記錄時(shí)滔吠,希望這條記錄沒有被別人更新,一旦記錄搶先被別人更新挠日,那么當(dāng)前更新就會(huì)失敗疮绷。
悲觀鎖:非常悲觀,無論什么操作都加鎖嚣潜。我們一旦加鎖冬骚,那它就一定是悲觀鎖。
樂觀鎖的實(shí)現(xiàn)方式
樂觀鎖的實(shí)現(xiàn)方式如下:
- 取出記錄時(shí)郑原,獲取當(dāng)前version唉韭。
- 更新時(shí),在條件中會(huì)帶上這個(gè)version犯犁。
- 執(zhí)行更新時(shí)属愤,set version=newVersion where version=oldVersion,其中oldVersion就是我們一開始獲取的version酸役。
- 如果version不對(duì)住诸,就會(huì)更新失敗。
//樂觀鎖失敗
@Test
void testOptimisticLocker2(){
//線程一查詢?cè)瓉淼臄?shù)據(jù)
User user = userMapper.selectById(1L);
//線程一修改當(dāng)前數(shù)據(jù)
user.setName("Jack2");
//線程二搶先更新了
User user2 = userMapper.selectById(1L);
user2.setName("Jack3 ");
userMapper.updateById(user2);
//線程一執(zhí)行修改
userMapper.updateById(user);
}
MP中如何配置樂觀鎖
1涣澡、在數(shù)據(jù)庫表中添加version字段贱呐,將@Version
注解添加到字段上。
@Version
private Integer version;
2入桂、添加樂觀鎖插件奄薇。
@Configuration
public class MPConfig {
//樂觀鎖插件 本質(zhì)是一個(gè)攔截器
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
}
3、測試后發(fā)現(xiàn)更新SQL中自動(dòng)帶上了版本號(hào)抗愁。
查詢策略
MP為我們提供了單條記錄馁蒂、多條記錄呵晚、指定數(shù)量、分頁等多種查詢方法沫屡,測試方法如下:
//查詢(使用的最多 饵隙,單個(gè),多個(gè)沮脖,指定數(shù)量金矛,分頁查詢)
@Test
void testSelectById(){
User user=userMapper.selectById(1L);
System.out.println(user);
}
@Test
void testSelectByIds(){
//批量查詢
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
@Test
void testSelectByCount(){
//查詢數(shù)據(jù)量
Integer count= userMapper.selectCount(null);
System.out.println(count);
}
@Test
void testSelectByMap(){
//簡單條件查詢
Map<String,Object> map=new HashMap<>();
map.put("name","wunian");
map.put("age",3);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分頁查詢
MP的分頁插件支持 MySQL、MariaDB勺届、Oracle驶俊、DB2、H2涮因、HSQL废睦、SQLite、Postgre养泡、SQLServer 等多種數(shù)據(jù)庫嗜湃。
測試代碼如下:
//分頁查詢 limit(sql) MP內(nèi)置了分頁插件,導(dǎo)入即可
@Test
void testPage(){
//1澜掩、先查詢總數(shù)
//2购披、本質(zhì)還是limit 0,10(默認(rèn)的)
//參數(shù)(當(dāng)前頁,每個(gè)頁面的大屑玳拧)
Page<User> page=new Page<>(2,5);
IPage<User> users = userMapper.selectPage(page, null);
System.out.println(page.getTotal());//總數(shù)
System.out.println(page.hasNext());//是否有下一頁
System.out.println(page.hasPrevious());//是否有上一頁
page.getRecords().forEach(System.out::println);//遍歷數(shù)據(jù)
System.out.println(page.getSize());//獲取當(dāng)前頁的記錄數(shù)
}
刪除策略
MP提供了刪除單條記錄和多條記錄的方法刚陡。測試代碼如下:
//刪除(單個(gè),多個(gè))
@Test
void testDeleteById(){
userMapper.deleteById(1251036873686134785L);
}
@Test
void testDeleteByIds(){
userMapper.deleteBatchIds(Arrays.asList(1251036873686134785L,1251045724569370626L));
}
//簡單的條件刪除
@Test
void testDeletMap(){
Map<String,Object> map=new HashMap<>();
map.put("name","wunian");
map.put("age",3);
userMapper.deleteByMap(map);
}
邏輯刪除
先來了解下邏輯刪除和物理刪除的概念:
- 邏輯刪除:并不是真的從數(shù)據(jù)庫中刪除了株汉,只是加了一個(gè)條件判斷而已筐乳。
- 物理刪除:直接從數(shù)據(jù)庫中刪除了。
業(yè)務(wù)場景:管理員在后臺(tái)可以看到被刪除的記錄乔妈,使用邏輯刪除可以保證項(xiàng)目的安全性和健壯性蝙云。
使用方法:
1、在數(shù)據(jù)庫中添加邏輯刪除字段deleted
2路召、在實(shí)體類字段中添加邏輯刪除注解@TableLogic
@TableLogic //邏輯刪除字段
private Integer deleted;
3勃刨、在配置類中添加處理邏輯刪除的插件。
//邏輯刪除插件
@Bean
public ISqlInjector sqlInjector() {
return new LogicSqlInjector();
}
4股淡、在配置文件中配置邏輯刪除身隐。
#配置邏輯刪除 刪除:1 不刪除:0
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
5、只要配置了邏輯刪除唯灵,以后的查詢都會(huì)帶上邏輯刪除字段贾铝,這樣能夠保證程序效率和結(jié)果正常吼拥。
6刘离、查詢被刪除的數(shù)據(jù)摩骨,請(qǐng)單獨(dú)手寫SQL疆虚。
SELECT * FROM user WHERE deleted=1
性能分析
MP提供了性能分析插件,它能在開發(fā)中幫助我們排除慢SQL水孩。
如果要使用性能分析插件,只需要在配置類中配置即可琐驴。
//SQL執(zhí)行效率插件
@Bean
@Profile({"dev","test"})// 設(shè)置 dev test 環(huán)境開啟
public PerformanceInterceptor performanceInterceptor() {
PerformanceInterceptor interceptor=new PerformanceInterceptor();
//允許執(zhí)行的sql的最長時(shí)間俘种,默認(rèn)的單位是毫秒
//超過這個(gè)時(shí)間sql會(huì)報(bào)錯(cuò)
interceptor.setMaxTime(100);
//格式化sql代碼
interceptor.setFormat(true);
return interceptor;
}
正常開發(fā)時(shí)可以在控制臺(tái)查看到SQL的執(zhí)行效率。
如果SQL的執(zhí)行時(shí)間绝淡,超過了我們?cè)O(shè)置的最長時(shí)間范圍宙刘,控制臺(tái)就會(huì)報(bào)錯(cuò)。
一般解決慢SQL的方法無非就是優(yōu)化SQL語句牢酵,建立索引悬包,分庫分表這些。
條件構(gòu)造器
我們平時(shí)編寫SQL馍乙,一般使用的最多的就是一些查詢條件布近,MP為我們提供了條件構(gòu)造器來動(dòng)態(tài)構(gòu)造SQL語句。測試代碼如下:
@SpringBootTest
public class WrapperTest {
@Autowired
private UserMapper userMapper;
//條件查詢器
@Test
void testWrapper(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
//鏈?zhǔn)骄幊趟扛瘢梢詷?gòu)造多個(gè)條件撑瞧,會(huì)自動(dòng)拼接SQL
wrapper
.isNotNull("name")
.ge("age",28); //大于等于
//.eq("age",100)
userMapper.delete(wrapper);
}
//邊界查詢
@Test
void testWrapper2(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age",20,28);
userMapper.selectCount(wrapper);
}
//精準(zhǔn)匹配
@Test
void testWrapper3(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
Map<String,Object> map=new HashMap<>();
map.put("name","Jack");
map.put("age",20);
wrapper.allEq(map);
userMapper.selectList(wrapper);
}
//模糊查詢
@Test
void testWrapper4(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.notLike("name","j") //like '%j%'
.likeRight("email","t"); // like 't%'
userMapper.selectMaps(wrapper);
}
//子查詢(in)
@Test
void testWrapper5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
//wrapper.in("id",1,2,3,4);
//子查詢
wrapper.inSql("id","select id from user where id<3");
userMapper.selectObjs(wrapper);
}
// and or
@Test
void testWrapper6(){
User user=new User();
user.setAge(100);
user.setName("Jack");
UpdateWrapper<User> updateWrapper = new UpdateWrapper<>();
//在一些新的框架中,鏈?zhǔn)骄幊滔则颍琹ambda表達(dá)式预伺,函數(shù)式接口用的非常多
updateWrapper
.like("name","k")
.or(i->i.eq("name","wunian").ne("age",0));
userMapper.update(user,updateWrapper);
}
//排序
@Test
void testWrapper7(){
QueryWrapper<User> wrapper=new QueryWrapper();
wrapper.orderByAsc("id");
userMapper.selectList(wrapper);
}
//多表查詢解決方案 last(不建議使用)
//一般大公司會(huì)設(shè)計(jì)冗余字段,很少用到多表查詢
//如果要多表查詢曼尊,沒有簡便辦法酬诀,自己擴(kuò)展即可
@Test
void testWrapper8(){
QueryWrapper<User> wrapper=new QueryWrapper();
wrapper.last("limit 1");
userMapper.selectList(wrapper);
}
}
注意:last方法只能調(diào)用一次,多次調(diào)用以最后一次為準(zhǔn)骆撇,并且有SQL注入的風(fēng)險(xiǎn)瞒御,請(qǐng)謹(jǐn)慎使用。