Spring Boot CLI是一个命令行工具,您可以使用它从start.spring.io引导新项目或对密码进行编码。
1. Installing the CLI
可以使用SDKMAN手动安装Spring Boot CLI(命令行界面)!(SDK管理器)或使用HomeBrew或MacPorts(如果您是OSX用户)。有关全面的安装说明,请参阅《入门》部分中的Get-started.html。
2. Using the CLI
一旦安装了CLI,就可以通过在命令行中键入Spring
并按Enter键来运行它。如果在不带任何参数的情况下运行Spring
,将显示一个帮助屏幕,如下所示:
$ spring
usage: spring [--help] [--version]
<command> [<args>]
Available commands are:
init [options] [location]
Initialize a new project using Spring Initializr (start.spring.io)
encodepassword [options] <password to encode>
Encode a password for use with Spring Security
shell
Start a nested shell
Common options:
--debug Verbose mode
Print additional status information for the command you are running
See 'spring help <command>' for more information on a specific command.
您可以键入Spring Help
以获取有关任何受支持命令的更多详细信息,如下例所示:
$ spring help init
spring init - Initialize a new project using Spring Initializr (start.spring.io)
usage: spring init [options] [location]
Option Description
------ -----------
-a, --artifact-id <String> Project coordinates; infer archive name (for
example 'test')
-b, --boot-version <String> Spring Boot version (for example '1.2.0.RELEASE')
--build <String> Build system to use (for example 'maven' or
'gradle') (default: maven)
-d, --dependencies <String> Comma-separated list of dependency identifiers to
include in the generated project
--description <String> Project description
-f, --force Force overwrite of existing files
--format <String> Format of the generated content (for example
'build' for a build file, 'project' for a
project archive) (default: project)
-g, --group-id <String> Project coordinates (for example 'org.test')
-j, --java-version <String> Language level (for example '1.8')
-l, --language <String> Programming language (for example 'java')
--list List the capabilities of the service. Use it to
discover the dependencies and the types that are
available
-n, --name <String> Project name; infer application name
-p, --packaging <String> Project packaging (for example 'jar')
--package-name <String> Package name
-t, --type <String> Project type. Not normally needed if you use --
build and/or --format. Check the capabilities of
the service (--list) for more details
--target <String> URL of the service to use (default: https://start.
spring.io)
-v, --version <String> Project version (for example '0.0.1-SNAPSHOT')
-x, --extract Extract the project archive. Inferred if a
location is specified without an extension
examples:
To list all the capabilities of the service:
$ spring init --list
To creates a default project:
$ spring init
To create a web my-app.zip:
$ spring init -d=web my-app.zip
To create a web/data-jpa gradle project unpacked:
$ spring init -d=web,jpa --build=gradle my-dir
Version
命令提供了一种快速检查您正在使用的Spring Boot版本的方法,如下所示:
$ spring version
Spring CLI v3.0.0
2.1. Initialize a New Project
init
命令允许您在不离开外壳的情况下使用start.spring.io创建一个新项目,如下例所示:
$ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'
前面的示例创建了一个my-project
目录,其中包含一个基于Maven的项目,该项目使用Spring-ot-starter-web
和Spring-ot-starter-data-jpa
。您可以使用--list
标志列出服务的能力,如下例所示:
$ spring init --list
=======================================
Capabilities of https://start.spring.io
=======================================
Available dependencies:
-----------------------
actuator - Actuator: Production ready features to help you monitor and manage your application
...
web - Web: Support for full-stack web development, including Tomcat and spring-webmvc
websocket - Websocket: Support for WebSocket development
ws - WS: Support for Spring Web Services
Available project types:
------------------------
gradle-build - Gradle Config [format:build, build:gradle]
gradle-project - Gradle Project [format:project, build:gradle]
maven-build - Maven POM [format:build, build:maven]
maven-project - Maven Project [format:project, build:maven] (default)
...
init
命令支持许多选项。有关详细信息,请参阅帮助
输出。例如,下面的命令创建了一个使用Java 17和war
打包的Gradle项目:
$ spring init --build=gradle --java-version=17 --dependencies=websocket --packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'
2.2. Using the Embedded Shell
Spring Boot包括用于Bash和zsh外壳的命令行完成脚本。如果您不使用这两个外壳(可能您是Windows用户),则可以使用shell
命令启动集成的外壳,如下例所示:
$ spring shell
Spring Boot (v3.0.0)
Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit.
在嵌入的外壳中,您可以直接运行其他命令:
$ version
Spring CLI v3.0.0
嵌入的外壳支持ANSI颜色输出以及制表符
完成。如果需要运行本机命令,可以使用!
前缀。要退出嵌入的外壳,请按ctrl-c
。