创建新项目

该命令使创建 Spring Boot 应用程序变得容易。spring boot newspring-doc.cn

此命令从现有功能齐全的 Spring Boot 应用程序的源代码存储库中复制内容以创建新项目。spring-doc.cn

要开始使用,请指定选项,该选项将创建具有测试的基本 RESTful Web 应用程序。 您还可以使用该选项创建具有不同功能的项目,例如 Spring Data JPA 或 Spring Cloud Stream。--name--fromspring-doc.cn

要进一步自定义,您可以灵活地指定各种选项(如 、 和 )以及 和 。 如果您提供 ,则会在克隆源代码存储库后重构代码。--group--artifact-id--version--package-name--description--package-namespring-doc.cn

以下部分提供了每个主题的详细说明。spring-doc.cn

有关向现有应用程序添加其他代码的更多信息,请参见 spring boot addUser Defined Commandsspring-doc.cn

快速开始

要在新目录中快速创建简单的 Web 应用程序,请运行以下命令:spring-doc.cn

spring boot new my-app
cd my-app
./mnvw spring-boot:run

这将在目录中创建一个基本的 Web 应用程序。 在此示例中,该选项是按位置传递的,相当于 。my-app--namespring boot new --name my-appspring-doc.cn

如果您希望在当前工作目录中创建项目,请指定名称:.spring-doc.cn

mkdir my-new-app
cd my-new-app
spring boot new .
./mvnw spring-boot:run

要创建具有不同功能的应用程序,请使用命令中的选项。因为 comes after you can use positional parameters.--fromspring boot new my-app--from--namespring-doc.cn

例如:spring-doc.cn

spring boot new my-app jpa
cd my-app
./mnvw spring-boot:run

前面的命令将创建一个包含 Spring Data JPA 功能的新应用程序。spring-doc.cn

在前面的示例中,新应用程序的名称 () 和选项 () 都作为位置参数提供。 它相当于使用 .my-app--fromjpaspring boot new --name my-app --from jpaspring-doc.cn

名称 ,将注册到默认的入门项目目录中,并用作具有一些其他元数据的特定 URL 的别名。 这将在下一节中详细介绍。jpaspring-doc.cn

按名称创建

项目目录包含演示特定 Spring 技术的代码存储库列表。 默认项目目录中的存储库类似于 Spring 入门指南中的内容,提供了一系列功能。spring-doc.cn

您可以选择注册自己的目录,从而提供具有不同复杂性和功能的代码存储库。spring-doc.cn

项目目录可帮助您找到新项目所需的功能。 使用命令将代码添加到现有项目时,您还可以引用项目目录中的项目名称。spring boot addspring-doc.cn

要查看默认 “入门” 目录中的已注册项目,请运行以下命令:spring-doc.cn

spring project-catalog list

此命令显示可与以下命令一起使用的可用项目目录:spring boot newspring-doc.cn

┌────┬──────────────────────────────────────────────┬───────────────────────┬───────────────────┐
│Name│URL                                           │Description            │Tags               │
├────┼──────────────────────────────────────────────┼───────────────────────┼───────────────────┤
│gs  │https://github.com/rd-1-2022/spring-gs-catalog│Getting Started Catalog│[java-11, boot-2.7]│
└────┴──────────────────────────────────────────────┴───────────────────────┴───────────────────┘
```

要查看可用项目,请使用以下命令:spring-doc.cn

spring project list

此命令提供您可以使用的项目列表。每个项目都有一个名称,您可以将其传递给 。 下表显示了典型的输出:spring boot newspring-doc.cn

┌─────────────┬────────────────────────────────────────────────────────┬─────────────────────┬───────┬───────────────┐
│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-doc.cn

spring boot new my-jpa jpa

此命令使用源代码存储库 URL: 中的应用程序。github.com/rd-1-2022/rpt-spring-data-jpaspring-doc.cn

还可以使用项目的名称作为命令的参数。spring boot add

通过 URL 创建

您可以直接使用项目源存储库的 URL,而不是将项目添加到 Spring CLI 中以使用短名称引用它。spring-doc.cn

例如,要创建 Spring JPA 项目,可以使用以下命令:spring-doc.cn

spring boot new my-jpa https://github.com/rd-1-2022/rpt-spring-data-jpa

选项

该命令采用以下选项,您可以通过运行以下命令来查看这些选项:spring boot newspring-doc.cn

spring boot new --help

该命令显示以下输出:spring-doc.cn

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]

选项和默认值

通过仅指定 option,则默认为 option 的值。 请考虑以下示例:--nameartifactId--namespring-doc.cn

spring boot new --name myapp
Cloning project from https://github.com/rd-1-2022/rest-service
Created project in directory 'myapp'

在生成的 中,名称 () 用作项目的 和 :pom.xmlmyappartifactIdnamespring-doc.cn

	<groupId>com.example</groupId>
	<artifactId>myapp</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>myapp</name>
	<description>RESTful web application</description>

添加该选项不仅会更改标记的值,还会更改程序包名称。 将项目重构为新的包名称。 请考虑以下示例:--groupidgroupIdspring-doc.cn

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

	<groupId>com.xkcd</groupId>
	<artifactId>myapp</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>myapp</name>
	<description>RESTful web application</description>

工程的目录结构如下:spring-doc.cn

$ 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