天天看點

Redis | 嘗試封裝一個操作工具類

介紹

本次主要介紹以下内容:

1、SpringMVC內建Redis

2、Spring Boot內建Redis(上)

3、Spring Boot內建Redis(中)

4、Spring Boot內建Redis(下)

5、使用redis為我們提供jar進行封裝

6、使用Spring Boot提供的方法進行封裝

内容比較多,會花一定的時間進行完善。

第一部分:SpringMVC內建Redis

第一步:依賴

<dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>${redis.version}</version>
        </dependency>           

第二步:bean注入

<!-- 引入jedis的properties配置檔案 -->
    <!--如果你有多個資料源需要通過<context:property-placeholder管理,且不願意放在一個配置檔案裡,那麼一定要加上ignore-unresolvable=“true"-->
    <context:property-placeholder location="classpath:properties/redis.properties" ignore-unresolvable="true" />

    <bean id="jedisPool" class="redis.clients.jedis.JedisPool">
        <constructor-arg name="poolConfig" ref="jedisPoolConfig" />
        <constructor-arg name="host" value="${redis.host}" />
        <constructor-arg name="port" value="${redis.port}" type="int" />
        <constructor-arg name="timeout" value="${redis.timeout}" type="int" />
        <constructor-arg name="password" value="${redis.password}" />
        <constructor-arg name="database" value="${redis.database}" type="int" />
    </bean>

    <bean class="redis.clients.jedis.JedisPoolConfig" id="jedisPoolConfig" />           

這樣,內建就算告一段落了,什麼意思?簡單來說,你可以開始編寫操作Redis的代碼了,是以,我們會放到後面說。

第二部分:Spring Boot內建Redis(上)

這部分主要說,将我們的項目換成Spring Boot,應該怎麼操作呢?

有兩種操作辦法,1、依然通過引入配置檔案的辦法,簡單來說,我們需要寫一個配置,加載配置檔案。2、也就是下面要說的。

jar還是之前那個。

application.yml

中添加如下配置:

# redis
redis:
  host: 
  port: 6379
  timeout: 3
  password: 
  poolMaxTotal: 10
  poolMaxIdle: 10
  poolMaxWait: 3           

配置代碼:

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @author Wenyi Feng
 * @since 2018-12-04
 */
@Component
@ConfigurationProperties(prefix = "redis")
@Data
public class RedisConfig {
    private String host;
    private int port;
    private int timeout;// 秒
    private String password;
    private int poolMaxTotal;
    private int poolMaxIdle;
    private int poolMaxWait;// 秒
}           

構造連接配接池:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Service;
import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;

/**
 * @author Wenyi Feng
 * @since 2018-12-04
 */
@Service
public class RedisPoolFactory {

    @Autowired
    RedisConfig redisConfig;

    @Bean
    public JedisPool jedisPoolFactory() {
        JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();
        jedisPoolConfig.setMaxIdle(redisConfig.getPoolMaxIdle());
        jedisPoolConfig.setMaxTotal(redisConfig.getPoolMaxTotal());
        jedisPoolConfig.setMaxWaitMillis(redisConfig.getPoolMaxWait() * 1000);
        return new JedisPool(jedisPoolConfig, redisConfig.getHost(), redisConfig.getPort(),
                redisConfig.getTimeout() * 1000,
                redisConfig.getPassword(), 0);
    }

}           

第三部分:Spring Boot內建Redis(中)

使用Spring Boot的初衷就是簡化我們的配置,那我們該怎麼做呢?

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

第二步:配置

spring:
  redis:
    host: 
    port: 6379
    password:            

這樣就行了。

什麼?這樣就行了?

沒錯。

當然,操作代碼,我們放到後面說。

第四部分:Spring Boot內建Redis(下)

上面是單台Redis,那麼叢集應該怎麼做呢?如下:

spring:
  redis:
    host: 
    port: 6379
    password: 
    cluster:
      nodes:            

使用英文逗号(,)隔開

