操作指南

本页介绍了您可以使用的操作：spring-doc.cn

生成

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

文件的内容是使用 key 定义的。textspring-doc.cn

以下示例显示了一个简单的操作：generatespring-doc.cn

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

Handlebars 模板引擎将 and 变量替换为实际值。传递给用户定义命令的命令行选项将作为模板引擎使用的变量公开。{{user-name}}{{os-name}}spring-doc.cn

有关预定义模板引擎变量的更多信息，请参阅模板引擎部分。spring-doc.cn

文本语法

YAML 的文字语法允许表示多行字符串或保留字符串中的格式和空格。spring-doc.cn

当您想要保持换行符和缩进，但某些特殊字符必须使用斜杠字符进行转义时，文本语法非常有用。spring-doc.cn

以下示例使用 YAML 中的 Literal 语法：spring-doc.cn

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-doc.cn

外部文件

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

要解决这些情况，您可以使用 key 指定用于生成文本的源文件。fromspring-doc.cn

以下示例使用该键：fromspring-doc.cn

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

该键是相对于运行命令的目录的。tospring-doc.cn

该文件与命令位于同一目录中，下面的清单显示了它的内容：json-template.json.spring/commands/hello/createspring-doc.cn

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

从介绍性示例运行会生成一个名为的文件，如下所示：spring hello createhello.jsonspring-doc.cn

$ 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-doc.cn

以下示例在键中使用 Handlebars 模板变量：tospring-doc.cn

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

有关预定义模板引擎变量的更多信息，请参阅模板引擎部分。spring-doc.cn

注入

该操作用于将文本注入文件。injectspring-doc.cn

您需要定义 key 或 key 以指示注入文本的位置。after:before:spring-doc.cn

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

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

下面的清单显示了一个操作，该操作在包含单词的行之后注入：injectINJECTED AFTERmarker2spring-doc.cn

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

运行此操作后的文本文件为：spring-doc.cn

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-doc.cn

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

运行此操作后的文本文件为：spring-doc.cn

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-doc.cn

下面的清单显示了运行 shell 命令的基本形式：spring-doc.cn

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

模板引擎变量是默认定义的，它是 Java 系统属性的值。tmp-dirjava.io.tmpdirspring-doc.cn

重定向输出

待定spring-doc.cn

注入 Maven 依赖

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

您可以在字段内使用 Handlebars 模板变量和表达式。text:spring-doc.cn

以下示例显示了注入 Maven 依赖项的基本语法：spring-doc.cn

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-doc.cn

您可以在字段内使用 Handlebars 模板变量和表达式。text:spring-doc.cn

下面的清单显示了注入 Maven 依赖项的基本语法：spring-doc.cn

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>

注入 Maven 构建插件

该操作会将 Maven Build Plugin 条目注入 Maven pom.xml 文件中。inject-maven-build-pluginspring-doc.cn

您可以在字段内使用 Handlebars 模板变量和表达式。text:spring-doc.cn

以下示例显示了注入 Maven 依赖项的基本语法：spring-doc.cn

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-doc.cn

您可以在字段内使用 Handlebars 模板变量和表达式。text:spring-doc.cn

以下示例显示了注入 Maven 存储库的基本语法：spring-doc.cn

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