嵌入式Redis伺服器在Spring Boot測試中的使用

碼農熊貓發表於2021-07-18
Redis伺服器Spring Boot

1、概述

Spring Data Redis提供了一種與Redis例項整合的簡單方法。

但是，在某些情況下，使用嵌入式伺服器比使用真實伺服器建立開發和測試環境更方便。

因此，我們將學習如何設定和使用嵌入式Redis伺服器。

2、依賴

讓我們首先新增必要的依賴項：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

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

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
</dependency>

這個spring-boot-starter-test包含我們需要執行整合測試的各種依賴。

此外，embedded-redis包含我們將使用的嵌入式伺服器。

3、設定

新增依賴項後，我們應該定義Redis伺服器和我們的應用程式之間的連線設定。

讓我們首先建立一個類來儲存我們的屬性：

@Configuration
public class RedisProperties {
    private int redisPort;
    private String redisHost;

    public RedisProperties(
      @Value("${spring.redis.port}") int redisPort, 
      @Value("${spring.redis.host}") String redisHost) {
        this.redisPort = redisPort;
        this.redisHost = redisHost;
    }

    // getters
}

接下來，我們應該建立一個配置類來定義連線並使用我們的屬性：

@Configuration
@EnableRedisRepositories
public class RedisConfiguration {

    @Bean
    public LettuceConnectionFactory redisConnectionFactory(
      RedisProperties redisProperties) {
        return new LettuceConnectionFactory(
          redisProperties.getRedisHost(), 
          redisProperties.getRedisPort());
    }

    @Bean
    public RedisTemplate<?, ?> redisTemplate(LettuceConnectionFactory connectionFactory) {
        RedisTemplate<byte[], byte[]> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);
        return template;
    }
}

配置非常簡單。這樣我們的嵌入式伺服器可以在其他的埠上執行。

4、嵌入式Redis伺服器

現在，我們將配置嵌入式伺服器並在我們的一項測試中使用它。

首先，讓我們在測試的資源目錄（src/test/resources）中建立一個application.properties檔案：

spring.redis.host=localhost
spring.redis.port=6370

之後，我們將建立一個@TestConfiguration註解的配置類：

@TestConfiguration
public class TestRedisConfiguration {

    private RedisServer redisServer;

    public TestRedisConfiguration(RedisProperties redisProperties) {
        this.redisServer = new RedisServer(redisProperties.getRedisPort());
    }

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

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

當context上下文啟動，伺服器就跟著啟動。它根據我們在屬性中定義的埠執行在我們的機器上。有了它，我們現在可以在不停止實際Redis伺服器的情況下執行測試了。

理想情況下，我們希望在隨機可用埠上啟動它，但嵌入式Redis尚不具備此功能。我們現在可以做的是通過ServerSocket API 獲取隨機埠。

此外，當上下文停止，伺服器也跟著停止。

伺服器也可以由我們自己的可執行檔案來提供：

this.redisServer = new RedisServer("/path/redis", redisProperties.getRedisPort());

此外，可執行檔案可以按不同的作業系統來定義：

RedisExecProvider customProvider = RedisExecProvider.defaultProvider()
.override(OS.UNIX, "/path/unix/redis")
.override(OS.Windows, Architecture.x86_64, "/path/windows/redis")
.override(OS.MAC_OS_X, Architecture.x86_64, "/path/macosx/redis");

this.redisServer = new RedisServer(customProvider, redisProperties.getRedisPort());

最後，讓我們建立一個使用TestRedisConfiguration類的測試吧：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestRedisConfiguration.class)
public class UserRepositoryIntegrationTest {

    @Autowired
    private UserRepository userRepository;

    @Test
    public void shouldSaveUser_toRedis() {
        UUID id = UUID.randomUUID();
        User user = new User(id, "name");

        User saved = userRepository.save(user);

        assertNotNull(saved);
    }
}

這樣使用者儲存就到了我們的嵌入式Redis伺服器。

此外，我們必須手動將TestRedisConfiguration新增到SpringBootTest。正如我們之前所說，伺服器在測試之前啟動並在測試之後停止。

5、結論

嵌入式Redis伺服器是在測試環境中替換實際伺服器的完美工具。我們已經看到了如何配置它以及如何在我們的測試中使用它。

更多技術乾貨，請訪問我的個人網站https://pinmost.com，或關注公眾號【碼農熊貓】

相關文章