SpringBoot整合SpringDataRedis

172 阅读4分钟

1. 综述

Spring Data是Spring公司的顶级项目,其中包含了多个相对独立的子项目,每个子项目都是对不同API的封装,所有Spring Boot整合Spring Data XXX的启动器都叫做spring-boot-starter-data-xxxx。而SpirngDataRedis则是Spring官方对redis的整合,其优势在于能够很方便的在Java项目中操作redis对象类型,来实现缓存/消息队列等功能。

2. 使用

2.1 在redis客户端配置链接

image.png

2.2 导入依赖

<!-- spring boot redis缓存引入 -->								
<dependency>
    <groupId>org.springframework.boot</groupId>	
    <artifactId>spring-boot-starter-data-redis</artifactId>				
</dependency>										
<!-- lecttuce 缓存连接池-->									
<dependency>										
    <groupId>org.apache.commons</groupId>			
    <artifactId>commons-pool2</artifactId>	
</dependency>										

2.3 添加application.yml依赖

spring:
  redis:
    host: 120.79.157.129
    port: 6379
    database: 2
    # password:  #默认为空
    lettuce:
      pool:
        max-active: 20  #最大连接数,负值表示没有限制,默认8
        max-wait: -1    #最大阻塞等待时间,负值表示没限制,默认-1
        max-idle: 8     #最大空闲连接,默认8
        min-idle: 0     #最小空闲连接,默认0							

2.4 测试代码

@Configuration
public class RedisConfig {
    @Autowired
    private RedisTemplate redisTemplate;
}

image.png

3. Redis封装

package com.imooc.utils;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.DataAccessException;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.connection.StringRedisConnection;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

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

@Component
public class RedisOperator {
   
   @Autowired
   private StringRedisTemplate redisTemplate;

   // Key(键),简单的key-value操作

   /**
    * 判断key是否存在
    * @param key
    * @return
    */
   public boolean keyIsExist(String key) {
      return redisTemplate.hasKey(key);
   }

   /**
    * 实现命令:TTL key,以秒为单位,返回给定 key的剩余生存时间(TTL, time to live)。
    * 
    * @param key
    * @return
    */
   public long ttl(String key) {
      return redisTemplate.getExpire(key);
   }
   
   /**
    * 实现命令:expire 设置过期时间,单位秒
    * 
    * @param key
    * @return
    */
   public void expire(String key, long timeout) {
      redisTemplate.expire(key, timeout, TimeUnit.SECONDS);
   }
   
   /**
    * 实现命令:increment key,增加key一次
    * 
    * @param key
    * @return
    */
   public long increment(String key, long delta) {
      return redisTemplate.opsForValue().increment(key, delta);
   }

   /**
    * 累加,使用hash
    */
   public long incrementHash(String name, String key, long delta) {
      return redisTemplate.opsForHash().increment(name, key, delta);
   }

   /**
    * 累减,使用hash
    */
   public long decrementHash(String name, String key, long delta) {
      delta = delta * (-1);
      return redisTemplate.opsForHash().increment(name, key, delta);
   }

   /**
    * hash 设置value
    */
   public void setHashValue(String name, String key, String value) {
      redisTemplate.opsForHash().put(name, key, value);
   }

   /**
    * hash 获得value
    */
   public String getHashValue(String name, String key) {
      return (String)redisTemplate.opsForHash().get(name, key);
   }

   /**
    * 实现命令:decrement key,减少key一次
    *
    * @param key
    * @return
    */
   public long decrement(String key, long delta) {
      return redisTemplate.opsForValue().decrement(key, delta);
   }

   /**
    * 实现命令:KEYS pattern,查找所有符合给定模式 pattern的 key
    */
   public Set<String> keys(String pattern) {
      return redisTemplate.keys(pattern);
   }

   /**
    * 实现命令:DEL key,删除一个key
    * 
    * @param key
    */
   public void del(String key) {
      redisTemplate.delete(key);
   }

   // String(字符串)

