创建新项目
spring boot new
命令可以轻松创建 Spring Boot 应用程序。
此命令会复制现有功能齐全的 Spring Boot 应用程序的源代码仓库内容,以创建新项目。
要开始使用,请指定 --name
选项,它会创建一个带有测试的基本 RESTful Web 应用程序。您也可以使用 --from
选项创建具有不同功能的项目,例如 Spring Data JPA 或 Spring Cloud Stream。
为了进一步定制,您可以灵活地指定各种选项(例如 --group
、--artifact-id
和 --version
),以及 --package-name
和 --description
。如果您提供了 --package-name
,则在克隆源代码仓库后会对代码进行重构。
以下各节详细解释了这些主题。
有关向现有应用程序添加额外代码的更多信息,请参阅 spring boot add 和 用户自定义命令。
快速入门
要在新目录中快速创建一个简单的 Web 应用程序,请运行以下命令
spring boot new my-app
cd my-app
./mnvw spring-boot:run
这会在 my-app
目录中创建一个基本的 Web 应用程序。在此示例中,--name
选项是以位置参数传递的,等同于 spring boot new --name my-app
。
如果您更喜欢在当前工作目录中创建项目,请将名称指定为 .
mkdir my-new-app
cd my-new-app
spring boot new .
./mvnw spring-boot:run
要创建具有不同功能的应用程序,请在 spring boot new my-app
命令中使用 --from
选项。由于 --from
在 --name
之后,您可以使用位置参数。
例如
spring boot new my-app jpa
cd my-app
./mnvw spring-boot:run
前面的命令创建了一个包含 Spring Data JPA 功能的新应用程序。
在前面的示例中,新应用程序的名称(my-app
)和 --from
选项(jpa
)都作为位置参数提供。它等同于使用 spring boot new --name my-app --from jpa
。
名称 jpa
已注册到默认的入门项目目录中,并作为带有额外元数据的特定 URL 的别名。以下部分将对此进行更详细的描述。
按名称创建
项目目录包含一系列展示特定 Spring 技术的代码仓库。默认项目目录中的仓库类似于 Spring 入门指南中的内容,提供了一系列功能。
您可以选择注册自己的目录,提供不同复杂度和功能的代码仓库。
项目目录可帮助您找到新项目所需的功能。通过使用 spring boot add
命令向现有项目添加代码时,您也可以参考项目目录中的项目名称。
要查看默认“入门”目录中已注册的项目,请运行以下命令
spring project-catalog list
此命令显示了可与 spring boot new
命令一起使用的可用项目目录
┌────┬──────────────────────────────────────────────┬───────────────────────┬───────────────────┐
│Name│URL │Description │Tags │
├────┼──────────────────────────────────────────────┼───────────────────────┼───────────────────┤
│gs │https://github.com/rd-1-2022/spring-gs-catalog│Getting Started Catalog│[java-11, boot-2.7]│
└────┴──────────────────────────────────────────────┴───────────────────────┴───────────────────┘
```
要查看可用项目,请使用以下命令
spring project list
此命令提供了一个可供使用的项目列表。每个项目都有一个名称,您可以将其传递给 spring boot new
。下表显示了典型的输出
┌─────────────┬────────────────────────────────────────────────────────┬─────────────────────┬───────┬───────────────┐
│Name │URL │Description │Catalog│Tags │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│web │https://github.com/rd-1-2022/rest-service │Hello, World RESTful │gs │[rest, web] │
│ │ │web service. │ │ │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│jpa │https://github.com/rd-1-2022/rpt-spring-data-jpa │Learn how to work │gs │[jpa, h2] │
│ │ │with JPA data │ │ │
│ │ │persistence using │ │ │
│ │ │Spring Data JPA. │ │ │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│scheduling │https://github.com/rd-1-2022/rpt-spring-scheduling-tasks│How to schedule tasks│gs │[scheduling] │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│config-client│https://github.com/rd-1-2022/rpt-config-client │Using the Config │gs │[config] │
│ │ │Client library │ │ │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│eureka │https://github.com/rd-1-2022/eureka │Spring Cloud Eureka │gs │[cloud, eureka]│
│ │ │Server │ │ │
├─────────────┼────────────────────────────────────────────────────────┼─────────────────────┼───────┼───────────────┤
│graphql │https://github.com/rd-1-2022/rpt-spring-graphql │Spring GraphQL │gs │[graphql] │
└─────────────┴────────────────────────────────────────────────────────┴─────────────────────┴───────┴───────────────┘
要创建使用 Spring Data JPA 的新项目,请运行以下命令
spring boot new my-jpa jpa
此命令使用源自以下源代码仓库 URL 的应用程序:github.com/rd-1-2022/rpt-spring-data-jpa
。
您也可以将项目名称用作 spring boot add 命令的参数。 |
按 URL 创建
除了将项目添加到 Spring CLI 以便使用短名称引用它之外,您还可以直接使用项目源代码仓库的 URL。
例如,要创建 Spring JPA 项目,可以使用以下命令
spring boot new my-jpa https://github.com/rd-1-2022/rpt-spring-data-jpa
选项
spring boot new
命令接受以下选项,您可以运行以下命令来查看它们
spring boot new --help
该命令显示以下输出
NAME
boot new - Create a new Spring Boot project from an existing project
SYNOPSIS
boot new --from String --name String --group-id String --artifact-id String --version String --description String --package-name String --path String --help
OPTIONS
--name String
Name of the new project
[Mandatory]
--from String
Create project from existing project name or URL
[Optional]
--group-id String
Group ID of the new project
[Optional]
--artifact-id String
Artifact ID of the new project
[Optional]
--version String
Version of the new project
[Optional]
--description String
Description of the new project
[Optional]
--package-name String
Package name for the new project
[Optional]
--path String
Path to run the command in, most of the time this is not necessary to specify and the default value is the current working directory.
[Optional]
--help or -h
help for boot new
[Optional]
选项和默认值
仅指定 --name
选项时,artifactId
将默认为 --name
选项的值。考虑以下示例
spring boot new --name myapp
Cloning project from https://github.com/rd-1-2022/rest-service
Created project in directory 'myapp'
在生成的 pom.xml
中,名称(myapp
)被用作 artifactId
和项目的 name
<groupId>com.example</groupId>
<artifactId>myapp</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>myapp</name>
<description>RESTful web application</description>
添加 --groupid
选项不仅会改变 groupId
标签的值,还会改变包名。项目会重构为新的包名。考虑以下示例
$ spring boot new --name myapp --group-id com.xkcd
Cloning project from https://github.com/rd-1-2022/rest-service
Refactoring package to com.xkcd.myapp
Created project in directory 'myapp'
生成的 pom.xml
包含以下内容
<groupId>com.xkcd</groupId>
<artifactId>myapp</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>myapp</name>
<description>RESTful web application</description>
项目的目录结构如下
$ tree myapp/
myapp/
├── LICENSE
├── mvnw
├── mvnw.cmd
├── pom.xml
├── README.adoc
└── src
├── main
│ └── java
│ └── com
│ └── xkcd
│ └── myapp
│ ├── Application.java
│ └── greeting
│ ├── GreetingController.java
│ └── Greeting.java
└── test
└── java
└── com
└── xkcd
└── myapp
└── greeting
└── GreetingControllerTests.java