微服務架構中的Redis

了解如何將Redis與Spring Cloud和Spring Data一起使用以提供配置服務器，消息代理和數據庫。

 

 

Redis可以廣泛用於微服務架構中。它可能是少數流行的軟件解決方案之一，你的應用程序可以通過許多不同的方式來利用這些解決方案。根據要求，它可以充當主數據庫，緩存或消息代理。雖然它也是鍵/值存儲，但我們可以將其用作微服務體系結構中的配置服務器或發現服務器。盡管通常將其定義為內存中的數據結構，但我們也可以在持久模式下運行它。

通過這篇文章，我將結合我自己所掌握的和近期在優銳課學習到的知識，向你展示一些將Redis與基於Spring Boot和Spring Cloud框架構建的微服務一起使用的示例。這些應用程序將使用Redis發布/訂閱，使用Redis作為緩存或主數據庫，最后使用Redis作為配置服務器，彼此之間進行異步通信。這是說明所描述體系結構的圖片。

 

 

 

Redis作為配置服務器

如果你已經使用Spring Cloud構建了微服務，則可能對Spring Cloud Config有所了解。它負責為微服務提供分布式配置模式。 不幸的是，Spring Cloud Config不支持將Redis作為屬性源的后端存儲庫。這就是為什么我決定派生一個Spring Cloud Config項目並實現此功能的原因。我希望我的實現將很快包含在Spring Cloud的官方發行版中，我們如何使用它？很簡單的。讓我們來看看。

Spring Boot的當前SNAPSHOT版本是2.2.0.BUILD-SNAPSHOT，與用於Spring Cloud Config的版本相同。在構建Spring Cloud Config Server時，我們僅需要包括這兩個依賴項，如下所示。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.0.BUILD-SNAPSHOT</version>
</parent>
<artifactId>config-service</artifactId>
<groupId>pl.piomin.services</groupId>
<version>1.0-SNAPSHOT</version>
<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-config-server</artifactId>
        <version>2.2.0.BUILD-SNAPSHOT</version>
    </dependency>
</dependencies>

 

默認情況下，Spring Cloud Config Server使用一個Git存儲庫后端。 我們需要激活一個redisprofile來強制它使用Redis作為后端。 如果你的Redis實例偵聽的地址不是localhost:6379，則需要使用spring.redis.*屬性覆蓋自動配置的連接設置。 這是我們的bootstrap.yml文件。

spring:
  application:
    name: config-service
  profiles:
    active: redis
  redis:
    host: 192.168.99.100

 

應用程序主類應使用@EnableConfigServer進行注釋。

@SpringBootApplication
@EnableConfigServer
public class ConfigApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(ConfigApplication.class).run(args);
    }
}

 

在運行應用程序之前，我們需要啟動Redis實例。這是將其作為Docker容器運行並在端口6379上公開的命令。

$ docker run -d --name redis -p 6379:6379 redis

 

每個應用程序的配置都必須在鍵${spring.application.name}或${spring.application.name}-${spring.profiles.active[n]}可用。

我們必須使用與配置屬性名稱相對應的鍵來創建hash。我們的示例應用程序驅動程序管理使用三個配置屬性：server.port用於設置HTTP偵聽端口，spring.redis.host用於更改用作消息代理和數據庫的默認Redis地址，以及sample.topic.name用於設置名稱。微服務之間用於異步通信的主題。這是我們為使用RDBTools可視化的驅動程序管理創建的Redis hash的結構。

 

 

該可視化等效於運行Redis CLI命令HGETALL，該命令返回哈希中的所有字段和值。

>> HGETALL driver-management
{
  "server.port": "8100",
  "sample.topic.name": "trips",
  "spring.redis.host": "192.168.99.100"
}

 

在Redis中設置鍵和值並使用有效的redisprofile運行Spring Cloud Config Server之后，我們需要在客戶端啟用分布式配置功能。為此，我們只需要將spring-cloud-starter-config依賴項包含到每個微服務的thepom.xml中即可。

<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>

 

我們使用Spring Cloud的最新穩定版本。

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Greenwich.SR1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

 

應用程序的名稱是在啟動時從屬性spring.application.name獲取的，因此我們需要提供以下bootstrap.yml文件。

spring:
  application:
    name: driver-management

 

 

Redis作為消息代理

現在，我們可以繼續研究基於微服務的體系結構中Redis的第二個用例——消息代理。我們將實現一個典型的異步系統，如下圖所示。在創建新行程並完成當前行程后，微服務行程管理會將通知發送到Redis Pub / Sub。該通知由預訂特定頻道的駕駛員管理和乘客管理兩者接收。

 

 

我們的申請非常簡單。我們只需要添加以下依賴項即可提供REST API並與Redis Pub / Sub集成。

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

 

我們應該使用通道名稱和發布者來注冊bean。TripPublisher負責將消息發送到目標主題。

