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 官網的一張圖說明:
本文將給出 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@Beanpublic JedisConnectionFactory redisConnectionFactory() { return new JedisConnectionFactory(new RedisStandaloneConfiguration());}
Luttuce
@Beanpublic LettuceConnectionFactory redisConnectionFactory2() {// LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisSocketConfiguration("/var/run/redis.sock")); LettuceConnectionFactory factory = new LettuceConnectionFactory(new RedisStandaloneConfiguration()); return factory;}
Spring Data Redis配置類有3個:
// 單點redisRedisStandaloneConfiguration config = new RedisStandaloneConfiguration();// 哨兵redisRedisSentinelConfiguration config = new RedisSentinelConfiguration();// 叢集redisRedisClusterConfiguration config = new RedisClusterConfiguration();
本篇都使用單點配置,叢集相關知識放在 Redis 專題講解
配置快取管理
@Beanpublic 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
@Autowiredprivate RedisTemplate redisTemplate;
我們也可以自己建立 RedisTemplate 物件定義資料儲存時序列化與反序列化的方式
@Beanpublic 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剩餘過期時間,返回毫秒
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