Spring Boot 2.1.6官方文档PDF版：快速入门与生产部署指南

需积分: 15 153 浏览量更新于2024-07-17 收藏 5.99MB PDF 举报

Spring-Boot-Reference-Guide-v2.1.6.RELEASE 是Spring Boot官方英文文档的一个PDF版本，针对2.1.6.RELEASE这一特定版本提供。该文档由多位知名开发者共同编写，包括Phillip Webb、Dave Syer、Josh Long等人，他们在Spring Boot项目中扮演了关键角色。Spring Boot是一个开源框架，旨在简化新项目的初始搭建和配置过程，使得开发人员能够快速启动并运行一个基于Spring的应用程序。文档的版权信息明确指出，用户可以为自己或与他人分享文档副本，但需确保不收取任何费用，并在复制的文档中包含原始版权声明，无论纸质还是电子形式分发。本书分为两大部分： I. Spring Boot Documentation 这部分主要介绍了文档的目的、获取帮助的方式以及如何一步步地使用Spring Boot。章节内容包括： 1. 关于文档：阐述了文档的目的，以及它如何帮助开发人员更好地理解和使用Spring Boot。 2. 获取帮助：指导读者在遇到问题时如何寻求官方支持和社区资源。 3. 第一阶段步骤：为初学者提供了从零开始使用Spring Boot的基础教程。 4. 与Spring Boot协作：深入讲解如何利用框架的各种特性来构建应用。 5. 向生产环境迁移：涉及部署策略、性能优化等高级主题。 6. 进阶话题：探讨更复杂的技术细节和最佳实践。 II. Getting Started 这部分详尽讲述了如何入门Spring Boot： 8. 引入Spring Boot：简要介绍Spring Boot的核心理念和优势。 9. 系统需求：明确了使用Spring Boot所需的最低硬件和软件要求，包括对Servlet容器的支持。 10. 安装Spring Boot： - 对Java开发者提供了详细的安装指南，包括： a. Maven安装：步骤清晰地指导用户配置Maven来管理Spring Boot项目。 b. Gradle安装：同样提供如何在项目中集成Gradle的指导。 - 使用Spring Boot CLI（命令行工具）： i. 手动安装：详细描述了手动下载和配置的过程。 ii. SDKMAN!安装：推荐的一种自动化工具安装方法。 iii. Homebrew/MacPorts安装：针对Mac用户，介绍如何通过包管理器安装。 - 除此之外，还有其他安装选项的说明。 Spring-Boot-Reference-Guide-v2.1.6.RELEASE 是一本非常实用的资源，不仅适合初学者快速上手Spring Boot，也适合经验丰富的开发人员查阅和更新他们的知识库。无论是对于学习还是项目开发，这份文档都是不可或缺的参考资料。

Build Tool VersionBuild Tool Version

Maven 3.3+

Gradle 4.4+

9.1 Servlet Containers

Spring Boot supports the following embedded servlet containers:

Name Servlet Version

Tomcat 9.0 4.0

Jetty 9.4 3.1

Undertow 2.0 4.0

You can also deploy Spring Boot applications to any Servlet 3.1+ compatible container.

10. Installing Spring Boot

Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Either way, you need Java SDK v1.8 or

higher. Before you begin, you should check your current Java installation by using the following command:

$ java -version

If you are new to Java development or if you want to experiment with Spring Boot, you might want to try the Spring Boot CLI (Command Line

Interface) first. Otherwise, read on for “classic” installation instructions.

10.1 Installation Instructions for the Java Developer

You can use Spring Boot in the same way as any standard Java library. To do so, include the appropriate spring-boot-*.jar files on your

classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor. Also, there is nothing special about

a Spring Boot application, so you can run and debug a Spring Boot application as you would any other Java program.

Although you could copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such as

Maven or Gradle).

10.1.1 Maven Installation

Spring Boot is compatible with Apache Maven 3.3 or above. If you do not already have Maven installed, you can follow the instructions at

maven.apache.org.

On many operating systems, Maven can be installed with a package manager. If you use OSX Homebrew, try

brew install maven . Ubuntu users can run sudo apt-get install maven . Windows users with Chocolatey can run

choco install maven from an elevated (administrator) prompt.

Spring Boot dependencies use the org.springframework.boot groupId . Typically, your Maven POM file inherits from the

spring-boot-starter-parent project and declares dependencies to one or more “Starters”. Spring Boot also provides an optional Maven

plugin to create executable jars.

