在《第一個MyBatis應用:Spring Boot整合MyBatis框架》文章中,SqlSessionFactory仍然是由MyBatis來構建的,通過SqlSessionFactory創建SqlSession,然後通過SqlSession來進行增刪查改操作,並沒有由Spring容器託管。
實際上,在Spring Boot中使用MyBatis本質就是在Spring框架中集成MyBatis,並沒有其他任何高級的東西。只不過在Spring Boot中使用時因為插件封裝的關係使得相關的配置可以更簡潔一些,但是這種封裝對於不熟悉MyBatis的人來講反而增加了理解的難度。
因此,本文將把如何在Spring Boot中使用MyBatis進行詳細介紹,希望對你有幫助。

Spring Cloud Alibaba微服務實戰技術專欄,從項目實踐出發,包括Spring Cloud Alibaba、Nacos、Gateway、Sentinel、Log日誌、分布式全局唯一ID、DDD領域驅動設計等等技術內容,可幫助你對Spring Cloud 微服務技術棧有更加全面和直觀的了解。相信你通過本專欄的練習和實踐,能夠學以致用,提升微服務應用的開發能力。
一、創建Maven示例項目
創建Maven示例項目mybatis-second,如圖所示:

然後,在pom.xml文件中添加依賴項:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.4</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
二、配置數據源
通過與 Spring Boot的整合,SqlSessionFactory 交由 Spring 來構建。構建時需要在Spring的配置文件中添加數據庫連接的四大屬性來配置數據源。
在 Spring Boot的application.yml配置文件中添加如下配置。
# 配置數據源
spring:
datasource:
url: jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
driver-class-name: com.mysql.cj.jdbc.Driver
username: root
password: xxx
# 整合mybatis
mybatis:
mapper-locations: classpath:mapper/*.xml
從上述 MyBatis的運行時參數中可以看到,可以通過參數mybatis.mapper-locations指定XML映射器所在位置。

XML映射器文件UserMapper.xml和上一章中的UserMapper.xml是一樣的,可以從上一篇文章中獲取。

三、集成MyBatis-Spring-Boot-Starter插件
通過插件
MyBatis-Spring-Boot-Starter在Spring Boot中集成MyBatis時,可以不用再去關心原生配置方式里的細節,直接使用默認配置就能實現最基本的功能。當然,同樣可以針對MyBatis的核心組件進行定製。
前面已經在項目的pom文件中添加了插件
MyBatis-Spring-Boot-Starter的依賴配置。
默認情況下,插件
MyBatis-Spring-Boot-Starter將進行如下配置:
- 自動檢查Spring Boot的數據源配置並構建DataSource對象
- 通過SqlSessionFactoryBean使用數據源構建並註冊SqlSessionFactory對象
- 從SqlSessionFactory中創建並註冊一個SqlSessionTemplate實例,其實就是構建一個SqlSession對象
- 自動掃描接口映射器,並將這些映射器與SqlSessionTemplate實例進行關聯,同時將它們註冊到Spring容器中
這些在Spring Boot中通過插件
MyBatis-Spring-Boot-Starter自動完成了。

既然MyBatis的配置已經完成了,那麼下一步的工作就是如何編寫和使用接口映射器。
四、定義接口映射器
在示例項目中,定義接口映射器UserMapper,代碼如下所示:
public interface UserMapper {
MyUser selectUserById(int id);
List<MyUser> selectAllUser();
void addUser(MyUser myUser);
void updateUser(MyUser myUser);
void deleteUser(int id);
}
插件
MyBatis-Spring-Boot-Starter會自動搜索使用了註解@Mapper的接口映射器並將其註冊到Spring容器中,也可以在Spring Boot啟動類上@MapperScan註解,示例項目採用這種方式。

五、使用接口映射器
我們在示例項目中創建了一個測試類UserMapperTest,在該類中直接注入接口映射器Bean進行使用。

測試類UserMapperTest 代碼如下所示:
@SpringBootTest
public class UserMapperTest {
@Autowired
private UserMapper userMapper;
@Test
void selectUserById() {
MyUser myUser = userMapper.selectUserById(5);
System.out.println(myUser);
}
@Test
void selectAllUser() {
List<MyUser> listUser = userMapper.selectAllUser();
for (MyUser myUser:listUser) {
System.out.println(myUser);
}
}
@Test
void addUser() {
MyUser myUser = new MyUser();
myUser.setUname(“Spring Cloud”);
myUser.setUsex(“男”);
userMapper.addUser(myUser);
}
@Test
void updateUser() {
MyUser myUser = new MyUser();
myUser.setUid(5);
myUser.setUname(“MyBatis”);
myUser.setUsex(“男”);
userMapper.updateUser(myUser);
}
@Test
void deleteUser() {
userMapper.deleteUser(6);
}
}
運行單元測試,驗證輸出結果,如圖所示:

至此可以看到,在Spring Boot中通過插件
MyBatis-Spring-Boot-Starter集成MyBatis時非常方便,只需要添加基本的數據源配置就可以使用了。
六、定製MyBatis運行時參數
在Spring Boot中對MyBatis進行定製主要是指在Spring Boot的配置文件中(如:application.yaml)對MyBatis運行參數進行自定義配置(使用mybatis作為配置參數前綴):
mybatis:
check-config-location: true # 是否檢測MyBatis運行參數配置文件
config-location:
classpath:/mybatis-config.xml # 指定MyBatis運行參數配置文件位置mapper-locations: classpath:/mapper/**/*.xml # 註冊XML映射器
type-aliases-package: test.springboot.model # 配置Java類型包名
type-handlers-package: test.springboot.handlers # 配置類型處理器包名
executor-type: SIMPLE # 指定執行器類型
configuration:
default-fetch-size: 20
default-statement-timeout: 30
上述配置參數最終是通過
mybatis-spring-boot-autoconfigure.jar加載和配置的。
另外,上述配置參數只是一個配置示例,詳細的配置參數列表請參考MyBatis配置官網:
http://www.mybatis.org/mybatis-3/zh/configuration.html。
總結起來,在Spring Boot中使用MyBatis可以使用2種方式:
(1)使用在Spring框架中集成MyBatis的原生集成方式
(2)使用插件
MyBatis-Spring-Boot-Starter集成MyBatis
上述兩種方式都可以實現對MyBatis的定製化配置,可以根據個人喜好進行選擇。無論如何,要想在Spring Boot中靈活使用好MyBatis,最基礎的還是MyBatis和Spring框架本身。

原創文章,作者:投稿專員,如若轉載,請註明出處:https://www.506064.com/zh-hant/n/224231.html
微信掃一掃
支付寶掃一掃