一、概述
1.1、什么是MyBatis-Plus
MyBatis-Plus (opens new window)（簡稱 MP）是一個(gè) MyBatis (opens new window)的增強(qiáng)工具，在 MyBatis 的基礎(chǔ)上
只做增強(qiáng)不做改變，為簡化開發(fā)、提高效率而生。
1.2、特性
- 無侵入：只做增強(qiáng)不做改變，引入它不會(huì)對現(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ù)防誤操作
1.3、支持?jǐn)?shù)據(jù)庫
任何能使用
MyBatis進(jìn)行 CRUD, 并且支持標(biāo)準(zhǔn) SQL 的數(shù)據(jù)庫，具體支持情況如下，如果不在下列表查看分頁部分教程 PR 您的支持。
- MySQL，Oracle，DB2，H2，HSQL，SQLite，PostgreSQL，SQLServer，Phoenix，Gauss ，ClickHouse，Sybase，OceanBase，F(xiàn)irebird，Cubrid，Goldilocks，csiidb
- 達(dá)夢數(shù)據(jù)庫，虛谷數(shù)據(jù)庫，人大金倉數(shù)據(jù)庫，南大通用(華庫)數(shù)據(jù)庫，南大通用數(shù)據(jù)庫，神通數(shù)據(jù)庫，瀚高數(shù)據(jù)庫
1.4、框架結(jié)構(gòu)
二、快速集成
2.1、SpringBoot項(xiàng)目快速集成
如果你的項(xiàng)目已經(jīng)配置了MyBatis，那么，你只需
1、引入mybatis-plus依賴，
替換掉mybatis的依賴2、將application配置中的mybatis改為mybatis-plus即可
-
引入依賴
<dependencies> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>最新版本</version> </dependency> </dependencies> -
application修改配置
mybatis-plus: mapper-locations: xxx executor-type: simple configuration: log-impl: org.apache.ibatis.logging.slf4j.Slf4jImpl
2.2、MyBatis-Plus類的特殊定義
MyBatis-Plus分別對Service層、Mapper層提供了功能拓展
想要使用MyBatis-Plus內(nèi)置的方法，需要實(shí)現(xiàn)MyBatis-Plus的特殊接口
-
Service層
// service接口需要繼承IService<User>接口 public interface UserService extends IService<User> { } // service實(shí)現(xiàn)類需要繼承ServiceImpl<UserMapper, User>接口 public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService { } -
Mapper層
// 需要繼承BaseMapper<User>接口 public interface UserMapper extends BaseMapper<User> { }
三、CRUD Boy
3.1、CRUD
對于CRUD，MyBatis-Plus提供了兩類接口：Service層、Mapper層。功能一樣，不同層有不同的方法。
【Service層】
private finally MyService myService; // 保存用戶（Service CRUD） myService.save(User);【Mapper層】
private finally MyMapper myMapper; // 保存用戶（Mapper CRUD） myMapper.insert(User);
-
使用示例
// 單個(gè)查詢 User user = userMapper.selectById(id); // 批量查詢 List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3)); // 條件查詢 HashMap<String, Object> map = new HashMap(); map.put("name", "十年"); map.put("age", 12); userMapper.selectByMap(map); -
更多操作
3.2、條件構(gòu)造器
Mybatis提供了QueryWrapper，可以讓我們自定義較為復(fù)雜的sql查詢條件
??
不支持以及不贊成在 RPC 調(diào)用中把 Wrapper 進(jìn)行傳輸
- wrapper 很重
- 傳輸 wrapper 可以類比為你的 controller 用 map 接收值(開發(fā)一時(shí)爽,維護(hù)火葬場)
- 正確的 RPC 調(diào)用姿勢是寫一個(gè) DTO 進(jìn)行傳輸,被調(diào)用方再根據(jù) DTO 執(zhí)行相應(yīng)的操作
- 我們拒絕接受任何關(guān)于 RPC 傳輸 Wrapper 報(bào)錯(cuò)相關(guān)的 issue 甚至 pr
-
使用示例
QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.isNotNull("name") .ge("age", 12) // 年齡小于12的 .notLike("name", "e") // and name not like '%e%' .likeRight("name", "est") // and name like 'est% .likeLeft("name", "est") // and name like '%est' .inSql("id", "select id from user where id < 3") // and id in (select id from user where id < 3) .orderByAsc("id");// 根據(jù)id正序 List<User> users = userMapper.selectList(wrapper); -
更多參考
3.3、主鍵策略
Mybatis-Plus提供了多種主鍵策略
public enum IdType {
AUTO(0), // 數(shù)據(jù)庫id自增
NONE(1), // 未設(shè)置主鍵
INPUT(2), // 手動(dòng)輸入
ASSIGN_ID(3), // 默認(rèn)的全局唯一id（雪花算法）
ASSIGN_UUID(4); // uuid
private final int key;
private IdType(int key) {
this.key = key;
}
public int getKey() {
return this.key;
}
}
3.3.1、基本使用
比如Mysql數(shù)據(jù)庫，在定義表的時(shí)候，字段可以直接設(shè)置自增，那么可以直接使用IdType.AUTO做自增
1、數(shù)據(jù)庫字段設(shè)置自增
2、實(shí)體類添加注解：@TableId(type = IdType.AUTO)
@TableId(type = IdType.AUTO) // 這個(gè)需要配合數(shù)據(jù)庫設(shè)置自增來使用
private Integer id;
3.3.2、INPUT的使用
對于Postgresql數(shù)據(jù)庫，并不支持直接設(shè)置字段自增，需要額外設(shè)置sequence來完成，那需要使用
type = IdType.INPUT來設(shè)置
-
1、配置類中編寫主鍵策略
內(nèi)置支持：
- DB2KeyGenerator
- H2KeyGenerator
- KingbaseKeyGenerator
- OracleKeyGenerator
- PostgreKeyGenerator
@Configuration public class MyBatisPlusConfig { /** * postgresql數(shù)據(jù)庫主鍵生成策略 */ @Bean public IKeyGenerator keyGenerator() { return new PostgreKeyGenerator(); } } -
2、實(shí)體類配置seq
// 類上使用@KeySequence指定sequence、數(shù)據(jù)庫類型 @KeySequence(value = "seq_user", dbType = DbType.POSTGRE_SQL) public class User extends Model<User> { // 字段上使用@TableId，指定數(shù)據(jù)庫字段名、主鍵策略類型 @TableId(value = "user_id", type = IdType.INPUT) private Integer userId; }
四、拓展
4.1、插件
編寫配置文件，在配置文件里集成插件
@MapperScan("") // 可以把啟動(dòng)類上的dao的文件目錄放到這里
@EnableTransactionManagement
@Configuration
public class MyBatisPlusConfig {
/**
* 插件配置
*/
}
4.1.1、分頁插件
-
注冊插件
@MapperScan("") // 可以把啟動(dòng)類上的dao的文件目錄放到這里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /** * MybatisPlus分頁插件配置 */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor(){ MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); PaginationInnerInterceptor paginationInnerInterceptor = new PaginationInnerInterceptor(DbType.POSTGRE_SQL); mybatisPlusInterceptor.addInnerInterceptor(paginationInnerInterceptor); return mybatisPlusInterceptor; } } -
使用插件
【內(nèi)置的mapper方法】
Mybatis-plus的內(nèi)置方法，進(jìn)行分頁，可以直接使用（方法第一個(gè)參數(shù)傳入page對象）
Page<User> page = new Page<>(1, 5); userMapper.selectPage(page, null); return page;【自定義的mapper方法】
對于自定義的mapper方法想要分頁，需要在mapper層的方法中額外增加page對象參數(shù)
IPage<UserVo> selectPageVo(IPage<?> page, Integer state); // or (class MyPage extends Ipage<UserVo>{ private Integer state; }) MyPage selectPageVo(MyPage page); // or List<UserVo> selectPageVo(IPage<UserVo> page, Integer state);<select id="selectPageVo" resultType="xxx.xxx.xxx.UserVo"> SELECT id,name FROM user WHERE state=#{state} </select>
4.1.2、樂觀鎖插件
【場景】
當(dāng)要更新一條記錄的時(shí)候，在更新的過程中，希望這條記錄沒有被別人更新
【原理】
樂觀鎖實(shí)現(xiàn)方式：
- 取出記錄時(shí)，獲取當(dāng)前 version
- 更新時(shí)，帶上這個(gè) version
- 執(zhí)行更新時(shí)， set version = newVersion where version = oldVersion
- 如果 version 不對，就更新失敗
-
注冊插件
@MapperScan("") // 可以把啟動(dòng)類上的dao的文件目錄放到這里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /** * 樂觀鎖插件 */ @Bean public MybatisPlusInterceptor mybatisPlusInterceptor() { MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor(); mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); return mybatisPlusInterceptor; } } -
使用插件
1、數(shù)據(jù)庫定義字段
2、在字段上加@Version注解
@Version private Integer version;
4.1.3、性能分析插件
對sql的格式化輸出、sql執(zhí)行時(shí)間、當(dāng)超過設(shè)置的時(shí)間則報(bào)錯(cuò)
【建議】：配置僅在dev和test就環(huán)境下生效
-
注冊插件
@MapperScan("") // 可以把啟動(dòng)類上的dao的文件目錄放到這里 @EnableTransactionManagement @Configuration public class MyBatisPlusConfig { /** * 性能分析插件 */ @Bean @Profile({"dev", "test"}) // 配置僅在dev和test就環(huán)境下生效 public PerformanceInterceptor performanceInterceptor() { PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); // 設(shè)置sql最大執(zhí)行時(shí)間（毫秒），超過則不執(zhí)行 performanceInterceptor.setMaxTime(500); // 設(shè)置對輸出的sql格式化 performanceInterceptor.setFormat(true); return performanceInterceptor; } } -
使用插件
直接在控制臺看即可
4.2、代碼生成器
mybatis-plus支持通過代碼，一鍵生成：目錄、對象文件、代碼
-
使用示例
public class MyFastAutoGenerator { /** * 絕對項(xiàng)目根路徑 */ private static final String OUT_DIR = ""; /** * 項(xiàng)目包路徑 */ private static final String PROJECT_DIR = ""; /** * 模塊名 */ private static final String MODULE_NAME = ""; /** * 數(shù)據(jù)庫配置 */ private static final String URL = ""; private static final String USERNAME = ""; private static final String PASSWORD = ""; /** * 需要生成的表名稱(可以填多個(gè)) */ private static final String[] GENERATE_TABLES = {"user"}; public static void main(String[] args) { FastAutoGenerator.create(URL, USERNAME, PASSWORD) // 全局配置 .globalConfig(builder -> { builder.outputDir(OUT_DIR) // 配置生成文件中的author .author("") // 注釋日期的格式 .commentDate("yyyy-MM-dd HH:mm:ss") .build(); }) // 包配置 .packageConfig(builder -> { builder.parent(PROJECT_DIR) .moduleName(MODULE_NAME) .controller("controller") .service("service") .serviceImpl("service.impl") .mapper("dao") .xml("dao.xml") .entity("model"); }) // Entity策略配置 .strategyConfig(builder -> { builder.addInclude(GENERATE_TABLES) // 跳過視圖的生成 .enableSkipView() // 去除前綴 .addTablePrefix("t_") .entityBuilder() // 駝峰 .naming(NamingStrategy.underline_to_camel) .build(); }) // Service策略配置 .strategyConfig(builder -> { builder.serviceBuilder() .formatServiceFileName("%sService") .build(); }) // Mapper策略配置 .strategyConfig(builder -> { builder.mapperBuilder() .formatMapperFileName("%sDao") .build(); }) // 可以使用Freemarker引擎模板，默認(rèn)的是Velocity引擎模板 .templateEngine(new VelocityTemplateEngine()) .execute(); } } -
效果展示
