您好,登錄后才能下訂單哦!
這篇文章給大家介紹怎么在C#中實現(xiàn)WebApi框架,內(nèi)容非常詳細,感興趣的小伙伴們可以參考借鑒,希望對大家能有所幫助。
首先,我們先看下凈化版WebApi的結(jié)構(gòu)。
如上圖所示,代碼結(jié)構(gòu)很簡單,除開配置文件,整個Web項目只有2個文件;而需要被調(diào)用的WebApi都被封裝到了WebApi程序集中了。
接下來我們一起看下編寫這個凈化版WebApi的過程吧。
凈化版WebApi編寫
WebApiConfig
首先,引入必要的Dll,如下圖所示。
然后,我們編寫Web項目的寫WebApiConfig;代碼如下:
public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.Filters.Add(new WebApiAttribute()); // 解決json序列化時的循環(huán)引用問題 config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore; // 對 JSON 數(shù)據(jù)使用混合大小寫。跟屬性名同樣的大小.輸出 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是個靜態(tài)類中,我們在其中創(chuàng)建了靜態(tài)注冊方法Register,在方法內(nèi),我們主要在做一件事,那就是為HttpConfiguration對象做配置。
而在配置中,我們將WepApi的路由配置成了webapi/{controller}/{id},也就是說,我們的WebApi未來的訪問地址將為【http://localhost:5180/webapi/Login】這樣的模式。
在WebApiConfig類中,我們還用到了這樣一個類WebApiAttribute,我們在為HttpConfiguration對象的Filters屬性,添加了這個類的對象。
通過Filters屬性這個字樣,我們可以得出,這個類主要應(yīng)用應(yīng)該是過濾。
下面我們看一下這個類的代碼:
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)] public class WebApiAttribute : ActionFilterAttribute { public override void OnActionExecuting(HttpActionContext actionContext) { //API執(zhí)行前觸發(fā) if (true)//當前設(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); } }
通過閱讀代碼,我們應(yīng)該可以發(fā)現(xiàn),這是一個AOP的過濾器。
在執(zhí)行真正WebApi之前,會先進入這里進行過濾,過濾通過的API,才會調(diào)用base.OnActionExecuting(actionContext)方法進行調(diào)用和執(zhí)行。
結(jié)束調(diào)用同理,結(jié)束調(diào)用前,會在該類中進行攔截和過濾處理。
配置文件
WebApiConfig編寫結(jié)束了,現(xiàn)在,我們需要將這個靜態(tài)類注冊到項目中。
打開Global.asax文件,編寫如下代碼:
[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)] public class WebApiAttribute : ActionFilterAttribute { public override void OnActionExecuting(HttpActionContext actionContext) { //API執(zhí)行前觸發(fā) if (true)//當前設(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); } }
可以看到,我們已通過Configure方法,將我們編寫好的WebApiConfig添加到了全局配置中了。
因為網(wǎng)站訪問都存在跨域問題,所以我們再向Global.asax中添加如下代碼處理:
protected void Application_BeginRequest(object sender, System.EventArgs e) { var req = System.Web.HttpContext.Current.Request; if (req.HttpMethod == "OPTIONS")//過濾options請求,用于js跨域 { Response.StatusCode = 200; Response.SubStatusCode = 200; Response.End(); } }
到此Web項目的編寫就完成了,下面我們在WebApi程序集中,編寫個簡單的WebApi,代碼如下:
public class LoginController : BaseApiController { public BaseResult Get() { try { return new BaseResult() { IsSuccess=true }; } catch (Exception ex) { throw ex; } }<br>} public class BaseApiController : ApiController { public string Options() { return null; } }
然后我們運行網(wǎng)站,進行WebApi訪問。
關(guān)于怎么在C#中實現(xiàn)WebApi框架就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。