如何在ASP.NET Core响应中自定义ModelErrors实例的返回格式

你现有如下ModelErrors类：

public class ModelErrors
{
    private Dictionary<string, List<string>> Errors { get; set; } = [];

    public void Add(string propertyName, string value)
    {
        // 检查该属性是否已有错误
        if (Errors.TryGetValue(propertyName, out List<string>? propErrors))
        {
            propErrors.Add(value);
        }
    }
}

当执行以下代码返回BadRequest时，希望将Errors从Dictionary<string, List<string>>转换为Dictionary<string, string>，把每个属性的所有错误信息拼接成单个字符串返回给客户端：

ModelErrors errs = new();
errs.Add("hello", "world");

return BadRequest(errs);

可以通过以下几种方式实现：

方法一：给ModelErrors添加转换方法 #

直接在ModelErrors类中新增转换方法，同时补全原Add方法的逻辑漏洞（原代码未处理属性名不存在的情况）：

public class ModelErrors
{
    private Dictionary<string, List<string>> Errors { get; set; } = [];

    public void Add(string propertyName, string value)
    {
        if (Errors.TryGetValue(propertyName, out List<string>? propErrors))
        {
            propErrors.Add(value);
        }
        else
        {
            Errors[propertyName] = new List<string> { value };
        }
    }

    // 新增转换为扁平化字典的方法
    public Dictionary<string, string> ToFlattenedErrors()
    {
        return Errors.ToDictionary(
            kvp => kvp.Key,
            kvp => string.Join("; ", kvp.Value)
        );
    }
}

使用时直接传入转换后的结果：

ModelErrors errs = new();
errs.Add("hello", "world");
errs.Add("hello", "another error");

return BadRequest(errs.ToFlattenedErrors());

方法二：自定义JSON序列化逻辑 #

如果希望直接返回ModelErrors实例时自动转换格式，可以通过自定义JSON转换器实现（以Newtonsoft.Json为例）：

1. 创建自定义转换器：

public class ModelErrorsConverter : JsonConverter<ModelErrors>
{
    public override void WriteJson(JsonWriter writer, ModelErrors? value, JsonSerializer serializer)
    {
        if (value == null)
        {
            writer.WriteNull();
            return;
        }

        var flattenedErrors = value.Errors.ToDictionary(
            kvp => kvp.Key,
            kvp => string.Join("; ", kvp.Value)
        );
        serializer.Serialize(writer, flattenedErrors);
    }

    public override ModelErrors? ReadJson(JsonReader reader, Type objectType, ModelErrors? existingValue, bool hasExistingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException("ModelErrors反序列化暂不支持");
    }
}

2. 修改ModelErrors类，让转换器能访问内部的Errors字典，并标记转换器：

[JsonConverter(typeof(ModelErrorsConverter))]
public class ModelErrors
{
    internal Dictionary<string, List<string>> Errors { get; set; } = [];

    // 保持原Add方法（已补全逻辑）
    public void Add(string propertyName, string value)
    {
        if (Errors.TryGetValue(propertyName, out List<string>? propErrors))
        {
            propErrors.Add(value);
        }
        else
        {
            Errors[propertyName] = new List<string> { value };
        }
    }
}

这样返回BadRequest(errs)时，JSON序列化会自动转换成扁平化的字典格式。

方法三：返回时直接转换 #

如果不想修改ModelErrors类，可在返回BadRequest时直接转换格式（需将Errors的访问修饰符改为internal或public）：

ModelErrors errs = new();
errs.Add("hello", "world");

var flattenedErrors = errs.Errors.ToDictionary(
    kvp => kvp.Key,
    kvp => string.Join("; ", kvp.Value)
);
return BadRequest(flattenedErrors);

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