   /**
    * 实现命令:SET key value,设置一个key-value(将字符串值 value关联到 key)
    * 
    * @param key
    * @param value
    */
   public void set(String key, String value) {
      redisTemplate.opsForValue().set(key, value);
   }

   /**
    * 实现命令:SET key value EX seconds,设置key-value和超时时间(秒)
    * 
    * @param key
    * @param value
    * @param timeout
    *            (以秒为单位)
    */
   public void set(String key, String value, long timeout) {
      redisTemplate.opsForValue().set(key, value, timeout, TimeUnit.SECONDS);
   }

   /**
    * 如果key不存在,则设置,如果存在,则报错
    * @param key
    * @param value
    */
   public void setnx60s(String key, String value) {
      redisTemplate.opsForValue().setIfAbsent(key, value, 60, TimeUnit.SECONDS);
   }

   /**
    * 如果key不存在,则设置,如果存在,则报错
    * @param key
    * @param value
    */
   public void setnx(String key, String value) {
      redisTemplate.opsForValue().setIfAbsent(key, value);
   }

   /**
    * 实现命令:GET key,返回 key所关联的字符串值。
    * 
    * @param key
    * @return value
    */
   public String get(String key) {
      return (String)redisTemplate.opsForValue().get(key);
   }

   /**
    * 批量查询,对应mget
    * @param keys
    * @return
    */
   public List<String> mget(List<String> keys) {
      return redisTemplate.opsForValue().multiGet(keys);
   }

   /**
    * 批量查询,管道pipeline
    * @param keys
    * @return
    */
   public List<Object> batchGet(List<String> keys) {

//    nginx -> keepalive
//    redis -> pipeline

      List<Object> result = redisTemplate.executePipelined(new RedisCallback<String>() {
         @Override
         public String doInRedis(RedisConnection connection) throws DataAccessException {
            StringRedisConnection src = (StringRedisConnection)connection;

            for (String k : keys) {
               src.get(k);
            }
            return null;
         }
      });

      return result;
   }


   // Hash(哈希表)

   /**
    * 实现命令:HSET key field value,将哈希表 key中的域 field的值设为 value
    * 
    * @param key
    * @param field
    * @param value
    */
   public void hset(String key, String field, Object value) {
      redisTemplate.opsForHash().put(key, field, value);
   }

   /**
    * 实现命令:HGET key field,返回哈希表 key中给定域 field的值
    * 
    * @param key
    * @param field
    * @return
    */
   public String hget(String key, String field) {
      return (String) redisTemplate.opsForHash().get(key, field);
   }

   /**
    * 实现命令:HDEL key field [field ...],删除哈希表 key 中的一个或多个指定域,不存在的域将被忽略。
    * 
    * @param key
    * @param fields
    */
   public void hdel(String key, Object... fields) {
      redisTemplate.opsForHash().delete(key, fields);
   }

   /**
    * 实现命令:HGETALL key,返回哈希表 key中,所有的域和值。
    * 
    * @param key
    * @return
    */
   public Map<Object, Object> hgetall(String key) {
      return redisTemplate.opsForHash().entries(key);
   }

   // List(列表)

   /**
    * 实现命令:LPUSH key value,将一个值 value插入到列表 key的表头
    * 
    * @param key
    * @param value
    * @return 执行 LPUSH命令后,列表的长度。
    */
   public long lpush(String key, String value) {
      return redisTemplate.opsForList().leftPush(key, value);
   }

   /**
    * 实现命令:LPOP key,移除并返回列表 key的头元素。
    * 
    * @param key
    * @return 列表key的头元素。
    */
   public String lpop(String key) {
      return (String)redisTemplate.opsForList().leftPop(key);
   }

   /**
    * 实现命令:RPUSH key value,将一个值 value插入到列表 key的表尾(最右边)。
    * 
    * @param key
    * @param value
    * @return 执行 LPUSH命令后,列表的长度。
    */
   public long rpush(String key, String value) {
      return redisTemplate.opsForList().rightPush(key, value);
   }

}