ASP.NET Web API中用ModelBinder修剪模型空格：MVC方法不适用怎么办

嘿，你提到的这个问题特别常见——MVC和Web API的IModelBinder接口确实存在差异，直接照搬MVC的代码自然行不通。别担心，我给你几个实用的解决思路：

思路1：实现Web API专属的自定义模型绑定器 #

Web API的IModelBinder要求返回bool类型，并且接收HttpActionContext作为参数，我们可以针对性地实现一个专门处理字符串修剪的绑定器：

public class TrimModelBinder : IModelBinder
{
    public bool BindModel(HttpActionContext actionContext, ModelBindingContext bindingContext)
    {
        // 只处理字符串类型的属性
        if (bindingContext.ModelType != typeof(string))
        {
            return false;
        }

        var valueProviderResult = bindingContext.ValueProvider.GetValue(bindingContext.ModelName);
        if (valueProviderResult == null)
        {
            return false;
        }

        var inputValue = valueProviderResult.AttemptedValue;
        if (string.IsNullOrEmpty(inputValue))
        {
            return false;
        }

        // 执行修剪操作并赋值给模型
        bindingContext.Model = inputValue.Trim();
        return true;
    }
}

注册绑定器的两种方式： #

• 全局生效：在WebApiConfig.cs的Register方法中配置，对所有字符串类型属性自动修剪：

  config.BindParameter(typeof(string), new TrimModelBinder());
  

• 局部生效：给特定模型的字符串属性单独标记绑定器：

  public class UserRequestModel
  {
      [ModelBinder(typeof(TrimModelBinder))]
      public string Username { get; set; }
      
      [ModelBinder(typeof(TrimModelBinder))]
      public string Email { get; set; }
  }
  

思路2：用TypeConverter实现全局字符串修剪 #

如果不想写模型绑定器，还可以用TypeConverter实现更简洁的全局处理：

1. 自定义一个字符串修剪转换器：

public class TrimStringConverter : 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)
    {
        var strValue = value as string;
        return string.IsNullOrEmpty(strValue) ? strValue : strValue.Trim();
    }
}

2. 在应用启动时注册这个转换器（比如Global.asax.cs的Application_Start方法）：

TypeDescriptor.AddAttributes(typeof(string), new TypeConverterAttribute(typeof(TrimStringConverter)));

这样所有字符串类型的属性都会自动修剪空格，无需额外标记。

思路3：针对JSON输入配置媒体格式化器 #

如果你的API主要接收JSON请求，可以直接修改JsonMediaTypeFormatter的设置，让序列化库自动处理字符串修剪：

在WebApiConfig.cs中添加配置：

config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new DefaultContractResolver
{
    ResolveContract = type =>
    {
        var contract = base.ResolveContract(type) as JsonObjectContract;
        if (contract != null)
        {
            foreach (var property in contract.Properties)
            {
                if (property.PropertyType == typeof(string))
                {
                    var originalSetter = property.ValueProvider.SetValue;
                    // 替换属性赋值逻辑，添加修剪操作
                    property.ValueProvider = new TrimValueProvider(originalSetter);
                }
            }
        }
        return contract;
    }
};

// 辅助类：包装原始赋值逻辑，添加修剪
public class TrimValueProvider : IValueProvider
{
    private readonly IValueProvider _originalProvider;

    public TrimValueProvider(IValueProvider originalProvider)
    {
        _originalProvider = originalProvider;
    }

    public void SetValue(object target, object value)
    {
        var strValue = value as string;
        _originalProvider.SetValue(target, strValue?.Trim());
    }

    public object GetValue(object target)
    {
        return _originalProvider.GetValue(target);
    }
}

这个方法仅对JSON请求有效，适合以JSON为主要交互格式的API场景。

以上几种方法都能解决你的问题，你可以根据项目的实际需求选择——全局绑定器或TypeConverter适合所有请求类型，媒体格式化器则更针对性地处理JSON输入。

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