共用方式為


Aspire Visual Studio Code 擴展

該AspireVisual Studio Code擴展提供了一組命令和工具,簡化您在Visual Studio Code中使用Aspire的工作。 此擴充功能包含建立專案、新增整合、設定解決方案及管理部署的命令。 此擴充功能需要Aspire CLI,並在Visual Studio Code命令選項板上提供類似的功能。

先決條件

若要使用 Aspire,您需要在本機安裝下列專案:

如需詳細資訊,請參閱 設定和工具,以及AspireAspire SDK

此外,在您能使用擴充套件之前,您必須安裝CLI並讓其可在您的 PATH 中使用。

安裝 Aspire 擴充功能

若要安裝 Aspire VS Code 延伸模組:

  1. 開啟 VS Code。

  2. 選取「檢視>延伸」或按 CtrlShift+X (Windows/+) 或 CmdLinux+Shift+X (macOS) 來開啟「延伸」檢視。

  3. 在擴充功能市集中搜尋「Aspire」。

  4. 選取 Aspire 所發佈的延伸模組。

  5. 選取安裝

    VS Code 的螢幕擷取畫面,顯示如何安裝 Aspire 延伸模組。

或者,您可以直接從 VS Code Marketplace 安裝延伸模組。

存取延伸模組指令

所有 Aspire 延伸指令都可從 VS Code 命令選項板取得:

  1. Ctrl+Shift+P (Windows/Linux) 或 Cmd+Shift+P (macOS) 開啟命令面板。
  2. 鍵入“Aspire”以過濾並顯示所有可用的 Aspire 命令。
  3. 從清單中選取所需的命令。

所有命令都會分組在「命令面板」中的類別 Aspire 下,方便探索。

可用的命令

Aspire VS Code 延伸模組提供下列命令:

Command Description Availability
Aspire: 新 Aspire 項目 從範本建立新的 Aspire 應用程式主機或入門應用程式。 有現貨
Aspire:新增整合 將主機整合 (Aspire.Hosting.*) 新增至 Aspire apphost。 有現貨
Aspire:配置 launch.json 將預設的Aspire偵錯工具啟動配置新增到工作區的launch.json,這將在工作區中偵測並運行apphost。 有現貨
Aspire:管理組態設定 管理組態設定,包括功能旗標。 有現貨
Aspire:打開 Aspire 終端機 開啟 Aspire VS Code 終端機以處理 Aspire 專案。 有現貨
Aspire:發佈部署工件 產生 Aspire 應用程式宿主的部署成品。 Preview
Aspire:部署應用程式 將應用程式主機的內容 Aspire 部署至其定義的部署目標。 Preview
Aspire:更新整合功能 更新 apphost 中的託管集成和 Aspire SDK。 Preview

建立新 Aspire 應用程式

若要使用擴充功能建立新 Aspire 應用程式:

  1. 開啟命令面板 (Ctrl+Shift+PCmd+Shift+P)。

  2. 執行 Aspire: New Aspire project 命令。

  3. 選取所需的範本:

  4. 指定專案名稱和位置。

    VS Code 的螢幕擷取畫面,示範如何使用延伸模組建立Aspire新的Aspire解決方案。

延伸模組會建立專案,並在 VS Code 中開啟它。

將整合功能加入至 Aspire 解決方案

Aspire 這些整合提供預先設定好的連線到各種雲端服務和相依項目。 若要新增整合項目:

  1. 開啟 [命令選擇區]。
  2. 執行 Aspire:新增整合 命令。
  3. 瀏覽或搜尋所需的整合套件。
  4. 選取整合以將其新增至您的AppHost專案。

延伸模組會將適當的 NuGet 套件參考新增至您的 AppHost 專案。

備註

新增整合命令會將主控整合新增至 AppHost 專案。 它不會將對應的用戶端整合新增至任何取用專案。

設定 Aspire 解決方案

擴充功能Aspire涵蓋若干命令,可在開發期間設定Aspire和Aspire CLI 的行為。

