ASP.NET Boilerplate中Redis缓存序列化异常问题解析

问题背景

在ASP.NET Boilerplate框架中，当开发者将项目升级到9.1.0版本后，使用Redis缓存时可能会遇到一个序列化异常。这个异常主要出现在两种场景中：

1. 使用AbpRedisCache时
2. 使用AbpPerRequestRedisCache时

错误信息显示系统无法序列化System.Type类型的实例，具体报错路径为$.ProviderApiType。

异常分析

该问题的根本原因在于ASP.NET Boilerplate 9.1.0版本中默认使用了System.Text.Json作为JSON序列化器，而Newtonsoft.Json则作为备选方案。System.Text.Json在设计上出于安全考虑，默认不支持System.Type类型的序列化，这与Newtonsoft.Json的行为不同。

当框架尝试将包含Type类型属性的对象序列化到Redis缓存时，System.Text.Json会抛出NotSupportedException异常。这在用户登录等需要缓存认证信息的场景中尤为常见。

解决方案

临时解决方案

1. 回退到Newtonsoft.Json
   在CoreModule中添加以下代码可以暂时解决问题：

   JsonExtensions.UseNewtonsoft = true;
   

2. 自定义Type类型转换器
   可以创建一个自定义的JsonConverter来处理Type类型的序列化：

   public class CustomJsonConverterForType : JsonConverter<Type>
   {
       public override Type Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
       {
           var typeName = reader.GetString();
           return Type.GetType(typeName);
       }
   
       public override void Write(Utf8JsonWriter writer, Type value, JsonSerializerOptions options)
       {
           writer.WriteStringValue(value.AssemblyQualifiedName);
       }
   }
   

   然后在Startup中注册：

   services.AddControllers()
       .AddJsonOptions(options => 
       {
           options.JsonSerializerOptions.Converters.Add(new CustomJsonConverterForType());
       });
   

根本解决方案

ASP.NET Boilerplate团队已经注意到这个问题，并提出了修复方案。开发者可以：

1. 实现自定义的IRedisCacheSerializer，正确处理Type类型的序列化
2. 等待官方发布包含修复的版本

最佳实践建议

1. 评估缓存内容
   检查哪些数据被缓存并导致了这个问题，考虑是否可以重构这些类型以避免包含Type属性。

2. 统一序列化策略
   在整个应用中保持一致的序列化策略，避免混合使用System.Text.Json和Newtonsoft.Json。

3. 监控缓存异常
   即使应用能继续运行，也应监控这些异常，因为它们可能影响性能或导致缓存失效。

4. 测试覆盖
   增加针对缓存序列化的单元测试，确保各种数据类型都能正确序列化和反序列化。

总结

这个问题展示了框架升级时可能遇到的兼容性挑战，特别是在底层组件更换时。开发者需要了解不同JSON序列化器的行为差异，并准备好相应的适配方案。对于ASP.NET Boilerplate用户来说，目前可以通过回退到Newtonsoft.Json或实现自定义转换器来解决这个问题，同时期待官方在后续版本中提供更完善的解决方案。