Question

如何让 Web API 统一回传格式以及例外处理

Answer 1

转载在使用WebApi的时候，有时候只想返回JSON；实现这一功能有多种方法，本文提供两种方式，一种传统的，一种作者认为是正确的方法。　　JSONinWebAPI–theformatterbasedapproach　　只支持JSON最普遍的做法是：首先清除其他所有的formatters，然后只保留JsonMediaTypeFormatter。　　有了HttpConfiguration的实例，你将会很简单的清除所有formatters，然后重新添加JsonMediaTypeFormatter。　　实现代码如下：　　configuration.Formatters.Clear();　　configuration.Formatters.Add(newJsonMediaTypeFormatter());这种方式虽然可以实现功能，但是所有的conentnegotiation还是会发生，这就会产生以下额外的开销了。因为，你已经知道要返回的结果了，也只想返回Json，其他的contentnegotiation都不需要了。　　下面的方法可以很好的解决这个问题。　　　　JSONinWebAPI–theconnegbasedapproach　　最好的方法是使用自定义的只返回JsonResult的contentnegotiation代替WebApi中默认的contentnegotiation。　　Conneg通过实现IContentNegotiator的Negotiator方法实现扩展。Negotiator方法返回ContentNegotiationResult（它包装了你选择的headers和formatter）。　　下面的方法通过传递一个JsonMediaTypeFormatter给自定义的connegnegotiator，让它一直返回applicaton/json的content-type以及JsonMediaTypeFormatter。这种方法避免了每次请求都要重新创建一次formatter。　　代码如下：　　publicclassJsonContentNegotiator:IContentNegotiator　　{　　privatereadonlyJsonMediaTypeFormatter_jsonFormatter;　　publicJsonContentNegotiator(JsonMediaTypeFormatterformatter)　　{　　_jsonFormatter=formatter;　　}　　publicContentNegotiationResultNegotiate(Typetype,HttpRequestMessagerequest,IEnumerableformatters)　　{　　varresult=newContentNegotiationResult(_jsonFormatter,newMediaTypeHeaderValue("application/json"));　　returnresult;　　}　　}接下来，你需要在HttpConfiguration实例上注册你的新的实现机制：　　　　varjsonFormatter=newJsonMediaTypeFormatter();　　//optional:setserializersettingshere　　config.Services.Replace(typeof(IContentNegotiator),newJsonContentNegotiator(jsonFormatter));　　通过替换默认的DefaultContentNegotiator，我们使用我们自定义的JsonContentNegotiator，它只支持Json，而且可以马上返回。　　如果你想更深入的了解ContentNegotiation的知识，你可以查看作者的这篇文章。　　总结　　通过使用自定义的JsonContentNegotiator替换系统默认的DefaultContentNegotiator，很好的实现WebApi只返回Json的功能，而且没有额外的开销。