SpringBoot2整合Redis

---

公司使用了soringboot-2.0.4寫新項目，今天在整合redis的時候到處碰壁，最後誤打誤撞整理出來了，現在記錄一下，方便以後使用。

---

• Pom依賴

因爲使用了redis最新的類 RedisStandaloneConfiguration 所以要加入jedis包，不然在代碼中會報錯，下面會說明。不是因爲排除掉本身的jedis包導致的，具體原因未知。

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-data-redis</artifactId>
			<!-- 1.5的版本默認採用的連接池技術是jedis 2.0以上版本默認連接池是lettuce, 在這裏採用        
            jedis，所以需要排除lettuce的jar -->
			<exclusions>
				<exclusion>
					<groupId>redis.clients</groupId>
					<artifactId>jedis</artifactId>
				</exclusion>
				<exclusion>
					<groupId>io.lettuce</groupId>
					<artifactId>lettuce-core</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
		<dependency>
			<groupId>redis.clients</groupId>
			<artifactId>jedis</artifactId>
		</dependency>

• Redis配置

我使用了yaml配置文件

   # -- Redis 配置
   redisconfig:
      host: XXXX
      port: 6379
      password: XXXX
      timeout: 10000  

因爲在JedisConnectionFactory中，它用了一個自己的JedisConnectionFactory.MutableJedisClientConfiguration()，

MutableJedisClientConfiguration會自動生成一個JedisPoolConfig，這個JedisPoolConfig繼承自GenericObjectPoolConfig，

他的pool的配置就是8個。 我認爲夠用了，所以沒有配置連接池相關信息。

該信息獲取自博文redis如何配置standAlone版的jedisPool。另外請自己讀取yaml的屬性信息。

• 配置Redis

package com.quark.data.tenant.server.configuration;

import java.time.Duration;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.RedisPassword;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.jedis.JedisClientConfiguration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import com.quark.data.tenant.server.model.conf.RedisConfig;
import com.quark.data.tenant.server.util.PropertiesUtil;
import com.quark.data.tenant.server.util.RedisUtil;

@Configuration
public class MyRedisConfiguration {

	// propertiesUtil 是我的yaml屬性文件類
	@Autowired
	private PropertiesUtil propertiesUtil;

	@Bean
	public JedisConnectionFactory jedisConnectionFactory() {
		
		RedisConfig redisconfig = propertiesUtil.getRedisconfig();
		RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration();
		redisStandaloneConfiguration.setHostName(redisconfig.getHost());
		redisStandaloneConfiguration.setPort(redisconfig.getPort());
		redisStandaloneConfiguration.setPassword(RedisPassword.of(redisconfig.getPassword()));
		JedisClientConfiguration.JedisClientConfigurationBuilder jedisClientConfiguration = JedisClientConfiguration
				.builder();
		jedisClientConfiguration.connectTimeout(Duration.ofMillis(redisconfig.getTimeout()));// connection
		// 如果不加入Jedis的包  這裏會報錯，原因未知
		JedisConnectionFactory factory = new JedisConnectionFactory(redisStandaloneConfiguration,
				jedisClientConfiguration.build());
		return factory;
	}

	/**
	 * 實例化 RedisTemplate 對象
	 *
	 * @return
	 */
	@Bean
	public RedisTemplate<String, Object> functionDomainRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
		RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
		initDomainRedisTemplate(redisTemplate, redisConnectionFactory);
		return redisTemplate;
	}

	/**
	 * 設置數據存入 redis 的序列化方式,並開啓事務
	 * 
	 * @param redisTemplate
	 * @param factory
	 */
	private void initDomainRedisTemplate(RedisTemplate<String, Object> redisTemplate, RedisConnectionFactory factory) {
		redisTemplate.setKeySerializer(new StringRedisSerializer());
		redisTemplate.setHashKeySerializer(new StringRedisSerializer());
		redisTemplate.setHashValueSerializer(new GenericJackson2JsonRedisSerializer());
		redisTemplate.setValueSerializer(new GenericJackson2JsonRedisSerializer());
		redisTemplate.setEnableTransactionSupport(true);
		redisTemplate.setConnectionFactory(factory);
	}

	@Bean
	public RedisUtil redisUtil() {
        // 注入redis工具類，在其他地方直接自動注入就可以使用了
		RedisUtil redisUtil = new RedisUtil();
		JedisConnectionFactory jedisConnectionFactory = jedisConnectionFactory();
		RedisTemplate<String, Object> functionDomainRedisTemplate = functionDomainRedisTemplate(jedisConnectionFactory);
		redisUtil.setRedisTemplate(functionDomainRedisTemplate);
		return redisUtil;
	}
}

• Redis工具類

這個工具類是網上的 我直接貼上用了，來源SpringBoot2.0基礎篇- MyBatis、Redis整合（JedisCluster集羣連接）

package com.quark.data.tenant.server.util;

import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;

@Component
public class RedisUtil {
	
	private RedisTemplate<String, Object> redisTemplate;  
	
    public void setRedisTemplate(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));  
            }  
        }  
    }  

    /** 
     * 普通緩存獲取 
     * @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 by 要增加幾(大於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 by 要減少幾(小於0) 
     * @return 
     */  
    public long decr(String key, long delta){    
        if(delta<0){  
            throw new RuntimeException("遞減因子必須大於0");  
        }  
        return redisTemplate.opsForValue().increment(key, -delta);    
    }    

    /** 
     * 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緩存的內容 
     * @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 值 
     * @param time 時間(秒) 
     * @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 值 
     * @param time 時間(秒) 
     * @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;  
        }  
	}
}

每一次的指正都促進我的成長，如果我有錯誤或您有疑問，請在下方留言。