ASP.NET Core MVC中如何自定义响应序列化方式？

在ASP.NET Core MVC中，你完全可以通过配置JSON序列化器来定制特定类型的序列化/反序列化行为，刚好能解决你这个AccountId结构体的需求——把默认的嵌套{"Value": "guid字符串"}格式改成直接输出Guid字符串。

下面分两种常用的序列化场景给你具体方案：

一、使用默认的System.Text.Json（.NET 6+推荐） #

ASP.NET Core 3.0及以上默认使用System.Text.Json作为序列化器，你只需要为AccountId编写一个自定义转换器，然后注册到MVC的序列化配置中即可。

1. 编写自定义JsonConverter #

创建一个继承自JsonConverter<AccountId>的转换器类，实现序列化和反序列化逻辑：

public class AccountIdConverter : JsonConverter<AccountId>
{
    // 反序列化：将字符串格式的Guid转为AccountId实例
    public override AccountId Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        var guidString = reader.GetString();
        if (Guid.TryParse(guidString, out var guid))
        {
            return new AccountId(guid);
        }
        throw new JsonException("无效的AccountId格式，请传入合法的Guid字符串");
    }

    // 序列化：直接输出AccountId内部的Guid字符串
    public override void Write(Utf8JsonWriter writer, AccountId value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value.Value.ToString());
    }
}

2. 注册转换器到MVC服务 #

在Program.cs（.NET 6+顶级语句模式）中，配置Controllers的Json选项，添加这个转换器：

var builder = WebApplication.CreateBuilder(args);

// 添加Controllers服务并配置Json序列化选项
builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new AccountIdConverter());
    });

var app = builder.Build();

// 中间件配置...
app.MapControllers();

app.Run();

二、使用Newtonsoft.Json（旧项目或特殊需求） #

如果你的项目仍然使用Newtonsoft.Json（比如通过AddNewtonsoftJson配置），可以用类似的方式编写转换器：

1. 编写Newtonsoft版本的转换器 #

public class AccountIdNewtonsoftConverter : JsonConverter<AccountId>
{
    public override void WriteJson(JsonWriter writer, AccountId value, JsonSerializer serializer)
    {
        // 序列化时直接输出Guid字符串
        writer.WriteValue(value.Value.ToString());
    }

    public override AccountId ReadJson(JsonReader reader, Type objectType, AccountId existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        // 反序列化时将字符串转为AccountId
        var guidString = reader.Value?.ToString();
        if (Guid.TryParse(guidString, out var guid))
        {
            return new AccountId(guid);
        }
        throw new JsonSerializationException("无效的AccountId格式，请传入合法的Guid字符串");
    }

    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(AccountId);
    }
}

2. 注册到Newtonsoft的序列化配置中 #

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        options.SerializerSettings.Converters.Add(new AccountIdNewtonsoftConverter());
    });

效果验证 #

配置完成后，当你的Action直接返回AccountId实例，或者返回包含AccountId属性的模型时，序列化结果都会变成纯Guid字符串，而不是嵌套的对象结构。比如原本的：

{"Value": "550e8400-e29b-41d4-a716-446655440000"}

会变成：

"550e8400-e29b-41d4-a716-446655440000"

内容的提问来源于stack exchange，提问作者Michał Dudak