C#淨化版WebApi框架

前言

咱們都知道WebApi是依賴於Asp.Net MVC的HttpRouteCollection進行路由 。

但WebApi和MVC之間是沒有依賴關係的， WebApi的基類ApiController繼承於IHttpController，而MVC的基類Controller 繼承於IController。

WebApi和MVC雖然都使用HttpRouteCollection進行路由，但WebApi經歷的通道是ServicesContainer，而MVC經歷通道仍是原始的IHttpModule。

但用Visual Studio建立的MVC WebApi項目一般會帶不少功能，而這些功能，不少是咱們並不想用的，或者咱們想用其餘開源控件代替它。

而直接建立空項目的WebApi又太原始。

因此，讓咱們編寫一個簡潔版本的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上了，歡迎你們下載。

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

----------------------------------------------------------------------------------------------------

注：此文章爲原創，任何形式的轉載都請聯繫做者得到受權並註明出處！
若您以爲這篇文章還不錯，請點擊下方的【推薦】，很是感謝！