MyBatisPlus詳解
- 2022 年 5 月 20 日
- 筆記
- mybatisPlus
1、MyBatisPlus概述
需要的基礎:MyBatis、Spring、SpringMVC
為什麼要學習?MyBatisPlus可以節省我們大量工作時間,所有的CRUD代碼它都可以自動化完成!
簡介
是什麼?MyBatis本來就是簡化JDBC操作的!
官網://baomidou.com/ MyBatis Plus,簡化MyBatis
技術沒有高低之分,只有使用技術的人有高低之別!
特性
- 無侵入:只做增強不做改變,引入它不會對現有工程產生影響,如絲般順滑
- 損耗小:啟動即會自動注入基本 CURD,性能基本無損耗,直接面向對象操作,BaseMapper<>
- 強大的 CRUD 操作:內置通用 Mapper、通用 Service,僅僅通過少量配置即可實現單表大部分 CRUD 操作,更有強大的條件構造器,滿足各類使用需求,以後簡單的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 操作智能分析阻斷,也可自定義攔截規則,預防誤操作
所有學不會都是給懶找的借口!伸手黨,白嫖黨!
2、快速入門
地址://baomidou.com/pages/226c21/
使用第三方組件:
- 導入對應的依賴
- 研究依賴如何配置
- 代碼如何編寫
- 提高擴展技術能力!
步驟
-
創建數據庫
mybatis_plus
-
創建user表
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) ); -- 真實開發中,version(樂觀鎖)、deleted(邏輯刪除)、gmt_create、gmt_modified DELETE FROM USER; 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]');
-
編寫項目,初始化項目!使用SpringBoot初始化!
-
導入依賴
<!--數據庫驅動--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> <!--lombok--> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> </dependency> <!--mybatis-plus--> <!--mybatis-plus 是自己開發的,並非官方的!--> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.0.5</version> </dependency>
說明:我們使用mybatis-plus可以節省我們大量的代碼,盡量不要同時導入mybatis和mybatis-plus,版本差異!
-
連接數據庫!這一步和mybatis相同!
spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT
-
傳統方式pojo-dao(連接mybatis,配置mapper.xml文件)-service-controller
使用mybatis-plus之後:
-
pojo
@Data @AllArgsConstructor @NoArgsConstructor public class User { private Long id; private String name; private Integer age; private String email; }
-
mapper接口
//在對應的Mapper上面繼承基本的類 BaseMapper @Repository //代表持久層 public interface UserMapper extends BaseMapper<User> { //所有的CRUD操作都已經編寫完成了 //你不需要像以前配置一大堆文件了! }
-
注意點,我們需要在主啟動類上去掃描我們的mapper包下的所有接口
@MapperScan("com.kuang.mapper")
啟動類
//掃描我們的mapper文件夾 @MapperScan("com.kuang.mapper") @SpringBootApplication public class MybatisPlusApplication { public static void main(String[] args) { SpringApplication.run(MybatisPlusApplication.class, args); } }
-
測試
@SpringBootTest class MybatisPlusApplicationTests { //繼承了BaseMapper,所有的方法都來自父類,我們也可以編寫自己的擴展方法! @Autowired private UserMapper userMapper; @Test void contextLoads() { //參數是一個 Wrapper,條件構造器,這裡我們先不用null //查詢全部用戶 List<User> users = userMapper.selectList(null); users.forEach(System.out::println); } }
-
結果
-
思考問題?
- SQL誰幫我們寫的?MyBatis-Plus 都寫好了
- 方法哪裡來的?MyBatis-Plus 都寫好了
3、配置日誌
我們所有的sql現在是不可見的,我們希望知道它是怎麼執行的,所以我們必須要看日誌!
# 配置日誌
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
配置完畢日誌之後,後面的學習就需要注意這個自動生成的SQL,喜歡上MyBatis-Plus!
4、CRUD擴展
插入操作
Insert 插入
//測試插入
@Test
public void testInsert(){
User user = new User();
user.setName("狂神說Java");
user.setAge(3);
user.setEmail("[email protected]");
int result = userMapper.insert(user); //幫我們自動生成id
System.out.println(result); //受影響的行數
System.out.println(user); //發現,id會自動回填
}
數據庫插入的id的默認值為:全局的唯一id
主鍵生成策略
默認 ID_WORKER 全局唯一id
分佈式系統唯一id生成://www.cnblogs.com/liujianping/p/10401842.html
雪花算法:
snowflake是Twitter開源的分佈式ID生成算法,結果是一個long型的ID。其核心思想是:使用41bit作為毫秒數,10bit作為機器的ID(5個bit是數據中心:不同地點,5個bit的機器ID),12bit作為毫秒內的流水號(意味着每個節點在每毫秒可以產生 4096 個 ID),最後還有一個符號位,永遠是0。可以保證幾乎全球唯一!
主鍵自增
我們需要配置主鍵自增:
-
實體類字段上
@TableId(type = IdType.AUTO)
-
數據庫字段一定要是自增的!
-
再次測試插入即可!
其餘的源碼解釋
public enum IdType {
AUTO(0), //數據庫id自增
NONE(1), //未設置主鍵
INPUT(2), //手動輸入
ID_WORKER(3), //默認的全局唯一id
UUID(4), //全局唯一id uuid
ID_WORKER_STR(5); //ID_WORKER 字符串表示法
}
更新操作
//測試更新
@Test
public void testUpdate(){
User user = new User();
//通過條件自動拼接動態sql
user.setId(6L);
user.setName("關注公眾號:狂神說");
user.setAge(18);
//注意:updateById 但是參數是一個對象!
int i = userMapper.updateById(user);
System.out.println(i);
}
所有的sql都是自動幫你動態配置的!
自動填充
創建時間、修改時間!這些操作一般都是自動化完成的,我們不希望手動更新!
阿里巴巴開發手冊:所有的數據庫表:gmt_create、gmt_modified幾乎所有的表都要配置上!而且需要自動化!
方式一:數據庫級別(工作中不允許修改數據庫)
-
在表中新增字段 create_time,update_time
-
再次測試插入方法,我們需要先把實體類同步!
@Data @AllArgsConstructor @NoArgsConstructor public class User { // 對應數據庫中的主鍵(uuid、自增id、雪花算法、redis、zookeeper!) @TableId(type = IdType.INPUT) //一旦手動輸入id之後,就需要自己配置id了! private Long id; private String name; private Integer age; private String email; private Date createTime; private Date updateTime; }
-
再次更新查看結果即可
方式二:代碼級別
-
刪除數據庫的默認值、更新操作!
-
實體類字段屬性上需要增加註解
//字段添加填充內容 @TableField(fill = FieldFill.INSERT) private Date createTime; @TableField(fill = FieldFill.INSERT_UPDATE) private Date updateTime;
-
編寫處理器來處理這個註解即可!
@Slf4j @Component //一定不要忘記把處理器加到IOC容器中! public class MyMetaObjectHandler implements MetaObjectHandler { //插入時的填充策略 @Override public void insertFill(MetaObject metaObject) { log.info("start insert fill......"); // setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject) 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); } }
-
測試插入、測試更新,觀察時間即可!
//測試插入 @Test public void testInsert(){ User user = new User(); user.setName("狂神說Java"); user.setAge(3); user.setEmail("[email protected]"); int result = userMapper.insert(user); //幫我們自動生成id System.out.println(result); //受影響的行數 System.out.println(user); //發現,id會自動回填 } //測試更新 @Test public void testUpdate(){ User user = new User(); //通過條件自動拼接動態sql user.setId(6L); user.setName("關注公眾號:狂神說"); user.setAge(19); //注意:updateById 但是參數是一個對象! int i = userMapper.updateById(user); System.out.println(i); }
樂觀鎖
在面試過程中,我們經常會被問到樂觀鎖、悲觀鎖!這個其實非常簡單!
樂觀鎖:顧名思義十分樂觀,他總是認為不會出現問題,無論幹什麼不去上鎖!如果出現了問題,再次更新值測試。
悲觀鎖:顧名思義十分悲觀,他總是認為總是會出現問題,無論幹什麼都會上鎖!再去操作!
version、new version
我們這裡主要講解 樂觀鎖 機制!
樂觀鎖實現方式:
- 取出記錄時,獲取當前version
- 更新時,帶上這個version
- 執行更新時,set version = new Version where version = oldVersion
- 如果version不對,就更新失敗
樂觀鎖:1、先查詢,獲得版本號 version = 1
-- A
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
-- B 線程搶先完成,這個時候 version = 2,會導致 A 修改失敗!
update user set name = "kuangshen", version = version + 1
where id = 2 and version = 1
測試一下MP的樂觀鎖插件
-
給數據庫中增加version字段
-
我們實體類加對應的字段
@Version //樂觀鎖version註解 private Integer version;
-
註冊組件
//掃描我們的mapper文件夾 @MapperScan("com.kuang.mapper") @EnableTransactionManagement //開啟自動配置事務 @Configuration //配置類 public class MyBatisPlusConfig { //註冊樂觀鎖插件 @Bean public OptimisticLockerInterceptor optimisticLockerInterceptor(){ return new OptimisticLockerInterceptor(); } }
-
測試一下!
//測試樂觀鎖成功! @Test public void testOptimisticLock(){ //1、查詢用戶信息 User user = userMapper.selectById(1L); //2、修改用戶信息 user.setName("kuangshen"); user.setEmail("[email protected]"); //3、執行更新操作 userMapper.updateById(user); } //測試樂觀鎖失敗!多線程下 @Test public void testOptimisticLock2(){ //線程 1 User user = userMapper.selectById(1L); user.setName("kuangshen111"); user.setEmail("[email protected]"); //模擬另外一個線程執行了插隊操作 User user2 = userMapper.selectById(1L); user2.setName("kuangshen222"); user2.setEmail("[email protected]"); userMapper.updateById(user2); //自旋鎖來多次嘗試提交! userMapper.updateById(user); //如果沒有樂觀鎖就會覆蓋插隊線程的值! }
查詢操作
//測試查詢
@Test
public void testSelectById(){
User user = userMapper.selectById(1L);
System.out.println(user);
}
//測試批量查詢!
@Test
public void testSelectByBatchId(){
List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
users.forEach(System.out::println);
}
//按條件查詢之一,使用map操作
@Test
public void testSelectByBatchIds(){
HashMap<String, Object> map = new HashMap<>();
//自定義要查詢的條件
map.put("name","狂神說Java");
map.put("age",3);
List<User> users = userMapper.selectByMap(map);
users.forEach(System.out::println);
}
分頁查詢
分頁在網站使用的十分之多!
- 原始的 limit 進行分頁
- pageHelper 第三方插件
- MP 其實也內置了分頁插件!
如何使用!
-
配置攔截器組件即可
//分頁插件 @Bean public PaginationInterceptor paginationInterceptor(){ return new PaginationInterceptor(); }
-
直接使用Page對象即可!
//測試分頁查詢 @Test public void testPage(){ //參數一:當前頁 //參數二:頁面大小 //使用了分頁插件之後,所有的分頁操作也變得簡單了! Page<User> page = new Page<>(2,5); userMapper.selectPage(page,null); page.getRecords().forEach(System.out::println); System.out.println(page.getTotal()); }
刪除操作
基本的刪除操作
//測試刪除
@Test
public void testDeleteById(){
userMapper.deleteById(1525818619938652164L);
}
//通過id批量刪除
@Test
public void testDeleteBatchId(){
userMapper.deleteBatchIds(Arrays.asList(1525818619938652161L,1525818619938652162L));
}
//通過map刪除
@Test
public void testDeleteMap(){
HashMap<String, Object> map = new HashMap<>();
map.put("name","狂神說Java");
userMapper.deleteByMap(map);
}
我們在工作中會遇到一些問題:邏輯刪除!
邏輯刪除
物理刪除:從數據庫中直接移除
邏輯刪除:在數據庫中沒有被移除,而是通過一個變量來讓它失效!deleted = 0 => deleted = 1
管理員可以查看被刪除的記錄!防止數據的丟失,類似於回收站!
測試一下:
-
在數據表中增加一個
deleted
字段 -
實體類中增加屬性
@TableLogic //邏輯刪除 private Integer deleted;
-
配置!
//邏輯刪除組件! @Bean public ISqlInjector sqlInjector(){ return new LogicSqlInjector(); }
# 配置邏輯刪除 mybatis-plus.global-config.db-config.logic-delete-value=1 mybatis-plus.global-config.db-config.logic-not-delete-value=0
-
測試一下刪除!
//測試刪除 @Test public void testDeleteById(){ userMapper.deleteById(1L); }
記錄依舊在數據庫,但是值卻已經變化了
//測試查詢 @Test public void testSelectById(){ User user = userMapper.selectById(1L); System.out.println(user); }
以上的所有CRUD操作及其擴展操作,我們都必須精通掌握!會大大提高你的工作和寫項目的效率!
性能分析插件
我們在平時開發中,會遇到一些慢sql。測試!druid……
作用:性能分析攔截器,用於輸出每條SQL語句及其執行時間
MP也提供性能分析插件,如果超過這個時間就停止運行!
-
導入插件
/* * SQL執行效率插件 */ @Bean @Profile({"dev","test"}) //設置 dev test 環境開啟,保證我們的效率 public PerformanceInterceptor performanceInterceptor(){ PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor(); // 在工作中,不允許用戶等待 performanceInterceptor.setMaxTime(100); //ms 設置sql執行的最大時間,如果超過了則不執行 performanceInterceptor.setFormat(true); //是否格式化代碼 return performanceInterceptor; }
記住,要在SpringBoot中配置環境為dev或者test環境!
# 設置開發環境 spring.profiles.active=dev
-
測試使用
//測試批量查詢! @Test public void testSelectByBatchId(){ List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3)); users.forEach(System.out::println); }
使用性能分析插件,可以幫助我們提高效率!
條件構造器
十分重要:Wrapper
我們寫一些複雜的sql就可以使用它來替代!
-
測試一,記住查看輸出的SQL進行分析
@Test void contextLoads() { //查詢name不為空的用戶,並且郵箱不為空的用戶,年齡大於等於12 QueryWrapper<User> wrapper = new QueryWrapper<User>(); wrapper .isNotNull("name") .isNotNull("email") .ge("age",12); userMapper.selectList(wrapper).forEach(System.out::println); //和我們剛才學習的map對比一下 }
-
測試二,記住查看輸出的SQL進行分析
@Test void test2(){ //查詢名字狂神說 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("name","狂神說"); User user = userMapper.selectOne(wrapper); System.out.println(user); //查詢一個數據,出現多個結果使用List或者Map }
-
測試三,記住查看輸出的SQL進行分析
@Test void test3(){ //查詢年齡在20~30歲之間的用戶 QueryWrapper<User> wrapper = new QueryWrapper<>(); wrapper.between("age",20,30); //區間 Integer count = userMapper.selectCount(wrapper); //查詢結果數 System.out.println(count); }
-
測試四,記住查看輸出的SQL進行分析
//模糊查詢 @Test void test4(){ //查詢年齡在20~30歲之間的用戶 QueryWrapper<User> wrapper = new QueryWrapper<>(); //左和右 %e e% %e% wrapper .notLike("name","e") .likeRight("email","t"); List<Map<String, Object>> maps = userMapper.selectMaps(wrapper); maps.forEach(System.out::println); }
-
測試五
//模糊查詢 @Test void test5(){ QueryWrapper<User> wrapper = new QueryWrapper<>(); //id在子查詢中查出來 wrapper.inSql("id","select id from user where id<3"); List<Object> objects = userMapper.selectObjs(wrapper); objects.forEach(System.out::println); }
-
測試六
//測試六 @Test void test6(){ QueryWrapper<User> wrapper = new QueryWrapper<>(); //通過id進行排序 wrapper.orderByDesc("id"); List<User> users = userMapper.selectList(wrapper); users.forEach(System.out::println); }
其餘的測試,可以自己下去多練習!
代碼自動生成器
dao、pojo、service、controller都給我自己去編寫完成!
AutoGenerator是MyBatis-Plus的代碼生成器,通過AutoGenerator可以快速生成Entity、Mapper、Mapper XML、Service、Controller等各個模塊的代碼,極大地提升了開發效率。
導入依賴:
<dependencies>
<!--文件上傳-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.80</version>
</dependency>
<!--數據庫驅動-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<!--mybatis-plus-->
<!--mybatis-plus 是自己開發的,並非官方的!-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--代碼生成器依賴-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.0.5</version>
</dependency>
<!--velocity模板引擎,Mybatis Plus代碼生成器需要-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!--druid-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.2.9</version>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</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>
測試:
//代碼自動生成器
public class KuangCode {
public static void main(String[] args) {
//需要構建一個代碼自動生成器對象
AutoGenerator mpg = new AutoGenerator();
//配置策略
//1、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath+"/src/main/java");
gc.setAuthor("狂神說");
gc.setOpen(false); //生成之後是否打開文件夾
gc.setFileOverride(false); //是否覆蓋
gc.setServiceName("%sService"); // 去Service的I前綴
gc.setIdType(IdType.ID_WORKER);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
//2、設置數據源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/kuang_community?useSSL=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、包的配置
PackageConfig pc = new PackageConfig();
pc.setModuleName("blog");
pc.setParent("com.kuang");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user"); //設置要映射的表名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("你自己的父類實體,沒有就不用設置!");
strategy.setEntityLombokModel(true); //自動lombok
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);
strategy.setControllerMappingHyphenStyle(true); //localhost:8080/hello_id_2
mpg.setStrategy(strategy);
mpg.execute(); //執行
}
}