ASP.NET WebApi中POST模型因无效GUID整体为null的问题求助

问题场景 #

定义模型：

public class FooModel
{
  public Guid ReferenceId { get; set; } // 重点属性
  public string SomeValue { get; set; }
}

控制器端点：

[HttpPost]
[ProducesResponseType(200)]
public async Task<IActionResult> SaveFoo([FromBody] FooModel model, CancellationToken ct)
{
  await _fooManager.SaveFoo(model, ct);
  return Ok();
}

当客户端POST包含无效GUID的JSON时：

{
  "referenceId": "some-invalid-guid!",
  "someValue": "some valid value"
}

整个model对象会变为null，即使将ReferenceId改为可空类型Guid?也无法解决。期望保留有效字段，将无效的referenceId设为null或空Guid。

原因分析 #

ASP.NET Core默认的JSON序列化器（System.Text.Json或Newtonsoft.Json）默认采用严格反序列化模式：只要有一个属性反序列化失败，整个对象的反序列化就会彻底失败，最终模型绑定返回null。即使将Guid改为可空类型，默认设置下仍会因无效值触发全局失败。

解决方案 #

方案1：使用System.Text.Json（ASP.NET Core 3.0+默认） #

在Program.cs（.NET 6+）或Startup.cs的服务配置中，修改JSON序列化选项，添加自定义Guid转换器并允许部分反序列化错误：

// .NET 6+ Program.cs示例
builder.Services.AddControllers()
    .AddJsonOptions(options =>
    {
        // 允许部分属性反序列化失败时，保留已成功绑定的字段
        options.AllowInputFormatterExceptionMessages = true;

        // 针对可空Guid：无效值转为null
        options.JsonSerializerOptions.Converters.Add(new JsonConverter<Guid?>()
        {
            public override Guid? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
            {
                if (reader.TokenType != JsonTokenType.String)
                    return null;
                string? value = reader.GetString();
                return Guid.TryParse(value, out Guid guid) ? guid : null;
            }

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

        // （可选）针对非可空Guid：无效值转为空Guid（Guid.Empty）
        options.JsonSerializerOptions.Converters.Add(new JsonConverter<Guid>()
        {
            public override Guid Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
            {
                if (reader.TokenType != JsonTokenType.String)
                    return Guid.Empty;
                string? value = reader.GetString();
                return Guid.TryParse(value, out Guid guid) ? guid : Guid.Empty;
            }

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

配置后：

• 若模型用Guid? ReferenceId，无效值会被转为null，SomeValue等有效字段正常保留；
• 若用非可空Guid ReferenceId，无效值会被转为Guid.Empty，模型不会为null。

方案2：使用Newtonsoft.Json（已配置的情况） #

如果项目使用Newtonsoft.Json替代默认序列化器，可通过以下配置处理：

builder.Services.AddControllers()
    .AddNewtonsoftJson(options =>
    {
        // 处理反序列化错误，标记为已处理避免全局失败
        options.SerializerSettings.Error = (sender, args) =>
        {
            args.ErrorContext.Handled = true;
        };

        // 自定义可空Guid转换器
        options.SerializerSettings.Converters.Add(new JsonConverter<Guid?>()
        {
            public override bool CanConvert(Type objectType)
            {
                return objectType == typeof(Guid?);
            }

            public override Guid? ReadJson(JsonReader reader, Type objectType, Guid? existingValue, bool hasExistingValue, JsonSerializer serializer)
            {
                if (reader.TokenType == JsonToken.Null)
                    return null;
                string? value = reader.Value?.ToString();
                return Guid.TryParse(value, out Guid guid) ? guid : null;
            }

            public override void WriteJson(JsonWriter writer, Guid? value, JsonSerializer serializer)
            {
                writer.WriteValue(value?.ToString());
            }
        });
    });

关键说明 #

• 核心是通过自定义转换器接管Guid的反序列化逻辑，将无效值转为预期的默认值（null或Guid.Empty）；
• 同时需要关闭序列化器的全局失败机制，确保单个属性的反序列化错误不影响整个对象的绑定。

内容的提问来源于stack exchange，提问作者Andrio