前言

我們都知道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

閱讀原文：原文鏈接