The following listing shows a typical pom.xml file:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

<groupId>com.example</groupId>

<artifactId>myproject</artifactId>

<version>0.0.1-SNAPSHOT</version>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>2.1.6.RELEASE</version>

</parent>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

</dependencies>

<build>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId>

</plugin>

</plugins>

</build>

</project>

The spring-boot-starter-parent is a great way to use Spring Boot, but it might not be suitable all of the time. Sometimes

you may need to inherit from a different parent POM, or you might not like our default settings. In those cases, see

Section 13.2.2, “Using Spring Boot without the Parent POM” for an alternative solution that uses an import scope.

10.1.2 Gradle Installation

Spring Boot is compatible with Gradle 4.4 and later. If you do not already have Gradle installed, you can follow the instructions at gradle.org.

Spring Boot dependencies can be declared by using the org.springframework.boot group . Typically, your project declares dependencies

to one or more “Starters”. Spring Boot provides a useful Gradle plugin that can be used to simplify dependency declarations and to create

executable jars.

Gradle Wrapper

The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a project. It is a small script and library that you

commit alongside your code to bootstrap the build process. See docs.gradle.org/4.2.1/userguide/gradle_wrapper.html for details.

More details on getting started with Spring Boot and Gradle can be found in the Getting Started section of the Gradle plugin’s reference guide.

10.2 Installing the Spring Boot CLI

The Spring Boot CLI (Command Line Interface) is a command line tool that you can use to quickly prototype with Spring. It lets you run Groovy

scripts, which means that you have a familiar Java-like syntax without so much boilerplate code.

You do not need to use the CLI to work with Spring Boot, but it is definitely the quickest way to get a Spring application off the ground.

10.2.1 Manual Installation

You can download the Spring CLI distribution from the Spring software repository:

spring-boot-cli-2.1.6.RELEASE-bin.zip

spring-boot-cli-2.1.6.RELEASE-bin.tar.gz

Cutting edge snapshot distributions are also available.

Once downloaded, follow the INSTALL.txt instructions from the unpacked archive. In summary, there is a spring script ( spring.bat for

Windows) in a bin/ directory in the .zip file. Alternatively, you can use java -jar with the .jar file (the script helps you to be sure that

the classpath is set correctly).

10.2.2 Installation with SDKMAN!

SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of various binary SDKs, including Groovy and

the Spring Boot CLI. Get SDKMAN! from sdkman.io and install Spring Boot by using the following commands:

$ sdk install springboot

$ spring --version

Spring Boot v2.1.6.RELEASE

If you develop features for the CLI and want easy access to the version you built, use the following commands:

The preceding instructions install a local instance of spring called the dev instance. It points at your target build location, so every time you

rebuild Spring Boot, spring is up-to-date.

You can see it by running the following command:

$ sdk ls springboot

================================================================================

Available Springboot Versions

================================================================================

> + dev

* 2.1.6.RELEASE

================================================================================

+ - local version

* - installed

> - currently in use

================================================================================

10.2.3 OSX Homebrew Installation

If you are on a Mac and use Homebrew, you can install the Spring Boot CLI by using the following commands:

$ brew tap pivotal/tap

$ brew install springboot

Homebrew installs spring to /usr/local/bin .

If you do not see the formula, your installation of brew might be out-of-date. In that case, run brew update and try again.

10.2.4 MacPorts Installation

If you are on a Mac and use MacPorts, you can install the Spring Boot CLI by using the following command:

$ sudo port install spring-boot-cli

10.2.5 Command-line Completion

The Spring Boot CLI includes scripts that provide command completion for the BASH and zsh shells. You can source the script (also named

spring ) in any shell or put it in your personal or system-wide bash completion initialization. On a Debian system, the system-wide scripts are

in /shell-completion/bash and all scripts in that directory are executed when a new shell starts. For example, to run the script manually if

you have installed by using SDKMAN!, use the following commands:

$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring

$ spring <HIT TAB HERE>

grab help jar run test version

If you install the Spring Boot CLI by using Homebrew or MacPorts, the command-line completion scripts are automatically

$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.1.6.RELEASE-bin/spring-2.1.6.RE

$ sdk default springboot dev

$ spring --version

Spring CLI v2.1.6.RELEASE

registered with your shell.

10.2.6 Windows Scoop Installation

If you are on a Windows and use Scoop, you can install the Spring Boot CLI by using the following commands:

> scoop bucket add extras

> scoop install springboot

