自定义模型绑定器用于处理复杂数据绑定场景，如将逗号分隔字符串转为List，需实现IModelBinder和IModelBinderProvider并注册到MVC选项中。
ASP.NET Core中的模型绑定器负责将HTTP请求中的数据（如查询字符串、表单数据、路由数据等）转换为Action方法可以使用的.NET对象。简单来说，它就是个翻译官，把浏览器发来的“外语”翻译成你的代码能理解的“母语”。自定义模型绑定器允许你更灵活地控制这个翻译过程，处理一些默认绑定器无法处理的复杂情况。
解决方案
ASP.NET Core的模型绑定器工作流程大致如下：
- 请求到达： HTTP请求到达服务器。
- 模型绑定器启动： ASP.NET Core MVC框架根据Action方法的参数类型和特性，选择合适的模型绑定器。
- 数据源查找： 模型绑定器查找请求中的数据源，例如查询字符串、表单数据、路由数据、请求头等。
- 数据转换： 模型绑定器将找到的数据转换为Action方法参数所需的类型。这可能涉及到类型转换、格式化、验证等操作。
-
模型验证： 如果Action方法参数使用了
[ApiController]
特性，或者显式使用了ModelState.IsValid
，则会对绑定后的模型进行验证。 - Action方法执行： 如果模型绑定成功且验证通过，则执行Action方法，并将绑定后的模型作为参数传递给它。
如何自定义模型绑定器？
自定义模型绑定器通常涉及以下几个步骤：
-
创建模型绑定器类： 实现
IModelBinder
接口，该接口只有一个方法BindModelAsync
。 -
实现
BindModelAsync
方法： 在该方法中，你需要编写自定义的绑定逻辑。这包括从请求中获取数据、进行类型转换、验证数据等。 -
创建模型绑定器提供程序： 实现
IModelBinderProvider
接口，该接口只有一个方法GetBinder
。 -
实现
GetBinder
方法： 在该方法中，你需要判断当前请求是否需要使用你的自定义模型绑定器。如果是，则返回你的模型绑定器实例；否则，返回null
。 -
注册模型绑定器提供程序： 在
Startup.cs
的ConfigureServices
方法中，将你的模型绑定器提供程序添加到MVC选项中。
代码示例：
假设我们需要自定义一个模型绑定器，用于将逗号分隔的字符串转换为
List。
// 1. 创建模型绑定器类
public class CommaSeparatedIntListModelBinder : IModelBinder
{
public Task BindModelAsync(ModelBindingContext bindingContext)
{
if (bindingContext == null)
{
throw new ArgumentNullException(nameof(bindingContext));
}
// 获取模型名称
var modelName = bindingContext.ModelName;
// 尝试从请求中获取值
var valueProviderResult = bindingContext.ValueProvider.GetValue(modelName);
if (valueProviderResult == ValueProviderResult.None)
{
return Task.CompletedTask;
}
bindingContext.ModelState.SetModelValue(modelName, valueProviderResult);
var stringValue = valueProviderResult.FirstValue;
// 如果值为空，则返回null
if (string.IsNullOrEmpty(stringValue))
{
return Task.CompletedTask;
}
try
{
// 将逗号分隔的字符串转换为List
var intList = stringValue.Split(',').Select(int.Parse).ToList();
// 设置模型绑定结果
bindingContext.Result = ModelBindingResult.Success(intList);
return Task.CompletedTask;
}
catch (FormatException)
{
bindingContext.ModelState.AddModelError(modelName, "Invalid integer format.");
return Task.CompletedTask;
}
}
}
// 2. 创建模型绑定器提供程序
public class CommaSeparatedIntListModelBinderProvider : IModelBinderProvider
{
public IModelBinder GetBinder(ModelBindingContext context)
{
if (context == null)
{
throw new ArgumentNullException(nameof(context));
}
// 判断是否需要使用自定义模型绑定器
if (context.Metadata.ModelType == typeof(List))
{
return new CommaSeparatedIntListModelBinder();
}
return null;
}
}
// 3. 注册模型绑定器提供程序
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers(options =>
{
options.ModelBinderProviders.Insert(0, new CommaSeparatedIntListModelBinderProvider());
});
} 使用示例：
[ApiController]
[Route("[controller]")]
public class MyController : ControllerBase
{
[HttpGet("GetList")]
public IActionResult GetList([FromQuery] List ids)
{
if (ids == null)
{
return BadRequest("IDs cannot be null.");
}
return Ok(ids);
}
} 现在，你可以通过以下URL来测试：
https://localhost:5001/MyController/GetList?ids=1,2,3,4,5
为什么需要自定义模型绑定器？有哪些常见的使用场景？
自定义模型绑定器可以处理一些内置模型绑定器无法处理的复杂情况，例如：
- 复杂类型转换： 将请求中的数据转换为复杂的.NET对象，例如将JSON字符串转换为自定义对象。
- 自定义数据源： 从非标准的数据源中获取数据，例如从Cookie、Session、数据库等。
- 自定义验证： 进行自定义的数据验证，例如根据业务规则验证数据。
- 处理遗留系统数据格式： 当需要与使用特殊数据格式的遗留系统集成时，可以使用自定义模型绑定器来解析这些格式。
- 安全考虑： 在绑定过程中执行额外的安全检查，例如防止恶意输入。
常见的使用场景包括：
-
日期时间格式转换： 将不同格式的日期时间字符串转换为
DateTime
对象。 - 枚举类型转换： 将字符串转换为枚举类型。
- 处理加密数据： 解密请求中的加密数据。
- 多部分/表单数据处理： 处理包含文件上传的多部分/表单数据。
- 从请求头读取数据： 从自定义的请求头中读取数据。
如何调试自定义模型绑定器？
调试自定义模型绑定器需要一些技巧，因为模型绑定过程发生在请求处理的早期阶段。以下是一些常用的调试方法：
-
使用断点： 在
BindModelAsync
方法中设置断点，可以逐步跟踪绑定过程，查看变量的值，以及了解绑定逻辑的执行情况。 -
使用日志： 在
BindModelAsync
方法中使用ILogger
接口记录日志，可以帮助你了解绑定过程中发生了什么，例如从请求中获取了哪些数据，进行了哪些类型转换，以及是否发生了错误。 -
使用ModelState： 使用
bindingContext.ModelState
来添加错误信息，可以帮助你了解模型验证是否通过，以及如果验证失败，失败的原因是什么。 - 单元测试： 编写单元测试来测试你的自定义模型绑定器，可以帮助你确保绑定逻辑的正确性，以及避免出现意外的错误。
- 中间件调试： 可以创建一个简单的中间件，在模型绑定之前或之后拦截请求，并记录相关信息。这可以帮助你了解请求的原始数据，以及模型绑定后的数据。
如何在不同的作用域中使用模型绑定器？
模型绑定器通常是在控制器级别或Action方法级别使用的。
-
控制器级别： 可以在控制器类上使用
[ModelBinder]
特性，指定该控制器下的所有Action方法都使用指定的模型绑定器。[ModelBinder(typeof(CommaSeparatedIntListModelBinder))] [ApiController] [Route("[controller]")] public class MyController : ControllerBase { [HttpGet("GetList")] public IActionResult GetList(Listids) { if (ids == null) { return BadRequest("IDs cannot be null."); } return Ok(ids); } } -
Action方法级别： 可以在Action方法的参数上使用
[ModelBinder]
特性，指定该参数使用指定的模型绑定器。[ApiController] [Route("[controller]")] public class MyController : ControllerBase { [HttpGet("GetList")] public IActionResult GetList([ModelBinder(typeof(CommaSeparatedIntListModelBinder))] Listids) { if (ids == null) { return BadRequest("IDs cannot be null."); } return Ok(ids); } }
选择哪种方式取决于你的需求。如果多个Action方法需要使用相同的模型绑定器，那么在控制器级别指定会更方便。如果只有个别Action方法需要使用特定的模型绑定器，那么在Action方法级别指定会更灵活。你甚至可以在
Startup.cs中全局注册绑定器提供程序，这样框架会自动根据类型匹配绑定器，而无需在控制器或Action方法上显式指定。
