Spring Boot 整合Redisson配置篇
摘要：介紹在Spring Boot 中，如何整合Redisson。
綜述
Redisson是Redis官方推薦的Java版的Redis客戶端。它提供了使用Redis的最簡單和最便捷的方法。Redisson的宗旨是促進使用者對Redis的關注分離（Separation of Concern），從而讓使用者能夠將精力更集中地放在處理業務邏輯上。
小編在《Spring Boot 整合Jedis連線Redis和簡單使用》中，先介紹如何在Windows系統安裝Redis環境,然後在Spring Boot 專案中整合 Jedis,最後簡單地做了一個使用Jedis操作redis連線池的測試用例。本文介紹如何在Spring Boot專案中整合Redisson。
引入Maven依賴
Spring Boot版本： 2.5.x。
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-boot-starter</artifactId>
<version>3.17.1</version>
</dependency>
叢集模式除了適用於Redis叢集環境，也適用於任何雲端計算服務商提供的叢集模式，例如AWS ElastiCache叢集版、Azure Redis Cache和阿里雲（Aliyun）的雲資料庫Redis版。
YAML檔案配置叢集
在YAML檔案中新增如下叢集化配置：
spring: redis: cluster: nodeAddresses: [ "redis://127.0.0.1:7005", "redis://127.0.0.1:7004", "redis://127.0.0.1:7003", "redis://127.0.0.1:7002", "redis://127.0.0.1:7001", "redis://127.0.0.1:7000" ] password: 123456 single: address: "redis://127.0.0.1:6379" database: 7
配置引數讀取類
先建立一個讀取屬性的類，通過註解@ConfigurationProperties讀取YAML中定義的屬性：
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.io.Serializable;
import java.util.List;
@Data
@Component
@ConfigurationProperties(prefix = "spring.redis")
public class RedisConfigProperties implements Serializable {
private static final long serialVersionUID = 8815222005846355408L;
private String password;
private cluster cluster;
private Single single;
public static class cluster {
private List<String> nodeAddresses;
public List<String> getNodeAddresses() {
return nodeAddresses;
}
public void setNodeAddresses(List<String> nodeAddresses) {
this.nodeAddresses = nodeAddresses;
}
@Override
public String toString() {
return "{" +
"nodeAddresses=" + nodeAddresses +
'}';
}
}
public static class Single {
private String address;
public Integer database;
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public Integer getDatabase() {
return database;
}
public void setDatabase(Integer database) {
this.database = database;
}
@Override
public String toString() {
return "Single{" +
"address='" + address + '\'' +
", database=" + database +
'}';
}
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public RedisConfigProperties.cluster getCluster() {
return cluster;
}
public void setCluster(RedisConfigProperties.cluster cluster) {
this.cluster = cluster;
}
}
@ConfigurationProperties(prefix = "spring.redis")用於限制上述配置類只讀取redis屬性。
Redisson 客戶端配置
所有對Redisson的使用都是通過RedissonClient，呼叫如下方法 getRedissonClient() 創建出RedissonClient例項：
import lombok.extern.slf4j.Slf4j;
import org.redisson.Redisson;
import org.redisson.api.RedissonClient;
import org.redisson.client.codec.StringCodec;
import org.redisson.config.ClusterServersConfig;
import org.redisson.config.Config;
import org.redisson.config.SingleServerConfig;
import org.redisson.config.TransportMode;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.io.IOException;
import java.util.List;
@Slf4j
@Configuration
public class MyRedissonConfig {
@Autowired(required = false)
private RedisConfigProperties redisConfigProperties;
/**
* 配置redisson叢集
* @return
*/
@Bean(destroyMethod = "shutdown")
public RedissonClient getRedissonClient() {
List<String> clusterNodes = redisConfigProperties.getCluster().getNodeAddresses();
log.info("【Redisson 配置】：{}", redisConfigProperties);
Config config = new Config();
//物件編碼選擇純字串編碼
config.setCodec(StringCodec.INSTANCE);
ClusterServersConfig clusterServersConfig = config.useClusterServers()
.addNodeAddress(clusterNodes.toArray(new String[clusterNodes.size()]));
//設定密碼
clusterServersConfig.setPassword(redisConfigProperties.getPassword());
//redis連線心跳檢測，防止一段時間過後，與redis的連線斷開
clusterServersConfig.setPingConnectionInterval(32000);
return Redisson.create(config);
}
/**
* 單機配置
* @return
* @throws IOException
*/
/* @Bean(destroyMethod = "shutdown")
RedissonClient singleRedisson() throws IOException {
log.info("【Redisson 配置】：{}", redisConfigProperties);
// 建立配置
Config config = new Config();
config.setCodec(StringCodec.INSTANCE);
config.setTransportMode(TransportMode.NIO);
SingleServerConfig singleServerConfig = config.useSingleServer()
.setAddress(redisConfigProperties.getSingle().getAddress())
.setDatabase(redisConfigProperties.getSingle().getDatabase());
return Redisson.create(config);
}*/
}
得到redisson物件，之後的分散式鎖由redisson物件操作。節點地址nodeAddress一般為多個，這些配置資訊放在yml中。java bean中已經給所有需要配置的屬性寫上了官方預設的初始值，你如果不考慮更改預設值，實際上只需要在application.properties新增redis連線地址就好：
#redis 單機地址
spring.redisson.address=192.168.1.204:6379
配置了redisson的資訊之後，就可以在專案中使用@Autowired注入org.redisson.api.RedissonClient（redisson提供的預設實現類是org.redisson.Redisson，且redisson-spring-boot-starter會自動往IOC容器中註冊org.redisson.Redisson）。啟動專案，在控制檯將列印配置資訊：
2022-05-03 10:51:32.102 [main] INFO -c.c.i.m.xxx.MyRedissonConfig - 【Redisson 配置】：RedisConfigProperties(password=123456, cluster={nodeAddresses=[redis://127.0.0.1:7005, redis://127.0.0.1:7004, redis://127.0.0.1:7003, redis://127.0.0.1:7002, redis://127.0.0.1:7001, redis://127.0.0.1:7000]}, single=Single{address='redis://127.0.0.1:6379', database=7})
由此可見，配置類已經成功載入YAML中的配置資訊。
知行合一
整合Redisson後，可用的 Spring Beans包括如下幾個：
- RedissonClient
- RedissonRxClient
- RedissonReactiveClient
- RedisTemplate
- ReactiveRedisTemplate
下面提供一個使用Bean RedissonClient操作String的示例：
@Autowired
private RedissonClient redissonClient;
private static void demo() {
RBucket<Object> bucket = redissonClient.getBucket("string-demo");
bucket.set("hello");
System.out.println(bucket.get());
}
結束語
本文主要為大家介紹了在spring boot中，整合redisson的最佳實踐。有需要的朋友可以拿來即用，希望能夠對大家有所幫助。
“我亦無他，惟手熟爾。”合理利用自己每一分每一秒的時間來學習提升自己，不要再用"沒有時間“來掩飾自己思想上的懶惰！趁年輕，使勁拼，給未來的自己一個交代！祝各位早日升職加薪！