SpringBoot整合Redis實戰項目

時間 2020-05-16

標籤 springboot 整合 redis 實戰項目欄目 Spring 简体版

原文原文鏈接

1、在Maven中引入Redis依賴

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

2、在application.properties中配置redis參數

# Redis數據庫索引（默認爲0） spring.redis.database=0 # Redis服務器地址 spring.redis.host=localhost # Redis服務器鏈接端口 spring.redis.port=6379 # Redis服務器鏈接密碼（默認爲空） spring.redis.password= #鏈接池最大鏈接數（使用負值表示沒有限制） spring.redis.jedis.pool.max-active=8 # 鏈接池最大阻塞等待時間（使用負值表示沒有限制） spring.redis.jedis.pool.max-wait=-1 # 鏈接池中的最大空閒鏈接 spring.redis.jedis.pool.max-idle=8 # 鏈接池中的最小空閒鏈接 spring.redis.jedis.pool.min-idle=0 # 鏈接超時時間（毫秒） spring.redis.timeout=300

注意：此處不一樣版本的springboot配置的信息不一致，網絡中其餘文章大多都是1.4版本的配置。本文用的2.0版本因此配置不同。html

參考大神文章：http://www.javashuo.com/article/p-rozccssk-dm.htmljava

3、代碼開發

一、程序目錄

說明：web

RedisConfig中重寫RedisTemplate類（why？）
Usercontroller中調用Redis實現數據存儲和讀取
User封裝數據POJO
RedisUtil封裝了RedisTemplate中的經常使用方法，能夠更好的操做Redis。

二、 RedisConfig開發

根據前面學到的知識點你們能夠知道：Spring繼承Redis後，由Spring建立的RedisTemplate類來託管做Redis的操做。redis

SpringBoot框架會自動幫咱們在容器中生成了一個RedisTemplate和一個StringRedisTemplate。可是這個RedisTemplate的泛型是<Object,Object>，這致使了代碼書寫不方便，咱們須要寫好多類型轉換的代碼；而且SpringBoot提供的這個RedisTemplate也沒有設置數據存在Redis時，key及value的序列化方式。這時咱們須要一個泛型爲<String,Object>形式的RedisTemplate，而且定義好序列化方式。咱們看一下spring中RedisAutoConfiguration的代碼：spring

@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; } }

看到這個@ConditionalOnMissingBean註解後，就知道若是Spring容器中有了RedisTemplate對象了，這個自動配置的RedisTemplate不會實例化。所以咱們能夠直接本身寫個配置類，配置RedisTemplate。因此咱們在RedisConfig中重寫RedisTemplate類，代碼以下：數據庫

import com.fasterxml.jackson.annotation.JsonAutoDetect; import com.fasterxml.jackson.annotation.PropertyAccessor; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.cache.annotation.CachingConfigurerSupport; import org.springframework.cache.annotation.EnableCaching; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.*; import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; /** * redis配置類 * @program: redisdemo * @Author: david * @Description: */ @Configuration @EnableCaching //開啓註解
public class RedisConfig extends CachingConfigurerSupport { /** * retemplate相關配置 * @param factory * @return
     */ @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) { RedisTemplate<String, Object> template = new RedisTemplate<>(); // 配置鏈接工廠
 template.setConnectionFactory(factory); //使用Jackson2JsonRedisSerializer來序列化和反序列化redis的value值（默認使用JDK的序列化方式）
        Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class); ObjectMapper om = new ObjectMapper(); // 指定要序列化的域，field,get和set,以及修飾符範圍，ANY是都有包括private和public
 om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); // 指定序列化輸入的類型，類必須是非final修飾的，final修飾的類，好比String,Integer等會跑出異常
 om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); jacksonSeial.setObjectMapper(om); // 值採用json序列化
 template.setValueSerializer(jacksonSeial); //使用StringRedisSerializer來序列化和反序列化redis的key值
        template.setKeySerializer(new StringRedisSerializer()); // 設置hash key 和value序列化模式
        template.setHashKeySerializer(new StringRedisSerializer()); template.setHashValueSerializer(jacksonSeial); template.afterPropertiesSet(); return template; } /** * 對hash類型的數據操做 * * @param redisTemplate * @return
     */ @Bean public HashOperations<String, String, Object> hashOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForHash(); } /** * 對redis字符串類型數據操做 * * @param redisTemplate * @return
     */ @Bean public ValueOperations<String, Object> valueOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForValue(); } /** * 對鏈表類型的數據操做 * * @param redisTemplate * @return
     */ @Bean public ListOperations<String, Object> listOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForList(); } /** * 對無序集合類型的數據操做 * * @param redisTemplate * @return
     */ @Bean public SetOperations<String, Object> setOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForSet(); } /** * 對有序集合類型的數據操做 * * @param redisTemplate * @return
     */ @Bean public ZSetOperations<String, Object> zSetOperations(RedisTemplate<String, Object> redisTemplate) { return redisTemplate.opsForZSet(); } }