@Configuration
public class TripConfiguration {
    @Autowired
    RedisTemplate<?, ?> redisTemplate;
    @Bean
    TripPublisher redisPublisher() {
        return new TripPublisher(redisTemplate, topic());
    }
    @Bean
    ChannelTopic topic() {
        return new ChannelTopic("trips");
    }
}

 

TripPublisher 使用RedisTemplate將消息發送到主題。 發送之前，它將使用Jackson2JsonRedisSerializer將對象中的所有消息轉換為JSON字符串。

public class TripPublisher {
    private static final Logger LOGGER = LoggerFactory.getLogger(TripPublisher.class);
    RedisTemplate<?, ?> redisTemplate;
    ChannelTopic topic;
    public TripPublisher(RedisTemplate<?, ?> redisTemplate, ChannelTopic topic) {
        this.redisTemplate = redisTemplate;
        this.redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer(Trip.class));
        this.topic = topic;
    }
    public void publish(Trip trip) throws JsonProcessingException {
        LOGGER.info("Sending: {}", trip);
        redisTemplate.convertAndSend(topic.getTopic(), trip);
    }
}

 

我們已經在發布方實現了邏輯。現在，我們可以在訂戶端進行實施。我們有兩個微服務驅動程序管理和乘客管理，它們偵聽旅行管理微服務發送的通知。我們需要定義RedisMessageListenerContainer bean並設置消息偵聽器實現類。

@Configuration
public class DriverConfiguration {
    @Autowired
    RedisConnectionFactory redisConnectionFactory;
    @Bean
    RedisMessageListenerContainer container() {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.addMessageListener(messageListener(), topic());
        container.setConnectionFactory(redisConnectionFactory);
        return container;
    }
    @Bean
    MessageListenerAdapter messageListener() {
        return new MessageListenerAdapter(new DriverSubscriber());
    }
    @Bean
    ChannelTopic topic() {
        return new ChannelTopic("trips");
    }
}

 

負責處理傳入通知的類需要實現MessageListenerinterface。 收到消息后，DriverSubscriber會將其從JSON反序列化為對象，並更改驅動程序的狀態。

@Service
public class DriverSubscriber implements MessageListener {
    private final Logger LOGGER = LoggerFactory.getLogger(DriverSubscriber.class);
    @Autowired
    DriverRepository repository;
    ObjectMapper mapper = new ObjectMapper();
    @Override
    public void onMessage(Message message, byte[] bytes) {
        try {
            Trip trip = mapper.readValue(message.getBody(), Trip.class);
            LOGGER.info("Message received: {}", trip.toString());
            Optional<Driver> optDriver = repository.findById(trip.getDriverId());
            if (optDriver.isPresent()) {
                Driver driver = optDriver.get();
                if (trip.getStatus() == TripStatus.DONE)
                    driver.setStatus(DriverStatus.WAITING);
                else
                    driver.setStatus(DriverStatus.BUSY);
                repository.save(driver);
            }
        } catch (IOException e) {
            LOGGER.error("Error reading message", e);
        }
    }
}

 

 

Redis作為主數據庫

盡管使用Redis的主要目的是內存中緩存或作為鍵/值存儲，但它也可以充當應用程序的主數據庫。在這種情況下，值得在持久模式下運行Redis。

$ docker run -d --name redis -p 6379:6379 redis redis-server --appendonly yes

 

使用hash操作和mmap結構將實體存儲在Redis中。每個實體都需要具有hash鍵和ID。

@RedisHash("driver")
public class Driver {
    @Id
    private Long id;
    private String name;
    @GeoIndexed
    private Point location;
    private DriverStatus status;
    // setters and getters ...
}

 

幸運的是，Spring Data Redis為Redis集成提供了眾所周知的存儲庫模式。要啟用它，我們應該使用@EnableRedisRepositories注釋配置或主類。當使用Spring倉庫模式時，我們不必自己構建對Redis的任何查詢。

@Configuration
@EnableRedisRepositories
public class DriverConfiguration {
// logic ...
}

 

使用Spring Data存儲庫，我們不必構建任何Redis查詢，只需遵循Spring Data約定的名稱方法即可。有關更多詳細信息，請參閱我以前的文章Spring Data Redis簡介。出於示例目的，我們可以使用Spring Data內部實現的默認方法。這是驅動程序管理中存儲庫接口的聲明。

public interface DriverRepository extends CrudRepository<Driver, Long> {}

 

不要忘記通過使用@EnableRedisRepositories注釋主應用程序類或配置類來啟用Spring Data存儲庫。

@Configuration
@EnableRedisRepositories
public class DriverConfiguration {
...
}

 

結論

微服務架構中Redis的使用案例多種多樣。我剛剛介紹了如何輕松地將其與Spring Cloud和Spring Data一起使用以提供配置服務器，消息代理和數據庫。Redis通常被認為是緩存存儲，但是我希望閱讀本文后你會對此有所改變。