操作文件

操作文件支持用户定义的命令。 这些文件以 YAML 格式编写，并存储在定义命令的目录中。spring-doc.cn

有关用户定义命令的目录结构的更多信息，请参阅有关 Action file Structure 的文档。spring-doc.cn

每个文件都包含一系列操作，这些操作按照它们在文件中定义的顺序运行。 操作执行帮助开发人员向其当前项目添加或修改代码和配置通常需要的任务。 操作可以运行另一个可执行应用程序，这有助于自动执行开发任务，例如使用供应商的 CLI 应用程序进行部署。spring-doc.cn

一个目录中可以有多个操作文件，并且它们按字母顺序进行评估。spring-doc.cn

评估顺序在将来的版本中可能会更改。

目前，只有少数操作存在，但更多操作已成为原型，即将推出。spring-doc.cn

操作列表包括：spring-doc.cn

  • generate - 创建新文件。spring-doc.cn

  • inject - 将文本注入到现有文件中的特定位置。spring-doc.cn

  • inject-maven-dependency - 将依赖项条目附加到当前 pom.xml 文件。spring-doc.cn

  • inject-maven-plugin - 将 Maven 插件条目附加到当前 pom.xml 文件spring-doc.cn

  • inject-maven-dependency-management - 将依赖项管理条目附加到当前pom.xml文件。spring-doc.cn

  • inject-maven-repository - 将存储库条目附加到当前 pom.xml 文件spring-doc.cn

  • inject-properties - 将属性附加到 Java 属性文件。spring-doc.cn

  • exec - 运行另一个程序。spring-doc.cn

一个介绍性示例

CLI 命令创建一个简单的用户定义命令，我们可以使用它来演示操作文件的组件。command newspring-doc.cn

spring command new --commandName hello --subCommandName create
Created user defined command /home/testing/rest-service/.spring/commands/hello/create

目录结构为spring-doc.cn

$ tree .spring
.spring
└── commands
    └── hello
        └── create
            ├── command.yaml
            └── hello.yaml

的内容 ，如下所示，它定义了一个名为 的命令行参数。 此参数在 action 文件中使用。command.yamlgreetinghello.yamlspring-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.yamlspring-doc.cn

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

了解 actions 文件

为了帮助您了解如何使用 YAML 语法创建操作文件，本节将介绍示例的每一行进行说明：spring-doc.cn

法典 解释。

行动：spring-doc.cn

将所有操作组合在一起。spring-doc.cn

生成：spring-doc.cn

要执行的操作类型。例如，此操作类型会生成文件。spring-doc.cn

自：spring-doc.cn

在文件系统中生成文件的位置。spring-doc.cn

发短信：spring-doc.cn

要生成的文件的内容。spring-doc.cn

运行用户定义的命令

$ spring hello create --greeting World!
Generated /home/testing/rest-service/hello.txt

$ cat hello.txt
Hello World! on Linux.

后续步骤