关键概念
项目
项目:托管在 GitHub 或 GitLab 中的“普通旧 Java 项目”。项目在 CLI 中注册,以便一个简单的名称可以引用它们。
例如,如果您注册名称为“jpa”的使用 Spring Data JPA 的项目的 GitHub URL,则可以通过调用命令从该项目创建一个新项目boot new my-jpa-app jpa
命令。 同样,您可以通过调用boot add jpa
命令。
与项目相关的命令是project list
,project add
和project remove
.
项目目录
项目目录:项目目录是共享共同主题的项目的集合。
向CLI注册目录后,使用时项目即可随时使用boot new
和boot add
命令。 目录是一个 YAML 文件,名称为project-catalog.yaml
. 它包含项目存储库 URL 的列表和关联的名称。该目录托管在 GitHub 或 GitLab 上
与项目目录相关的命令包括catalog list
,catalog add
和catalog remove
用户定义的命令
命令:这些是声明性定义的命令,可用于添加或修改代码和配置文件。
您还可以运行任意可执行文件来执行开发工作流中常见的任何任意任务。用户定义的命令集成到 CLI 中,并且与内置命令相同。
用户定义的命令由三个部分组成:command name
这sub-command name
和options
. 命令名称和子命令名称是使用目录结构约定定义的。
例如,要创建命令名称为controller
子命令名称new
,使目录结构如下:
.spring/commands/controller/new
在此目录中,您可以有一个名为command.yaml
定义命令的描述、选项和默认值。此目录(和子目录)包含作文件,这些作文件定义了要对项目执行的作。
角色
在 CLI 中,角色提供了一种跨用户定义的命令组织和重用变量的方法。
Spring CLI 包括一个始终存在的默认未命名角色。此外,角色可以与特定名称相关联,以进一步区分其用途和用法。这些角色作为 YAML 文件存储在.spring/roles
目录,它位于.spring/commands
目录。
这些角色允许您定义可在作文件中访问的变量,从而提供一种在命令之间共享数据的方法。
还可以使用角色为命令行选项提供值。如果命令行选项没有指定的值,并且已使用与命令选项相同的名称定义了角色变量,那么该命令将使用该特定命令选项的角色变量的值。
与项目相关的一些常见角色命令包括role add
,role remove
和role set