SpringBoot 整合redis,自定义序列化方式

本文介绍如何在SpringBoot项目中自定义Redis序列化方式,包括创建RedisConfiguration类、实现CachingConfigurer接口、定制序列化与反序列化方法等步骤。

SpringBoot 使用自定义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 了。

### Spring Boot 中 Redis整合序列化配置 在 Spring Boot 中整合 Redis 并对其进行序列化配置是一项常见的需求。以下是关于如何实现这一目标的具体方法。 #### 配置依赖项 为了使 Spring Boot 能够支持 Redis,需要引入 `spring-boot-starter-data-redis` 和 `lettuce` 或者 `jedis` 客户端作为连接器[^1]。以下是一个典型的 Maven 依赖示例: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <!-- 如果使用 Lettuce --> <dependency> <groupId>io.lettuce.core</groupId> <artifactId>lettuce-core</artifactId> </dependency> ``` #### 创建 Redis 配置类 通过创建自定义Redis 配置类来设置序列化方式。默认情况下,Spring Data Redis 使用的是 JdkSerializationRedisSerializer 进行对象序列化和反序列化。然而,在实际应用中通常推荐使用更高效的序列化工具,比如 Jackson JSON Serializer 或 String Redis Serializer[^2]。 下面展示了一个基于 JSON 的序列化配置实例: ```java import com.fasterxml.jackson.annotation.JsonAutoDetect; import com.fasterxml.jackson.annotation.PropertyAccessor; import com.fasterxml.jackson.databind.ObjectMapper; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.data.redis.connection.RedisConnectionFactory; import org.springframework.data.redis.core.RedisTemplate; import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer; import org.springframework.data.redis.serializer.StringRedisSerializer; @Configuration public class RedisConfig { @Bean public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) { RedisTemplate<String, Object> template = new RedisTemplate<>(); // 设置 key 的序列化方式为字符串形式 template.setKeySerializer(new StringRedisSerializer()); // 设置 value 的序列化方式为 JSON 形式 Jackson2JsonRedisSerializer<Object> jacksonSer = new Jackson2JsonRedisSerializer<>(Object.class); ObjectMapper objectMapper = new ObjectMapper(); objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); jacksonSer.setObjectMapper(objectMapper); template.setValueSerializer(jacksonSer); template.setHashValueSerializer(jacksonSer); // 对 hash 类型的数据也采用相同的序列化策略 template.setConnectionFactory(connectionFactory); return template; } } ``` 此代码片段展示了如何利用 Jackson 将复杂 Java 实体转换成 JSON 字符串存储到 Redis 中,并能够正确读取出来。 #### 测试 Redis 功能 完成上述配置之后,可以编写简单的测试案例验证功能是否正常工作。例如保存一个 User 对象至 Redis 及其检索过程如下所示: ```java @Service public class UserService { private final RedisTemplate<String, Object> redisTemplate; public UserService(RedisTemplate<String, Object> redisTemplate){ this.redisTemplate = redisTemplate; } public void saveUser(User user){ redisTemplate.opsForValue().set(user.getId(), user); } public Optional<User> getUser(String id){ return Optional.ofNullable((User) redisTemplate.opsForValue().get(id)); } } // 假设有一个名为 'User' 的实体类 class User{ private Long id; private String name; // getters and setters... } ``` 以上即是在 Spring Boot 中集成 Redis 并进行适当序列化的完整流程说明。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值