共用方式為


教學課程:在Visual Studio中使用 Angular 建立 ASP.NET Core 應用程式

在本文中,您將瞭解如何建置 ASP.NET Core 專案,以作為 API 後端和 Angular 專案作為 UI。

Visual Studio 包含支援 Angular 和 React 的 ASP.NET 核心單頁應用程式 (SPA) 範本。 範本會在您的 ASP.NET Core 專案中提供內建的用戶端應用程式資料夾,其中包含每個架構的基底檔案和資料夾。

您可以使用本文所述的 方法來建立 ASP.NET 核心單頁應用程式:

  • 將用戶端應用程式放在與 ASP.NET Core 專案以外的個別專案中
  • 根據計算機上安裝的 Framework CLI 建立客戶端專案

注意

本文說明在Visual Studio 2022 17.8版中使用更新範本的專案建立程式。

先決條件

請務必安裝下列項目:

  • 已安裝 ASP.NET 和 Web 開發 工作負載的 Visual Studio 2022 17.8 版或更新版本。 請移至 Visual Studio 下載 頁面以免費安裝它。 如果您需要安裝工作負載並已經有 Visual Studio,請移至 [Tools>Get Tools and Features...,這會開啟 Visual Studio 安裝程式。 選擇 ASP.NET 和 Web 開發 工作負載,然後選擇 修改
  • npm (https://www.npmjs.com/),包含在 Node.js 中
  • Angular CLI (https://angular.dev/tools/cli),它可以是您選擇的版本。 前端專案是使用您在本機計算機上安裝的 Framework CLI 工具所建立,因此這會決定範本中使用的 Angular 版本。

建立前端應用程式

  1. 在 [開始視窗] 中(選擇 [檔案]>[開始視窗] 開啟),選取 [建立新專案]

    顯示建立新專案螢幕快照

  2. 在頂端的搜尋列中搜尋 Angular,然後選取 [Angular],然後選取 [ASP.NET Core]。

    顯示選擇範本的螢幕快照。

  3. 將專案命名 AngularWithASP,然後選取 下一步

    在 [其他資訊] 對話框中,確定已啟用 [為 HTTPS 設定]。 在大部分情況下,將其他設定保留為預設值。

  4. 選取 建立

    [方案總管視窗] 顯示如下內容:

    顯示 [方案總管] 的螢幕快照。

    相較於 獨立 Angular 樣本,您會看到一些新的和已修改的檔案與 ASP.NET Core 整合:

    • aspnetcore-https.js
    • proxy.conf.js
    • package.json(修改)
    • angular.json(修改)
    • app.components.ts
    • app.module.ts

    如需其中一些項目檔的詳細資訊,請參閱 後續步驟

設定項目屬性

  1. 在 [方案總管] 中,以滑鼠右鍵按兩下 AngularWithASP.Server 項目,然後選擇 [屬性]

    顯示 [開啟項目屬性] 的螢幕快照。

  2. 在 [屬性] 頁面中,開啟 [偵錯] 索引標籤,然後選取 [開啟偵錯啟動配置檔 UI] 選項。 如果存在,請取消核取 HTTPs 配置檔或以 ASP.NET Core 專案命名的配置檔 啟動瀏覽器 選項。

    顯示除錯啟動設定檔 UI 的螢幕截圖。

    這個值可防止使用來源天氣數據開啟網頁。

    注意

    在 Visual Studio 中,launch.json 會在 [偵錯] 工具列中儲存與 [開始] 按鈕相關聯的啟動設定。 launch.json 必須位於 .vscode 資料夾底下。

  3. 以滑鼠右鍵點擊 [方案總管] 中的方案,然後選取 [屬性]。 確認 [啟動項目設定] 已設定為 [多個專案],且這兩個專案的 [動作] 已設定為 [開始]。

啟動專案

F5,或選取視窗頂端的 [開始] 按鈕,以啟動應用程式。 出現兩個命令提示字元:

  • 執行 ASP.NET 核心 API 專案
  • 執行 ng start 命令的 Angular CLI

注意

檢查主控台輸出以查找訊息。 例如,可能會有通知要求更新 Node.js。

Angular 應用程式隨即出現,並透過 API 填入 (localhost 埠可能與螢幕快照不同)。

顯示天氣預報應用程式的螢幕快照。

如果您沒有看到應用程式,請參閱 疑難解答

發佈專案

從 Visual Studio 2022 17.3 版開始,您可以使用 Visual Studio 發佈工具發佈整合式解決方案。

注意

若要使用發佈,請使用 Visual Studio 2022 17.3 版或更新版本建立 JavaScript 專案。

  1. 在 [方案總管] 中,以滑鼠右鍵點擊 AngularWithASP.Server 專案,然後選取 [新增>專案參考]

    確定已選取 angularwithasp.client 專案。

  2. 選擇 [確定]

  3. 再次以滑鼠右鍵按下 ASP.NET Core 專案,然後選取 [編輯項目檔]

    這會開啟專案的 .csproj 檔案。

  4. .csproj 檔案中,確定專案參考包含一個 <ReferenceOutputAssembly> 元素,且其值設定為 false

    此參考看起來應該如下所示:

     <ProjectReference Include="..\angularwithasp.client\angularwithasp.client.esproj">
       <ReferenceOutputAssembly>false</ReferenceOutputAssembly>
     </ProjectReference>
    
  5. 以滑鼠右鍵按兩下 [ASP.NET Core 專案],然後選擇 [重載專案],如果該選項可用。

  6. Program.cs中,請確定下列程式代碼存在。

    app.UseDefaultFiles();
    app.UseStaticFiles();
    
    // Configure the HTTP request pipeline.
    if (app.Environment.IsDevelopment())
    {
       app.UseSwagger();
       app.UseSwaggerUI();
    }
    
  7. 若要發佈,請以滑鼠右鍵按兩下 ASP.NET Core 專案,選擇 [發佈],然後選取符合您所需發佈案例的選項,例如 Azure、發佈至資料夾等。

    發佈程式花費的時間比只針對 ASP.NET Core 專案花費更多時間,因為發佈時會叫用 npm run build 命令。 BuildCommand 預設會執行 npm run build

    如果您發佈至資料夾,請參閱 ASP.NET Core 目錄結構,以取得新增至 publish 資料夾之檔案的詳細資訊。

故障排除

Proxy 錯誤

您可能會看到下列錯誤:

[HPM] Error occurred while trying to proxy request /weatherforecast from localhost:4200 to https://localhost:5001 (ECONNREFUSED) (https://nodejs.org/api/errors.html#errors_common_system_errors)

如果您看到此問題,很可能是因為前端先於後端啟動。

  • 當您看到後端命令提示字元啟動並執行之後,只要在瀏覽器中重新整理 Angular 應用程式即可。
  • 此外,請確認後端已設定為在前端之前啟動。 若要確認,請在 [方案總管] 中選取方案,從 [專案] 選單選擇 [屬性]。 接下來,選取 設定啟始專案,並確保後端 ASP.NET Core 專案排在清單的首位。 如果不是第一個專案,請選取專案,並使用向上鍵按鈕將它設為啟動清單中的第一個專案。

驗證埠

如果天氣數據未正確載入,您可能也需要確認您的埠設置是否正確。

  1. 移至 ASP.NET Core 專案中的 launchSettings.json 檔案 (在 [屬性] 資料夾中)。 從 applicationUrl 屬性取得埠號碼。

    如果有多個 applicationUrl 屬性,請使用 https 端點尋找一個。 看起來應該類似 https://localhost:7049

  2. 然後,移至 Angular 專案的 proxy.conf.js 檔案(查看 src 資料夾)。 更新目標屬性,以符合 launchSettings.json中的 applicationUrl 屬性。 當您更新它時,該值看起來應該會像這樣:

    target: 'https://localhost:7049',
    

Docker

如果您建立一個啟用了 Docker 支援的專案,請執行下列步驟:

  1. 載入應用程式之後,使用 Visual Studio 中的 [容器] 視窗 取得 Docker HTTPS 連接埠。 檢查 [環境] 索引標籤 或 [埠] 索引標籤

    顯示 Docker 容器埠的螢幕快照。

  2. 開啟 Angular 專案的 proxy.conf.js 檔案。 更新 target 變數,以符合 [容器] 視窗中的 HTTPS 連接埠。 例如,在下列程式代碼中:

    const target = env.ASPNETCORE_HTTPS_PORT ? `https://localhost:${env.ASPNETCORE_HTTPS_PORT}` :
       env.ASPNETCORE_URLS ? env.ASPNETCORE_URLS.split(';')[0] : 'https://localhost:7209';
    

    https://localhost:7209 變更為相符的 HTTPS 連接埠(在此範例中為 https://localhost:62958)。

  3. 重新啟動應用程式。

後續步驟

如需 ASP.NET Core 中 SPA 應用程式的詳細資訊,請參閱 開發單頁應用程式下的 Angular 一節。 連結的文章提供項目檔的其他內容,例如 aspnetcore-https.jsproxy.conf.js,雖然實作的詳細數據因專案範本差異而有所不同。 例如,Angular 檔案會包含在個別專案中,而不是 ClientApp 資料夾。

如需用戶端項目專屬的 MSBuild 資訊,請參閱 JSPS的 MSBuild 屬性。