關鍵概念

Spring CLI 依賴於貫穿整個專案的幾個關鍵概念

專案

專案: 在 GitHub 或 GitLab 上託管的“普通 Java 專案”。專案在 CLI 中註冊,以便可以使用簡單的名稱來引用它們。

例如,如果在 CLI 中註冊一個使用 Spring Data JPA 的 GitHub 專案 URL,並將其命名為“jpa”,則可以使用命令 boot new my-jpa-app jpa 從該專案建立一個新專案。類似地,您可以透過呼叫 boot add jpa 命令向現有專案新增 JPA 功能。

與專案相關的命令包括 project listproject addproject remove

專案目錄

專案目錄: 專案目錄是共享共同主題的專案集合。

在 CLI 中註冊目錄後,在使用 boot newboot add 命令時,專案就可以隨時使用了。目錄是一個名為 project-catalog.yaml 的 YAML 檔案。它包含專案倉庫 URL 列表和相關的名稱。該目錄託管在 GitHub 或 GitLab 上。

與專案目錄相關的命令包括 catalog listcatalog addcatalog remove

使用者自定義命令

命令: 這些是宣告性定義的命令,允許您新增或修改程式碼和配置檔案。

您還可以執行任意可執行檔案來執行開發工作流程中常見的任何任務。使用者自定義命令整合到 CLI 中,並與內建命令具有相同的外觀。

使用者自定義命令包含三個部分:命令名稱子命令名稱選項。命令名稱和子命令名稱透過目錄結構約定來定義。

例如,要建立一個命令名稱為 controller、子命令名稱為 new 的新使用者自定義命令,請建立以下目錄結構:

.spring/commands/controller/new

在此目錄中,可以有一個名為 command.yaml 的檔案,用於定義命令的描述、選項和預設值。此目錄(以及子目錄)包含定義對專案執行的操作的操作檔案。

操作檔案

操作檔案: 這些檔案定義了可以對專案執行的操作。

角色

在您的 CLI 中,角色提供了一種在使用者自定義命令之間組織和重用變數的方式。

Spring CLI 包含一個始終存在的預設匿名角色。此外,角色可以與特定名稱關聯,以進一步區分其用途和用法。這些角色以 YAML 檔案形式儲存在 .spring/roles 目錄中,該目錄與 .spring/commands 目錄位於同一級別。

這些角色允許您定義在操作檔案中可訪問的變數,從而提供一種在命令之間共享資料的方式。

您還可以使用角色為命令列選項提供值。如果某個命令列選項沒有指定值,並且存在一個與該命令選項同名的角色變數,則該命令將使用該角色變數的值作為該特定命令選項的值。

一些與專案相關的常見角色命令包括 role addrole removerole set