Spring Data Redis 最佳實踐！

  • 2020 年 3 月 26 日
  • 筆記

Spring Data Redis 是Spring 框架提供的用於操作Redis的方式，最近整理了下它的用法，解決了使用過程中遇到的一些難點與坑點，希望對大家有所幫助。本文涵蓋了Redis的安裝、Spring Cache結合Redis的使用、Redis連接池的使用和RedisTemplate的使用等內容。

Redis安裝

這裡提供Linux和Windows兩種安裝方式，由於Windows下的版本最高只有3.2版本，所以推薦使用Linux下的版本，目前最新穩定版本為5.0，也是本文中使用的版本。

Linux

這裡我們使用Docker環境下的安裝方式。

  • 下載Redis5.0的Docker鏡像；
docker pull redis:5.0
  • 使用Docker命令啟動Redis容器；
docker run -p 6379:6379 --name redis   -v /mydata/redis/data:/data   -d redis:5.0 redis-server --appendonly yes

Windows

想使用Windows版本的朋友可以使用以下安裝方式。

  • 下載Windows版本的Redis,下載地址：https://github.com/MicrosoftArchive/redis/releases
  • 下載完後解壓到指定目錄；
  • 在當前地址欄輸入cmd後，執行redis的啟動命令：redis-server.exe redis.windows.conf

Spring Cache 操作Redis

Spring Cache 簡介

當Spring Boot 結合Redis來作為快取使用時，最簡單的方式就是使用Spring Cache了，使用它我們無需知道Spring中對Redis的各種操作，僅僅通過它提供的@Cacheable 、@CachePut 、@CacheEvict 、@EnableCaching等註解就可以實現快取功能。

常用註解

@EnableCaching

開啟快取功能，一般放在啟動類上。

@Cacheable

使用該註解的方法當快取存在時，會從快取中獲取數據而不執行方法，當快取不存在時，會執行方法並把返回結果存入快取中。一般使用在查詢方法上，可以設置如下屬性：

  • value：快取名稱（必填），指定快取的命名空間；
  • key：用於設置在命名空間中的快取key值，可以使用SpEL表達式定義；
  • unless：條件符合則不快取；
  • condition：條件符合則快取。

@CachePut

使用該註解的方法每次執行時都會把返回結果存入快取中。一般使用在新增方法上，可以設置如下屬性：

  • value：快取名稱（必填），指定快取的命名空間；
  • key：用於設置在命名空間中的快取key值，可以使用SpEL表達式定義；
  • unless：條件符合則不快取；
  • condition：條件符合則快取。

@CacheEvict

使用該註解的方法執行時會清空指定的快取。一般使用在更新或刪除方法上，可以設置如下屬性：

  • value：快取名稱（必填），指定快取的命名空間；
  • key：用於設置在命名空間中的快取key值，可以使用SpEL表達式定義；
  • condition：條件符合則快取。

使用步驟

  • 在pom.xml中添加項目依賴：
<!--redis依賴配置-->  <dependency>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-starter-data-redis</artifactId>  </dependency>
  • 修改配置文件application.yml，添加Redis的連接配置；
spring:    redis:      host: 192.168.6.139 # Redis伺服器地址      database: 0 # Redis資料庫索引（默認為0）      port: 6379 # Redis伺服器連接埠      password: # Redis伺服器連接密碼（默認為空）      timeout: 1000ms # 連接超時時間
  • 在啟動類上添加@EnableCaching註解啟動快取功能；
@EnableCaching  @SpringBootApplication  public class MallTinyApplication {        public static void main(String[] args) {          SpringApplication.run(MallTinyApplication.class, args);      }    }
  • 接下來在PmsBrandServiceImpl類中使用相關註解來實現快取功能，可以發現我們獲取品牌詳情的方法中使用了@Cacheable註解，在修改和刪除品牌的方法上使用了@CacheEvict註解；