三、RedisUtil開發

重寫redisTemplate後，可使用自定義的redisTemplate來操做Redis了，可是操做的代碼仍是過於複雜，例如：json

所以有必要封裝一個工具類來簡化redisTemplate操做。RedisUtil應運而生。代碼以下：瀏覽器

import org.springframework.beans.factory.annotation.Autowired; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.stereotype.Component; import org.springframework.util.CollectionUtils; import java.util.List; import java.util.Map; import java.util.Set; import java.util.concurrent.TimeUnit; /** * redisTemplate封裝 * * @author david */ @Component public class RedisUtil { @Autowired private RedisTemplate<String, Object> redisTemplate; public RedisUtil(RedisTemplate<String, Object> redisTemplate) { this.redisTemplate = 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; } } /** * 根據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; } } /** * 普通緩存放入並設置時間 * @param key 鍵 * @param value 值 * @param time 時間(秒) time要大於0 若是time小於等於0 將設置無限期 * @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); } //================================Map=================================
    /** * HashGet * @param key 鍵 不能爲null * @param item 項 不能爲null * @return 值 */
    public Object hget(String key,String item){ return redisTemplate.opsForHash().get(key, item); } /** * 獲取hashKey對應的全部鍵值 * @param key 鍵 * @return 對應的多個鍵值 */
    public Map<Object,Object> hmget(String key){ return redisTemplate.opsForHash().entries(key); } /** * HashSet * @param key 鍵 * @param map 對應多個鍵值 * @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 並設置時間 * @param key 鍵 * @param map 對應多個鍵值 * @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表中放入數據,若是不存在將建立 * @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表中放入數據,若是不存在將建立 * @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遞增 若是不存在,就會建立一個 並把新增後的值返回 * @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=============================
    /** * 根據key獲取Set中的全部值 * @param key 鍵 * @return
     */
    public Set<Object> sGet(String key){ try { return redisTemplate.opsForSet().members(key); } catch (Exception e) { e.printStackTrace(); return null; } } /** * 根據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; } } /** * 將數據放入set緩存 * @param key 鍵 * @param values 值 能夠是多個 * @return 成功個數 */
    public long sSet(String key, Object...values) { try { return redisTemplate.opsForSet().add(key, values); } catch (Exception e) { e.printStackTrace(); return 0; } } /** * 將set數據放入緩存 * @param key 鍵 * @param time 時間(秒) * @param values 值 能夠是多個 * @return 成功個數 */
    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 移除的個數 */
    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緩存的內容 * @param key 鍵 * @param start 開始 * @param end 結束 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倒數第二個元素，依次類推 * @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; } } /** * 根據索引修改list中的某條數據 * @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 移除的個數 */
    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; } } }

四、User開發

public class User implements Serializable{ private int id; private String userName; private String password; //省略...
}

五、UserController開發

import org.lanqiao.entity.User;
import org.lanqiao.utile.RedisUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * Created by David on 2019/9/3.
 */
@RestController
public class UserController {
    @Autowired
    RedisUtil redisUtil;

    @RequestMapping("/set")
    public String set() {
        User user = new User(1, "david", "123");
        redisUtil.set("user", user);
        return "success saved user !";
    }

    @RequestMapping("/get")
    public String get() {
        User user = (User) redisUtil.get("user");
        return user.toString();
    }
}