验证模型属性 WCF Web APi

Question

我有一组使用 WCF Web Api 托管的服务，我需要做的是验证应用程序模型内的属性。

例如，在 MVC 3 中，我像这样装饰模型中的属性：

    [StringLength(30)]
    public string UserName { get; set; }

然后在控制器中，我像这样继续验证操作系统，模型是否满足验证参数：

    [HttpPost]
    ActionResult Create(Model myModel)
    { 
        if(ModelState.IsValid(){
           Post the model
        }
        else
        {
           Don't post the model
        }
    }

有没有办法在 WCF Web Api 中执行类似的操作？

Answer 1

好吧，我终于成功验证了我的模型的工作情况。我编写了一个验证处理程序和几个扩展方法。首先是验证处理程序：

 public class ValidationHandler<T> : HttpOperationHandler
 {
    private readonly HttpOperationDescription _httpOperationDescription;

    public ValidationHandler(HttpOperationDescription httpOperationDescription) 
    {
        _httpOperationDescription = httpOperationDescription;
    }

    protected override IEnumerable<HttpParameter> OnGetInputParameters()
    {
        return _httpOperationDescription.InputParameters
            .Where(prm => prm.ParameterType == typeof(T));
    }

    protected override IEnumerable<HttpParameter> OnGetOutputParameters()
    {
        return _httpOperationDescription.InputParameters
            .Where(prm => prm.ParameterType == typeof(T));
    }

    protected override object[] OnHandle(object[] input)
    {
        var model = input[0];
        var validationResults = new List<ValidationResult>();
        var context = new ValidationContext(model, null, null);
        Validator.TryValidateObject(model, context, validationResults,true);
        if (validationResults.Count == 0)
        {
            return input;
        }
        else
        {
            var response = new HttpResponseMessage() 
            { 
                Content = new StringContent("Model Error"),
                StatusCode = HttpStatusCode.BadRequest
            };
            throw new HttpResponseException(response);
        }
    }
}

注意处理程序如何接收 T 对象，这主要是因为我想验证 API 中的所有模型类型。因此，OnGetInputParameters 指定处理程序需要接收 T 类型对象，OnGetOutputParameters 指定处理程序需要返回具有相同 T 类型的对象，以防满足验证策略，如果不满足，请查看 on handler 方法如何抛出异常让客户端知道存在验证问题。

现在我需要注册处理程序，为此我编写了几个扩展方法，遵循 Pedro Felix 博客 http://pfelix.wordpress.com/2011/09/24/wcf-web-apicustom-parameter-conversion/（这个博客帮助了我很多，关于整个处理程序操作的事情有一些很好的解释）。这些是扩展方法：

public static WebApiConfiguration ModelValidationFor<T>(this WebApiConfiguration conf)
    {
        conf.AddRequestHandlers((coll, ep, desc) => 
            {
                if (desc.InputParameters.Any(p => p.ParameterType == typeof(T)))
                { 
                    coll.Add(new ValidationHandler<T>(desc));
                }
            });
        return conf;
    }

这个方法检查操作中是否有 T 类型参数，如果有，它将处理程序添加到该特定操作。

该方法调用另一个扩展方法 AddRequestHandler，该方法添加新的处理程序，而不删除以前注册的处理程序（如果存在）。

public static WebApiConfiguration AddRequestHandlers(
        this WebApiConfiguration conf,
        Action<Collection<HttpOperationHandler>,ServiceEndpoint,HttpOperationDescription> requestHandlerDelegate) 
    {
        var old = conf.RequestHandlers;
        conf.RequestHandlers = old == null ? requestHandlerDelegate :
                                        (coll, ep, desc) => 
                                        {
                                            old(coll, ep, desc);
                                        };
        return conf;
    }

最后一件事是注册处理程序：

        var config = new WebApiConfiguration();
        config.ModelValidationFor<T>(); //Instead of passing a T object pass the object you want to validate
        routes.SetDefaultHttpConfiguration(config);

        routes.MapServiceRoute<YourResourceObject>("SomeRoute");

就是这样..希望它对其他人有帮助！

Answer 2

我目前正在开发一个 HttpOperationHandler ，它完全可以满足您的需求。现在还没有完成，但是这个伪代码可能会让您了解如何做到这一点。

public class ValidationHandler : HttpOperationHandler
{
    private readonly HttpOperationDescription _httpOperationDescription;
    private readonly Uri _baseAddress;

    public ValidationHandler(HttpOperationDescription httpOperationDescription, Uri baseAddress)
    {
        _httpOperationDescription = httpOperationDescription;
        _baseAddress = baseAddress;
    }

    protected override IEnumerable<HttpParameter> OnGetInputParameters()
    {
        return new[] { HttpParameter.RequestMessage };
    }

    protected override IEnumerable<HttpParameter> OnGetOutputParameters()
    {
        var types = _httpOperationDescription.InputParameters.Select(x => x.ParameterType); 

        return types.Select(type => new HttpParameter(type.Name, type));
    }

    protected override object[] OnHandle(object[] input)
    {
        var request = (HttpRequestMessage)input[0];
        var uriTemplate = _httpOperationDescription.GetUriTemplate();

        var uriTemplateMatch = uriTemplate.Match(_baseAddress, request.RequestUri);

        var validationResults = new List<ValidationResult>();

        //Bind the values from uriTemplateMatch.BoundVariables to a model

        //Do the validation with Validator.TryValidateObject and add the results to validationResults

        //Throw a exception with BadRequest http status code and add the validationResults to the message

        //Return an object array with instances of the types returned from the OnGetOutputParmeters with the bounded values
    }
}

OnGetInputParameters 值告诉 OnHandle 方法的预期输出，OnGetOutputParameters 告诉 OnHandle 方法的预期输出（稍后将注入到服务中的方法中）。

然后，您可以使用 HttpConfiguration 将处理程序添加到路由，如下所示：

 var httpConfiguration = new HttpConfiguration
            {
                RequestHandlers = (collection, endpoint, operation) => collection.Add(new ValidationHandler(operation, endpoint.Address.Uri))
            };
 RouteTable.Routes.MapServiceRoute<MyResource>("MyResource", httpConfiguration);

Answer 3

发布在 MSDN 上有一个创建行为的示例为此，应该有效。您还可以使用 Validator.ValidateObject 手动调用验证器（或将其包装作为扩展方法）并返回验证错误，这本质上就是该行为正在做的事情。

Answer 4

首先，我应该说很棒的问题+答案 Daniel

但是，我已经进一步完善了它并添加了它。

ValidationHander

我对此做了一些改进。它现在基于通用的HttpOperationHandler，因此它可以获取HttpRequestMessage。这样做的原因是我可以返回使用正确媒体类型（来自接受标头）格式化的错误消息。

public class ValidationHandler<TResource> : HttpOperationHandler<TResource, HttpRequestMessage, HttpRequestMessage>
{
    public ValidationHandler() : base("response") { }

    protected override HttpRequestMessage OnHandle(TResource model, HttpRequestMessage requestMessage)
    {
        var results = new List<ValidationResult>();
        var context = new ValidationContext(model, null, null);
        Validator.TryValidateObject(model, context, results, true);

        if (results.Count == 0)
        {
            return requestMessage;
        }

        var errorMessages = results.Select(x => x.ErrorMessage).ToArray();

        var mediaType = requestMessage.Headers.Accept.FirstOrDefault();
        var response = new RestValidationFailure(errorMessages);
        if (mediaType != null)
        {
            response.Content = new ObjectContent(typeof (string[]), errorMessages, mediaType);
        }
        throw new HttpResponseException(response);
    }
}

扩展方法

您提供的 2 个方法与在 ModelValidationFor 方法中添加 ValidationHandler 时不再需要的 desc 参数几乎保持相同

。添加了一个额外的扩展方法。这是为了确保所有“资源”类都经过验证。这主要是我的懒惰和健忘造成的。我永远忘记在某个地方的列表中添加一些类。 （这就是我编写通用 Windsor 安装程序的原因！）

public static void ValidateAllResourceTypes(this WebApiConfiguration config, string assemblyFilter = "MyCompany*.dll")
{
    var path = Path.GetDirectoryName((new Uri(Assembly.GetExecutingAssembly().CodeBase)).AbsolutePath);
    var dc = new DirectoryCatalog(path, assemblyFilter);
    var assemblies = dc.LoadedFiles.Select(Assembly.LoadFrom).ToList();
    assemblies.ForEach(assembly =>
    {
        var resourceTypes = assembly.GetTypes()
            .Where(t => t.Namespace != null && t.Namespace.EndsWith("Resources"));

        foreach (var resourceType in resourceTypes)
        {
            var configType = typeof(Extensions);
            var mi = configType.GetMethod("ModelValidationFor");
            var mi2 = mi.MakeGenericMethod(resourceType);
            mi2.Invoke(null, new object[] { config });
        }
    });            
}

我为 DirectoryCatalog 类使用了 System.ComponentModel.Composition.Hosting 命名空间（以前称为 MEF）。在本例中，我只是使用以“Resources”结尾的命名空间来查找我的“Resource”类。将其更改为使用自定义属性或您可能喜欢的任何其他方式来识别哪些类是您的“资源”并不需要太多工作。

RestValidationFailure

这是我制作的一个小帮助器类，用于允许验证失败响应的一致行为。

public class RestValidationFailure : HttpResponseMessage
{
    public RestValidationFailure(string[] messages)
    {
        StatusCode = HttpStatusCode.BadRequest;
        foreach (var errorMessage in messages)
        {
            Headers.Add("X-Validation-Error", errorMessage);
        }
    }
}

---

所以，现在我得到了所有验证错误的一个很好的列表（以我喜欢的媒体类型）。

享受！ :)