筆記 - 如何在 ASP.NET CORE Web API 中加入 Angular 6 | sqz777 der 技術小本本 - 點部落

2018-07-15

筆記 - 如何在 ASP.NET CORE Web API 中加入 Angular 6

4267
0
筆記

目前visual studio 專案範本看起來只有出到 angular 4 但是我想用 6 XD

所以花了不少時間在研究他

前言

這一次實作以 .NET CORE 2.0 來加入angular 6，未來版本可能會有些不同

文章中若有錯誤的地方麻煩請告知我! <(_ _)>

直接看Code點我(GitHub連結)

前置動作

確認是否安裝 .NET CORE
確認是否安裝 Node.js 及 npm
Angular CLI 也可參考 Angular.io 的 quick start 進行安裝

請使用 node -v 以及 npm -v，確認 node 版本為 8.x 以及 npm 版本為 5.x 或以上

創建及設定 ASP.NET CORE Web API 專案

開啟 Visual Studio 新增一個 Web API 的 .NET CORE 專案

按下 OK 後選取「API」再按下 OK

成功開啟後，為了只需要讓 Angular CLI 幫我們編譯，所以需要設定專案設定檔

在 csproj 檔中加入以下的程式碼

<PropertyGroup>
     <TypeScriptCompileBlocked>true</TypeScriptCompileBlocked>
</PropertyGroup>

創建 Web API專案時，會預設開啟 api/values 這個頁面所以為了避免這樣的動作，要到 Properties 中的 launchSettings.json 進行設定，將 launchUrl 設為空就可以了

所有的 launchSettings.json 的 Code 如下

{
  "iisSettings": {
    "windowsAuthentication": false,
    "anonymousAuthentication": true,
    "iisExpress": {
      "applicationUrl": "http://localhost:8572/",
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "AspNetCoreAndAngular6Demo": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "http://localhost:8573/"
    }
  }
}

接著就需要判斷進來的 request 是需要存取網頁還是要api了，所以在Startup.cs中的 Configure 要加入以下的程式碼

app.Use(async (context, next) =>
{
    await next();
    if (context.Response.StatusCode == 404 &&                       // 該資源不存在
        !System.IO.Path.HasExtension(context.Request.Path.Value) && // 網址最後沒有帶副檔名
        !context.Request.Path.Value.StartsWith("/api"))             // 網址不是 /api 開頭（不是發送 API 需求）
    {
        context.Request.Path = "/index.html";                       // 將網址改成 /index.html
        context.Response.StatusCode = 200;                          // 並將 HTTP 狀態碼修改為 200 成功

        await next();
    }
});

因為將要使用 Angular CLI會幫助我們編譯出前端網頁的靜態檔案，所以我們需要可以存取靜態檔案的middleware，所以在 Startup.cs 中的 Configure 要加入兩個方法

app.UseDefaultFiles()
app.UseStaticFiles()

目前 Configure 中會變成這個樣子

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }

    app.Use(async (context, next) =>
    {
        await next();
        if (context.Response.StatusCode == 404 &&                       // 該資源不存在
            !System.IO.Path.HasExtension(context.Request.Path.Value) && // 網址最後沒有帶副檔名
            !context.Request.Path.Value.StartsWith("/api"))             // 網址不是 /api 開頭（不是發送 API 需求）
        {
            context.Request.Path = "/index.html";                       // 將網址改成 /index.html
            context.Response.StatusCode = 200;                          // 並將 HTTP 狀態碼修改為 200 成功

            await next();
        }
    });

    app.UseDefaultFiles();
    app.UseStaticFiles();
    app.UseMvc();
}