Action Guide
Generate
generate
操作用于生成文件,它需要一个 to
键来指定目标路径。路径相对于执行用户自定义命令的位置。如果文件已存在,则不会覆盖它。
使用 text
键定义文件内容。
以下示例展示了一个简单的 generate
操作:
actions:
- generate:
to: hello.txt
text: Hello {{user-name}} on {{os-name}}.
{{user-name}}
和 `{{os-name}} 变量由 Handlebars 模板引擎替换为实际值。传递给用户自定义命令的命令行选项会用作变量,供模板引擎使用。
有关预定义模板引擎变量的更多信息,请参阅 Template Engine 部分。
Literal Syntax
YAML 的文本语法允许表示多行字符串或保留字符串中的格式和空格。
当您要保留换行符和缩进,但某些特殊字符必须使用反斜杠字符进行转义时,文本语法很有用。
以下示例在 YAML 中使用了文本语法:
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).
通过使用 |
字符后跟缩进块,该字符串将被视为文本,并保留换行符和缩进。
External File
在某些情况下,由于需要转义,很难使用文本语法嵌入文本。JSON 文件、正则表达式和文件路径是出现此类困难的常见示例。此外,您可能希望单独编辑文本内容,以使用文本编辑器的语法突出显示和验证功能。
要解决这些情况,可以使用 from
键指定用于生成文本的源文件。
以下示例使用了 from
键:
actions:
- generate:
to: hello.json
from: json-template.json
to
键是相对于运行命令的目录。
json-template.json
文件位于与命令(.spring/commands/hello/create
)相同的目录中。以下清单显示了内容:
{
"operatingSystem": "{{os-name}}",
"phoneNumbers": [
{
"type": "iPhone",
"number": "0123-4567-8888"
},
{
"type": "home",
"number": "0123-4567-8910"
}
]
}
从 introductory example 运行 spring hello create
,会生成一个名为 hello.json
的文件,如下所示:
$ 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"
}
]
}
Variable Replacement in Keys
您还可以在 to
、from
和 text
键中使用 Handlebars 模板变量。
以下示例在 to
键中使用 Handlebars 模板变量:
actions:
- generate:
to: src/main/java/{{root-package-dir}}/{{feature}}/{{capitalizeFirst feature}}Controller.java
from: RestController.java
有关预定义模板引擎变量的更多信息,请参阅 Template Engine 部分。
Inject
inject
操作用于将文本注入文件。
需要定义 after:
键或 before:
键来指示要注入文本的位置。
以下清单显示了一个示例文件:
Hello there.
This is a test file.
We are going to insert before the line that has the word marker1
marker2
以下清单显示了一个 inject
操作,它在包含单词 marker2
的行后注入 INJECTED AFTER
:
actions:
- inject:
to: sample.txt
text: "INJECTED AFTER"
after: marker2
运行此操作后的文本文件为:
Hello there.
This is a test file.
We are going to insert before the line that has the word marker1
marker2
INJECTED AFTER
以下清单显示了一个 inject
操作,它在包含单词 marker1
的行前注入 INJECTED BEFORE
:
actions:
- inject:
to: sample.txt
text: "INJECTED BEFORE"
before: marker1
运行此操作后的文本文件为:
Hello there.
This is a test file.
INJECTED BEFORE
We are going to insert before the line that has the word marker1
marker2
Inject Maven Dependency
inject-maven-dependency
操作向您的 Maven pom.xml 文件中注入 Maven 依赖项条目。
您可以在 text:
域中使用 Handlebars 模板变量和表达式。
以下示例显示了注入 Maven 依赖项的基本语法:
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>
Inject Maven Dependency Management
inject-maven-dependency-management
操作向您的 Maven pom.xml 文件中注入 Maven 依赖项管理条目。
您可以在 text:
域中使用 Handlebars 模板变量和表达式。
以下清单显示了注入 Maven 依赖项的基本语法:
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 Build Plugin
inject-maven-build-plugin
操作向您的 Maven pom.xml 文件中注入 Maven 构建插件条目。
您可以在 text:
域中使用 Handlebars 模板变量和表达式。
以下示例显示了注入 Maven 依赖项的基本语法:
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>