SpringBoot 使用redis 時，自定義redis 序列化方式

最近在學習redis 時，看了網上的文章，發現他們的序列化我這邊無法使用，原因是用來序列化的類裡面引用的jar 我這邊專案竟然沒有，所以打算自定義一個序列化儲存方式，特此記錄。

當前日期：2018-5-31
專案環境為：
1. IDEA 2018.1.4
2. Springboot 2.0.2
3. spring-boot-starter-web
4. spring-boot-starter-cache
5. spring-boot-starter-data-redis

建立RedisConfiguration

類進行redia 配置。

其實對於spring-boot-starter-data-redis 這個包中的預設配置了redia 伺服器的預設連結、埠號等其他的連線資訊，詳細的屬性，可以檢視org.springframework.boot.autoconfigure.data.redis.RedisProperties 中的詳細配置資訊

建立RedisConfiguration 類實現CachingConfigurer 介面，注入redia 連線工廠，重寫cacheManager方法，實現spring cache 管理redia 快取。

@Autowired
RedisConnectionFactory redisConnectionFactory;

@Override
 

public CacheManager cacheManager(){
    return RedisCacheManager.create(redisConnectionFactory);
}

快取物件集合中，快取是以key-value形式儲存的。當不指定快取的key時，SpringBoot會使用keyGenerator() 方法生成key，所以重寫keyGenerator() 方法。

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

可自行更改，自定義序列化key 的方法。

新增RedisTemplate 型別的bean 供自己手動呼叫redia 功能。

@Bean
public RedisTemplate<String, String> redisTemplate() {
    StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
    stringRedisTemplate.setValueSerializer(new UserRedisSerializer());
    stringRedisTemplate.setConnectionFactory(this.redisConnectionFactory);
    return stringRedisTemplate;
}

使用StringRedisTemplate 類進行屬性的序列化，序列化方式使用UserRedisSerializer 類。

建立UserRedisSerializer 類，實現RedisSerializer<Object> 介面，重寫序列化與反序列化方法。

public class UserRedisSerializer implements RedisSerializer<Object> {

    @Override
    public byte[] serialize(Object o) throws SerializationException {
        ByteArrayOutputStream byteOut = new ByteArrayOutputStream();
        ObjectOutputStream objOut;
        try {
            objOut = new ObjectOutputStream(byteOut);
            objOut.writeObject(o);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return byteOut.toByteArray();
    }

    @Override
    public Object deserialize(byte[] bytes) throws SerializationException {
        if(bytes == null) return null;
        ByteArrayInputStream byteIn = new ByteArrayInputStream(bytes);
        ObjectInputStream objIn;
        Object obj;
        try {
            objIn = new ObjectInputStream(byteIn);
            obj =objIn.readObject();
        } catch (IOException | ClassNotFoundException e) {
            e.printStackTrace();
            return null;
        }
        return obj;
    }
}

功能是將需要處理的類，通過object 流序列化為字串，存入redis 中。
deserialize() 反序列化方法中，第一行檢測是否為空的原因是在儲存的時候，儲存結束會呼叫一次反序列化，原因尚未知，如有了解的可以回覆評論我，多謝。

此時即可建立JUnit 測試類進行測試。

@Test
public void test1(){

    @Autowired
    RedisTemplate redisTemplate;

    redisTemplate.opsForValue().set("TestData", new User("zhangsan", "123456"));
    System.out.println(redisTemplate.opsForValue().get("TestData"));

}

此時會在redis 中getTestData獲取到key 的資訊並在控制檯發現User 類的輸出。
User 類自行建立就好。

這樣自定義序列化方式就OK 了。