Redis 是一個高性能的Key-Value內存數據庫。Spring 官方對 Redis 提供支持，使用 Spring Data Redis 可以選擇 Jedis 或 Lettuce 客戶端，在 Spring Boot 項目中操作 Redis 簡單方便。

Spring Data Redis 是 Spring Data 家族的一部分，它提供了配置方法和訪問 Redis 接口的抽象。在內底層實現上，我們可以選擇使用 Jedis 或 Lettuce 來訪問 Redis 數據庫。

Jedis 和 Lettuce 都是 Redis 的客戶端。簡單來說，Jedis 是社區的開源項目， Lettuce的連接是基于Netty的，關于他們的比較，引用 Spring Data Redis 官網的一張圖說明：

lettuce-jedis-compare.png

本文將給出 Jedis 和 Lettuce 兩種集成方法。

引入依賴

• 在pom.xml文件中加入

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

不用指定版本，因為在 Spring Boot 應用中，spring-boot-dependencies 中聲明了版本信息，也是和現 Spring Boot 版本契合度最高的。自己手動指定可能會引發不可意料的兼容問題。

• 如果使用 jedis ，則引入

<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>{version}</version>
</dependency>

• 如果使用 Luttuce ，則引入

<dependency>
    <groupId>io.lettuce</groupId>
    <artifactId>lettuce-core</artifactId>
    <version>{version}</version>
</dependency>

我現在所使用的 Spring Data Redis 2.3.x 版本默認使用 Luttuce 且已引入依賴。

配置

• 在 application.xml 中加入

spring:
  redis:
    host: 127.0.0.1 # redis ip
    port: 6379 # redis 端口
    password: # redis 登錄密碼
    database: 1 # 數據庫
    ssl: false
    timeout: 2s

以上是連接 Redis 的通用配置，Spring Boot 支持對 Jedis 或 Luttuce 的一些屬性進行配置。更多請參考Spring Boot Data Properties

使用

創建 RedisConnectionFactory 工廠

• Jedis

@Bean
public JedisConnectionFactory redisConnectionFactory() {
    return new JedisConnectionFactory(new RedisStandaloneConfiguration());
}

• Luttuce

@Bean
public LettuceConnectionFactory redisConnectionFactory2() {
//    LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisSocketConfiguration("/var/run/redis.sock"));
    LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisStandaloneConfiguration());
    return factory;
}

Spring Data Redis配置類有3個：

// 單點redis
RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
// 哨兵redis
RedisSentinelConfiguration config = new RedisSentinelConfiguration();
// 集群redis
RedisClusterConfiguration config = new RedisClusterConfiguration();

本篇都使用單點配置，集群相關知識放在 Redis 專題講解

配置緩存管理

@Bean
public CacheManager cacheManager(RedisConnectionFactory factory) {

    RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig();
    // 設置緩存的默認超時時間：30分鐘
    redisCacheConfiguration.entryTtl(Duration.ofMinutes(30L));
    // 如果是空值，不緩存
    redisCacheConfiguration.disableCachingNullValues();
    // 設置key序列化器
    redisCacheConfiguration.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()));
    // 設置value序列化器
    redisCacheConfiguration.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));

    RedisCacheManager.RedisCacheManagerBuilder build = RedisCacheManager.builder(RedisCacheWriter.nonLockingRedisCacheWriter(factory));
    RedisCacheManager cacheManager = build.cacheDefaults(redisCacheConfiguration).build();

    return cacheManager;
}

經過以上配置，Spring Boot 會自動裝配，直接使用 RedisTemplate 操作 Redis

@Autowired
private RedisTemplate redisTemplate;

我們也可以自己創建 RedisTemplate 對象定義數據存儲時序列化與反序列化的方式

@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {

    RedisTemplate<String, Object> template = new RedisTemplate<>();
    template.setConnectionFactory(factory);
    Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
    ObjectMapper om = new ObjectMapper();
    om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
    om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
    jackson2JsonRedisSerializer.setObjectMapper(om);
    StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
    // key采用String的序列化方式
    template.setKeySerializer(stringRedisSerializer);
    // hash的key也采用String的序列化方式
    template.setHashKeySerializer(stringRedisSerializer);
    // value序列化方式采用jackson
    template.setValueSerializer(jackson2JsonRedisSerializer);
    // hash的value序列化方式采用jackson
    template.setHashValueSerializer(jackson2JsonRedisSerializer);
    template.afterPropertiesSet();

    return template;
}

RedisTemplate 類

RedisTemplate 是 Spring Data Redis 中提供用來訪問 Redis 的類。以下是它的一些常用方法：

Boolean hasKey(key)
Redis 中 key 是否存在

Long getExpire(key)
獲取key剩余過期時間，返回毫秒

Boolean delete(key)
刪除key

SetOperations opsForSet()
獲取set類型數據操作對象

ListOperations opsForList()
獲取list類型數據操作對象

ValueOperations opsForValue()
獲取鍵值數據操作對象

HashOperations opsForHash()
獲取Map數據操作對象

更多方法參考官方API文檔：RedisTemplate

基于 Redis 的分布式鎖

在 Redis中使用 setnx 和 expire 可以實現分布式鎖，以下是它的用法：

set key value [EX seconds] [PX milliseconds] [NX|XX]

EX seconds：設置失效時長，單位秒
PX milliseconds：設置失效時長，單位毫秒
NX：key不存在時設置value，成功返回OK，失敗返回(nil)
XX：key存在時設置value，成功返回OK，失敗返回(nil)

setnx不能同時完成expire設置失效時長，不能保證setnx和expire的原子性，所以在做分布式鎖時要合成一條命令使用。

在 Jedis 提供的API中是有 setNX 方法的，在 RedisTemplate 中可以這樣：

Boolean flag = redisTemplate.opsForValue().setIfAbsent(lockKey, value, 10, TimeUnit.SECONDS);
if (!flag) {
    // 已鎖定
}

系統使用 Redis 做緩存能極大提高性能。后續會發布 Spring 緩存的使用。

除非注明，否則均為"攻城獅·正"原創文章，轉載請注明出處。
本文鏈接：https://engr-z.com/129.html