用户自定义命令指南

用户定义的命令允许您向 Spring CLI 添加自定义命令。 命令的目录结构表示引入 shell 的命令和子命令。spring-doc.cn

例如，的目录结构转换为 CLI 中的命令。controller\newcontroller newspring-doc.cn

位于子命令目录中的文件是：spring-doc.cn

  • 一个 named 的文件，用于描述命令及其参数。command.yamlspring-doc.cn

  • 一个或多个操作文件，用于描述向项目添加代码或配置时要执行的操作。spring-doc.cn

使用以下命令将用户定义的命令注册到 CLI：spring-doc.cn

command add --from <repository-url>

该存储库的内容将复制到您的现有项目中。spring-doc.cn

例如，查看 github.com/rd-1-2022/udc-spring-controller 存储库的内容。spring-doc.cn

结构

所有用户定义的命令的目录结构都位于以下路径下：spring-doc.cn

.spring/commands

因此，对于前面提到的用户定义命令 ，命令描述文件和操作文件所在的完整目录结构将为：controller newspring-doc.cn

.spring/commands/controller/new

在此目录中，您可以定义：spring-doc.cn

  • 描述命令的作用和命令参数的文件。command.yamlspring-doc.cn

  • 一个或多个操作文件，用于定义要为此命令运行的操作。spring-doc.cn

例如，github.com/rd-1-2022/udc-spring-controller 存储库的目录内容如下所示：spring-doc.cn

.
├── README.adoc
└── .spring
    └── commands
        └── controller
            └── new
                ├── command.yaml
                ├── create-controller.yaml
                └── RestController.java

描述命令

前面提到的命令的文件内容如下：command.yamlcontroller newspring-doc.cn

command:
  description: Generate a new Spring Controller
  options:
    #
    - name: feature
      description: name of the feature package
      dataType: string
      defaultValue: person
      inputType: text
      required: true

该文件包含命令的简要说明和一系列命令行选项。spring-doc.cn

的选项是必需的。默认值为 .namedataTypestringspring-doc.cn

可以是 、 、 、 、 或 。dataTypeintintegerboolbooleandoublefloatlongshortstringspring-doc.cn

Spring CLI 在运行时合并这些命令，它们在请求一般帮助和特定于命令的帮助时出现。 下面的清单显示了一个示例：spring-doc.cn

$spring help

<output truncated>

User-defined Commands
       controller new: Generate a new Spring Controller

下面的清单显示了第二个示例：spring-doc.cn

$ spring help controller new
NAME
       controller new - Generate a new Spring Controller

SYNOPSIS
       controller new --feature String

OPTIONS
       --feature String
       name of the feature package
       [Optional, default = person]

操作文件

操作文件的结构类似于 GitHub 操作文件。spring-doc.cn

操作文件可以命名为您喜欢的任何名称。CLI 查找具有 和 文件扩展名的文件。.yaml.ymlspring-doc.cn

完成特定任务所需的操作文件数量不限。操作文件的运行顺序是深度优先，然后按字母顺序排列。spring-doc.cn

下面的清单显示了一个简单的示例：spring-doc.cn

actions:
  - generate:
      to: hello.txt
      text: Hello at {{now}} on {{os-name}}.

此操作将在当前工作目录中生成一个名为 （如果尚不存在） 的文件。 模板内容包含 kebab-case 变量名称。hello.txtspring-doc.cn

和 变量来自 Java 系统属性，并自动注册到模板引擎中。 该变量是命令运行时间的值。user-nameos-namenownew java.util.Date()spring-doc.cn

作为创建 Java 代码的更实际示例，以下三个清单显示了 name 操作文件的内容及其相关操作，以及存储库 github.com/rd-1-2022/udc-spring-controller 中的模板化 Java 文件。 变量是一个命令选项。Controller.javafeaturespring-doc.cn

