在 Spring Boot 中使用 Redis

yzbyzz發表於2018-05-06
Spring BootRedis

Redis 本身的一些概念

本文中的程式碼見 spring-boot-redis。

Redis 支援的資料結構

  • String 字串
  • Hash 字典
  • List 列表
  • Set 集合
  • Sorted Set 有序集合

String 和 Hash 的對比

String 實際是就是一個 Key - Value 的對映；

Hash 就是一個 Key - （Key - Value） 的兩層對映。

# redis-cli
# Redis 中命令不區分大小寫。這裡命令使用小寫，僅在特別的地方用大寫。
# 引數使用“大寫+下劃線”的方式。

# String
set KEY VALUE
get KEY

# Hash
hset HASH_NAME KEY VALUE
hget HASH_NAME KEY
hMset HASH_NAME KEY0 VALUE0 KEY1 VALUE1 ...
hMget HASH_NAME KEY0 KEY1 ...
複製程式碼

STACK OVERFLOW 上一個對 String 和 Hash 的討論

對於一個物件是把本身的資料序列化後用 String 儲存，還是使用 Hash 來分別儲存物件的各個屬性：

  • 如果在大多數時候要訪問物件的大部分資料：使用 String
  • 如果在大多數時候只要訪問物件的小部分資料：使用 Hash
  • 如果物件裡面還有物件這種結構複雜的，最好用 String。否則最外層用 Hash，裡面又將物件序列化，兩者混用可能導致混亂。

Spring Boot 新增 Redis 的配置

以 gradle 為例。

  • 修改 build.gradle
compile("org.springframework.boot:spring-boot-starter-data-redis")
複製程式碼
  • 修改 application.yml
spring:
    # redis
    redis:
        host: 127.0.0.1
        # 資料庫索引（預設為0）
        database: 0
        port: 6379
        password: PASSWORD
        # 連線池中的最大空閒連線
        pool.max-idle: 8
        # 連線池中的最小空閒連線
        pool.min-idle: 0
        # 連線池最大連線數（使用負值表示沒有限制）
        pool.max-active: 8
        # 連線池最大阻塞等待時間（使用負值表示沒有限制）
        pool.max-wait: -1
        # 連線超時時間（毫秒）
        timeout: 0
複製程式碼
  • 新增 RedisConfig
package zz.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.lang.reflect.Method;
import java.util.HashMap;
import java.util.Map;

/**
 * RedisConfig
 *
 * @author zz
 * @date 2018/5/7
 */
@Configuration
@EnableCaching
@Slf4j
public class RedisConfig extends CachingConfigurerSupport {
    @Bean
    public KeyGenerator wiselyKeyGenerator() {
        return new KeyGenerator() {
            private static final String SEPARATE = ":";

            @Override
            public Object generate(Object target, Method method, Object... params) {
                log.debug("+++++generate");
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(SEPARATE).append(method);
                for (Object obj : params) {
                    sb.append(SEPARATE).append(obj);
                }
                return sb.toString();
            }
        };
    }

    /**
     * https://www.jianshu.com/p/9255b2484818
     *
     * TODO: 對 Spring @CacheXXX 註解進行擴充套件：註解失效時間 + 主動重新整理快取
     */
    @Bean
    public CacheManager cacheManager(@SuppressWarnings("rawtypes") RedisTemplate redisTemplate) {
        log.debug("++++cacheManager");
        RedisCacheManager redisCacheManager =new RedisCacheManager(redisTemplate);
        redisCacheManager.setTransactionAware(true);
        redisCacheManager.setLoadRemoteCachesOnStartup(true);

        // 最終在 Redis 中的 key = @Cacheable 註解中 'cacheNames' + 'key'
        redisCacheManager.setUsePrefix(true);

        // 所有 key 的預設過期時間，不設定則永不過期
        // redisCacheManager.setDefaultExpiration(6000L);

        // 對某些 key 單獨設定過期時間
        // 這裡的 key 是 @Cacheable 註解中的 'cacheNames'
        Map<String, Long> expires = new HashMap<>(10);
        // expires.put("feedCategoryDto", 5000L);
        // expires.put("feedDto", 5000L);
        redisCacheManager.setExpires(expires);

        return redisCacheManager;
    }


    // value serializer

    private Jackson2JsonRedisSerializer getJackson2JsonRedisSerializer() {
        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);

