自定义Redis序列化工具

为什么用户需要自己创建一个redis配置类?

SpringBoot提供了对Redis的自动配置功能,在RedisAutoConfiguration类中默认为我们配置了客户端连接(Lettuce和Jedis),以及数据操作模板(StringRedisTemplate和RedisTemplate),下列代码有一个@ConditionalOnMissingBean和@Bean的注解,@ConditionalOnMissingBean注解判断是否执行初始化代码,即如果用户已经创建了bean,则相关的初始化代码不再执行。这导致了默认的是redisTemplate方法会被执行。
自定义Redis序列化工具_第1张图片
RedisTemplate是Spring提供用于操作redis数据库的一个类。将数据存放到Redis中,以及数据读取。这里必然涉及到数据的序列化和反序列化。RedisTemplate默认的系列化类是JdkSerializationRedisSerializer,用JdkSerializationRedisSerializer序列化的话,被序列化的对象必须实现Serializable接口。在存储内容时,除了属性的内容外还存了其它内容在里面,总长度长,且不容易阅读。所以才需要创建一个redis的配置类覆盖默认的序列化。我们要求是存储的数据可以方便查看,也方便反系列化,方便读取数据。
自定义Redis序列化工具_第2张图片
spring为我们提供了多种序列化方式,都在org.springframework.data.redis.serializer包下,常用的分别是:

  • JdkSerializationRedisSerializer
  • GenericJackson2JsonRedisSerializer
  • StringRedisSerializer
  • Jackson2JsonRedisSerializer

JacksonJsonRedisSerializer是spring提供的序列化工具,GenericJackson2JsonRedisSerializer是fastjson提供的json序列化工具,两者都能把字符串序列化成json,但是后者会在json中加入 @class属性,类的全路径包名,方便反系列化。前者如果存放了List则在反系列化的时候如果没指定TypeReference则会报错java.util.LinkedHashMap cannot be cast to 。
两者的具体区别如下:JacksonJsonRedisSerializer和GenericJackson2JsonRedisSerializer的区别

通过RedisSerializer接口实现自定义的redis的序列化工具

Springboot中除了对常用的关系型数据库提供了优秀的自动化支持之外,对于很多nosql数据库一样提供了自动化配置的支持,包括:redis、MongoDB、elasticsearch、solr和Cassandra。

1、springboot对Redis的支持和使用

Spring Boot提供的数据访问框架Spring Data Redis基于Jedis。可以通过如下方式来配制maven依赖


    org.springframework.boot
    spring-boot-starter-data-redis

可以在application.properties中加入Redis服务端的相关配置,也可以使用springboot的方式直接在application.yml文件中进行配置,本文采用在.yml文件中配置的方式实现:
自定义Redis序列化工具_第3张图片
以下是一个redis配置工具类实例,该实例中使用StringRedisSerializer设置key的序列化方式为字符串方式,使用自定义redis序列化类 FastJsonRedisSerializer设置value的序列化方式为json方式。

2、自定义redis序列化类:

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.SerializationException;
import java.nio.charset.Charset;

/**
 * 自定义redis序列化类FastJsonRedisSerializer
 * @author: liumengbing
 * @date: 2019/05/28 10:52
 **/
public class FastJsonRedisSerializer implements RedisSerializer {

    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
    private Class clazz;

    public FastJsonRedisSerializer(Class clazz) {
        super();
        this.clazz = clazz;
    }

    @Override
    public byte[] serialize(T t) throws SerializationException {
        if(t == null){
            return new byte[0];
        }
        return JSON.toJSONString(t, SerializerFeature.WriteClassName).getBytes(DEFAULT_CHARSET);
    }

    @Override
    public T deserialize(byte[] bytes) throws SerializationException {
        if(bytes == null || bytes.length < 0){
            return null;
        }
        String string = new String(bytes,DEFAULT_CHARSET);
        return JSON.parseObject(string,clazz);
    }
}

3、Redis配置工具类:

package com.example.springboottest;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.redis.connection.RedisPassword;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

/**
 * redis配置工具类
 * @author: liumengbing
 * @date: 2019/04/11 10:53
 **/
@Configuration
public class RedisConfig {

    @Value("${spring.redis.host}")
    String rhost;
    @Value("${spring.redis.port}")
    Integer rport;
    @Value("${spring.redis.database}")
    Integer rdatabase;
    @Value("${spring.redis.password}")
    String rpassword;

    @Bean
    @Primary
    public JedisConnectionFactory jedisConnectionFactory(){
        RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration(rhost, rport);
        redisStandaloneConfiguration.setDatabase(rdatabase);
        redisStandaloneConfiguration.setPassword(RedisPassword.of(rpassword));
        JedisConnectionFactory jedisConnectionFactory = new JedisConnectionFactory(redisStandaloneConfiguration);
        jedisConnectionFactory.afterPropertiesSet();
        return jedisConnectionFactory;
    }

    @Bean
    @Primary
    public RedisTemplate redisTemplate(
            @Qualifier("jedisConnectionFactory")JedisConnectionFactory jedisConnectionFactory){
        RedisTemplate redisTemplate = new RedisTemplate();
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        //设置序列化Key的实例化对象,Key的序列化始终是字符串方式
        redisTemplate.setKeySerializer(stringRedisSerializer);
        redisTemplate.setHashKeySerializer(stringRedisSerializer);

        FastJsonRedisSerializer fastJsonRedisSerializer = new FastJsonRedisSerializer<>(Object.class);
        //设置序列化Value的实例化对象
        redisTemplate.setValueSerializer(fastJsonRedisSerializer);
        redisTemplate.setHashValueSerializer(fastJsonRedisSerializer);

        redisTemplate.setConnectionFactory(jedisConnectionFactory);
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }
}
 
  

引申:
为什么Spring redis中缓存的对象需要实现 Serializable 序列化接口
使用Spring Data Redis时,遇到的几个问题

你可能感兴趣的:(Java,SpringBoot)