/**   * PmsBrandService實現類   * Created by macro on 2019/4/19.   */  @Service  public class PmsBrandServiceImpl implements PmsBrandService {      @Autowired      private PmsBrandMapper brandMapper;        @CacheEvict(value = RedisConfig.REDIS_KEY_DATABASE, key = "'pms:brand:'+#id")      @Override      public int update(Long id, PmsBrand brand) {          brand.setId(id);          return brandMapper.updateByPrimaryKeySelective(brand);      }        @CacheEvict(value = RedisConfig.REDIS_KEY_DATABASE, key = "'pms:brand:'+#id")      @Override      public int delete(Long id) {          return brandMapper.deleteByPrimaryKey(id);      }        @Cacheable(value = RedisConfig.REDIS_KEY_DATABASE, key = "'pms:brand:'+#id", unless = "#result==null")      @Override      public PmsBrand getItem(Long id) {          return brandMapper.selectByPrimaryKey(id);      }    }
  • 我們可以調用獲取品牌詳情的介面測試下效果，此時發現Redis中存儲的數據有點像亂碼，並且沒有設置過期時間；

存儲JSON格式數據

此時我們就會想到有沒有什麼辦法讓Redis中存儲的數據變成標準的JSON格式，然後可以設置一定的過期時間，不設置過期時間容易產生很多不必要的快取數據。

  • 我們可以通過給RedisTemplate設置JSON格式的序列化器，並通過配置RedisCacheConfiguration設置超時時間來實現以上需求，此時別忘了去除啟動類上的@EnableCaching註解，具體配置類RedisConfig程式碼如下；
/**   * Redis配置類   * Created by macro on 2020/3/2.   */  @EnableCaching  @Configuration  public class RedisConfig extends CachingConfigurerSupport {        /**       * redis資料庫自定義key       */      public  static final String REDIS_KEY_DATABASE="mall";        @Bean      public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {          RedisSerializer<Object> serializer = redisSerializer();          RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();          redisTemplate.setConnectionFactory(redisConnectionFactory);          redisTemplate.setKeySerializer(new StringRedisSerializer());          redisTemplate.setValueSerializer(serializer);          redisTemplate.setHashKeySerializer(new StringRedisSerializer());          redisTemplate.setHashValueSerializer(serializer);          redisTemplate.afterPropertiesSet();          return redisTemplate;      }        @Bean      public RedisSerializer<Object> redisSerializer() {          //創建JSON序列化器          Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<>(Object.class);          ObjectMapper objectMapper = new ObjectMapper();          objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);          objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);          serializer.setObjectMapper(objectMapper);          return serializer;      }        @Bean      public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory) {          RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);          //設置Redis快取有效期為1天          RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()                  .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer())).entryTtl(Duration.ofDays(1));          return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);      }    }
  • 此時我們再次調用獲取商品詳情的介面進行測試，會發現Redis中已經快取了標準的JSON格式數據，並且超時時間被設置為了1天。

使用Redis連接池

SpringBoot 1.5.x版本Redis客戶端默認是Jedis實現的，SpringBoot 2.x版本中默認客戶端是用Lettuce實現的，我們先來了解下Jedis和Lettuce客戶端。

Jedis vs Lettuce

Jedis在實現上是直連Redis服務，多執行緒環境下非執行緒安全，除非使用連接池，為每個 RedisConnection 實例增加物理連接。

Lettuce是一種可伸縮，執行緒安全，完全非阻塞的Redis客戶端，多個執行緒可以共享一個RedisConnection，它利用Netty NIO框架來高效地管理多個連接，從而提供了非同步和同步數據訪問方式，用於構建非阻塞的反應性應用程式。

使用步驟

  • 修改application.yml添加Lettuce連接池配置，用於配置執行緒數量和阻塞等待時間；
spring:    redis:      lettuce:        pool:          max-active: 8 # 連接池最大連接數          max-idle: 8 # 連接池最大空閑連接數          min-idle: 0 # 連接池最小空閑連接數          max-wait: -1ms # 連接池最大阻塞等待時間，負值表示沒有限制
  • 由於SpringBoot 2.x中默認並沒有使用Redis連接池，所以需要在pom.xml中添加commons-pool2的依賴；
<dependency>      <groupId>org.apache.commons</groupId>      <artifactId>commons-pool2</artifactId>  </dependency>
  • 如果你沒添加以上依賴的話，啟動應用的時候就會產生如下錯誤；
Caused by: java.lang.NoClassDefFoundError: org/apache/commons/pool2/impl/GenericObjectPoolConfig  	at org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration$LettucePoolingClientConfigurationBuilder.<init>(LettucePoolingClientConfiguration.java:84) ~[spring-data-redis-2.1.5.RELEASE.jar:2.1.5.RELEASE]  	at org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration.builder(LettucePoolingClientConfiguration.java:48) ~[spring-data-redis-2.1.5.RELEASE.jar:2.1.5.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$PoolBuilderFactory.createBuilder(LettuceConnectionConfiguration.java:149) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration.createBuilder(LettuceConnectionConfiguration.java:107) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration.getLettuceClientConfiguration(LettuceConnectionConfiguration.java:93) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration.redisConnectionFactory(LettuceConnectionConfiguration.java:74) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$$EnhancerBySpringCGLIB$$5caa7e47.CGLIB$redisConnectionFactory$0(<generated>) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$$EnhancerBySpringCGLIB$$5caa7e47$$FastClassBySpringCGLIB$$b8ae2813.invoke(<generated>) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at org.springframework.cglib.proxy.MethodProxy.invokeSuper(MethodProxy.java:244) ~[spring-core-5.1.5.RELEASE.jar:5.1.5.RELEASE]  	at org.springframework.context.annotation.ConfigurationClassEnhancer$BeanMethodInterceptor.intercept(ConfigurationClassEnhancer.java:363) ~[spring-context-5.1.5.RELEASE.jar:5.1.5.RELEASE]  	at org.springframework.boot.autoconfigure.data.redis.LettuceConnectionConfiguration$$EnhancerBySpringCGLIB$$5caa7e47.redisConnectionFactory(<generated>) ~[spring-boot-autoconfigure-2.1.3.RELEASE.jar:2.1.3.RELEASE]  	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_91]  	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_91]  	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_91]  	at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_91]  	at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:154) ~[spring-beans-5.1.5.RELEASE.jar:5.1.5.RELEASE]  	... 111 common frames omitted