command:
  description: Generate a new Spring Controller
  options:
    #
    - name: feature
      description: name of the feature package
      dataType: string
      defaultValue: person
      inputType: text
actions:
  - generate:
      to: src/main/java/{{root-package-dir}}/{{feature}}/{{capitalizeFirst feature}}Controller.java
      from: RestController.java

该字段定义要生成的文件的位置。to:spring-doc.cn

如果要生成的文件已存在，则不会覆盖该文件，除非在与该字段相同的级别添加名为 的附加字段。overwrite:to:spring-doc.cn

package {{root-package}}.{{feature}};

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class {{capitalizeFirst feature}}Controller {

	@GetMapping("/{{feature}}")
	public String greeting() {
		return "Hello {{feature}}";
	}
}

所有命令行参数都作为变量传递给模板引擎。在这种情况下，将传递该选项。featurespring-doc.cn

一个有用的内置变量是 ，它是包含注释的类所在的目录。root-package-dir@SpringApplicationspring-doc.cn

模板引擎

模板引擎是 Handlebars。 默认情况下，会注册多个 Handlebar 辅助对象spring-doc.cn

在前面的示例中，template 变量是使用 Handlebars 帮助程序的示例。{{capitalizeFirst feature}}spring-doc.cn

默认情况下，几个系统变量会暴露给模板引擎：spring-doc.cn

  • System.getProperties()可用作{{system-properties}}spring-doc.cn

  • System.getenv()可用作{{system-environment}}spring-doc.cn

  • 当前时间（由 定义 ）可用作new Date().toString(){{now}}spring-doc.cn

  • system 属性可用作java.io.tmpdir{{tmp-dir}}spring-doc.cn

  • system 属性的 使用方式为 * system 属性的file.separator{{file-separator}}os.name{{os-name}}spring-doc.cn

  • system 属性可用作user.name{\{user.name}}spring-doc.cn

Spring Boot 主应用程序类所在的 Java 包名称以 .{{root-package}}spring-doc.cn

Spring Boot 主应用程序类所在的目录为 。{{root-package-dir}}spring-doc.cn

Maven 模型还公开了几个变量：spring-doc.cn

创建新的用户定义命令

一种简单的入门方法是运行以下命令：spring-doc.cn

spring command new hello create

这将创建一个用户定义的命令，该命令以名为 .hellocreatespring-doc.cn

您可以通过运行 来查看 的完整选项集。 以下清单显示输出为：spring command newspring command new --helpspring-doc.cn

$ spring command new --help
NAME
       command new - Create a new user-defined command

SYNOPSIS
       command new --commandName String --subCommandName String --path String --help

OPTIONS
       --commandName String
       The name of the user-defined command to create
       [Optional, default = hello]

       --subCommandName String
       The name of the user-defined sub-command to create
       [Optional, default = new]

       --path String
       Path to execute command in
       [Optional]

       --help or -h
       help for command new
       [Optional]

运行会生成以下目录结构和文件。spring command new hello createspring-doc.cn

.
├── README.adoc
└── .spring
    └── commands
        └── hello
            └── create
                ├── command.yaml
                └── hello.yaml

下面的清单显示了文件的内容。它包含一个名为 .command.yamlgreetingspring-doc.cn

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     # TEXT

以下清单显示了名为 .它会生成名为hello.yamlhello.txtspring-doc.cn

actions:
  - generate:
      to: hello.txt
      text: Hello {{greeting}} at {{now}} on {{os-name}}.

当您运行命令时，该命令将列在标题下。User-defined Commandsspring helpspring-doc.cn

...
User-defined Commands
       hello create: Generate a new file with a hello message

运行该命令将生成包含以下内容的文件：spring hello createhello.txtspring-doc.cn

Hello World at Mar 9, 2023 on Linux.

了解更多

Action Guide 介绍了可在操作文件中使用的所有选项（用于向项目添加或修改代码和配置）。spring-doc.cn