WebApi - 路由

這段時間的部落格打算和大家一起分享下webapi的使用和心得，主要原因是群裡面有朋友說希望能有這方面的文章分享，隨便自己也再回顧下；後面將會和大家分不同篇章來分享交流心得，希望各位多多掃碼支援和點贊，謝謝，希望大家喜歡：

 

. 使用vs建立webapi專案及專案結構介紹

. 預設路由模板介紹

. 屬性路由標記的使用

 

下面一步一個腳印的來分享：

. 使用vs建立webapi專案及專案結構介紹

首先，滑鼠右鍵解決方案=》新增=》新建專案=》選擇"Asp.net web應用程式"=》輸入專案的名稱，我這裡是Stage.Api=》點選確定按鈕，效果如：

然後會彈出一個介面，裡面有三種模板選擇，這裡簡單介紹下；

1. 選擇"Empty模板"=》勾選"Web Api"，如果不需要測試的話即可點選"確定"按鈕就行了，然後解決方案中會生成一個很空的api專案，這裡簡單截圖下選擇的介面圖：

 

2. 選擇“MVC”=》勾選“Web API”=》點選“確定”，這個介面可以更改身份驗證，如圖：

 

3. 選擇“Web API”=》直接點選“確定”（這裡始終是選擇mvc+webapi，其實就是上面的選擇項），這裡就不再截圖了各位一嘗試點選下試試；

我這裡就選擇webapi來建立專案，目錄結構和說明如：

因為前面建立專案時候勾選了“MVC”與“Web API”，所以這個專案中包括了兩者的初始檔案，由目錄結構能看出mvc和webapi相識度很高，除了試圖外幾乎能認可一樣，當然具體程式碼還是有差別的，下面我們就開始來初步瞭解下webapi的routing吧；

 

. 預設路由模板介紹

首先，這裡只說webapi的預設路由，來看App_Start/WebApiConfig.cs檔案中預設路由類程式碼如下：

public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API configuration and services

            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }

這個 Register 方法傳遞的引數 HttpConfiguration 型別；然後 config.MapHttpAttributeRoutes(); 主要功能是：允許專案框架可以使用屬性標記來擴充套件路由； config.Routes.MapHttpRoute 對應有四個擴充套件方法，程式碼如：

//
        // 摘要: 
        //     對映指定的路由模板。
        //
        // 引數: 
        //   routes:
        //     應用程式的路由的集合。
        //
        //   name:
        //     要對映的路由的名稱。
        //
        //   routeTemplate:
        //     路由的路由模板。
        //
        // 返回結果: 
        //     對對映路由的引用。
        public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate);
        //
        // 摘要: 
        //     對映指定的路由模板並設定預設路由值。
        //
        // 引數: 
        //   routes:
        //     應用程式的路由的集合。
        //
        //   name:
        //     要對映的路由的名稱。
        //
        //   routeTemplate:
        //     路由的路由模板。
        //
        //   defaults:
        //     一個包含預設路由值的物件。
        //
        // 返回結果: 
        //     對對映路由的引用。
        public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate, object defaults);
        //
        // 摘要: 
        //     對映指定的路由模板並設定預設路由值和約束。
        //
        // 引數: 
        //   routes:
        //     應用程式的路由的集合。
        //
        //   name:
        //     要對映的路由的名稱。
        //
        //   routeTemplate:
        //     路由的路由模板。
        //
        //   defaults:
        //     一個包含預設路由值的物件。
        //
        //   constraints:
        //     一組表示式，用於限制 routeTemplate 的值。
        //
        // 返回結果: 
        //     對對映路由的引用。
        public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate, object defaults, object constraints);
        //
        // 摘要: 
        //     對映指定的路由模板並設定預設的路由值、約束和終結點訊息處理程式。
        //
        // 引數: 
        //   routes:
        //     應用程式的路由的集合。
        //
        //   name:
        //     要對映的路由的名稱。
        //
        //   routeTemplate:
        //     路由的路由模板。
        //
        //   defaults:
        //     一個包含預設路由值的物件。
        //
        //   constraints:
        //     一組表示式，用於限制 routeTemplate 的值。
        //
        //   handler:
        //     請求將被排程到的處理程式。
        //
        // 返回結果: 
        //     對對映路由的引用。
        public static IHttpRoute MapHttpRoute(this HttpRouteCollection routes, string name, string routeTemplate, object defaults, object constraints, HttpMessageHandler handler);