自由操作Redis

Spring Cache 給我們提供了操作Redis快取的便捷方法，但是也有很多局限性。比如說我們想單獨設置一個快取值的有效期怎麼辦？我們並不想快取方法的返回值，我們想快取方法中產生的中間值怎麼辦？此時我們就需要用到RedisTemplate這個類了，接下來我們來講下如何通過RedisTemplate來自由操作Redis中的快取。

RedisService

定義Redis操作業務類，在Redis中有幾種數據結構，比如普通結構（對象），Hash結構、Set結構、List結構，該介面中定義了大多數常用操作方法。

/**   * redis操作Service   * Created by macro on 2020/3/3.   */  public interface RedisService {        /**       * 保存屬性       */      void set(String key, Object value, long time);        /**       * 保存屬性       */      void set(String key, Object value);        /**       * 獲取屬性       */      Object get(String key);        /**       * 刪除屬性       */      Boolean del(String key);        /**       * 批量刪除屬性       */      Long del(List<String> keys);        /**       * 設置過期時間       */      Boolean expire(String key, long time);        /**       * 獲取過期時間       */      Long getExpire(String key);        /**       * 判斷是否有該屬性       */      Boolean hasKey(String key);        /**       * 按delta遞增       */      Long incr(String key, long delta);        /**       * 按delta遞減       */      Long decr(String key, long delta);        /**       * 獲取Hash結構中的屬性       */      Object hGet(String key, String hashKey);        /**       * 向Hash結構中放入一個屬性       */      Boolean hSet(String key, String hashKey, Object value, long time);        /**       * 向Hash結構中放入一個屬性       */      void hSet(String key, String hashKey, Object value);        /**       * 直接獲取整個Hash結構       */      Map<Object, Object> hGetAll(String key);        /**       * 直接設置整個Hash結構       */      Boolean hSetAll(String key, Map<String, Object> map, long time);        /**       * 直接設置整個Hash結構       */      void hSetAll(String key, Map<String, Object> map);        /**       * 刪除Hash結構中的屬性       */      void hDel(String key, Object... hashKey);        /**       * 判斷Hash結構中是否有該屬性       */      Boolean hHasKey(String key, String hashKey);        /**       * Hash結構中屬性遞增       */      Long hIncr(String key, String hashKey, Long delta);        /**       * Hash結構中屬性遞減       */      Long hDecr(String key, String hashKey, Long delta);        /**       * 獲取Set結構       */      Set<Object> sMembers(String key);        /**       * 向Set結構中添加屬性       */      Long sAdd(String key, Object... values);        /**       * 向Set結構中添加屬性       */      Long sAdd(String key, long time, Object... values);        /**       * 是否為Set中的屬性       */      Boolean sIsMember(String key, Object value);        /**       * 獲取Set結構的長度       */      Long sSize(String key);        /**       * 刪除Set結構中的屬性       */      Long sRemove(String key, Object... values);        /**       * 獲取List結構中的屬性       */      List<Object> lRange(String key, long start, long end);        /**       * 獲取List結構的長度       */      Long lSize(String key);        /**       * 根據索引獲取List中的屬性       */      Object lIndex(String key, long index);        /**       * 向List結構中添加屬性       */      Long lPush(String key, Object value);        /**       * 向List結構中添加屬性       */      Long lPush(String key, Object value, long time);        /**       * 向List結構中批量添加屬性       */      Long lPushAll(String key, Object... values);        /**       * 向List結構中批量添加屬性       */      Long lPushAll(String key, Long time, Object... values);        /**       * 從List結構中移除屬性       */      Long lRemove(String key, long count, Object value);  }

