這篇文章給大家介紹怎么在C#中實(shí)現(xiàn)WebApi框架，內(nèi)容非常詳細(xì)，感興趣的小伙伴們可以參考借鑒，希望對(duì)大家能有所幫助。
首先，我們先看下凈化版WebApi的結(jié)構(gòu)。
如上圖所示，代碼結(jié)構(gòu)很簡(jiǎn)單，除開(kāi)配置文件，整個(gè)Web項(xiàng)目只有2個(gè)文件；而需要被調(diào)用的WebApi都被封裝到了WebApi程序集中了。
接下來(lái)我們一起看下編寫(xiě)這個(gè)凈化版WebApi的過(guò)程吧。
凈化版WebApi編寫(xiě)
WebApiConfig
首先，引入必要的Dll，如下圖所示。
然后，我們編寫(xiě)Web項(xiàng)目的寫(xiě)WebApiConfig；代碼如下：
重慶分公司
重慶分公司
public static class WebApiConfig
{
public static void Register(HttpConfiguration config)
{
config.Filters.Add(new WebApiAttribute());
// 解決json序列化時(shí)的循環(huán)引用問(wèn)題
config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
// 對(duì) JSON 數(shù)據(jù)使用混合大小寫(xiě)。跟屬性名同樣的大小.輸出
config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new DefaultContractResolver();
// Web API 路由
config.MapHttpAttributeRoutes();
config.Routes.MapHttpRoute(
name: "DefaultApi",
routeTemplate: "webapi/{controller}/{id}",
defaults: new { id = RouteParameter.Optional }
);
}
}可以看到WebApiConfig是個(gè)靜態(tài)類(lèi)中，我們?cè)谄渲袆?chuàng)建了靜態(tài)注冊(cè)方法Register，在方法內(nèi)，我們主要在做一件事，那就是為HttpConfiguration對(duì)象做配置。
而在配置中，我們將WepApi的路由配置成了webapi/{controller}/{id}，也就是說(shuō)，我們的WebApi未來(lái)的訪問(wèn)地址將為【http://localhost:5180/webapi/Login】這樣的模式。
在WebApiConfig類(lèi)中，我們還用到了這樣一個(gè)類(lèi)WebApiAttribute，我們?cè)跒镠ttpConfiguration對(duì)象的Filters屬性，添加了這個(gè)類(lèi)的對(duì)象。
通過(guò)Filters屬性這個(gè)字樣，我們可以得出，這個(gè)類(lèi)主要應(yīng)用應(yīng)該是過(guò)濾。
下面我們看一下這個(gè)類(lèi)的代碼：
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public class WebApiAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(HttpActionContext actionContext)
{
//API執(zhí)行前觸發(fā)
if (true)//當(dāng)前設(shè)置，所有API都可以被調(diào)用
{
base.OnActionExecuting(actionContext);
}
else
{
throw new Exception("Error");
}
}
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
//API執(zhí)行后觸發(fā) 若發(fā)生例外則不在這邊處理
if (actionExecutedContext.Exception != null)
return;
base.OnActionExecuted(actionExecutedContext);
}
}通過(guò)閱讀代碼，我們應(yīng)該可以發(fā)現(xiàn)，這是一個(gè)AOP的過(guò)濾器。
在執(zhí)行真正WebApi之前，會(huì)先進(jìn)入這里進(jìn)行過(guò)濾，過(guò)濾通過(guò)的API，才會(huì)調(diào)用base.OnActionExecuting(actionContext)方法進(jìn)行調(diào)用和執(zhí)行。
結(jié)束調(diào)用同理，結(jié)束調(diào)用前，會(huì)在該類(lèi)中進(jìn)行攔截和過(guò)濾處理。
配置文件
WebApiConfig編寫(xiě)結(jié)束了，現(xiàn)在，我們需要將這個(gè)靜態(tài)類(lèi)注冊(cè)到項(xiàng)目中。
打開(kāi)Global.asax文件，編寫(xiě)如下代碼：
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public class WebApiAttribute : ActionFilterAttribute
{
public override void OnActionExecuting(HttpActionContext actionContext)
{
//API執(zhí)行前觸發(fā)
if (true)//當(dāng)前設(shè)置，所有API都可以被調(diào)用
{
base.OnActionExecuting(actionContext);
}
else
{
throw new Exception("Error");
}
}
public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
{
//API執(zhí)行后觸發(fā) 若發(fā)生例外則不在這邊處理
if (actionExecutedContext.Exception != null)
return;
base.OnActionExecuted(actionExecutedContext);
}
}可以看到，我們已通過(guò)Configure方法，將我們編寫(xiě)好的WebApiConfig添加到了全局配置中了。
因?yàn)榫W(wǎng)站訪問(wèn)都存在跨域問(wèn)題，所以我們?cè)傧騁lobal.asax中添加如下代碼處理：
protected void Application_BeginRequest(object sender, System.EventArgs e)
{
var req = System.Web.HttpContext.Current.Request;
if (req.HttpMethod == "OPTIONS")//過(guò)濾options請(qǐng)求，用于js跨域
{
Response.StatusCode = 200;
Response.SubStatusCode = 200;
Response.End();
}
}到此Web項(xiàng)目的編寫(xiě)就完成了，下面我們?cè)赪ebApi程序集中，編寫(xiě)個(gè)簡(jiǎn)單的WebApi，代碼如下：
public class LoginController : BaseApiController
{
public BaseResult Get()
{
try
{
return new BaseResult() { IsSuccess=true };
}
catch (Exception ex)
{
throw ex;
}
}
}
public class BaseApiController : ApiController
{
public string Options()
{
return null;
}
}然后我們運(yùn)行網(wǎng)站，進(jìn)行WebApi訪問(wèn)。
關(guān)于怎么在C#中實(shí)現(xiàn)WebApi框架就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無(wú)理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國(guó)服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡(jiǎn)單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢(shì)，專(zhuān)為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場(chǎng)景需求。
