.net – 如何从ModelState键中删除前缀?

前端之家收集整理的这篇文章主要介绍了.net – 如何从ModelState键中删除前缀?前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
例如,有一个Web Api操作方法
  1. public HttpMessageResponse Post(UserDto userDto)
  2. {
  3. if (!this.ModelState.IsValid)
  4. {
  5. return this.Request.CreateErrorResponse(
  6. HttpStatusCode.BadRequest,this.ModelState);
  7. }
  8.  
  9. // ...
  10. }

客户端发送以下请求:

  1. HTTP POST: /api/user
  2. { "username": "me","password": "Pa$sw0rd" }

并得到回应:

  1. HTTP 201/Created:
  2. { "message": "Your request is invalid.","modelState": { "userDto.Password": "Your password is too strong." } }

默认情况下,action方法通过使用action方法中使用的参数名前缀模型错误来公开实现细节。如果客户端应用程序在清理模型错误,然后是服务器端代码更改(例如,您用Post(UserDto dto)替换了Post(UserDto userDto))签名时,会重新编码此前缀名称,并且所有客户端应用程序都停止工作。

这就是为什么你需要确保这个前缀在服务器端被删除。问题是如何正确地做,没有使事情复杂化。例如,您可以创建一个自定义序列化程序,并在序列化期间删除这些前缀。但是为了做到这一点,你需要知道模型参数的名称调用代码可能看起来像这样:

  1. public HttpMessageResponse Post(UserDto userDto)
  2. {
  3. if (!this.ModelState.IsValid)
  4. {
  5. return this.Request.CreateCustomErrorResponse(
  6. HttpStatusCode.BadRequest,this.ModelState,modelName: "userDto");
  7. }
  8.  
  9. // ...
  10. }

解决方法

第一部分:

Also error messages returned to a client shouldn’t contain those prefixes

我同意将参数名称作为所有模型状态错误的前缀都不是很大的行为。幸运的是,具有此行为的服务是可替换的。你只需要一个自定义IBodyModelValidator。这是它的样子(使用Decorator模式让默认服务做大部分工作):

  1. public class PrefixlessBodyModelValidator : IBodyModelValidator
  2. {
  3. private readonly IBodyModelValidator _innerValidator;
  4.  
  5. public PrefixlessBodyModelValidator(IBodyModelValidator innerValidator)
  6. {
  7. if (innerValidator == null)
  8. {
  9. throw new ArgumentNullException("innerValidator");
  10. }
  11.  
  12. _innerValidator = innerValidator;
  13. }
  14.  
  15. public bool Validate(object model,Type type,ModelMetadataProvider MetadataProvider,HttpActionContext actionContext,string keyPrefix)
  16. {
  17. // Remove the keyPrefix but otherwise let innerValidator do what it normally does.
  18. return _innerValidator.Validate(model,type,MetadataProvider,actionContext,String.Empty);
  19. }
  20. }

然后,用你的包装默认服务:

  1. config.Services.Replace(typeof(IBodyModelValidator),new PrefixlessBodyModelValidator(config.Services.GetBodyModelValidator()));

对于第二部分:

elso replace “modelState” with “errors”

目前的原因是“modelState”是您当前的代码

  1. return Request.CreateErrorResponse(HttpStatusCode.BadRequest,ModelState);

有效地执行以下操作:

  1. HttpError error = new HttpError(ModelState,false);
  2. return Request.CreateResponse(HttpStatusCode.BadRequest,error);

由于HttpError被序列化,并且它有一个名为“ModelState”的属性,这就是您在响应中看到的。

如果要使用不同的属性名称,可以使用自定义错误类:

  1. public class PrettyHttpError
  2. {
  3. public PrettyHttpError(ModelStateDictionary modelState)
  4. {
  5. Message = "Your request is invalid.";
  6. Errors = new Dictionary<string,IEnumerable<string>>();
  7.  
  8. foreach (var item in modelState)
  9. {
  10. var itemErrors = new List<string>();
  11. foreach (var childItem in item.Value.Errors)
  12. {
  13. itemErrors.Add(childItem.ErrorMessage);
  14. }
  15. Errors.Add(item.Key,itemErrors);
  16. }
  17. }
  18.  
  19. public string Message { get; set; }
  20.  
  21. public IDictionary<string,IEnumerable<string>> Errors { get; set; }
  22. }

然后使用此错误类型创建您的响应,而不是HttpError:

  1. PrettyHttpError error = new PrettyHttpError(ModelState);
  2. return Request.CreateResponse(HttpStatusCode.BadRequest,error);

PrettyHttpError和PrefixlessBodyModelValidator的组合给出了您请求的输出

猜你在找的asp.Net相关文章