如何为继承自不可控基类的属性添加JsonPropertyName特性？

当需要将JSON反序列化为继承自基类的自定义类，但基类的属性与JSON字段不匹配，且无法控制该基类时，该如何处理？

示例JSON：

{
  "prop1": "Value1",
  "prop2": "Value2"
}

希望将上述JSON反序列化为MyClass类：

public class MyClass : Base
{
    [JsonPropertyName("prop2")]
    public string? Property2 { get; set; }
}

public class Base // 无法修改该基类
{
  public string? Property1 { get; init; }
}

请问是否应该重写基类的属性并为其添加特性装饰？

首先明确：不建议重写基类属性。原因有两点：一是示例中的基类Property1未标记为virtual，无法直接重写；二是即便基类属性支持重写，强行添加JsonPropertyName特性可能破坏基类原有逻辑（比如基类内部依赖该属性的默认序列化行为）。

针对这种无法修改基类的场景，推荐以下几种可靠方案：

方案1：自定义JsonConverter #

编写针对MyClass的转换器，手动处理属性映射逻辑：

public class MyClassConverter : JsonConverter<MyClass>
{
    public override MyClass? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        using var doc = JsonDocument.ParseValue(ref reader);
        var root = doc.RootElement;
        
        var myClass = new MyClass
        {
            Property1 = root.TryGetProperty("prop1", out var prop1) ? prop1.GetString() : null,
            Property2 = root.TryGetProperty("prop2", out var prop2) ? prop2.GetString() : null
        };
        
        return myClass;
    }

    public override void Write(Utf8JsonWriter writer, MyClass value, JsonSerializerOptions options)
    {
        writer.WriteStartObject();
        writer.WriteString("prop1", value.Property1);
        writer.WriteString("prop2", value.Property2);
        writer.WriteEndObject();
    }
}

使用时将转换器加入序列化配置：

var options = new JsonSerializerOptions();
options.Converters.Add(new MyClassConverter());
var myClass = JsonSerializer.Deserialize<MyClass>(json, options);

方案2：中间DTO映射 #

先将JSON反序列化为与JSON结构完全匹配的DTO类，再手动映射到MyClass：

// 与JSON字段一一对应的DTO
public class MyClassDto
{
    [JsonPropertyName("prop1")]
    public string? Prop1 { get; set; }
    
    [JsonPropertyName("prop2")]
    public string? Prop2 { get; set; }
}

映射代码：

var dto = JsonSerializer.Deserialize<MyClassDto>(json);
var myClass = new MyClass
{
    Property1 = dto?.Prop1,
    Property2 = dto?.Prop2
};

这种方式逻辑清晰，适合结构复杂或需要额外数据校验的场景。

方案3：全局命名策略配置（仅适用于规则性命名差异） #

如果JSON与基类的属性差异是统一的命名规则（比如JSON用小驼峰，基类用帕斯卡），可以直接配置序列化选项：

var options = new JsonSerializerOptions
{
    PropertyNameCaseInsensitive = true,
    PropertyNamingPolicy = JsonNamingPolicy.CamelCase // 根据实际命名规则调整
};
var myClass = JsonSerializer.Deserialize<MyClass>(json, options);

注意：该方案仅适合批量匹配的场景，无法处理单个属性的自定义映射。

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