单元测试第三篇,演示在单元测试时,如何对Redis操作进行mock,便于本地或CI/CD环境的质量测试、覆盖率测试。
相关代码已经放在Github上:源代码

注:有些资料说,embedded-redis存在一些问题,我在具体使用中,因为只使用了基本的key value操作,暂时未发现。

下面简述开发过程:
1、首先,还是正常建立项目,并有常规的REDIS操作的业务逻辑;

2、项目添加mock库的引用,打开pom.xml,添加:

<dependency>
    <groupId>it.ozimov</groupId>
    <artifactId>embedded-redis</artifactId>
    <version>0.7.3</version>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
        </exclusion>
    </exclusions>
</dependency>

注1:scope为test,是仅在单元测试时引入,运行时并不引入。
注2:该库依赖的slf4j-simple,会跟spring引入的slf4j有冲突,因此需要排除。

3、application.yml配置文件,添加 profiles: unittest 配置节,指向localhost:

spring:
  profiles: unittest # 单元测试,通过注解 ActiveProfiles 使用这一段
  redis:
    host: localhost
    port: 6379
    database: 15            # 数据库索引,注意只支持 0到15

4、在单元测试代码里,启动引入的redis监听:

private static RedisServer redisServer;

/**
 * 启动Redis,并在6379端口监听
 */
@BeforeAll
static void startRedis() {
    // https://github.com/kstyrc/embedded-redis/issues/51
    redisServer = RedisServer.builder()
            .port(6379)
            .setting("maxmemory 128M") //maxheap 128M
            .build();

    redisServer.start();
}

/**
 * 析构方法之后执行,停止Redis.
 */
@AfterAll
static void stopRedis() {
    redisServer.stop();
}

5、好了,现在可以直接对项目进行测试了,所有的Redis操作,都会指向127.0.0.1的mock实例。

如果你在运行时有问题,可以下载上面的源码,进行对比,看看你的代码哪里有问题。

最后补一句:
Redis的最佳使用场景,是缓存场景,一般不建议把Redis使用在其它场景。
实际工作经历中,经常碰到把Redis当数据库、当消息队列等等各种用途。
在遇到问题排查,或故障恢复时,这些使用场景,经常会带来巨大的麻烦,甚至数据丢失等风险,慎重。

Logo

旨在为数千万中国开发者提供一个无缝且高效的云端环境,以支持学习、使用和贡献开源项目。

更多推荐