角色
角色提供一種組織和重複使用跨使用者定義命令變數的方法。
預設情況下,Spring CLI 包含一個始終可用的未命名角色。如果未指定特定角色,命令將使用預設角色。
為了進一步自訂和區分角色,您可以將它們與特定名稱關聯。這些具名角色儲存在 .spring/roles
目錄中,該目錄與 .spring/commands
目錄位於同一層級。
角色讓您定義可以使用 Handlebars 在動作檔案中存取的變數,讓您在命令之間共享資料。
此外,您可以使用角色為命令列選項提供值。如果命令列選項沒有指定值,並且存在與命令選項同名的角色變數,則命令會自動使用該角色變數的值來作為該特定選項的值。
檔案結構
對於每個角色,都會在 .spring/roles/vars
目錄中建立一個對應的檔案。例如,如果有名為 qa
和 prod
的角色,則目錄結構如下所示
$ tree .spring/roles/vars -lr
.spring/roles/vars
├── vars.yml
├── vars-qa.yml
└── vars-prod.yml
vars.yml
檔案用於預設角色。
此結構遵循與使用特定配置檔的 Spring 應用程式設定類似的模式。但是,角色變數不表現出與 Spring Profile 相同的行為,例如除了檔案中的位置之外,還從其他位置(例如環境變數)檢索值。
快速入門
在這個快速入門中,我們將示範如何將變數新增到預設角色,並在產生檔案時使用它們的值。
首先,將角色變數 'greeting' 的值設定為 'Mondo'
$ spring role set --key greeting --value Mondo
Key-value pair added to the default role
鍵值對儲存在根專案目錄下的 ./spring/roles/vars/vars.yml
檔案中。
若要檢索變數的值,請使用以下命令
$ spring role get --key greeting
Mondo
現在我們建立另一個角色變數
$ spring role set --key language --value Italian
Key-value pair added to the default role
現在我們可以將這些變數合併到使用者定義的命令中。我們建立一個名為 hello say
的使用者定義命令
$ spring command new --command-name hello --sub-command-name say
Created user defined command /home/mark/testing-spring-cli/roles/myapp/.spring/commands/hello/say
在 .spring/commands/hello/say
目錄內,您可以找到一個名為 command.yaml
的檔案,其內容如下
command:
description: Generate a new file with a hello message
options:
#
- name: greeting
description: who or what to say hello to
dataType: string
defaultValue: World
inputType: text
請注意,命令列選項名稱為 greeting
,這與我們建立的角色變數的名稱相符。
在 .spring/commands/hello/say
目錄中,有一個名為 hello.yaml
的動作檔案,其內容如下
actions:
- generate:
to: hello.txt
text: Hello {{greeting}} on {{os-name}}.
現在我們更新檔案以包含
actions:
- generate:
to: hello.txt
text: Hello {{greeting}} on {{os-name}}. {{#if language}} {{language}} {{/if}}
當執行命令時,如果沒有傳遞 greeting
命令列選項,則 greeting
的值會從同名的角色變數中取得,而不是使用預設值 World
。
此外,由於我們已定義角色變數 language,因此我們可以測試其是否存在,並將其值包含在輸出中。請注意,language 不是命令列選項。以下命令(及其輸出)可以做到這一點
$ spring hello say
Using Role variable instead of default command line option for key = greeting , value = Mondo from the default role
Generated /home/mark/testing-spring-cli/roles/myapp/hello.txt
產生的檔案包含
Hello Mondo on Linux. Italian
{{greeting}}
的值來自角色變數,因為它沒有作為命令列選項提供。
{{language}}
變數不是命令列選項,但它可用於 Handlebars 表達式。
現在我們可以移除產生的檔案。在互動式 Shell 中,我們執行 . ! rm hello.txt
並傳入 greeting
命令列選項
$ spring hello say --greeting amico
產生的檔案包含
Hello amico on Linux. Italian
設定變數
若要設定角色變數的值,請使用 spring role set
命令
spring role set --key greeting --value Mondo
您可以選擇性地使用 --role
選項來指定角色。
取得變數
若要檢索角色變數的值,請使用以下命令
spring role get --key greeting
您可以選擇性地使用 --role 選項來指定角色。
然後可以在使用 Handlebars 範本的動作檔案中存取角色變數 greeting。有關範例,請參閱快速入門章節。
角色變數也用於比對使用者定義的命令選項名稱。如果沒有明確作為命令列選項提供值,則會使用角色變數的值。
您也可以使用特殊命令 . !
,當您在互動式 Shell 中時,檢視包含角色變數的檔案的完整內容
spring:>. ! cat .spring/roles/vars/vars.yml
greeting: mondo