C#凈化版WebApi框架的實(shí)現(xiàn)
前言
我們都知道WebApi是依賴于Asp.Net MVC的 ，所以，想創(chuàng)建WebApi，就需要先創(chuàng)建一個(gè)Asp.Net MVC項(xiàng)目。
但用Visual Studio創(chuàng)建的MVC項(xiàng)目通常會(huì)帶很多功能，而這些功能，很多是我們并不想用的，或者我們想用其他開(kāi)源控件代替它。
而這樣雜亂的起始項(xiàng)目，對(duì)于我們這種有精神潔癖的開(kāi)發(fā)者而言，簡(jiǎn)直是折磨。
所以，讓我們編寫一個(gè)簡(jiǎn)潔版本的WebApi來(lái)凈化世界吧。
凈化版WebApi預(yù)覽
首先，我們先看下凈化版WebApi的結(jié)構(gòu)。
如上圖所示，代碼結(jié)構(gòu)很簡(jiǎn)單，除開(kāi)配置文件，整個(gè)Web項(xiàng)目只有2個(gè)文件；而需要被調(diào)用的WebApi都被封裝到了WebApi程序集中了。
接下來(lái)我們一起看下編寫這個(gè)凈化版WebApi的過(guò)程吧。
凈化版WebApi編寫
WebApiConfig
首先，引入必要的Dll，如下圖所示。
然后，我們編寫Web項(xiàng)目的寫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ù)使用混合大小寫。跟屬性名同樣的大小.輸出
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)類中，我們?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類中，我們還用到了這樣一個(gè)類WebApiAttribute，我們?cè)跒镠ttpConfiguration對(duì)象的Filters屬性，添加了這個(gè)類的對(duì)象。
通過(guò)Filters屬性這個(gè)字樣，我們可以得出，這個(gè)類主要應(yīng)用應(yīng)該是過(guò)濾。
下面我們看一下這個(gè)類的代碼：
[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ì)在該類中進(jìn)行攔截和過(guò)濾處理。
配置文件
WebApiConfig編寫結(jié)束了，現(xiàn)在，我們需要將這個(gè)靜態(tài)類注冊(cè)到項(xiàng)目中。
打開(kā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)//當(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方法，將我們編寫好的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)目的編寫就完成了，下面我們?cè)赪ebApi程序集中，編寫個(gè)簡(jiǎn)單的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;
}
}
然后我們運(yùn)行網(wǎng)站，進(jìn)行WebApi訪問(wèn)。
如上圖所示，我們的WebApi訪問(wèn)成功。
到此C#凈化版WebApi框架就介紹完了。
框架代碼已經(jīng)傳到Github上了，歡迎大家下載。
Github地址：https://github.com/kiba518/WebApi
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
C#中BitmapImage與BitmapSource接口的區(qū)別對(duì)比小結(jié)
BitmapImage和BitmapSource都可以用于表示和顯示圖像,本文就來(lái)介紹一下C#中BitmapImage與BitmapSource接口的區(qū)別對(duì)比,具有一定的參考價(jià)值,感興趣的可以了解一下2024-03-03
C#連接操作 MySQL 數(shù)據(jù)庫(kù)實(shí)例(使用官方驅(qū)動(dòng))
這篇文章主要介紹了C#連接操作 MySQL 數(shù)據(jù)庫(kù)實(shí)例(使用官方驅(qū)動(dòng)),本文講解了C#中的Mysql連接方法和SQL操作方法,需要的朋友可以參考下2015-02-02
這篇文章主要介紹了C#正則表達(dá)式使用方法,大家參考使用2013-11-11
C#實(shí)現(xiàn)簡(jiǎn)單的loading提示控件實(shí)例代碼
本文通過(guò)實(shí)例代碼給大家介紹了C#實(shí)現(xiàn)簡(jiǎn)單的loading提示控件功能，代碼非常簡(jiǎn)單，具有參考借鑒價(jià)值，需要的朋友參考下吧2017-09-09
C#使用OleDb操作Excel和數(shù)據(jù)庫(kù)的策略
在C#編程中,使用OleDb可以方便地實(shí)現(xiàn)對(duì)Excel文件和數(shù)據(jù)庫(kù)的操作,本文探討了在C#中使用OleDb技術(shù)操作Excel和數(shù)據(jù)庫(kù)的策略,文章詳述了OleDb的定義、配置環(huán)境的步驟,并通過(guò)實(shí)際代碼示例演示了如何高效讀寫Excel文件和交互數(shù)據(jù)庫(kù),需要的朋友可以參考下2024-05-05
這篇文章主要介紹了C#中自定義事件和委托實(shí)例的,本文先是闡述了事件的原理,然后講解了事件和委托的步驟,并給出了實(shí)例代碼,需要的朋友可以參考下2015-01-01
相對(duì)C#來(lái)說(shuō)，md5算法就相對(duì)簡(jiǎn)單很多，因?yàn)?System.Security.Cryptography;?已經(jīng)包含了md5算法。所以我們只需創(chuàng)建MD5類對(duì)象即可實(shí)現(xiàn)md5算法，今天通過(guò)本文給大家介紹C#?md5?算法實(shí)現(xiàn)，感興趣的朋友一起看看吧2022-11-11
這篇文章主要給大家介紹了關(guān)于利用C#代碼將html樣式文件與Word文檔互換的方法，文中通過(guò)示例代碼將兩種轉(zhuǎn)換介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧。2017-11-11
這篇文章主要介紹了C#反射應(yīng)用,實(shí)例分析了通過(guò)反射實(shí)現(xiàn)多系統(tǒng)數(shù)據(jù)庫(kù)的配置方法,是比較實(shí)用的技巧,需要的朋友可以參考下2014-12-12
C#實(shí)現(xiàn)字符串轉(zhuǎn)換成字節(jié)數(shù)組的簡(jiǎn)單實(shí)現(xiàn)方法
這篇文章主要介紹了C#實(shí)現(xiàn)字符串轉(zhuǎn)換成字節(jié)數(shù)組的簡(jiǎn)單實(shí)現(xiàn)方法,僅一行代碼即可搞定,非常簡(jiǎn)單實(shí)用,需要的朋友可以參考下2015-05-05