        return jackson2JsonRedisSerializer;
    }

    private GenericJackson2JsonRedisSerializer getGenericJackson2JsonRedisSerializer() {
        return new GenericJackson2JsonRedisSerializer();
    }

    /**
     *
     * Once configured, the template is thread-safe and can be reused across multiple instances.
     * -- https://docs.spring.io/spring-data/data-redis/docs/current/reference/html/
     */
    @Bean
    public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
        log.debug("++++redisTemplate");
        StringRedisTemplate template = new StringRedisTemplate(factory);

        // key serializer
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();


        RedisSerializer valueRedisSerializer;
        // -- 1 Jackson2JsonRedisSerializer
        // valueRedisSerializer = getJackson2JsonRedisSerializer();

        // -- 2 GenericJackson2JsonRedisSerializer
        valueRedisSerializer = getGenericJackson2JsonRedisSerializer();

        // set serializer
        template.setKeySerializer(stringRedisSerializer);
        template.setValueSerializer(valueRedisSerializer);
        template.setHashKeySerializer(stringRedisSerializer);
        template.setHashValueSerializer(valueRedisSerializer);

        template.afterPropertiesSet();
        return template;
    }
}


複製程式碼

RedisConfig 中定義了三個函式，主要作用如下：

  • wiselyKeyGenerator：定義了一個生成 Redis 的 key 的方法。如下文使用了 @Cacheable 註解的地方，可以指定 key 的生成方法使用我們這個函式。
  • cacheManager：定義了對 Redis 的一些基本設定。
  • redisTemplate：對我們要使用的 RedisTemplate 做一些設定。主要是確定序列化方法。

RedisTemplate 設定序列化器

Spring Redis 雖然提供了對 list、set、hash 等資料型別的支援，但是沒有提供對 POJO 物件的支援，底層都是把物件序列化後再以位元組的方式儲存的。

因此，Spring Data Redis 提供了若干個 Serializer，主要包括：
  • JdkSerializationRedisSerializer： 預設的序列化器。序列化速度快，生成的位元組長度較大。
  • OxmSerializer： 生成 XML 格式的位元組。
  • StringSerializer： 只能對 String 型別進行序列化。
  • JacksonJsonRedisSerializer：以 JSON 格式進行序列化。
  • Jackson2JsonRedisSerializer：JacksonJsonRedisSerializer 的升級版。
  • GenericJackson2JsonRedisSerializer：Jackson2JsonRedisSerializer 的泛型版。
RedisTemplate 中需要宣告 4 種 serializer（預設使用的是 JdkSerializationRedisSerializer）：
  • keySerializer ：對於普通 K-V 操作時，key 採取的序列化策略
  • valueSerializer：value 採取的序列化策略
  • hashKeySerializer： 在 hash 資料結構中，hash-key 的序列化策略
  • hashValueSerializer：hash-value 的序列化策略

無論如何，建議 key/hashKey 採用 StringRedisSerializer。

by Spring-data-redis: serializer例項

我們設定了 serializer 後，讀寫 Redis 要使用同一種 serizlizer，否則會讀不出之前用不同 serializer 寫入的資料。

也就是設定 valueSerializer 為GenericJackson2JsonRedisSerializer，然後寫入了資料。 後面要讀資料的時候，如果將 valueSerializer 又設定成了 Jackson2JsonRedisSerializer，那麼讀取資料時就會報錯。

通常情況下，我們只需要在 RedisConfig 中統一設定好 4 個 serializer 即可。

Jackson2JsonRedisSerializer 與 GenericJackson2JsonRedisSerializer 的對比

  • 兩者都是將物件的資料序列化成 JSON 格式的字串。
  • Jackson2JsonRedisSerializer 需要自己指定 ObjectMaper 或某個特定的型別。
  • GenericJackson2JsonRedisSerializer 是 Jackson2JsonRedisSerializer 的一個特例，預設支援所有型別。
  • 兩者序列化時，都會將原始物件的類名和包名寫入 JSON 字串中。以便反序列化時，確認要將 JSON 轉成何種格式。
可用如下方式來獲得通用的 Jackson2JsonRedisSerializer
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);
複製程式碼

Jackson2JsonRedisSerializer 與 GenericJackson2JsonRedisSerializer 生成 JSON 的對比

