在ASP.NET Core 2的TypeConverter中如何标记转换错误？

我来给你梳理一下具体的实现步骤，刚好你提到的「格式错误时标记错误（抛异常）」的需求完全可以通过TypeConverter结合ASP.NET Core的模型绑定机制实现：

1. 实现自定义TypeConverter #

首先你需要编写继承自TypeConverter的转换器类，在ConvertFrom方法里处理字符串到自定义类型的转换，解析失败时抛出带详细信息的异常：

public class CustomIdTypeConverter : TypeConverter
{
    // 声明该转换器支持从字符串转换到目标类型
    public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
    {
        return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
    }

    public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
    {
        if (value is string inputStr)
        {
            // 调用自定义解析方法，这里假设返回包含解析状态的结果对象
            var parseResult = ParseCustomId(inputStr);
            
            if (!parseResult.Success)
            {
                // 抛出带内部异常的ArgumentException，让模型绑定系统捕获并标记错误
                throw new ArgumentException("无效的自定义类型格式", nameof(value), parseResult.Exception);
            }
            
            return parseResult.Value;
        }

        // 处理其他类型的转换（默认逻辑）
        return base.ConvertFrom(context, culture, value);
    }

    // 示例解析方法：根据你的实际业务逻辑编写
    private (bool Success, CustomId Value, Exception Exception) ParseCustomId(string input)
    {
        // 这里写你的格式校验逻辑，比如长度、字符规则等
        if (string.IsNullOrWhiteSpace(input) || input.Length != 8)
        {
            return (false, null, new FormatException("自定义类型必须是8位非空字符"));
        }

        // 解析成功则返回自定义类型实例
        return (true, new CustomId(input), null);
    }
}

// 你的自定义类型示例
public class CustomId
{
    public string Value { get; }

    public CustomId(string value)
    {
        Value = value;
    }
}

2. 注册TypeConverter让模型绑定生效 #

有两种方式可以让ASP.NET Core识别你的转换器：

方式一：给自定义类型添加特性标记 #

直接在你的自定义类型上加上[TypeConverter]特性，指定对应的转换器：

[TypeConverter(typeof(CustomIdTypeConverter))]
public class CustomId
{
    public string Value { get; }

    public CustomId(string value)
    {
        Value = value;
    }
}

方式二：全局注册转换器（适合不想修改自定义类型的场景） #

在Startup.cs的ConfigureServices方法里全局注册转换器：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options =>
    {
        // 检查是否已经注册过转换器，避免重复注册
        var existingConverterAttr = TypeDescriptor.GetAttributes(typeof(CustomId))
            .OfType<TypeConverterAttribute>()
            .FirstOrDefault();
        
        if (existingConverterAttr == null)
        {
            TypeDescriptor.AddAttributes(typeof(CustomId), 
                new TypeConverterAttribute(typeof(CustomIdTypeConverter)));
        }
    });
}

3. 错误处理与模型验证 #

当TypeConverter抛出异常时，ASP.NET Core的模型绑定系统会自动将异常信息添加到ModelState中，你只需要在控制器里检查ModelState.IsValid即可：

[HttpGet("api/data")]
public IActionResult GetData([FromQuery] CustomId id)
{
    if (!ModelState.IsValid)
    {
        // 返回包含错误信息的BadRequest响应
        return BadRequest(ModelState);
    }

    // 正常业务逻辑处理
    return Ok($"Received valid CustomId: {id.Value}");
}

此时如果传入的字符串格式错误，客户端会收到类似这样的错误响应：

{
  "id": [
    "无效的自定义类型格式"
  ]
}

关键注意点 #

• 一定要重写CanConvertFrom方法，明确告诉类型转换器系统该转换器支持从字符串转换到你的自定义类型。
• 抛出异常时建议带上内部异常（比如解析时的FormatException），这样ModelState里的错误信息会更详细，便于排查问题。
• ASP.NET Core 2.x的模型绑定系统会自动捕获TypeConverter转换过程中抛出的异常，无需额外编写异常捕获逻辑。

内容的提问来源于stack exchange，提问作者Mikkel R. Lund