MVC WebAPI数据注释错误消息空字符串

时间:2015-08-28 02:37:42

标签: asp.net-mvc-4 asp.net-web-api owin

我已经实现了一个OWIN自托管webapi,我正在尝试使用数据注释和ActionFilterAttribute将格式错误返回给用户。我在数据注释上设置了自定义错误消息,但是当我尝试从ModelState检索消息时,它总是一个空字符串(如下图所示)。

enter image description here

型号:

GameScene

过滤器:

public class JobPointer
{
    [Required(ErrorMessage = "JobId Required")]
    public Guid JobId { get; set; }
}

端点:

public class ModelValidationFilter : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        if (actionContext.ModelState.IsValid) return;
        string errors = actionContext.ModelState.SelectMany(state => state.Value.Errors).Aggregate("", (current, error) => current + (error.ErrorMessage + ". "));

        actionContext.Response = actionContext.Request.CreateErrorResponse(
            HttpStatusCode.BadRequest, errors);
    }

}

请求正文:

[HttpPost]
public HttpResponseMessage DescribeJob(JobPointer jobId)
{

   Job job = _jobhelper.GetJob(jobId.JobId);
   return Request.CreateResponse(HttpStatusCode.OK, job);
}

响应:

{

}

如果我将ModelValidationFilter中的error.Message更改为error.Exception.Message我返回默认验证错误:

Status Code: 400
{
  "Message": ". "
}

1 个答案:

答案 0 :(得分:2)

我知道这是一个老问题,但我遇到了这个问题,并自己找到了解决方案。

正如您无疑发现的那样,因为Guid是一个不可为空的类型[必需]会产生一条不友好的错误消息(我假设因为JSON解析器在实际获得模型验证之前将其选中)。

你可以通过让Guid可以为空来解决这个问题......

public class JobPointer
{
    [Required(ErrorMessage = "JobId Required")]
    public Guid? JobId { get; set; }
}

...但是,这在所有情况下都不是一个可行的选项(就像我的情况一样),所以我最终编写了自己的验证属性,该属性会根据它检查属性的空声明... < / p>

public class IsNotEmptyAttribute : ValidationAttribute
{

    public override bool IsValid(object value)
    {

        if (value == null) return false;

        var valueType = value.GetType();
        var emptyField = valueType.GetField("Empty");

        if (emptyField == null) return true;

        var emptyValue = emptyField.GetValue(null);

        return !value.Equals(emptyValue);

    }
}

然后您可以实现......

public class JobPointer
{
    [IsNotEmpty(ErrorMessage = "JobId Required")]
    public Guid JobId { get; set; }
}