首页
/ OrchardCore中禁用JsonStringEnumConverter的配置方法

OrchardCore中禁用JsonStringEnumConverter的配置方法

2025-05-29 04:50:39作者:咎岭娴Homer

在OrchardCore 2.1.3版本中,系统默认引入了JsonStringEnumConverter,这一改动将枚举类型序列化为字符串而非整数。虽然这种改变对大多数应用场景有利,但对于某些特定场景,特别是需要严格控制存储空间使用的高频交易系统,这种改变可能带来不便。

背景分析

JsonStringEnumConverter是System.Text.Json提供的一个转换器,它能够将枚举值序列化为对应的字符串名称而非数字值。这种序列化方式具有更好的可读性,但在以下场景中可能不适用:

  1. 需要与旧系统保持兼容,旧系统依赖枚举的整数值
  2. 存储空间极其有限,需要最小化数据体积
  3. 与其他系统交互,这些系统只能处理枚举的数值形式

OrchardCore在文档序列化中默认启用了这个转换器,这会影响内容项(ContentItem)和其他文档的存储格式。

解决方案

通过分析OrchardCore的源代码,我们发现可以通过修改DocumentJsonSerializerOptions和JOptions.Default的配置来移除JsonStringEnumConverter。以下是完整的实现方案:

public static class DocumentJsonSerializerExtensions
{
    public static void RemoveJsonStringEnumConverter(this IServiceCollection services)
    {
        services.Configure<DocumentJsonSerializerOptions>(options =>
        {
            var enumConverter = options.SerializerOptions.Converters
                .FirstOrDefault(x => x.GetType() == typeof(JsonStringEnumConverter));
            
            if (enumConverter != null)
            {
                options.SerializerOptions.Converters.Remove(enumConverter);
            }

            var defaultConverter = JOptions.Default.Converters
                .FirstOrDefault(x => x.GetType() == typeof(JsonStringEnumConverter));
            
            if (defaultConverter != null)
            {
                JOptions.Default.Converters.Remove(defaultConverter);
            }
        });
    }
}

在应用程序启动时调用此扩展方法:

public void ConfigureServices(IServiceCollection services)
{
    services.AddOrchardCms();
    services.RemoveJsonStringEnumConverter();
}

实现原理

这个解决方案通过两个关键步骤确保枚举值以整数形式序列化:

  1. 从DocumentJsonSerializerOptions中移除JsonStringEnumConverter,这会影响OrchardCore文档的序列化行为
  2. 从JOptions.Default中移除相同的转换器,确保所有使用默认JSON选项的地方都保持一致

需要注意的是,这个配置应该放在主Web项目的启动代码中,而不是模块的启动代码中。因为在模块被激活前,主应用可能已经执行了一些序列化操作。

性能考量

对于高频交易系统,使用整数而非字符串序列化枚举可以带来以下优势:

  1. 减少存储空间:整数通常占用更少的字节
  2. 提高序列化/反序列化速度:整数处理比字符串更高效
  3. 降低网络传输开销:在分布式系统中尤为重要

兼容性建议

虽然本文介绍了如何禁用JsonStringEnumConverter,但在大多数情况下,建议开发者适应新的字符串序列化方式,因为:

  1. 字符串形式的枚举值更具可读性
  2. 更易于调试和维护
  3. 是.NET生态系统的推荐做法

只有在确实需要整数序列化的特定场景下,才建议使用本文的解决方案。

通过这种灵活的配置方式,OrchardCore既保持了默认的最佳实践,又为特殊需求提供了解决方案,体现了框架设计的包容性和可扩展性。

登录后查看全文
热门项目推荐

热门内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512