ASP.NetCore基于ABP架构配置ToJson序列化

Grizelda ·

更新时间:2024-09-20

· 435 次阅读

一、前言

我们采用ABP架构用MVC Controller或Web API返回给前端结果ToJson序列化后得到的属性命名都是采用js的驼峰格式，即首字母小写，后面单词首字母大写的格式（如：后台属性名为OrderName，返回的前端js为orderName）。但在实际项目开发中由于某种原因（比如给老系统提供接口或现有系统集成等）需要采用给后台属性名一致或自己特定的格式，下面就介绍一下基于ABP架构ToJson如何修改默认配置和自定义配置。

二、修改ToJson序列化默认配置

在Startup文件进行默认配置修改，代码如下：

public class Startup
{
        private readonly IConfigurationRoot _appConfiguration;
        public Startup(IHostingEnvironment env)
        {
            _appConfiguration = env.GetAppConfiguration();
        }
        public IServiceProvider ConfigureServices(IServiceCollection services)
        {
            // MVC
            services.AddMvc()
　　　　　　  .AddJsonOptions(options =>
            {
                //配置tojson格式配置 DefaultContractResolver 为和后台属性名保持一致（即：后台属性名为OrderName，前端js获得属性名也为OrderName）
                options.SerializerSettings.ContractResolver = new DefaultContractResolver();
                //修改为CamelCasePropertyNamesContractResolver，为js的驼峰格式，即abp默认格式（即：后台属性名为OrderName，前端js获得属性名为orderName）
                //options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
            });
　　　　  }
}

三、ToJson序列化自定义配置

如果需要自定义ToJson序列化格式，需要先写一个子类继承DefaultContractResolver，重写ResolvePropertyName方法，代码如下：

public class MyPropertyNamesContractResolver : DefaultContractResolver
{
        protected override string ResolvePropertyName(string propertyName)
        {
            //属性名全部返回小写
            return propertyName .ToLower();
        }
}

再参考第二点在Startup文件将配置替换为MyPropertyNamesContractResolver

services.AddMvc()
.AddJsonOptions(options =>
{
     //配置tojson格式替换为自定义格式 MyPropertyNamesContractResolver （即：后台属性名为OrderName，前端js获得属性名为ordername）
     options.SerializerSettings.ContractResolver = new MyPropertyNamesContractResolver();
     options.SerializerSettings.DateFormatString = "yyyy'-'MM'-'dd' 'HH':'mm':'ss"; //返回给前台的JSON数据中时间格式去掉T
});

到此这篇关于ASP.Net Core基于ABP架构配置To Json序列化的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持软件开发网。

abp ASP

1024 个赞