SpringBoot中如何對數據訪問層進行單元測試?
前言
我們公司作為一個面向銀行、金融機構的TO B類企業，頻繁遇到各個甲方爸爸提出的國產化數據庫的改造需求，包括OceanBase, TiDB，geldenDB等等。每次適配都需要投入大量的人力進行測試工作，那么有沒有更高效、低成本的方式去解決這個問題呢？本文就介紹一種快高效、可復用的解決方案——對數據訪問層做單元測試。
Mybatis測試依賴
我們項目采用的SpringBoot + Mybatis作為開發框架，大家第一想到可以用SpringBoot自帶的測試注解@SpringBootTest進行測試。但是使用該注解有一個最大的弊端就是需要啟動整個容器，注入全部的bean，那么一次測試就相當于啟動一次應用，我們的應用啟動一次就要花費近70~80秒，黃花菜都涼了。
圖片
那么有沒有更好的辦法，有必要注入全量的bean嗎？是不是只要注入數據訪問層相關的bean即可，其實官方的mybatis就給了我們這樣的的解決方案。
- 引入依賴mybatis-spring-boot-starter-test
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter-test</artifactId>
<version>2.3.0</version>
<scope>test</scope>
</dependency>- Mapper接口
@Mapper
public interface CityMapper {
@Select("SELECT * FROM CITY WHERE state = #{state}")
City findByState(@Param("state") String state);
}- 使用junit5的測試類
// 使用junit5
@MybatisTest
// 使用真實的數據源進行測試
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class CityMapperTest {
@Autowired
private CityMapper cityMapper;
@Test
public void findByStateTest() {
City city = cityMapper.findByState("CA");
assertThat(city.getName()).isEqualTo("San Francisco");
assertThat(city.getState()).isEqualTo("CA");
assertThat(city.getCountry()).isEqualTo("US");
}
}- 自定義一個啟動類
@MybatisTest在默認情況下將會探測到帶有 @SpringBootApplication的類。因此，由于 bean定義的一些方法，可能會發生一些意想不到的錯誤，或者一些不必要的組件被裝入 ApplicationContext。為了避免這種情況，我們可以在與測試類相同的包中創建帶有 @SpringBootApplication 的類。
package sample.mybatis.mapper;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
class MapperTestApplication {
}
圖片
- 運行結果
圖片
詳細內容參考 https://github.com/mybatis/spring-boot-starter/blob/master/mybatis-spring-boot-test-autoconfigure/src/site/zh/markdown/index.md**但是，**上面是使用原生mybatis的測試方式，而我們項目用的是基于mybatis封裝的開源框架tkMapper，github地址是[https://github.com/abel533/Mapper](https://github.com/abel533/Mapper)，并不適用啊，無解，只能去看下mybatis-spring-boot-starter-test的原理。
實現原理
實際上mybatis-spring-boot-starter-test的實現原理很簡單，代碼目錄結構如下：
圖片
- @MybatisTest注解如下，引入MybatisTestContextBootstrapper測試引導程序。同時引入其他的注解，進行自動裝配。
圖片
- @AutoConfigureMybatis由MybatisTest注解引入，會去找META-INF下的spring.factories,自動組裝mybatis相關的bean
圖片
那么基于目前的理解，我們也可以簡單實現一個基于TkMapper的測試框架。
Mapper測試框架
我們參照mybatis原生的實現方式
- 重新命名，內容不變
圖片
- 修改spring.factories添加MapperAutoConfiguration
圖片
- 使用自定義測試注解@MapperTest
圖片
雖然這里有**insert**語句，但是測試結束，事務會被回滾，數據不會真的插入到表中，所以是可以反復進行測試的。
圖片
總結
本文分享了基于springboot+mybatis項目中針對數據訪問層進行單元測試的一種方式，這種方式只注入mybatis相關的bean，快速高效的對不同類型的數據庫進行測試，保證程序的正確性。
其實，對于大多數據的程序員來說，寫單元測試可能是一種負擔和累贅，但是如果你的單元測試真的能夠在你的項目中有其價值，那么就是值得的，千萬不要為了單元測試而單元測試。
