Spring Boot 2.0 整合 Redis（Lettuce）

【Redis 系列】 Redis 數(shù)據(jù)類型
【Redis 系列】 Redis 數(shù)據(jù)命令
【Redis 系列】 Redis 發(fā)布訂閱與事物

一、前言

在前面的幾篇文章中簡單的總結(jié)了一下Redis相關(guān)的知識。本章主要講解一下 Spring Boot 2.0 整合 Redis。Jedis 和 Lettuce 是 Java 操作 Redis 的客戶端。在 Spring Boot 1.x 版本默認(rèn)使用的是 jedis ，而在 Spring Boot 2.x 版本默認(rèn)使用的就是Lettuce。關(guān)于 Jedis 跟 Lettuce 的區(qū)別如下：

  • Jedis在實現(xiàn)上是直接連接的redis server，如果在多線程環(huán)境下是非線程安全的，這個時候只有使用連接池，為每個Jedis實例增加物理連接
  • Lettuce的連接是基于Netty的，連接實例（StatefulRedisConnection）可以在多個線程間并發(fā)訪問，應(yīng)為StatefulRedisConnection是線程安全的，所以一個連接實例（StatefulRedisConnection）就可以滿足多線程環(huán)境下的并發(fā)訪問，當(dāng)然這個也是可伸縮的設(shè)計，一個連接實例不夠的情況也可以按需增加連接實例。

二、示例

本章的示例工程是基于Gradle構(gòu)建的，有需要的朋友可以自己轉(zhuǎn)成Maven構(gòu)建。

2.1 依賴

在build.gradle文件中新增redis的依賴

