Sa-Token中JsonIgnore注解对Redis序列化的影响分析

背景介绍

在使用Sa-Token框架进行身份认证和权限管理时，开发者经常需要将用户主体信息缓存到Redis中。在实际开发中，我们可能会遇到这样的场景：某些字段需要使用@JsonIgnore注解来避免返回给前端，但这些字段在Redis序列化时也被忽略了，导致后端使用时无法获取完整数据。

问题本质

这个问题本质上是一个序列化策略的冲突问题。@JsonIgnore是Jackson库提供的注解，它的作用是全局性的，意味着无论在什么场景下进行JSON序列化，被标记的字段都会被忽略。而开发者期望的是：

1. 前端返回时忽略敏感字段
2. Redis存储时保留完整数据
3. 后端使用时能获取全部字段

技术原理分析

在Sa-Token的默认实现中，使用了Jackson库进行序列化操作。当对象被序列化到Redis时，Jackson会遵循@JsonIgnore的规则，导致被标记的字段不会出现在Redis中。这是因为：

1. 序列化过程无法区分"前端序列化"和"存储序列化"的上下文
2. @JsonIgnore是一个硬性规则，没有场景区分能力
3. Redis存储本质上也是一种序列化操作

解决方案探讨

方案一：使用不同的序列化策略

可以配置Spring使用Jackson进行常规序列化，而让Sa-Token使用其他序列化方式(如JDK序列化或Fastjson)。这样Sa-Token在序列化到Redis时就不会识别@JsonIgnore注解。

实现要点：

1. 在Sa-Token配置中指定不同的序列化器
2. 确保两种序列化方式不会互相干扰
3. 注意不同序列化方式的数据兼容性

方案二：使用视图过滤

Jackson提供了视图(Views)功能，可以更精细地控制字段的序列化行为：

public class Views {
    public static class Public {}
    public static class Internal extends Public {}
}

@Entity
public class User {
    @JsonView(Views.Public.class)
    private String username;
    
    @JsonView(Views.Internal.class)
    private String password;
}

然后在不同的序列化场景指定不同的视图：

// 返回前端时使用Public视图
objectMapper.writerWithView(Views.Public.class).writeValueAsString(user);

// Redis存储时使用Internal视图
objectMapper.writerWithView(Views.Internal.class).writeValueAsString(user);

方案三：自定义注解和序列化器

可以创建自定义注解如@RedisInclude，然后实现一个自定义的Jackson序列化器，在Redis序列化时忽略@JsonIgnore但尊重@RedisInclude。

实现步骤：

1. 定义自定义注解
2. 实现自定义序列化器
3. 在Sa-Token配置中使用这个自定义序列化器

最佳实践建议

1. 明确区分数据使用场景：清晰定义哪些数据需要在前端展示，哪些只需要在后端使用

2. 采用视图方案：对于大多数项目，使用Jackson的视图功能是最优雅的解决方案

3. 考虑安全性：即使某些字段不需要返回前端，存储在Redis中时也要考虑加密敏感信息

4. 文档化策略：在团队内部明确序列化策略，避免不同开发者采用不同方案

总结

在Sa-Token框架中使用@JsonIgnore注解时，需要注意它对Redis序列化的全局影响。通过理解序列化的工作原理和Jackson的各种特性，开发者可以选择最适合自己项目的解决方案。视图过滤方案提供了最大的灵活性，而使用不同序列化策略则相对简单易实现。无论选择哪种方案，保持一致性并确保团队所有成员理解其工作原理是关键。