RedisServiceImpl

RedisService的實現類，使用RedisTemplate來自由操作Redis中的快取數據。

/**   * redis操作實現類   * Created by macro on 2020/3/3.   */  @Service  public class RedisServiceImpl implements RedisService {      @Autowired      private RedisTemplate<String, Object> redisTemplate;        @Override      public void set(String key, Object value, long time) {          redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);      }        @Override      public void set(String key, Object value) {          redisTemplate.opsForValue().set(key, value);      }        @Override      public Object get(String key) {          return redisTemplate.opsForValue().get(key);      }        @Override      public Boolean del(String key) {          return redisTemplate.delete(key);      }        @Override      public Long del(List<String> keys) {          return redisTemplate.delete(keys);      }        @Override      public Boolean expire(String key, long time) {          return redisTemplate.expire(key, time, TimeUnit.SECONDS);      }        @Override      public Long getExpire(String key) {          return redisTemplate.getExpire(key, TimeUnit.SECONDS);      }        @Override      public Boolean hasKey(String key) {          return redisTemplate.hasKey(key);      }        @Override      public Long incr(String key, long delta) {          return redisTemplate.opsForValue().increment(key, delta);      }        @Override      public Long decr(String key, long delta) {          return redisTemplate.opsForValue().increment(key, -delta);      }        @Override      public Object hGet(String key, String hashKey) {          return redisTemplate.opsForHash().get(key, hashKey);      }        @Override      public Boolean hSet(String key, String hashKey, Object value, long time) {          redisTemplate.opsForHash().put(key, hashKey, value);          return expire(key, time);      }        @Override      public void hSet(String key, String hashKey, Object value) {          redisTemplate.opsForHash().put(key, hashKey, value);      }        @Override      public Map<Object, Object> hGetAll(String key) {          return redisTemplate.opsForHash().entries(key);      }        @Override      public Boolean hSetAll(String key, Map<String, Object> map, long time) {          redisTemplate.opsForHash().putAll(key, map);          return expire(key, time);      }        @Override      public void hSetAll(String key, Map<String, Object> map) {          redisTemplate.opsForHash().putAll(key, map);      }        @Override      public void hDel(String key, Object... hashKey) {          redisTemplate.opsForHash().delete(key, hashKey);      }        @Override      public Boolean hHasKey(String key, String hashKey) {          return redisTemplate.opsForHash().hasKey(key, hashKey);      }        @Override      public Long hIncr(String key, String hashKey, Long delta) {          return redisTemplate.opsForHash().increment(key, hashKey, delta);      }        @Override      public Long hDecr(String key, String hashKey, Long delta) {          return redisTemplate.opsForHash().increment(key, hashKey, -delta);      }        @Override      public Set<Object> sMembers(String key) {          return redisTemplate.opsForSet().members(key);      }        @Override      public Long sAdd(String key, Object... values) {          return redisTemplate.opsForSet().add(key, values);      }        @Override      public Long sAdd(String key, long time, Object... values) {          Long count = redisTemplate.opsForSet().add(key, values);          expire(key, time);          return count;      }        @Override      public Boolean sIsMember(String key, Object value) {          return redisTemplate.opsForSet().isMember(key, value);      }        @Override      public Long sSize(String key) {          return redisTemplate.opsForSet().size(key);      }        @Override      public Long sRemove(String key, Object... values) {          return redisTemplate.opsForSet().remove(key, values);      }        @Override      public List<Object> lRange(String key, long start, long end) {          return redisTemplate.opsForList().range(key, start, end);      }        @Override      public Long lSize(String key) {          return redisTemplate.opsForList().size(key);      }        @Override      public Object lIndex(String key, long index) {          return redisTemplate.opsForList().index(key, index);      }        @Override      public Long lPush(String key, Object value) {          return redisTemplate.opsForList().rightPush(key, value);      }        @Override      public Long lPush(String key, Object value, long time) {          Long index = redisTemplate.opsForList().rightPush(key, value);          expire(key, time);          return index;      }        @Override      public Long lPushAll(String key, Object... values) {          return redisTemplate.opsForList().rightPushAll(key, values);      }        @Override      public Long lPushAll(String key, Long time, Object... values) {          Long count = redisTemplate.opsForList().rightPushAll(key, values);          expire(key, time);          return count;      }        @Override      public Long lRemove(String key, long count, Object value) {          return redisTemplate.opsForList().remove(key, count, value);      }  }