Scoop installs spring to ~/scoop/apps/springboot/current/bin .

If you do not see the app manifest, your installation of scoop might be out-of-date. In that case, run scoop update and try again.

10.2.7 Quick-start Spring CLI Example

You can use the following web application to test your installation. To start, create a file called app.groovy , as follows:

@RestController

class ThisWillActuallyRun {

@RequestMapping("/")

String home() {

"Hello World!"

}

Then run it from a shell, as follows:

$ spring run app.groovy

The first run of your application is slow, as dependencies are downloaded. Subsequent runs are much quicker.

Open localhost:8080 in your favorite web browser. You should see the following output:

Hello World!

10.3 Upgrading from an Earlier Version of Spring Boot

If you are upgrading from an earlier release of Spring Boot, check the “migration guide” on the project wiki that provides detailed upgrade

instructions. Check also the “release notes” for a list of “new and noteworthy” features for each release.

When upgrading to a new feature release, some properties may have been renamed or removed. Spring Boot provides a way to analyze your

application’s environment and print diagnostics at startup, but also temporarily migrate properties at runtime for you. To enable that feature, add

the following dependency to your project:

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-properties-migrator</artifactId>

<scope>runtime</scope>

</dependency>

Properties that are added late to the environment, such as when using @PropertySource , will not be taken into account.

Once you’re done with the migration, please make sure to remove this module from your project’s dependencies.

To upgrade an existing CLI installation, use the appropriate package manager command (for example, brew upgrade ) or, if you manually

installed the CLI, follow the standard instructions, remembering to update your PATH environment variable to remove any older references.

11. Developing Your First Spring Boot Application

This section describes how to develop a simple “Hello World!” web application that highlights some of Spring Boot’s key features. We use

Maven to build this project, since most IDEs support it.

The spring.io web site contains many “Getting Started” guides that use Spring Boot. If you need to solve a specific problem,

check there first.

You can shortcut the steps below by going to start.spring.io and choosing the "Web" starter from the dependencies searcher.

Doing so generates a new project structure so that you can start coding right away. Check the Spring Initializr documentation for

more details.

Before we begin, open a terminal and run the following commands to ensure that you have valid versions of Java and Maven installed:

$ java -version

java version "1.8.0_102"

Java(TM) SE Runtime Environment (build 1.8.0_102-b14)

Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)

$ mvn -v

Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)

Maven home: /usr/local/Cellar/maven/3.3.9/libexec

Java version: 1.8.0_102, vendor: Oracle Corporation

This sample needs to be created in its own folder. Subsequent instructions assume that you have created a suitable folder and

that it is your current directory.

11.1 Creating the POM

We need to start by creating a Maven pom.xml file. The pom.xml is the recipe that is used to build your project. Open your favorite text editor

and add the following:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">

<groupId>com.example</groupId>

<artifactId>myproject</artifactId>

<version>0.0.1-SNAPSHOT</version>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>2.1.6.RELEASE</version>

</parent>

</project>

The preceding listing should give you a working build. You can test it by running mvn package (for now, you can ignore the “jar will be empty -

no content was marked for inclusion!” warning).

At this point, you could import the project into an IDE (most modern Java IDEs include built-in support for Maven). For simplicity,

we continue to use a plain text editor for this example.

11.2 Adding Classpath Dependencies

Spring Boot provides a number of “Starters” that let you add jars to your classpath. Our sample application has already used

spring-boot-starter-parent in the parent section of the POM. The spring-boot-starter-parent is a special starter that provides

useful Maven defaults. It also provides a dependency-management section so that you can omit version tags for “blessed” dependencies.

剩余295页未读，继续阅读

哥的世界你不懂

粉丝: 17
资源: 12

Spring Boot 2.1.6官方文档PDF版：快速入门与生产部署指南

SpringBoot 2.x 中Spring-Session实现分布式Session共享详解

下载 peek-plugin-docdb-2.1.6.tar.gz Python库 - 支持Zookeeper分布式

Spring Boot实战：依赖管理和Maven使用详解

spring-boot-2.1.6.RELEASE.zip

spring-boot-2.1.6.RELEASE.jar

spring-boot-starter-2.1.6.RELEASE.jar

spring-boot-actuator-2.1.6.RELEASE.jar

spring-boot-devtools-2.1.6.RELEASE.jar

spring-boot-maven-plugin-2.1.6.RELEASE.jar

spring-boot-actuator-autoconfigure-2.1.6.RELEASE.jar

最新资源