第五部分:使用redis為我們提供jar進行封裝

首先,要明确,Redis十分強大,是以,也是相當負責。當然你也可以覺得很簡單。

我們知道redis是以key-value的形式儲存資料的,那麼這裡就有一個問題,集合對象應該怎麼儲存呢?

是以,這裡提供兩種解決思路:一是将其轉成String進行儲存(這是Spring推薦的);二是使用byte[](這是Redis推薦的)。

好了,話不多少,我們開始撸代碼。

依賴:

<dependency>
            <groupId>redis.clients</groupId>
            <artifactId>jedis</artifactId>
            <version>${redis.version}</version>
        </dependency>           

方案1:

/**
     * 擷取資料
     * @param prefix 字首
     * @param key
     * @param clazz
     * @param <T>
     * @return
     */
    public <T> T get(KeyPrefix prefix, String key, Class<T> clazz) {
        Jedis jedis = null;
        try {
            jedis = jedisPool.getResource();

            // 真正的key
            String realKey = prefix.getPrefix() + key;
            String str = jedis.get(realKey);
            return stringToBean(str, clazz);
        } finally {
            returnToPool(jedis);
        }
    }

    /**
     * 設定對象
     * @param prefix 字首
     * @param key
     * @param obj
     * @param <T>
     * @return
     */
    public <T> boolean set(KeyPrefix prefix, String key, T obj) {
        Jedis jedis = null;
        try {
            jedis = jedisPool.getResource();
            String str = beanToString(obj);
            if (StringUtils.isEmpty(str)) {
                return false;
            }
            // 生成真正的key
            String realKey = prefix.getPrefix() + key;
            int seconds = prefix.expireSeconds();
            if (seconds <= 0) {
                jedis.set(realKey, str);
            } else {
                jedis.setex(realKey, seconds, str);
            }
            return true;
        } finally {
            returnToPool(jedis);
        }
    }           

方案2:

/**
     * 将值存到Redis中
     * @param key 唯一辨別
     * @param value 二進制格式資料
     * @return 傳回二進制格式資料,表示操作成功,反之,操作失敗
     */
    public byte[] set(byte[] key, byte[] value) {
        Jedis jedis = getResource();
        try {
            jedis.set(key, value);
            return value;
        } finally {
            jedis.close();
        }
    }

    /**
     * 通過一個key擷取value
     * @param key 唯一辨別
     * @return 二進制格式資料
     */
    public byte[] get(byte[] key) {
        Jedis jedis = getResource();
        try {
            return jedis.get(key);
        } finally {
            jedis.close();
        }
    }           

方案一和方案二操作是一樣的,不同的處理思路不一樣,一個将對象轉成字元串(啟發:JSON),一個是将對象當作資料,進行序列化進行存儲和讀取。

第六部分:使用Spring Boot提供的方法進行封裝

前面你是不是覺得好簡單啊,其實我一直也是這麼認為的。下面我們看看Spring是如何為我們解讀Redis的。

首先我們知道Spring為我們提供了兩個東東。

@Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Autowired
    private RedisTemplate redisTemplate;           

這下,你也應該明白我 前面說的了吧,Spring居然為String單獨寫了一個,而代碼不足10行。

我們看看RedisTemplate提供了哪些方法。

以上是部分截圖。

我們來嘗試寫一個簡單的例子:

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

import javax.annotation.Resource;

/**
 * @author Wenyi Feng
 * @since 2018-12-04
 */
@Service
public class ByteRedisService {

    @Resource
    private RedisTemplate<byte[], byte[]> redisTemplate;

    public void set(byte[] key, byte[] value) {
        redisTemplate.opsForValue().set(key, value);
    }

    public byte[] get(byte[] key) {
        return redisTemplate.opsForValue().get(key);
    }

}           

參考文檔

[1]

Shiro安全架構入門 - Redis部分

[2]

Java秒殺系統方案優化 高性能高并發實戰 - Redis部分