SpringBoot中如何对数据访问层进行单元测试？

阳光穿透心脏的1/2处 2023-10-13 19:54 10阅读 0赞

## 前言 ##

我们公司作为一个面向银行、金融机构的TO B类企业，频繁遇到各个甲方爸爸提出的国产化数据库的改造需求，包括OceanBase, TiDB，geldenDB等等。每次适配都需要投入大量的人力进行测试工作，那么有没有更高效、低成本的方式去解决这个问题呢？本文就介绍一种快高效、可复用的解决方案——对数据访问层做单元测试。

## Mybatis测试依赖 ##

我们项目采用的SpringBoot + Mybatis作为开发框架，大家第一想到可以用SpringBoot自带的测试注解@SpringBootTest进行测试。但是使用该注解有一个最大的**弊端**就是需要启动整个容器，注入全部的bean，那么一次测试就相当于启动一次应用，我们的应用启动一次就要花费近**70~80**秒，黄花菜都凉了。

![format_png][]

![get_code_MWQ1Y2I2Nzg4MmQ3M2M5MDVjZTUyZTAyNDdlZGVmNGIsMTY4OTczMTI1ODU2Nw][]

那么有没有更好的办法，有必要注入全量的bean吗？是不是只要注入数据访问层相关的bean即可，其实官方的mybatis就给了我们这样的的解决方案。

1.  引入依赖mybatis-spring-boot-starter-test

xml复制代码<dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter-test</artifactId>
      <version>2.3.0</version>
      <scope>test</scope>
    </dependency>

1.  Mapper接口

less复制代码@Mapper
    public interface CityMapper {
    
        @Select("SELECT * FROM CITY WHERE state = #{state}")
        City findByState(@Param("state") String state);
    
    }

1.  使用junit5的测试类

less复制代码// 使用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");
        }
    
    }

1.  自定义一个启动类

@MybatisTest 在默认情况下将会探测到带有 @SpringBootApplication 的类。 因此，由于 bean 定义的一些方法，可能会发生一些意想不到的错误，或者一些不必要的组件被装入 ApplicationContext 。 为了避免这种情况，我们可以在与测试类相同的包中创建带有 @SpringBootApplication 的类。

java复制代码package sample.mybatis.mapper;
    
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    class MapperTestApplication {
    
    }

![get_code_NmRkODY5OTEwNTY5YTBkYTA5YThjOGU4ZTAxMzI0YjEsMTY4OTczMTI1ODU2Nw][]

![format_png 1][]

1.  运行结果

![format_png 2][]

详细内容参考 [github.com/mybatis/spr…][github.com_mybatis_spr]

**但是，** 上面是使用原生mybatis的测试方式，而我们项目用的是基于mybatis封装的开源框架`tkMapper`，`github`地址是`https://github.com/abel533/Mapper`，并不适用啊，无解，只能去看下`mybatis-spring-boot-starter-test`的原理。

### 实现原理 ###

实际上`mybatis-spring-boot-starter-test`的实现原理很简单，代码目录结构如下：

![format_png 3][]

1.  `@MybatisTest`注解如下，引入`MybatisTestContextBootstrapper`测试引导程序。同时引入其他的注解，进行自动装配。

![format_png 4][]

1.  `@AutoConfigureMybatis`由`MybatisTest`注解引入，会去找`META-INF`下的`spring.factories`,自动组装mybatis相关的bean

![format_png 5][]

那么基于目前的理解，我们也可以简单实现一个基于`TkMapper`的测试框架。

### Mapper测试框架 ###

我们参照`mybatis`原生的实现方式

1.  重新命名，内容不变

![format_png 6][]

1.  修改`spring.factories`添加`MapperAutoConfiguration`

![format_png 7][]

1.  使用自定义测试注解`@MapperTest`

![format_png 8][]

**虽然这里有**`insert`**语句，但是测试结束，数据不会真的插入到表中，因为`MapperTest`注解上包含了事务注解，所以是可以反复进行测试的。**

![format_png 9][]

![get_code_YzA0YmQ5OGRlNTY4YTcyMTNjMmVlZTI3NTEwMzNjMjcsMTY4OTczMTI1ODU2Nw][]

## 总结 ##

本文分享了基于springboot+mybatis项目中针对数据访问层进行单元测试的一种方式，这种方式只注入mybatis相关的bean，快速高效的对不同类型的数据库进行测试，保证程序的正确性。

其实，对于大多数据的程序员来说，写单元测试可能是一种负担和累赘，但是如果你的单元测试真的能够在你的项目中有其价值，那么就是值得的，千万不要为了单元测试而单元测试。

[format_png]: https://img-blog.csdnimg.cn/img_convert/610cffff7f44de9ea5df9c25b670a6c9.webp?x-oss-process=image/format,png
[get_code_MWQ1Y2I2Nzg4MmQ3M2M5MDVjZTUyZTAyNDdlZGVmNGIsMTY4OTczMTI1ODU2Nw]: https://mp.toutiao.com/mp/agw/article_material/open_image/get?code=MWQ1Y2I2Nzg4MmQ3M2M5MDVjZTUyZTAyNDdlZGVmNGIsMTY4OTczMTI1ODU2Nw==
[get_code_NmRkODY5OTEwNTY5YTBkYTA5YThjOGU4ZTAxMzI0YjEsMTY4OTczMTI1ODU2Nw]: https://mp.toutiao.com/mp/agw/article_material/open_image/get?code=NmRkODY5OTEwNTY5YTBkYTA5YThjOGU4ZTAxMzI0YjEsMTY4OTczMTI1ODU2Nw==
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/003a7a7e84e5edb460293b5415842a51.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/c845b91c842a7efa5a58891b1bc97084.webp?x-oss-process=image/format,png
[github.com_mybatis_spr]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fmybatis%2Fspring-boot-starter%2Fblob%2Fmaster%2Fmybatis-spring-boot-test-autoconfigure%2Fsrc%2Fsite%2Fzh%2Fmarkdown%2Findex.md
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/ae50c5bfd0f34b5bfa71813abafc280d.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/cca927cab9158f96c62ae9d908287585.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/5a03e8d9849dd92e3b68ee7cd265aee2.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/090e62ad88a93d85d47a9b69286f1cdf.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/bfdc9b803881a4a5fec1a55d190d2fef.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/66d7b04651054d28c4d1187bd0c0d6ee.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/408b67b9244e4829bfc77e3899efb78b.webp?x-oss-process=image/format,png
[get_code_YzA0YmQ5OGRlNTY4YTcyMTNjMmVlZTI3NTEwMzNjMjcsMTY4OTczMTI1ODU2Nw]: https://mp.toutiao.com/mp/agw/article_material/open_image/get?code=YzA0YmQ5OGRlNTY4YTcyMTNjMmVlZTI3NTEwMzNjMjcsMTY4OTczMTI1ODU2Nw==