# Jackson2JsonRedisSerializer 序列化的效果
127.0.0.1:6379> get 123
"[\"zz.domain.User\",{\"id\":123,\"name\":\"name\"}]"
127.0.0.1:6379> get userList
"[\"java.util.LinkedList\",[[\"zz.domain.User\",{\"id\":233,\"name\":\"new\"}],[\"zz.domain.User\",{\"id\":233,\"name\":\"new\"}]]]"
複製程式碼
# GenericJackson2JsonRedisSerializer 序列化的效果
127.0.0.1:6379> get 123
"{\"@class\":\"zz.domain.User\",\"id\":123,\"name\":\"name\"}"
127.0.0.1:6379> get userList
"[\"java.util.LinkedList\",[{\"@class\":\"zz.domain.User\",\"id\":233,\"name\":\"new\"},{\"@class\":\"zz.domain.User\",\"id\":233,\"name\":\"new\"}]]"

複製程式碼

如何使用

使用註解來快取函式的結果

在要快取的方法上使用註解 @Cacheable、@CachePut、@CacheEvict 分別用於快取返回資料、更新快取資料、刪除快取資料。

package zz.service;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
import zz.domain.User;

/**
 * UserService
 *
 * @author zz
 * @date 2018/5/7
 */
@Service
@Slf4j
public class UserService {
    public final String DEFAULT_NAME = "def";

    @Cacheable(cacheNames = "user", key = "'id_'+#userId")
    public User get(int userId) {
        // get from db
        log.debug("[++] get userId=" + userId);

        User user = new User();
        user.setId(userId);
        user.setName(DEFAULT_NAME);
        log.debug("[++] create default user=" + user);
        return user;
    }

    @CachePut(cacheNames = "user", key = "'id_'+#user.getId()")
    public User update(User user) {
        // save to db
        log.debug("[++] update user=" + user);
        return user;
    }

    @CacheEvict(cacheNames = "user", key = "'id_'+#userId")
    public void delete(int userId) {
        // delete from db
        log.debug("[++] delete userId=" + userId);
    }

    @CachePut(cacheNames = "user", key = "'id_'+#userId")
    public User updateName(int userId, String name) {
        // update to db
        log.debug("[++] updateName userId=" + userId + ", name=" + name);

        User user = get(userId);
        user.setName(name);
        return user;
    }
    
    public void innerCall(int userId) {
        log.debug("[++] innerCall");
        get(userId);
    }
}

複製程式碼
  • 對函式的快取是通過代理來實現的 ： 類內部的某個函式對其他函式（即便被呼叫函式有 @CacheXXX 註解）的呼叫是不會走代理的，也就沒有快取。(比如 innerCall 呼叫 get 時不會使用快取) 。
  • 註解可以放到 Service、Dao 或 Controller 層。
  • @CacheXXX 會快取函式的返回值。比如 increaseComment 會快取更新後的 FeedCount。
  • 當快取中有資料時，@Cacheable 註解的函式不會執行，直接返回快取中的資料。
  • @CachePut、@CacheEvit 註解的函式，無論如何都會執行。

自定義快取

如果要更細粒度地控制 Redis，可以使用 RedisTemplate、StringRedisTemplate

StringRedisTemplate 是 RedisTemplate 的一個特例：key 和 value 都是 String 型別。

  • RedisTemplate 預設使用 JDK 對 key 和 value 進行序列化，轉成位元組存入 Redis。
  • StringRedisTemplate 的 key、value 本身就是 String，使用 StringRedisSerializer 將 String 轉成位元組存入 Redis。

當我們將 RedisTemplate 的 keySerializer 和 valueSerializer 都設定成了 StringRedisSerializer，則 RedisTemplate 和 StringRedisTemplate 的效果是相同的，就像下面的樣例所示。

RedisTemplate 對 Redis 中各個資料結構的操作

  • redisTemplate.opsForValue();//操作字串
  • redisTemplate.opsForHash();//操作hash
  • redisTemplate.opsForList();//操作list
  • redisTemplate.opsForSet();//操作set
  • redisTemplate.opsForZSet();//操作有序set
package zz;

import lombok.extern.slf4j.Slf4j;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import org.springframework.test.context.junit4.SpringRunner;
import zz.domain.User;
import zz.service.UserService;

import java.util.LinkedList;
import java.util.List;

/**
 * zz.TestRedis
 *
 * @author zz
 * @date 2018/5/7
 */
@SpringBootTest
@RunWith(SpringRunner.class)
@Slf4j
public class TestRedis {

    @Autowired
    StringRedisTemplate stringRedisTemplate;