具體的引數說明已經備註好了，通過備註我們簡單總結下name：某類别範本的唯一名稱，routeTemplate：路由模板，defaults：預設引數；我們自動生成的預設模板格式如： api/{controller}/{id} ，由經驗得出這裡的Controller指的就是我們在Controllers資料夾中建立的apiController的名稱，id對應的是引數，這裡有預設值 RouteParameter.Optional 表示id引數可選傳遞；好了通過引數的分析講解說明，咋們來在瀏覽器中訪問下我們自動生成的模板地址，看能得到什麼資料，我這裡是通過iis指向了我這個webapi專案，訪問的地址如： http://localhost:1001/api/values ，這個時候會出現一個錯誤：

不要慌張，這個所由於我們初建專案，沒有生成造成的（這裡簡單描述下網站和專案的最大使用區別，1.網站如果是更新了web頁面的程式碼，不需要重新生成 2.如果是專案的話修改了程式碼必須要重新生成，不然釋出沒有任何效果），好咋們生成後，重新在瀏覽器中訪問上面的地址，得到如下結果：

再來看一下對應的程式碼檔案 Controllers/ValuesController.cs ，然後程式碼如：

 // GET api/values
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

我們得到的結果就是這段程式碼執行出來的資料；

 

. 屬性路由標記的使用

這裡先來說下，webapi常用到的允許訪問方式的標記有GET，POST，PUT，DELETE等，有朋友立馬就反應過來這幾乎和MVC試圖中的設定差不多呢，是的就是這樣；然後再來了解下路由標記Route的使用，先來看一段程式碼：

// GET api/values
        [Route("webapi")]
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }

仔細的朋友能夠發現這裡就是上面我們直接訪問 http://localhost:1001/api/values 地址的測試程式碼，現在我們增加了標記 [Route("webapi")] 有什麼作用呢，咋們先來生成下專案，然後再訪問之前使用的地址 http://localhost:1001/api/values 得到的結果如：

此時我們無法正常得到剛才的文字結果，這是因為Route標記吧路由地址改為 http://localhost:1001/webapi 這樣直接訪問action的方法，好咋們使用該地址在瀏覽器得出結果如下：

和加Route之前得到的結果是一樣的，由此我們得到Route標記有改變路由地址的功能，下面我們來看下Route類程式碼：

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true, Inherited = true)]
    public sealed class RouteAttribute : Attribute, IHttpRouteInfoProvider
    {
        public RouteAttribute();
        public RouteAttribute(string template);

        public string Name { get; set; }
        public int Order { get; set; }
        public string Template { get; }
    }

由上可知我們剛才使用到了 RouteAttribute(string template) 建構函式來傳遞對應的引數，看程式碼中Order，Name兩個屬性，這個可能會在今後講解中使用到，以後再說；下面我們再來看RoutePrefix及她的一段程式碼相關程式碼：

[RoutePrefix("v")]
    public class ValuesController : ApiController

再來訪問我們剛才的地址： http://localhost:1001/webapi ，此時得到的錯誤資訊“無法找到資源。”，那我們再來改變下路徑如： http://localhost:1001/v/webapi ，能正常得到結果：

由此RoutePrefix的效果，體現出來了，如果這是了該標記，就需要我們訪問api地址時，需要加上對應的v才行，這個對應的程式碼是：

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
    public sealed class RoutePrefixAttribute : Attribute
    {
        public RoutePrefixAttribute(string prefix);

        public string Prefix { get; }
    }

好了，本篇就到這裡了，主要是電腦沒電了，下次繼續分享webapi文章，希望各位多多支援，勿噴。