角色

角色提供了一种在用户定义的命令中组织和重复使用变量的方法。

默认情况下，Spring CLI 包含一个始终可用的未命名角色。如果没有指定特定角色，则命令将使用默认角色。

为了进一步自定义和区分角色，您可以将它们与特定名称关联。这些命名的角色存储为 YAML 文件，位于 .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 配置文件相同的行为，例如从文件之外的其他位置（例如环境变量）检索值。

快速入门

在本快速入门中，我们将演示如何向默认角色添加变量，以及在生成文件时使用其值。

首先，我们将角色变量“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。

此外，由于我们已经定义了角色变量语言，因此我们可以测试其存在并将其值包含在输出中。请注意，语言不是命令行选项。以下命令（显示及其输出）执行此操作

$ 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。有关示例，请参阅快速入门部分。

role 变量还用于与用户定义的命令选项名称进行匹配。如果未明确提供值作为命令行选项，则使用 role 变量的值。

在交互式 shell 中，您还可以使用特殊命令 . ! 来查看包含 role 变量的文件的全部内容

spring:>. ! cat .spring/roles/vars/vars.yml
greeting: mondo

添加角色

要添加角色，请使用以下命令

spring role add qa

此命令创建一个名为 qa 的角色。

在根项目目录下创建一个名为 ./spring/roles/vars/vars-qa.yml 的文件。

列出角色

要列出可用的角色，请使用以下命令

spring role list

此命令显示角色列表

┌────┐
│Name│
├────┤
│qa  │
└────┘

删除角色

要删除角色，请使用以下命令

spring role remove qa

此命令删除名为 qa 的角色。