MyBaits-Plus目錄
- 一、概述
-
- 1、特性
- 二、MP程式測試
-
- 1、項目搭建
- 2、selectList 方法
-
- 2.1、配置日志
- 3、insert 方法
-
- 3.1、主鍵生成政策
- 4、update
-
- 4.1、自動填充
- 4.2、樂觀鎖
- 5、查詢常用方法
-
- 5.1、selectById(int)
- 5.2、selectBatchIds(集合)
- 5.3、selectByMap(map)
- 5.4、分頁查詢
- 6、delete
-
- 6.1、deleteById(int)
- 6.2、其它方法進行删除
- 6.3、邏輯删除
- 三、Wrapper條件構造器
-
- 1、isNotNull
- 2、eq
- 3、between
- 4、notLike
- 5、inSql
- 6、orderByDesc
- 四、代碼生成器
- 五、其它
一、概述
MyBatis-Plus(簡稱 MP)是一個 MyBatis的增強工具,在 MyBatis 的基礎上隻做增強不做改變,為簡化開發、提高效率而生。
MP官網:https://baomidou.com/
1、特性
- 無侵入:隻做增強不做改變,引入它不會對現有工程産生影響,如絲般順滑
- 損耗小:啟動即會自動注入基本 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 操作智能分析阻斷,也可自定義攔截規則,預防誤操作
二、MP程式測試
1、項目搭建
步驟:
1、搭建資料庫
-- 建立資料庫
CREATE DATABASE `mybatis-plus`
-- 切換資料庫
USE `mybatis-plus`
-- 建立使用者表
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)
);
-- 插入資訊
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
2、建立SpringBoot項目并導入相關依賴
注意: 盡量不要同時導入MyBatis和MyBatis-Plus的依賴、可能會出現版本沖突問題。
<dependencies>
<!-- mybatis-plus -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>
<!-- mysql -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!-- lombok插件 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 測試 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
3、配置資料庫連接配接,properties檔案
注意:如果使用MySql8版本的需要注意與MySql5的驅動不同,同時要增加時區配置,這裡使用MySql8。
# mysql 8 驅動不同,增加時區
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus?serverTimezone=GMT
spring.datasource.username=root
spring.datasource.password=root
# mysql 5
# spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# spring.datasource.url=jdbc:mysql://localhost:3306/mybatis-plus
4、建立包 / 實體類
這裡使用的Lombok插件,隻需添加以下注解即可生成get/set、toString,有參無參方法等。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private Long id;
private String name;
private Integer age;
private String email;
}
5、建立包 / mapper接口
說明:
- 要在對應的mapper接口中繼承BaseMapper類
- 泛型值傳入的對象
- 添加@Repository 或 @Mapper 注解,代表為持久層。
@Repository
public interface UserMapper extends BaseMapper<User> {
}
6、在主啟動類上添加掃描Mapper的注解
@MapperScan(“mapper接口的包位置r”)
@MapperScan("com.plus.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusApplication.class, args);
}
}
2、selectList 方法
@SpringBootTest
class MybatisPlusApplicationTests {
@Autowired
private UserMapper userMapper;
@Test
void contextLoads() {
// 參數Wrapper:條件構造器,暫時不用
// 查詢全部
List<User> users = userMapper.selectList(null);
users.forEach(System.out::println);
}
}
所有基本常用方法都來自繼承的BaseMapper類,也可以在mapper接口中定義指定的方法。
檢視運作結果:
2.1、配置日志
我們想看運作的SQL是什麼樣子的,需要配置日志。
# 配置日志(預設控制台輸出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
再次運作檢視結果:
3、insert 方法
@Test
void testInsert(){
User user = new User();
user.setName("周公瑾");
user.setAge(20);
user.setEmail("[email protected]");
int row = userMapper.insert(user);
System.out.println(row + "\n" + user);
}
檢視SQL結果:
可以看到ID是MP自動生成的。
3.1、主鍵生成政策
實體類id對應資料庫中的主鍵生成政策有(uuid、自增id、雪花算法、redis)
- 自增:分庫分表時要在一張表最後面的值加一。
- UUID:每次生成随機唯一的值,同時随機生成的值太多不友善排序。
- Redis:原子操作實作
- MP自帶政策:通過雪花算法實作,每次值不同。
配置主鍵自增:
- 在實體類要自增的屬性上添加注解:
@TableId(type = IdType.AUTO)
- 需要保證資料庫字段一定是自增!
- 測試插入
@TableId(type = IdType.AUTO)
private Long id;
源碼:
package com.baomidou.mybatisplus.annotation;
import lombok.Getter;
/**
* 生成ID類型枚舉類
*/
@Getter
public enum IdType {
/**
* 資料庫ID自增
* 該類型請確定資料庫設定了 ID自增 否則無效
*/
AUTO(0),
/**
* 該類型為未設定主鍵類型(注解裡等于跟随全局,全局裡約等于 INPUT)
*/
NONE(1),
/**
* 使用者輸入ID
* 該類型可以通過自己注冊自動填充插件進行填充
*/
INPUT(2),
/* 以下3種類型、隻有當插入對象ID 為空,才自動填充。 */
/**
* 配置設定ID (主鍵類型為number或string),
* 預設實作類 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
*/
ASSIGN_ID(3),
/**
* 配置設定UUID (主鍵類型為 string)
* 預設實作類 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
*/
ASSIGN_UUID(4),
ID_WORKER(3),
ID_WORKER_STR(3),
UUID(4);
private final int key;
IdType(int key) {
this.key = key;
}
}
雪花算法介紹
SnowFlake 算法,是 Twitter 開源的分布式 id 生成算法。其核心思想就是:使用一個 64 bit 的 long 型的數字作為全局唯一 id。在分布式系統中的應用十分廣泛,且ID 引入了時間戳,基本上保持自增的 。
4、update
@Test
void testUpdate() {
User user = new User();
user.setId(1346409041650515970L);
user.setName("周瑜");
user.setAge(21);
userMapper.updateById(user);
}
所有sql會通過調節幫我們動态配置。
4.1、自動填充
開發中需要知道一條insert語句的添加時間 和 update語句的修改時間,通常會在資料庫表字段添加: 建立時間 gmt_create 和 修改時間 gmt_modified 、同時這些字段需要自動化。
常用方式:修改代碼實作自動化
1、在資料庫表中添加字段:create_time、update_time
ALTER TABLE `user`
ADD COLUMN `create_time` datetime NOT NULL
ADD COLUMN `update_time` datetime NOT NULL
2、同步實體類屬性
private Date createTime;
private Date updateTime;
3、在屬性上添加相應注解
@TableField(fill = FieldFill.INSERT) // 插入時
private Date createTime;
@TableField(fill = FieldFill.INSERT_UPDATE) // 修改時
private Date updateTime;
4、配置中繼資料處理器
@Slf4j // 添加日志
@Component // 交給SpringIOC管理
public class MyMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
log.info("start insert fill ....");
this.setFieldValByName("createTime", new Date(), metaObject);
this.setFieldValByName("updateTime", new Date(), metaObject);
}
@Override
public void updateFill(MetaObject metaObject) {
log.info("start update fill ....");
this.setFieldValByName("updateTime", new Date(), metaObject);
}
}
- 編寫類并實作MetaObjectHandler類
- 重寫插入insertFill和updateFill更新時的填充政策方法
- 将該類交給Spring管理和添加日志
@Component
@Slf4j
- 列印日志資訊
log.info("start ... ");
-
setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
- 參數:fieldName 自動填充的字段名;fieldVal 要插入的字段值;metaObject 給那個資料處理;
5、測試添加和修改
4.2、樂觀鎖
樂觀鎖:無論幹什麼操作、不上鎖、不會考慮失敗、出了錯誤再次測試。
悲觀鎖:無論幹什麼操作、都上鎖、經常考慮失敗、出了錯誤不會測試。
要求:在更新一條記錄時,希望這條記錄沒有被别人搶先更新。
比如:如果在多線程的情況下A線程要對表中的一條資料做更新、而B線程搶先在A線程之前把資料修改了,而這樣會導緻A線程在更新這條資料時會失敗。
樂觀鎖實作方式:
- 在資料庫表中添加version字段、int類型、預設值為1;
- 同步實體類屬性 并 添加樂觀鎖注解
@Version
@Version
private Integer version;
- 注冊樂觀鎖元件
@EnableTransactionManagement // 開啟事務管理
@Configuration // 配置類
public class MyBatisPlusConfig {
// 注冊樂觀鎖;進行所有操作時進行攔截,然後進行自動化處理 舊版本
// 注冊樂觀鎖插件(新版:3.4.0)
@Bean
public MybatisPlusInterceptor myBatisPlusInterceptor(){
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 樂觀鎖插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
return interceptor;
}
}
4.測試修改成功樂觀鎖
// 測試樂觀鎖成功
@Test
void testLock(){
// 1、查詢根據id擷取使用者資訊
User user = userMapper.selectById(1L);
// 2、修改使用者資訊
user.setName("張三三");
// 3、修改
userMapper.updateById(user);
}
檢視使用樂觀鎖修改成功的結果:
在單線程的情況下、MP會自動将version帶上、會将原version進行對比、修改成功後+1
5.測試修改失敗樂觀鎖
如果沒有樂觀鎖會覆寫插隊線程的值;
@Test
void testLock2(){
// 線程A
User user = userMapper.selectById(1L);
user.setName("張三三1");
// 線程B
User user2 = userMapper.selectById(1L);
user2.setName("張三三2");
userMapper.updateById(user2);
userMapper.updateById(user);
}
5、查詢常用方法
5.1、selectById(int)
隻擷取一條資訊通過:selectById(int)方法
通過ID查詢目前一個使用者資訊
@Test
void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user.toString());
}
5.2、selectBatchIds(集合)
通過集合擷取批量資訊,通過:selectBatchIds(集合)方法
通過多個ID查詢批量使用者資訊
@Test
void testSelectBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
5.3、selectByMap(map)
通過定義map實作自定義條件查詢:selectByMap( map ) 方法
@Test
void testSelectByMap(){
HashMap<String, Object> map = new HashMap<>();
// 自定義查詢條件
map.put("email", "[email protected]");
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
5.4、分頁查詢
步驟:
1、配置分頁插件
// 注冊樂觀鎖插件(新版:3.4.0)
@Bean
public MybatisPlusInterceptor myBatisPlusInterceptor(){
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
// 樂觀鎖插件
interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
// DbType:資料庫類型(根據類型擷取應使用的分頁方言)
// 分頁插件
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
2、測試分頁
@Test
void testPage(){
// page current:目前頁;size 頁面大小
Page<User> page = new Page<>(1,5);
userMapper.selectPage(page, null);
// 列印記錄
page.getRecords().forEach(System.out::println);
}
Page類方法:
// page current:目前頁;size 頁面大小
Page<User> page = new Page<>(current ,size);
page.getTotal(); // 總數量
page.hasPrevious(); // 是否有上一頁
page.hasNext(); // 是否有下一頁
page.getSize(); // 擷取大小
page.getCurrent(); // 目前參數
page.getRecords(); // 擷取所有記錄
6、delete
6.1、deleteById(int)
通過int值進行單個删除
@Test
void testDelete(){
userMapper.deleteById(1346409041650515971L);
}
6.2、其它方法進行删除
// 多個ID進行批量删除
deleteBatchIds(Arrays.asList(id1,id2,id3));
// 條件删除
HashMap<String, Object> map = new HashMap<>();
map.put("name", "value");
userMapper.deleteByMap(map);
6.3、邏輯删除
- 實體删除:直接從資料庫中删除
- 邏輯删除:沒有從資料庫中删除,通過變量讓它失效。
- 邏輯删除的作用:管理者可檢視被删除的記錄,防止資料丢失。
實作方式:
1、在資料庫表中添加字段:deleted、int類型、預設值為0;
2、同步實體類并添加邏輯删除注解
@TableLogic
private Integer deleted;
3、配置邏輯删除元件,在properties檔案中配置。
注意:如果MP版本是3.4.0+版本配置以下即可,如果版本比較低還需要注冊;
# 配置邏輯删除 ,1已被删除的值;0沒有被删除的值
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
4、測試邏輯删除(删除1号使用者)
@Test
void testDelete2(){
userMapper.deleteById(1L);
}
檢視執行結果:
執行邏輯删除,并不是真正的删除,而是将資料庫表中deleted字段的預設值0改為1,那麼在查詢時是否可以查到該使用者呢?
5、測試查詢 1号 使用者
在查詢1号使用者時執行的SQL會動态的将deleted=0該條件加上,結果為0
三、Wrapper條件構造器
Wrapper :上面的方法隻能執行簡單的SQL、而Wrapper類可執行複雜的SQL;
測試:
1、isNotNull
查詢多條資料:selectList( wrapper ) 傳回List
例子:查詢name不為空的使用者 并且 郵箱不為空 年齡大于等于20
@Test
void t1(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.isNotNull("name")
.isNotNull("email")
.ge("age", 20);
userMapper.selectList(wrapper).forEach(System.out::println);
}
2、eq
查詢一條資料:selectOne( wrapper ) 傳回一個對象;
查詢指定字段的值;
@Test
void t2(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "周瑜");
userMapper.selectOne(wrapper);
}
3、between
查詢結果數量:selectCount( wrapper ) 傳回Internet類型資料
區間查詢:年齡在18-25之間的數量
@Test
void t3(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.between("age", 18,25);
userMapper.selectCount(wrapper); // 查詢結果數
}
4、notLike
模糊查詢:查詢name中不包含a的 并且 email 以t右邊開頭
@Test
void t4(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper
.notLike("name", "a")
.likeRight("email", "t");
List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
maps.forEach(System.out::println);
}
5、inSql
@Test
void t5(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
// id 在子查詢中查出來
wrapper.inSql("id", "select id from user where id < 20");
userMapper.selectObjs(wrapper); // 查詢一些對象
}
6、orderByDesc
**排序查詢:**通過ID進行降序
@Test
void t6(){
QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.orderByDesc("id");
List<User> users = userMapper.selectList(wrapper);
users.forEach(System.out::println);
}
四、代碼生成器
注意: MyBatis-Plus 從 3.0.3
之後移除了代碼生成器與模闆引擎的預設依賴,需要手動添加相關依賴:
<!-- 代碼生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!-- 模闆引擎(預設) -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import java.util.ArrayList;
public class MyCodeAutoGenerator {
public static void main(String[] args) {
// 建立代碼生成器對象
AutoGenerator autoGenerator = new AutoGenerator();
// 1、全局配置
GlobalConfig gC = new GlobalConfig();
// 擷取目前項目目錄
String projectPath = System.getProperty("user.dir");
gC.setOutputDir(projectPath+"/src/main/java"); // 代碼要生成到那個目錄
// 設定作者
gC.setAuthor("Lomus");
// 是否打開資料總管
gC.setOpen(false);
// 是否覆寫原來生成的
gC.setFileOverride(false);
// 去掉service的I字首
// gC.setServiceName("%sService");
// ID生成政策
gC.setIdType(IdType.AUTO);
// 設定日期類型
gC.setDateType(DateType.ONLY_DATE);
// 是否配置Swagger文檔
// gC.setSwagger2(true);
// 将全局配置放入自動生成器中
autoGenerator.setGlobalConfig(gC);
// 2、設定資料源 要改
DataSourceConfig dataSource = new DataSourceConfig();
dataSource.setDriverName("com.mysql.cj.jdbc.Driver");
dataSource.setUrl("jdbc:mysql://localhost:3306/資料庫名?serverTimezone=GMT");
dataSource.setUsername("root");
dataSource.setPassword("密碼");
dataSource.setDbType(DbType.MYSQL);
autoGenerator.setDataSource(dataSource);
// 3、設定生成那些包
PackageConfig pC = new PackageConfig();
// 設定子產品名
pC.setModuleName("stu");
// 類放入那個包下
pC.setParent("com.plus");
pC.setEntity("entity");
pC.setMapper("mapper");
pC.setService("service");
pC.setController("controller");
// 設定包
autoGenerator.setPackageInfo(pC);
// 4、政策配置
StrategyConfig strategy = new StrategyConfig();
// 設定要映射的表 ... 可用逗号隔開 要改的地方
strategy.setInclude("student");
// 設定包的命名規則(下劃線轉駝峰)
strategy.setNaming(NamingStrategy.underline_to_camel);
// 設定列的名字
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 是否使用Lombok的注解
strategy.setEntityLombokModel(true);
// 設定邏輯删除
strategy.setLogicDeleteFieldName("deleted");
// 設定自動填充
TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
TableFill gmtModified = new TableFill("gmt_modified",FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(gmtCreate);
tableFills.add(gmtModified);
strategy.setTableFillList(tableFills);
// 設定樂觀鎖
strategy.setVersionFieldName("version");
// 設定駝峰命名
strategy.setRestControllerStyle(true);
// 設定URL請求字段轉換為下劃線命名
strategy.setControllerMappingHyphenStyle(true);
// 政策
autoGenerator.setStrategy(strategy);
// 執行
autoGenerator.execute();
}
}
五、其它
關于低版本的注冊配置,由于性能分頁插件 在 MP3.2.0 後,性能分析插件被移除了,官方推薦使用第三方性能分析插件。
// 注冊樂觀鎖;進行所有操作時進行攔截,然後進行自動化處理 3.3.0-版本
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
// 分頁插件
@Bean
public PaginationInterceptor paginationInterceptor() {
PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
return paginationInterceptor;
}
本文參考于哔哩哔哩UP主:狂神說MyBatis-Plus章節和MyBatis-Plus官方文檔