ABP框架中Json格式化要怎么实现？有哪些常用配置方法？

ABP框架基于ASP.NET Core构建，其Json序列化能力默认依赖System.Text.Json组件，开发者可以通过多种配置方式调整序列化规则，满足不同场景下的数据格式要求。

ABP中Json格式化的默认配置

ABP框架在启动时会自动配置基础的Json序列化规则，默认情况下会处理驼峰命名、中文编码等基础问题，无需开发者额外编写配置代码即可完成基础的接口数据序列化。如果需要调整默认行为，可以在模块的配置阶段进行修改。

修改默认序列化选项

在ABP应用的模块类中，可以通过配置AbpSystemTextJsonOptions来调整全局的Json序列化规则，示例代码如下：

using Microsoft.Extensions.DependencyInjection;
using Volo.Abp.Json.SystemTextJson;
using Volo.Abp.Modularity;

namespace MyProject
{
    [DependsOn(typeof(AbpJsonSystemTextJsonModule))]
    public class MyProjectModule : AbpModule
    {
        public override void ConfigureServices(ServiceConfigurationContext context)
        {
            // 配置全局Json序列化选项
            Configure<AbpSystemTextJsonOptions>(options =>
            {
                // 获取System.Text.Json的序列化选项
                var jsonOptions = options.JsonSerializerOptions;
                // 设置属性名称使用驼峰命名
                jsonOptions.PropertyNamingPolicy = System.Text.Json.JsonNamingPolicy.CamelCase;
                // 设置日期格式
                jsonOptions.Converters.Add(new System.Text.Json.Serialization.JsonStringEnumConverter());
            });
        }
    }
}

常用Json格式化配置场景

自定义日期格式

默认情况下System.Text.Json对日期的序列化格式不符合很多业务的需求，我们可以通过自定义转换器来实现指定格式的日期输出：

using System.Text.Json;
using System.Text.Json.Serialization;

// 自定义日期格式转换器
public class DateTimeJsonConverter : JsonConverter<DateTime>
{
    private readonly string _format;

    public DateTimeJsonConverter(string format)
    {
        _format = format;
    }

    public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        return DateTime.Parse(reader.GetString());
    }

    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.ToString(_format));
    }
}

// 在配置中注册转换器
Configure<AbpSystemTextJsonOptions>(options =>
{
    options.JsonSerializerOptions.Converters.Add(new DateTimeJsonConverter("yyyy-MM-dd HH:mm:ss"));
});

忽略空值属性

如果接口返回的数据中不需要包含值为null的属性，可以开启忽略空值的配置：

Configure<AbpSystemTextJsonOptions>(options =>
{
    // 忽略值为null的属性
    options.JsonSerializerOptions.DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull;
});

处理循环引用

当实体之间存在导航属性关联时，序列化可能会出现循环引用的问题，可以通过配置引用处理方式解决：

Configure<AbpSystemTextJsonOptions>(options =>
{
    // 忽略循环引用，出现循环时不再序列化后续属性
    options.JsonSerializerOptions.ReferenceHandler = System.Text.Json.Serialization.ReferenceHandler.IgnoreCycles;
});

控制器级别的Json格式化配置

如果只需要对某个控制器或者某个接口方法单独设置Json格式化规则，不需要修改全局配置，可以在方法上添加JsonResult返回时指定序列化选项：

using Microsoft.AspNetCore.Mvc;
using System.Text.Json;

[Route("api/test")]
public class TestController : Controller
{
    [HttpGet]
    public JsonResult GetTestData()
    {
        var data = new
        {
            Id = 1,
            Name = "测试数据",
            CreateTime = DateTime.Now
        };
        // 单独指定该接口的序列化选项
        var options = new JsonSerializerOptions
        {
            PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
            Converters = { new DateTimeJsonConverter("yyyy年MM月dd日") }
        };
        return new JsonResult(data, options);
    }
}

注意事项

• ABP框架如果同时使用Newtonsoft.Json组件，需要优先确认当前项目使用的序列化组件，避免配置不生效。
• 自定义转换器时需要同时实现Read和Write方法，否则会出现反序列化失败的问题。
• 全局配置会影响所有接口的返回数据，修改前需要确认是否会对已有业务造成影响。

通过上述配置方式，开发者可以根据实际业务需求灵活调整ABP框架中的Json格式化规则，适配不同的前后端交互场景。

ABPJson_formatserializationASP.NET_Core修改时间：2026-06-04 14:59:58