    @Autowired
    RedisTemplate redisTemplate;

    @Autowired
    UserService userService;

    @Test
    public void testSerializer() {
        // 1.
        // 這裡的 opsForValue().get() 的引數必須轉成 String 型別。
        // 除非在 RedisConfig 中 將 keySerializer 設定成 GenericJackson2JsonRedisSerializer 等能將其他型別轉換成 String 的。

        // 2.
        // 如果切換了 RedisConfig 中的 ValueSerializer，要先用 redis-cli 將其中的舊資料刪除。
        // 不同 Serializer 格式之間的轉換可能存在問題。

        final int ID = 123;
        User oldUser;
        oldUser = (User) redisTemplate.opsForValue().get(String.valueOf(ID));
        log.debug("oldUser=" + oldUser);

        User user = new User();
        user.setId(ID);
        user.setName("name");
        log.debug("user=" + user);

        redisTemplate.opsForValue().set(String.valueOf(user.getId()), user);

        User newUser;
        newUser = (User) redisTemplate.opsForValue().get(String.valueOf(ID));
        log.debug("newUser=" + newUser);

        Assert.assertEquals(user.getId(), newUser.getId());
        Assert.assertEquals(user.getName(), newUser.getName());


        List<User> userList = new LinkedList<>();
        userList.add(user);
        user.setId(233);
        user.setName("new");
        userList.add(user);

        redisTemplate.opsForValue().set("userList", userList);
        List<User> newUserList;
        newUserList = (List<User>) redisTemplate.opsForValue().get("userList");

        Assert.assertEquals(userList, newUserList);
    }

    @Test
    public void testSerizlizer2() {
        // 儲存用於恢復，以免影響其他部分
        RedisSerializer oldKeySerializer = redisTemplate.getKeySerializer();
        RedisSerializer oldValueSerializer = redisTemplate.getValueSerializer();

        RedisSerializer redisSerializer = new StringRedisSerializer();
        redisTemplate.setKeySerializer(redisSerializer);
        redisTemplate.setValueSerializer(redisSerializer);

        final String KEY = "key";
        String VALUE = "value";

        redisTemplate.opsForValue().set(KEY, VALUE);
        Assert.assertEquals(VALUE, redisTemplate.opsForValue().get(KEY));
        Assert.assertEquals(VALUE, stringRedisTemplate.opsForValue().get(KEY));


        VALUE = "Val2";
        stringRedisTemplate.opsForValue().set(KEY, VALUE);
        Assert.assertEquals(VALUE, stringRedisTemplate.opsForValue().get(KEY));
        Assert.assertEquals(VALUE, redisTemplate.opsForValue().get(KEY));


        // 恢復原本設定
        redisTemplate.setKeySerializer(oldKeySerializer);
        redisTemplate.setValueSerializer(oldValueSerializer);
    }


    @Test
    public void testCache() {
        final int USER_ID = 1;

        User user = userService.get(USER_ID);
        log.debug("user=" + user);
        Assert.assertEquals(userService.DEFAULT_NAME, user.getName());

        // 這次會直接返回 cache
        user = userService.get(USER_ID);
        log.debug("user=" + user);

        // 獲得修改過的 cache
        final String ANOTHER_NAME = "another user";
        user.setName(ANOTHER_NAME);
        userService.update(user);
        user = userService.get(USER_ID);
        log.debug("user=" + user);
        Assert.assertEquals(ANOTHER_NAME, user.getName());

        // 直接呼叫 get 會走快取，通過 innerCall 來呼叫 get 不會走快取
        log.debug("------ before");
        userService.get(USER_ID);
        log.debug("------ middle");
        userService.innerCall(USER_ID);
        log.debug("------ after");

        // 另一種修改的方式
        final String NEW_NAME = "updated";
        userService.updateName(USER_ID, NEW_NAME);
        user = userService.get(USER_ID);
        log.debug("user=" + user);
        Assert.assertEquals(NEW_NAME, user.getName());


        // 刪除後，cache 中的資料會被刪除，name 會變成初始值
        userService.delete(USER_ID);
        user = userService.get(USER_ID);
        log.debug("user=" + user);
        Assert.assertEquals(userService.DEFAULT_NAME, user.getName());

        // 即使 cache 中沒有該資料，也會執行 delete 中的邏輯
        userService.delete(USER_ID);
        userService.delete(USER_ID);

    }

}


複製程式碼

相關文章