C# 凈化版 WebAPI 框架

作者：kiba518

連結：http://www.cnblogs.com/kiba/p/10598626.html

前言

我們都知道WebAPI是依賴於ASP.NET MVC，所以想建立WebAPI就需要先建立一個ASP.NET MVC專案。

 

但用Visual Studio建立的MVC專案通常會帶很多功能，而這些功能，很多是我們並不想用的，或者我們想用其他開源控制元件代替它。

 

而這樣雜亂的起始專案，對於我們這種有精神潔癖的開發者而言，簡直是折磨。

 

所以，讓我們編寫一個簡潔版本的WebAPI來凈化世界吧。

凈化版WebAPI預覽

首先，我們先看下凈化版WebAPI的結構。

 

 

如上圖所示，程式碼結構很簡單，除開配置檔案，整個Web專案只有2個檔案；而需要被呼叫的WebAPI都被封裝到了WebAPI程式集中了。

 

接下來我們一起看下編寫這個凈化版WebAPI的過程吧。

凈化版WebAPI編寫

WebApiConfig

 

首先，引入必要的Dll，如下圖所示。

 

 

然後，我們編寫Web專案的寫WebApiConfig；程式碼如下：

 

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Filters.Add(new WebApiAttribute());
        // 解決json序列化時的迴圈取用問題
    config.Formatters.JsonFormatter.SerializerSettings.ReferenceLoopHandling = Newtonsoft.Json.ReferenceLoopHandling.Ignore;
        // 對 JSON 資料使用混合大小寫。跟屬性名同樣的大小.輸出
     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是個靜態類中，我們在其中建立了靜態註冊方法Register，在方法內，我們主要在做一件事，那就是為HttpConfiguration物件做配置。

 

而在配置中，我們將WepApi的路由配置成了webapi/{controller}/{id}，也就是說，我們的WebAPI未來的訪問地址將為【http://localhost:5180/webapi/Login】這樣的樣式。

 

在WebApiConfig類中，我們還用到了這樣一個類WebApiAttribute，我們在為HttpConfiguration物件的Filters屬性，添加了這個類的物件。

 

透過Filters屬性這個字樣，我們可以得出，這個類主要應用應該是過濾。

 

下麵我們看一下這個類的程式碼：

 

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited = true, AllowMultiple = true)]
public class WebApiAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(HttpActionContext actionContext)
    {
        //API執行前觸發
        if (true)//當前設定，所有API都可以被呼叫
        {
            base.OnActionExecuting(actionContext);
        }
        else
        {
            throw new Exception("Error");
        }
    } 
    public override void OnActionExecuted(HttpActionExecutedContext actionExecutedContext)
    {
        //API執行後觸發 若發生例外則不在這邊處理
        if (actionExecutedContext.Exception != null)
            return;
        base.OnActionExecuted(actionExecutedContext);
    }
}

 

透過閱讀程式碼，我們應該可以發現，這是一個AOP的過濾器。

 

在執行真正WebAPI之前，會先進入這裡進行過濾，過濾透過的API，才會呼叫 base.OnActionExecuting(actionContext)方法進行呼叫和執行。

 

結束呼叫同理，結束呼叫前，會在該類中進行攔截和過濾處理。

 

配置檔案

 

WebApiConfig編寫結束了，現在，我們需要將這個靜態類註冊到專案中。

 

開啟Global.asax檔案，編寫如下程式碼：

 

protected void Application_Start()
{
    GlobalConfiguration.Configure(WebApiConfig.Register); 
GlobalConfiguration.Configuration.Formatters.XmlFormatter.SupportedMediaTypes.Clear();//刪除XML格式 回應
}

 

可以看到，我們已透過Configure方法，將我們編寫好的WebApiConfig新增到了全域性配置中了。

 

因為網站訪問都存在跨域問題，所以我們再向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;
        }
    }
}
public class BaseApiController : ApiController
{  
    public string Options()
    {
        return null;
    }
}

 

然後我們執行網站，進行WebAPI訪問。

 

 

如上圖所示，我們的WebAPI訪問成功，到此C#凈化版WebAPI框架就介紹完了。

 

Github地址：https://github.com/kiba518/WebApi