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