配置 launch.json 以進行除錯

若要在 VS Code 中執行和偵錯 Aspire 應用程式,您必須設定檔案 launch.json

  1. 開啟 [命令選擇區]。
  2. 執行 Aspire: Configure launch.json 命令。
  3. 延伸模組會將預設 Aspire 偵錯工具設定新增至工作區的 launch.json 檔案。

預設設定如下所示:

{
    "type": "aspire",
    "request": "launch",
    "name": "Aspire: Launch Default AppHost",
    "program": "${workspaceFolder}"
}

您可以自訂 program 欄位以指向特定的 AppHost 專案檔案。 例如:

{
    "type": "aspire",
    "request": "launch",
    "name": "Aspire: Launch MyAppHost",
    "program": "${workspaceFolder}/MyAppHost/MyAppHost.csproj"
}

管理組態設定

Aspire: 管理配置設定指令會aspire config執行要求選項,並在 VS Code 終端機中顯示結果。 使用 getset 命令配置 Aspire CLI。 使用命令 list 顯示當前配置值。

在開發模式中執行 Aspire 解決方案

若要在開發模式中執行 Aspire 應用程式:

  1. 確保已按照配置 launch.json 進行調試一節中的說明進行配置launch.json
  2. 選取 [檢視>執行] 或按 CtrlShift+D (Windows/+) 或 CmdLinux+Shift+D (macOS) 來開啟 [執行和偵錯] 檢視。
  3. 從下拉式清單中選取您的 Aspire 啟動設定。
  4. 選取綠色的 [開始偵錯] 按鈕,或按 F5

擴充功能會建置並啟動 AppHost 專案、在瀏覽器中啟動 Aspire 儀錶板,並啟用解決方案中所有資源的偵錯。

或者,您可以使用 Aspire 開啟 Aspire: Open Aspire terminal VS Code 終端機,並執行 aspire run --start-debug-session 以啟動 VS Code 除錯階段作業。

從編輯器執行或偵錯

當您的工作區中偵測到 AppHost 專案時,您也可以直接從編輯器執行或偵錯它。 檢視 AppHost 檔案時,請使用編輯器標題列中的執行按鈕。

部署工件發佈

這很重要

此功能為 預覽版

Aspire:發佈部署工件的指令會為您的Aspire AppHost 產生部署工件。 此命令會將資源序列化至磁碟,讓部署工具取用資源。

若要發布部署構件:

  1. 開啟 [命令選擇區]。
  2. 執行 Aspire:發佈部署工件 指令。
  3. 選取所產生構件的輸出位置。

此命令會叫用已註冊的發佈回呼註釋,以產生構件,例如:

  • Bicep 檔案用於 Azure 資源。
  • Docker 撰寫 YAML 檔案。
  • Kubernetes 舵手圖表。

如需發佈的詳細資訊 Aspire ,請參閱 Aspire 發佈和部署概觀

部署 Aspire 解決方案

這很重要

此功能為 預覽版

:Aspire 部署應用程式主機命令會將 AppHost 的內容Aspire部署至其定義的部署目標。

若要部署 Aspire 解決方案:

  1. 開啟 [命令選擇區]。
  2. 執行 Aspire: Deploy app host 命令。
  3. 請依照提示選取部署目標,並提供任何必要的設定。

此指令會發佈部署構件,然後呼叫部署回呼註釋,以將資源部署至指定的目標。

如需部署的詳細資訊 Aspire ,請參閱 Aspire 發佈和部署概觀

開啟 Aspire 終端

:Aspire 開啟 Aspire 終端機 指令會開啟一個已設定為使用Aspire專案的終端機視窗。 此終端機可讓您輕鬆存取 Aspire CLI 命令,並預先設定適當的環境變數。

意見反應和問題

若要報告 Aspire VS Code 延伸模組的問題或提出功能需求:

  1. 造訪 AspireGitHub 存放庫
  2. 建立新問題並新增標籤 area-extension

另請參閱