5 Star 2 Fork 3

故梦 / Spring Initializer 源码

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Spring Initializr Build Status initializr

Spring Initializr 工具提供了一个可扩展的 API,用于通过实现的几个常见概念来生成基于 JVM 的项目。

  • 生成的项目支持Java、Kotlin和Groovy语言。

  • 使用Apache Maven 和 Gradle的实现构建系统抽象。

  • 支持'. gitignore' 。

  • 具有一些自定义资源生成的挂钩点(hook-points)。

项目的各种选项以元数据模型表示,该模型允许您配置:一系列的依赖项、支持的 JVM 和平台版本等。

Spring Initializr 还公开 Web 站点来生成实际项目,此外以众所周知的格式提供元数据,从而允许第三方客户端提供必要的援助。

提供了一组用于SpringBoot项目的可选的约定,并用于我们的链接中的生产实例:https://start.spring.io. To better understand how our 为了更好地了解我们的服务是怎样被配置的,您可能需要特别地检查 [服务] [配套项目], the {service}/blob/master/start-site/src/main/resources/application.yml[配置我们的实例]. 此类配置也在文档中详细介绍。

注:虽然Spring Initializr现在在 Maven Central 上可以获取,但它仍然处于 1.0 之前 状态,在这期间,仍然可能会对本项目进行主要的重构。访问: milestones page 查看变化的概述

安装并且开始使用

参考文档可在 {docs}/html/[HTML format] 处查看.

各个模块

Spring Initializr 具有以下模块:

  • initializr-actuator: * "初始执行器":可选模块,用于在项目生成时提供额外的信息和统计信息。

  • initializr-bom:提供物料清单,以便您在项目中进行依赖性管理。

  • initializr-docs: 文档.

  • initializr-generator: 项目生成的核心类库.

  • initializr-generator-spring: 为特定项目定义典型、特别约定的可选模块 可以重复使用或使用您自己的约定来替换

  • initializr-generator-test: 项目生成测试基础设施

  • initializr-metadata: 项目各个方面的元数据基础结构

  • initializr-service-sample: 展示基本的自定义实例

  • initializr-version-resolver: 初始化版本解析器 可选模块,用于从任意 POM 中提取版本号

  • initializr-web: 第三方客户端的 Web 站点

支持的接口

Spring Initializr 能够按下列方式来使用:

  • 在命令行上使用, {boot-doc}/#cli-init[the Spring Boot CLI] or simply with cURL or HTTPie. *在编辑器中使用, 其中: STS, IntelliJ IDEA Ultimate, NetBeans (with this plugin) VSCode (with the vscode-spring-initializr plugin).

  • Web网页中使用来构建项目 (link:https://start.spring.io).

还有其他的命令行集成,您也可以以此来构建自己的应用!

生成一个工程

由于 Spring Initializr 不具有 Web UI,因此您可以使用任何开箱即用的内容集的成来生成项目。例如,以下"curl"命令下载 一个包含基于 Maven 的项目和启动所需的基础结构的项目,以此来启动Spring Boot应用程序。

$ curl https://start.spring.io/starter.zip -o demo.zip

当然,你可以自定义要生成的项目,并具有多种选项:

  • 你要生成项目的基本信息: groupId, artifactId, version, name, description and packageName

    • "name"属性还用于生成默认应用程序名称。逻辑是:应用程序的名称等于具有 "Application"后缀的"name"属性(除非已存在后缀)。当然,如果 指定名称包含 java 标识符的无效字符,"应用程序"可用作回退。

    • "artifactId"属性不仅定义了你要编译的工程的识别信息,也作为了工程本身的名称。

  • dependencies: 你所要添加到项目的依赖标识符。 这些个标识符通过configuration被定义,且被暴露在metadata

  • type: 你所想要生成项目的类型(e.g. maven-project) 同样,每个服务公开支持数十亿的类型,这些在metadata可以见到.

  • javaVersion: JVM语言版本 (e.g. 1.8).

  • bootVersion: SpringBoot的版本 (e.g. 2.1.0.RELEASE).

  • language: 编码时要使用的语言 (e.g. java).

  • packaging: 项目的包结构 (e.g. jar).

  • applicationName: application class 的名字 (默认情况下,通过`name`属性推断).

  • baseDir: 项目创建的基本的目录的名字. 默认情况下, 项目保存在根路径(root)

一下为一些具体的命令行代码示例:

Tip

You can "curl" an instance to get a usage page with examples (try curl https://start.spring.io)

This command generates an another-project directory holding a Gradle web-based Groovy project using the actuator:

$ curl https://start.spring.io/starter.tgz -d dependencies=web,actuator \
-d language=groovy -d type=gradle-project -d baseDir=another-project | tar -xzvf -
Note
The /starter.tgz endpoint offers the same feature as /starter.zip but generates a compressed tarball instead.

You could use this infrastructure to create your own client since the project is generated via a plain HTTP call.

Service metadata

The service metadata is used by all clients to know which values they should expose for the standard attributes of a project. For instance, a custom version can specify that the default groupId is com.example.acme. You can grab the metadata on the root endpoint with the appropriate Accept header:

$ curl -H 'Accept: application/json' https://start.spring.io
Note
As stated above, if you use curl without an accept header, you’ll retrieve a human readable text version of the metadata.

HTTPie is also supported:

$ http https://start.spring.io Accept:application/json

The metadata basically lists the capabilities of the service, that is the available options for all request parameters (dependencies, type, bootVersion, etc.) A client to the service uses that information to initialize the select options and the tree of available dependencies.

The metadata also lists the default values for simple text parameter (i.e. the default name for the project).

Note
More details about the structure of the metadata are {docs}/html/#metadata-format[available in the documentation].

Running your own instance

You can easily run your own instance. The initializr-web modules uses Spring Boot so when it is added to a project, it will trigger the necessary auto-configuration to deploy the service.

The initializr-service-sample showcases a basic custom instance with dedicated metadata.

If you want to run our instance at https://start.spring.io, refer to run the default instance locally.

Building from Source

You need Java 1.8 and a bash-like shell.

Building

Invoke the build at the root of the project:

$ ./mvnw clean install

To generate the docs as well, you should enable the full profile:

$ ./mvnw clean install -Pfull

License

Spring Initializr is Open Source software released under the Apache 2.0 license.

Apache License Version 2.0, January 2004 https://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/i_sxt/spring_initializer_source_code.git
git@gitee.com:i_sxt/spring_initializer_source_code.git
i_sxt
spring_initializer_source_code
Spring Initializer 源码
master

搜索帮助