用于Spring Boot的嵌入式Redis

Question

我在机器上本地Redis服务器的帮助下，使用Spring Boot运行集成测试用例。

但我想要一个嵌入式Redis服务器，它不依赖于任何服务器，可以在任何环境下运行，比如H2内存数据库。我该怎么做？

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@IntegrationTest("server.port:0")
@SpringApplicationConfiguration(classes = Application.class) 
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
public class MasterIntegrationTest {

}

Answer 1

另一种简洁的方法是使用test容器库，它可以在Docker容器中运行任何类型的应用程序，Redis也不例外。我最喜欢的是它与Spring Test生态系统轻轻耦合。

maven的依赖关系：

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>testcontainers</artifactId>
    <version>${testcontainers.version}</version>
</dependency>

简单集成测试：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT, properties = {"management.port=0"})
@ContextConfiguration(initializers = AbstractIntegrationTest.Initializer.class)
@DirtiesContext
public abstract class AbstractIntegrationTest {

    private static int REDIS_PORT = 6379;

    @ClassRule
    public static GenericContainer redis = new GenericContainer("redis:5-alpine").withExposedPorts(REDIS_PORT);

    public static class Initializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
        @Override
        public void initialize(ConfigurableApplicationContext ctx) {
            // Spring Boot 1.5.x
            TestPropertySourceUtils.addInlinedPropertiesToEnvironment(ctx,
                "spring.redis.host=" + redis.getContainerIpAddress(),
                "spring.redis.port=" + redis.getMappedPort(REDIS_PORT));

            // Spring Boot 2.x.
            TestPropertyValues.of(
                "spring.redis.host:" + redis.getContainerIpAddress(),
                "spring.redis.port:" + redis.getMappedPort(REDIS_PORT))
                .applyTo(ctx);
        }
    }
}

自Spring Framework 5.2.5（Spring Boot 2.3.x）以来，您可以使用功能强大的DynamicPropertySource注释。以下是一个示例：

@ExtendWith(SpringExtension.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_CLASS)
public abstract class AbstractIT {

    static GenericContainer redisContainer = new GenericContainer("redis:5-alpine").withExposedPorts(6379);

    @DynamicPropertySource
    static void properties(DynamicPropertyRegistry r) throws IOException {
        r.add("spring.redis.host", redisContainer::getContainerIpAddress);
        r.add("spring.redis.port", redisContainer::getFirstMappedPort);
    }
}

Answer 2

您可以使用ozimov/intend-redis作为Maven（-test）-依赖项（这是kstyrc/intend-redis的继承者）。

>

<dependencies>
  ...
  <dependency>
    <groupId>it.ozimov</groupId>
    <artifactId>embedded-redis</artifactId>
    <version>0.7.1</version>
    <scope>test</scope>
  </dependency>

为集成测试调整应用程序属性

spring.redis.host=localhost
spring.redis.port=6379

在测试配置中使用嵌入式redis服务器

@TestConfiguration
public static class EmbededRedisTestConfiguration {

  private final redis.embedded.RedisServer redisServer;

  public EmbededRedisTestConfiguration(@Value("${spring.redis.port}") final int redisPort) throws IOException {
    this.redisServer = new redis.embedded.RedisServer(redisPort);
  }

  @PostConstruct
  public void startRedis() {
    this.redisServer.start();
  }

  @PreDestroy
  public void stopRedis() {
    this.redisServer.stop();
  }
}

Answer 3

您可以使用嵌入式Redis，如https://github.com/kstyrc/embedded-redis

>

将依赖项添加到pom。xml

调整集成测试的属性以指向嵌入式redis，例如：

spring:
  redis:
    host: localhost
    port: 6379

在仅在测试中定义的组件中实例化嵌入式redis服务器：

@Component
public class EmbededRedis {

    @Value("${spring.redis.port}")
    private int redisPort;

    private RedisServer redisServer;

    @PostConstruct
    public void startRedis() throws IOException {
        redisServer = new RedisServer(redisPort);
        redisServer.start();
    }

    @PreDestroy
    public void stopRedis() {
        redisServer.stop();
    }
}