操作文件指南 (Guide to Action Files) _ Spring CLI 0.9.0 中文文档(官方文档中文翻译) —

本页介绍您可以使用的操作：Spring中文文档

生成

该操作用于生成文件。它需要一个键来指定目标路径。该路径相对于执行用户定义命令的位置。如果文件已存在，则不会覆盖它。generatetoSpring中文文档

文件的内容是使用密钥定义的。textSpring中文文档

以下示例演示了一个简单的操作：generateSpring中文文档

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

和变量被 Handlebars 模板引擎替换为实际值。传递给用户定义命令的命令行选项将公开为模板引擎要使用的变量。{{user-name}}{{os-name}}Spring中文文档

有关预定义模板引擎变量的详细信息，请参阅模板引擎部分。Spring中文文档

文字语法

YAML 的文字语法允许表示多行字符串或保留字符串中的格式和空格。Spring中文文档

当您想要保持换行符和缩进时，文本语法很有用，但某些特殊字符必须使用斜杠字符进行转义。Spring中文文档

以下示例使用 YAML 中的文字语法：Spring中文文档

actions:
  - generate:
      to:  hello.txt
      text: |
        This is a multi-line
        string using the literal syntax.
        It preserves the line breaks
        and indentation exactly as written.
        \t This is a tab character.
        \n This is a newline character.
        \\ This is a backslash.
        \u2713 This is a Unicode character (checkmark symbol).

通过使用后跟缩进块的字符，字符串被视为文本，并保留换行符和缩进。|Spring中文文档

外部文件

在某些情况下，由于需要转义，很难使用文本语法嵌入文本。 JSON 文件、正则表达式和文件路径是出现此类困难的常见示例。此外，您可能希望将文本内容与操作文件分开编辑，以使用文本编辑器的语法突出显示和验证功能。Spring中文文档

若要解决这些情况，可以使用密钥指定用于生成文本的源文件。fromSpring中文文档

以下示例使用密钥：fromSpring中文文档

actions:
  - generate:
      to:  hello.json
      from: json-template.json

该键相对于运行命令的目录。toSpring中文文档

该文件与命令位于同一目录中，以下列表显示了其内容：json-template.json.spring/commands/hello/createSpring中文文档

{
  "operatingSystem": "{{os-name}}",
  "phoneNumbers": [
    {
      "type": "iPhone",
      "number": "0123-4567-8888"
    },
    {
      "type": "home",
      "number": "0123-4567-8910"
    }
  ]
}

从介绍性示例运行会生成一个名为的文件，如下所示：spring hello createhello.jsonSpring中文文档

$ spring hello create
Generated /home/testing/rest-service/hello.json

$ cat hello.json

{
  "operatingSystem": "Linux",
  "phoneNumbers": [
    {
      "type": "iPhone",
      "number": "0123-4567-8888"
    },
    {
      "type": "home",
      "number": "0123-4567-8910"
    }
  ]
}

密钥中的变量替换

您还可以在、和键中使用 Handlebars 模板变量。tofromtextSpring中文文档

以下示例在键中使用 Handlebars 模板变量：toSpring中文文档

actions:
  - generate:
      to: src/main/java/{{root-package-dir}}/{{feature}}/{{capitalizeFirst feature}}Controller.java
      from: RestController.java

有关预定义模板引擎变量的详细信息，请参阅模板引擎部分。Spring中文文档

注入

该操作用于将文本注入到文件中。injectSpring中文文档

您需要定义键或键来指示注入文本的位置。after:before:Spring中文文档

以下列表显示了一个示例文件：Spring中文文档

Hello there.
This is a test file.
We are going to insert before the line that has the word marker1
marker2

以下列表显示了在包含单词的行之后注入的操作：injectINJECTED AFTERmarker2Spring中文文档

actions:
  - inject:
      to: sample.txt
      text: "INJECTED AFTER"
      after: marker2

运行此操作后的文本文件为：Spring中文文档

Hello there.
This is a test file.
We are going to insert before the line that has the word marker1
marker2
INJECTED AFTER

以下列表显示了在包含单词的行之前注入的操作：injectINJECTED BEFOREmarker1Spring中文文档

actions:
  - inject:
      to: sample.txt
      text: "INJECTED BEFORE"
      before: marker1

运行此操作后的文本文件为：Spring中文文档

Hello there.
This is a test file.
INJECTED BEFORE
We are going to insert before the line that has the word marker1
marker2

执行官

该操作运行 shell 命令。execSpring中文文档

以下清单显示了运行 shell 命令的基本形式：Spring中文文档

actions:
  - exec:
      command: mkdir {{tmp-dir}}/scratch

缺省情况下，模板引擎变量是 Java 系统属性的值。tmp-dirjava.io.tmpdirSpring中文文档

重定向输出

待定Spring中文文档

注入 Maven 依赖项

该操作将 Maven 依赖项条目注入 Maven pom.xml 文件。inject-maven-dependencySpring中文文档

您可以在字段中使用 Handlebars 模板变量和表达式。text:Spring中文文档

以下示例显示了注入 Maven 依赖项的基本语法：Spring中文文档

actions:
  - inject-maven-dependency:
      text: |
        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>

        <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-test</artifactId>
          <scope>test</scope>
        </dependency>

        <dependency>
          <groupId>com.h2database</groupId>
          <artifactId>h2</artifactId>
          <scope>runtime</scope>
        </dependency>

注入 Maven 依赖管理

该操作将 Maven 依赖项管理条目注入到 Maven pom.xml 文件中。inject-maven-dependency-managementSpring中文文档

您可以在字段中使用 Handlebars 模板变量和表达式。text:Spring中文文档

以下列表显示了注入 Maven 依赖项的基本语法：Spring中文文档

actions:
  - inject-maven-dependency-management:
      text: |
        <dependency>
          <groupId>org.springframework.modulith</groupId>
          <artifactId>spring-modulith-bom</artifactId>
          <version>0.6.0.RELEASE</version>
          <scope>import</scope>
          <type>pom</type>
        </dependency>

Inject Maven 构建插件

该操作将 Maven 构建插件条目注入到 Maven pom.xml 文件中。inject-maven-build-pluginSpring中文文档

您可以在字段中使用 Handlebars 模板变量和表达式。text:Spring中文文档

以下示例显示了注入 Maven 依赖项的基本语法：Spring中文文档

actions:
  - inject-maven-build-plugin:
      text: |
        <plugin>
           <groupId>net.bytebuddy</groupId>
           <artifactId>byte-buddy-maven-plugin</artifactId>
           <version>1.14.4</version>
           <configuration>
             <classPathDiscovery>true</classPathDiscovery>
           </configuration>
           <executions>
             <execution>
               <goals>
                 <goal>transform-extended</goal>
               </goals>
             </execution>
           </executions>
         </plugin>

注入 Maven 存储库

该操作将 Maven 存储库条目注入到 Maven pom.xml 文件中。inject-maven-repositorySpring中文文档

您可以在字段中使用 Handlebars 模板变量和表达式。text:Spring中文文档

以下示例显示了注入 Maven 存储库的基本语法：Spring中文文档

actions:
  - inject-maven-repository:
      text: |
        <repository>
          <id>spring-snapshots</id>
          <url>https://repo.spring.io/snapshot</url>
        </repository>