RedisController

測試RedisService中快取操作的Controller，大家可以調用測試下。

/**   * Redis測試Controller   * Created by macro on 2020/3/3.   */  @Api(tags = "RedisController", description = "Redis測試")  @Controller  @RequestMapping("/redis")  public class RedisController {      @Autowired      private RedisService redisService;      @Autowired      private PmsBrandService brandService;        @ApiOperation("測試簡單快取")      @RequestMapping(value = "/simpleTest", method = RequestMethod.GET)      @ResponseBody      public CommonResult<PmsBrand> simpleTest() {          List<PmsBrand> brandList = brandService.list(1, 5);          PmsBrand brand = brandList.get(0);          String key = "redis:simple:" + brand.getId();          redisService.set(key, brand);          PmsBrand cacheBrand = (PmsBrand) redisService.get(key);          return CommonResult.success(cacheBrand);      }        @ApiOperation("測試Hash結構的快取")      @RequestMapping(value = "/hashTest", method = RequestMethod.GET)      @ResponseBody      public CommonResult<PmsBrand> hashTest() {          List<PmsBrand> brandList = brandService.list(1, 5);          PmsBrand brand = brandList.get(0);          String key = "redis:hash:" + brand.getId();          Map<String, Object> value = BeanUtil.beanToMap(brand);          redisService.hSetAll(key, value);          Map<Object, Object> cacheValue = redisService.hGetAll(key);          PmsBrand cacheBrand = BeanUtil.mapToBean(cacheValue, PmsBrand.class, true);          return CommonResult.success(cacheBrand);      }        @ApiOperation("測試Set結構的快取")      @RequestMapping(value = "/setTest", method = RequestMethod.GET)      @ResponseBody      public CommonResult<Set<Object>> setTest() {          List<PmsBrand> brandList = brandService.list(1, 5);          String key = "redis:set:all";          redisService.sAdd(key, (Object[]) ArrayUtil.toArray(brandList, PmsBrand.class));          redisService.sRemove(key, brandList.get(0));          Set<Object> cachedBrandList = redisService.sMembers(key);          return CommonResult.success(cachedBrandList);      }        @ApiOperation("測試List結構的快取")      @RequestMapping(value = "/listTest", method = RequestMethod.GET)      @ResponseBody      public CommonResult<List<Object>> listTest() {          List<PmsBrand> brandList = brandService.list(1, 5);          String key = "redis:list:all";          redisService.lPushAll(key, (Object[]) ArrayUtil.toArray(brandList, PmsBrand.class));          redisService.lRemove(key, 1, brandList.get(0));          List<Object> cachedBrandList = redisService.lRange(key, 0, 3);          return CommonResult.success(cachedBrandList);      }  }

項目源碼地址

https://github.com/macrozheng/mall-learning/tree/master/mall-tiny-redis

VirMach 便宜 VPS

QNews

QNews