buildscript {
    ext {
        springBootVersion = '2.1.0.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

group = 'priv.simon.springboot'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
    mavenCentral()
}


dependencies {
    implementation('org.springframework.boot:spring-boot-starter-data-redis')
    implementation('org.springframework.boot:spring-boot-starter-web')
    testImplementation('org.springframework.boot:spring-boot-starter-test')
}

2.2 配置文件

lettuce的默認(rèn)配置已經(jīng)基本滿足需求了，如果有需要可以自行配置

##端口號
server.port=8888

# Redis數(shù)據(jù)庫索引（默認(rèn)為0）
spring.redis.database=0
# Redis服務(wù)器地址
spring.redis.host=localhost
# Redis服務(wù)器連接端口
spring.redis.port=6379
# Redis服務(wù)器連接密碼（默認(rèn)為空）
spring.redis.password=
##連接池最大連接數(shù)（使用負(fù)值表示沒有限制） 默認(rèn)8
#spring.redis.lettuce.pool.max-active=8
## 連接池中的最大空閑連接 默認(rèn)8
#spring.redis.lettuce.pool.max-idle=8
## 連接池中的最小空閑連接 默認(rèn)0
#spring.redis.lettuce.pool.min-idle=0
## 連接池最大阻塞等待時間（使用負(fù)值表示沒有限制） 默認(rèn) -1
#spring.redis.lettuce.pool.max-wait=-1
# 連接超時時間（毫秒）
spring.redis.timeout=200

2.3 RredisTemplate 配置

2.3.1 RredisTemplate自動配置

在引入redis的依賴后，RredisTemplate會自動配置，可以直接注入RedisTemplate使用。

@Configuration
@ConditionalOnClass(RedisOperations.class)
@EnableConfigurationProperties(RedisProperties.class)
@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
public class RedisAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<Object, Object> redisTemplate(
            RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        RedisTemplate<Object, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

    @Bean
    @ConditionalOnMissingBean
    public StringRedisTemplate stringRedisTemplate(
            RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

}

Spring Boot 自動幫我們在容器中生成了一個RedisTemplate和一個StringRedisTemplate。但是，這個RedisTemplate的泛型是<Object,Object>。這樣在寫代碼就很不方便，要寫好多類型轉(zhuǎn)換的代碼。

因為有@ConditionalOnMissingBean(name = "redisTemplate")注解,所以如果Spring容器中有一個name 為redisTemplate 的 RedisTemplate 對象那么這個自動配置的RedisTemplate就不會實例化。

2.3.2 配置一個RredisTemplate

我們需要一個泛型為<String,Object>形式的RedisTemplate，并且設(shè)置這個RedisTemplate在數(shù)據(jù)存在Redis時key及value的序列化方式(默認(rèn)使用的JdkSerializationRedisSerializer 這樣的會導(dǎo)致我們通過redis desktop manager顯示的我們key跟value的時候顯示不是正常字符)。

@Configuration
public class RedisConfig {
  @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 因為@Bean注解是根據(jù)方法名配置這個bean的name的，覆蓋默認(rèn)配置

2.4 Redis 操作的工具類

下面這個工具類包含Redis的一些基本操作，大家可以參考

/**
 * redis 工具類
 *
 * @author simon
 * @date 2018-11-28 10:35
 **/
 @Component
 public class RedisUtils {
   /**
    * 注入redisTemplate bean
    */
   @Autowired
   private RedisTemplate <String,Object> redisTemplate;

   /**
    * 指定緩存失效時間
    *
    * @param key  鍵
    * @param time 時間(秒)
    * @return
    */
   public boolean expire(String key, long time) {
     try {
       if (time > 0) {
         redisTemplate.expire(key, time, TimeUnit.SECONDS);
       }
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 根據(jù)key獲取過期時間
    *
    * @param key 鍵 不能為null
    * @return 時間(秒) 返回0代表為永久有效
    */
   public long getExpire(String key) {
     return redisTemplate.getExpire(key, TimeUnit.SECONDS);
   }

   /**
    * 判斷key是否存在
    *
    * @param key 鍵
    * @return true 存在 false不存在
    */
   public boolean hasKey(String key) {
     try {
       return redisTemplate.hasKey(key);
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 刪除緩存
    *
    * @param key 可以傳一個值 或多個
    */
   @SuppressWarnings("unchecked")
   public void del(String... key) {
     if (key != null && key.length > 0) {
       if (key.length == 1) {
         redisTemplate.delete(key[0]);
       } else {
         redisTemplate.delete(CollectionUtils.arrayToList(key));
       }
     }
   }
   // ============================String(字符串)=============================

   /**
    * 普通緩存獲取
    *
    * @param key 鍵
    * @return 值
    */
   public Object get(String key) {
     return key == null ? null : redisTemplate.opsForValue().get(key);
   }

   /**
    * 普通緩存放入
    *
    * @param key   鍵
    * @param value 值
    * @return true成功 false失敗
    */
   public boolean set(String key, Object value) {
     try {
       redisTemplate.opsForValue().set(key, value);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 普通緩存放入并設(shè)置時間
    *
    * @param key   鍵
    * @param value 值
    * @param time  時間(秒) time要大于0 如果time小于等于0 將設(shè)置無限期
    * @return true成功 false 失敗
    */
   public boolean set(String key, Object value, long time) {
     try {
       if (time > 0) {
         redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
       } else {
         set(key, value);
       }
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 遞增
    *
    * @param key   鍵
    * @param delta 要增加幾(大于0)
    * @return
    */
   public long incr(String key, long delta) {
     if (delta < 0) {
       throw new RuntimeException("遞增因子必須大于0");
     }
     return redisTemplate.opsForValue().increment(key, delta);
   }

   /**
    * 遞減
    *
    * @param key   鍵
    * @param delta 要減少幾(小于0)
    * @return
    */
   public long decr(String key, long delta) {
     if (delta < 0) {
       throw new RuntimeException("遞減因子必須大于0");
     }
     return redisTemplate.opsForValue().increment(key, -delta);
   }
   // ================================Hash(哈希)=================================

   /**
    * HashGet
    *
    * @param key  鍵 不能為null
    * @param item 項 不能為null
    * @return 值
    */
   public Object hget(String key, String item) {
     return redisTemplate.opsForHash().get(key, item);
   }

   /**
    * 獲取hashKey對應(yīng)的所有鍵值
    *
    * @param key 鍵
    * @return 對應(yīng)的多個鍵值
    */
   public Map <Object, Object> hmget(String key) {
     return redisTemplate.opsForHash().entries(key);
   }

   /**
    * HashSet
    *
    * @param key 鍵
    * @param map 對應(yīng)多個鍵值
    * @return true 成功 false 失敗
    */
   public boolean hmset(String key, Map <String, Object> map) {
     try {
       redisTemplate.opsForHash().putAll(key, map);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * HashSet 并設(shè)置時間
    *
    * @param key  鍵
    * @param map  對應(yīng)多個鍵值
    * @param time 時間(秒)
    * @return true成功 false失敗
    */
   public boolean hmset(String key, Map <String, Object> map, long time) {
     try {
       redisTemplate.opsForHash().putAll(key, map);
       if (time > 0) {
         expire(key, time);
       }
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 向一張hash表中放入數(shù)據(jù),如果不存在將創(chuàng)建
    *
    * @param key   鍵
    * @param item  項
    * @param value 值
    * @return true 成功 false失敗
    */
   public boolean hset(String key, String item, Object value) {
     try {
       redisTemplate.opsForHash().put(key, item, value);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 向一張hash表中放入數(shù)據(jù),如果不存在將創(chuàng)建
    *
    * @param key   鍵
    * @param item  項
    * @param value 值
    * @param time  時間(秒) 注意:如果已存在的hash表有時間,這里將會替換原有的時間
    * @return true 成功 false失敗
    */
   public boolean hset(String key, String item, Object value, long time) {
     try {
       redisTemplate.opsForHash().put(key, item, value);
       if (time > 0) {
         expire(key, time);
       }
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 刪除hash表中的值
    *
    * @param key  鍵 不能為null
    * @param item 項 可以使多個 不能為null
    */
   public void hdel(String key, Object... item) {
     redisTemplate.opsForHash().delete(key, item);
   }

   /**
    * 判斷hash表中是否有該項的值
    *
    * @param key  鍵 不能為null
    * @param item 項 不能為null
    * @return true 存在 false不存在
    */
   public boolean hHasKey(String key, String item) {
     return redisTemplate.opsForHash().hasKey(key, item);
   }

   /**
    * hash遞增 如果不存在,就會創(chuàng)建一個 并把新增后的值返回
    *
    * @param key  鍵
    * @param item 項
    * @param by   要增加幾(大于0)
    * @return
    */
   public double hincr(String key, String item, double by) {
     return redisTemplate.opsForHash().increment(key, item, by);
   }

   /**
    * hash遞減
    *
    * @param key  鍵
    * @param item 項
    * @param by   要減少記(小于0)
    * @return
    */
   public double hdecr(String key, String item, double by) {
     return redisTemplate.opsForHash().increment(key, item, -by);
   }
   // ============================Set(集合)=============================

   /**
    * 根據(jù)key獲取Set中的所有值
    *
    * @param key 鍵
    * @return
    */
   public Set <Object> sGet(String key) {
     try {
       return redisTemplate.opsForSet().members(key);
     } catch (Exception e) {
       e.printStackTrace();
       return null;
     }
   }

   /**
    * 根據(jù)value從一個set中查詢,是否存在
    *
    * @param key   鍵
    * @param value 值
    * @return true 存在 false不存在
    */
   public boolean sHasKey(String key, Object value) {
     try {
       return redisTemplate.opsForSet().isMember(key, value);
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 將數(shù)據(jù)放入set緩存
    *
    * @param key    鍵
    * @param values 值 可以是多個
    * @return 成功個數(shù)
    */
   public long sSet(String key, Object... values) {
     try {
       return redisTemplate.opsForSet().add(key, values);
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }

   /**
    * 將set數(shù)據(jù)放入緩存
    *
    * @param key    鍵
    * @param time   時間(秒)
    * @param values 值 可以是多個
    * @return 成功個數(shù)
    */
   public long sSetAndTime(String key, long time, Object... values) {
     try {
       Long count = redisTemplate.opsForSet().add(key, values);
       if (time > 0)
         expire(key, time);
       return count;
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }

   /**
    * 獲取set緩存的長度
    *
    * @param key 鍵
    * @return
    */
   public long sGetSetSize(String key) {
     try {
       return redisTemplate.opsForSet().size(key);
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }

   /**
    * 移除值為value的
    *
    * @param key    鍵
    * @param values 值 可以是多個
    * @return 移除的個數(shù)
    */
   public long setRemove(String key, Object... values) {
     try {
       Long count = redisTemplate.opsForSet().remove(key, values);
       return count;
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }
   // ===============================List(列表)=================================

   /**
    * 獲取list緩存的內(nèi)容
    *
    * @param key   鍵
    * @param start 開始
    * @param end   結(jié)束 0 到 -1代表所有值
    * @return
    */
   public List <Object> lGet(String key, long start, long end) {
     try {
       return redisTemplate.opsForList().range(key, start, end);
     } catch (Exception e) {
       e.printStackTrace();
       return null;
     }
   }

   /**
    * 獲取list緩存的長度
    *
    * @param key 鍵
    * @return
    */
   public long lGetListSize(String key) {
     try {
       return redisTemplate.opsForList().size(key);
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }

   /**
    * 通過索引 獲取list中的值
    *
    * @param key   鍵
    * @param index 索引 index>=0時， 0 表頭，1 第二個元素，依次類推；index<0時，-1，表尾，-2倒數(shù)第二個元素，依次類推
    * @return
    */
   public Object lGetIndex(String key, long index) {
     try {
       return redisTemplate.opsForList().index(key, index);
     } catch (Exception e) {
       e.printStackTrace();
       return null;
     }
   }

   /**
    * 將list放入緩存
    *
    * @param key   鍵
    * @param value 值
    * @return
    */
   public boolean lSet(String key, Object value) {
     try {
       redisTemplate.opsForList().rightPush(key, value);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 將list放入緩存
    *
    * @param key   鍵
    * @param value 值
    * @param time  時間(秒)
    * @return
    */
   public boolean lSet(String key, Object value, long time) {
     try {
       redisTemplate.opsForList().rightPush(key, value);
       if (time > 0)
         expire(key, time);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 將list放入緩存
    *
    * @param key   鍵
    * @param value 值
    * @return
    */
   public boolean lSet(String key, List <Object> value) {
     try {
       redisTemplate.opsForList().rightPushAll(key, value);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 將list放入緩存
    *
    * @param key   鍵
    * @param value 值
    * @param time  時間(秒)
    * @return
    */
   public boolean lSet(String key, List <Object> value, long time) {
     try {
       redisTemplate.opsForList().rightPushAll(key, value);
       if (time > 0)
         expire(key, time);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 根據(jù)索引修改list中的某條數(shù)據(jù)
    *
    * @param key   鍵
    * @param index 索引
    * @param value 值
    * @return
    */
   public boolean lUpdateIndex(String key, long index, Object value) {
     try {
       redisTemplate.opsForList().set(key, index, value);
       return true;
     } catch (Exception e) {
       e.printStackTrace();
       return false;
     }
   }

   /**
    * 移除N個值為value
    *
    * @param key   鍵
    * @param count 移除多少個
    * @param value 值
    * @return 移除的個數(shù)
    */
   public long lRemove(String key, long count, Object value) {
     try {
       Long remove = redisTemplate.opsForList().remove(key, count, value);
       return remove;
     } catch (Exception e) {
       e.printStackTrace();
       return 0;
     }
   }
 }

具體測試部分就省略了。

源代碼下載

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,279評論 6贊 342
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具（例如配置管理，服務(wù)發(fā)現(xiàn)，斷路器，智...
    卡卡羅2017閱讀 136,641評論 19贊 139
  • 剛讀大學(xué)的時候，寢室兄弟教我申請QQ號，我記得自己取了名字叫做“祖父藍(lán)”。他不理解，覺得這是什么鬼。其實我是想到了...
    逗號commas閱讀 1,518評論 55贊 25
  • 悟空成了猴王以后，一只老猴子前來，告訴他花果山往東走，有一仙山。仙山上住著一個魔頭，名曰沉芒。沉芒對花果山的猴子們...
    卿渺閱讀 511評論 0贊 2
  • 17歲那年，我們熱血青春，想干啥就干啥，從來不顧后果，18歲那年，我們口無遮攔，心里從來藏不住秘密。24歲那年，我...
    Fred_young閱讀 1,281評論 0贊 0

友情鏈接更多精彩內(nèi)容