web API ,net - .net core 對比學習-文件目錄概述

個人正在學習.net web Api的相關知識，因此用這一系列博客做一記錄。 1. 首先我們分別創建 .net web api 項目和 .net core web api 項目。 2. 我們首先比較一下兩個項目的目錄結構。下圖中是用 vs2017 創建的 .net web api(左)和.net ...

個人正在學習.net web Api的相關知識，因此用這一系列博客做一記錄。

1. 首先我們分別創建 .net web api 項目和 .net core web api 項目。

2. 我們首先比較一下兩個項目的目錄結構。

下圖中是用 vs2017 創建的 .net web api(左)和.net core web api(右) 項目。

從目錄結構上我們可以看出 .net web api 除了controller 意外還保留了view, model 和一些放靜態文件(fonts, script, content)的文件夾，除此之外還有area 文件夾，學過 asp.net mvc的同學應該會瞭解area的概念，我們不再贅述。

除此之外還有favorite.ico 文件，如果我們用這個項目作為一個單純的web api 項目我們會發現除了model以外以上提到的其他的我們都可以完全刪除。

然後是web.config 來管理我們asp.net 的一些相關配置，在.net core web api 項目中有類似作用的appsettings.json 文件，如果我們需要發佈.net core web api 到IIS上也需要加上我們自己的web.config文件。

packages.config 文件是包管理相關的配置文件。

3. 入口文件比較

Global.asax.cs 文件是.net web api 的入口文件(因為我建立的是基於 MVC 的web api項目，因此入口文件跟asp.net mvc 是一樣的)。由下麵的代碼我們可以看出來在WebApiApplication類裡面的Application_Statr 方法裡面註冊了項目所需要的一些配置。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Mvc;
using System.Web.Optimization;
using System.Web.Routing;

namespace FreWebApi
{
    public class WebApiApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            AreaRegistration.RegisterAllAreas(); //註冊area
            GlobalConfiguration.Configure(WebApiConfig.Register); //註冊web api 路由
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);//註冊全局過濾器
            RouteConfig.RegisterRoutes(RouteTable.Routes);//註冊asp.net mvc 路由，當項目單純用於作為api使用可以不註冊asp.net 路由
            BundleConfig.RegisterBundles(BundleTable.Bundles);// 註冊bundles 也不是web api所必須的
        }
    }
}

而.net core web api 項目的入口文件是Program.cs 文件。從下麵的代碼我們可以看出來我們的入口方法是Program類裡面的Main方法(是不是很熟悉的感覺)，從code上我們可以看出只是在Main方法裡面調用了CreateWebHostBuilder方法。

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Logging;

namespace CoreWebApi
{
    public class Program
    {
        /// <summary>
        /// 入口是 Main 方法看起來跟console項目有些類似。
        /// </summary>
        /// <param name="args"></param>
        public static void Main(string[] args)
        {
            CreateWebHostBuilder(args).Build().Run();//在 Main 方法直接調用下麵的CreateWebHostBuilder方法。
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>();
    }
}

學過Asp.net MVC 的同學大家都知道，在Application_Statr註冊的配置項其實都是在App_Start文件夾裡面，下麵我們展開這個文件夾。

從上圖中的文件來看我們很容易看出來對應的配置在那個文件裡面，前面提到過RouteConfig和BundleConfig不是wenApi所必須的所以我們還是重點來看一些WebApiConfig和FilterConfig.

1) FilterConfig: 這個類裡面預設添加了HandleErrorAttribute這是一個全局過濾器，主要用於處理異常。

using System.Web;
using System.Web.Mvc;

namespace FreWebApi
{
    public class FilterConfig
    {
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            filters.Add(new HandleErrorAttribute());
        }
    }
}

2）WebApiConfig: 註冊了webApi的路由，這些路由是在HttpConfiguration實例的Routes集合屬性裡面，這裡我們註意我們這裡註冊的都是http路由，當註冊asp.net mvc 路由時，是放在RouteTable.Routes集合裡面。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web.Http;

namespace FreWebApi
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API 配置和服務

            // Web API 路由
            config.MapHttpAttributeRoutes();

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

說到這裡有的同學可能會奇怪我們的 .net core web API的各種配置又在哪裡呢？我們接著看我們入口類裡面的CreateWebHostBuilder方法，在這個方法裡面用Lambda表達式調用了WebHost的CreateDefaultBuilder方法，官網的解釋如下：

Initializes a new instance of the WebHostBuilder class with pre-configured defaults.
使用預先配置的預設值初始化WebHostBuilder類的新實例。

如果需要獲取詳細信息的同學，可以參見其他專門將asp.net 的博客這裡我們只將項目結構。然後我們調用的這個實例的UseStartup方法，官網解釋如下：

Specify the startup type to be used by the web host.
指定Web Host要使用的啟動類.

同樣的我們對此不做深究，但我們可以從解釋中看出來這裡指定了啟動類，然後我們打開傳入的泛型類Startup，我們打開Startup.cs文件，查看裡面的代碼：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Options;

namespace CoreWebApi
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
                app.UseHsts();
            }

            app.UseHttpsRedirection();
            app.UseMvc();
        }
    }
}

從上面的code上我們可以看到裡面有ConfigService方法和Config方法，但是我們並沒有看到類似與.net web api的關於註冊路由或者過濾器的任何code，不要慌我們來改寫一下ConfigService和config方法。

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(
        options =>
        {
            options.Filters.Add<ExceptionFilterAttribute>(); // an instance
        }
        ).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
}

// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    else
    {
        // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
        app.UseHsts();
    }

    app.UseHttpsRedirection();
    app.UseMvc(
        routes => routes.MapRoute(
            name: "default",
            template: "{ controller}/{ action}/{ id}"
            )                
    );
    
}

從上面改寫以後的方法裡面我們就可以清晰的看到過濾器和路由的配置了。

最後我們來展開controllers文件夾：

從下圖中我們看到 .net web api生產了兩個預設的controller，讓我們查看兩個controller的定義：

由下麵的代碼我們明顯的看到HomenController是為Asp.Net mvc準備的，繼承於Controller類，而ValuesController才是我們真正需要的web api的controller繼承於ApiController 類。

public class HomeController : Controller

public class ValuesController : ApiController

最後我們來比較一下兩個Api的controller：

從下圖中我們可以看出兩個API的主要不用在於controller的父類不同，然後是asp.net core 預設使用了路由屬性，這也是它可以再config裡面預設沒有配置路由的原因。