Spring Boot 2.1.4.RELEASE 参考指南

需积分: 9 84 浏览量更新于2024-07-17 收藏 5.96MB PDF 举报

"Spring Boot Reference Guide.pdf" 《Spring Boot参考指南》是Spring官方发布的一份详尽的文档，旨在帮助开发者理解和使用Spring Boot框架。这份指南覆盖了从基础到高级的多个主题，由多位Spring社区的重要贡献者共同编写，包括Phillip Webb、Dave Syer、Josh Long等人。文档版本为2.1.4.RELEASE，适用于2012年至2018年的版权规定。该文档分为以下几个主要部分： 1. Spring Boot文档介绍：这部分简要介绍了文档的目的和内容，以及获取帮助的途径。 2. 开始使用：这里详细介绍了Spring Boot的基本概念，以及为什么选择Spring Boot作为开发平台。 3. 系统需求：明确了使用Spring Boot所需的系统环境，包括Servlet容器的相关信息。 4. 安装Spring Boot：提供了针对Java开发者的安装步骤，包括Maven和Gradle的安装指南，以及Spring Boot命令行界面（CLI）的安装方法。 5. 使用Spring Boot：这部分涵盖了如何开始一个Spring Boot项目，包括基本配置、自动配置、启动器和依赖管理等核心特性。 6. 学习Spring Boot特性：深入探讨了Spring Boot的各种特性，如健康检查、外部化配置、测试支持等。 7. 进入生产环境：指导如何将Spring Boot应用部署到生产环境，包括监控、日志和安全等方面。 8. 高级主题：这部分涵盖了更深入的技术细节，可能涉及自定义starter、构建自己的自动配置、插件开发等内容。 Spring Boot简化了Spring的应用程序开发，通过提供默认配置和自动配置功能，使得开发者可以快速构建可运行的Java应用。其核心特性包括内嵌式Servlet容器（如Tomcat或Jetty），无需额外的打包步骤即可直接运行； Starter POMs，方便添加常用功能模块；以及对各种第三方库的集成支持，如数据访问、安全、消息传递等。在系统要求方面，Spring Boot支持多种Servlet容器，例如Tomcat和Jetty，这些容器用于运行基于Spring Boot的应用。安装过程包括对构建工具（如Maven或Gradle）的设置，以便于管理和构建Spring Boot项目。此外，Spring Boot CLI（命令行界面）的安装允许开发者直接通过命令行编写和运行Spring Boot应用。《Spring Boot参考指南》是学习和掌握Spring Boot不可或缺的资源，它详细阐述了Spring Boot的各个方面，无论你是初学者还是经验丰富的开发者，都能从中受益。

4/14/2019 Spring Boot Reference Guide

https://docs.spring.io/spring-boot/docs/2.1.4.RELEASE/reference/htmlsingle/ 16/300

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>

4/14/2019 Spring Boot Reference Guide

https://docs.spring.io/spring-boot/docs/2.1.4.RELEASE/reference/htmlsingle/ 17/300

<version>0.0.1-SNAPSHOT</version>

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

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

<version>2.1.4.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.4.RELEASE-bin.zip

spring-boot-cli-2.1.4.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

4/14/2019 Spring Boot Reference Guide

https://docs.spring.io/spring-boot/docs/2.1.4.RELEASE/reference/htmlsingle/ 18/300

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.4.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.4.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

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

$ sdk default springboot dev

$ spring --version

Spring CLI v2.1.4.RELEASE

4/14/2019 Spring Boot Reference Guide

https://docs.spring.io/spring-boot/docs/2.1.4.RELEASE/reference/htmlsingle/ 19/300

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

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.

4/14/2019 Spring Boot Reference Guide

https://docs.spring.io/spring-boot/docs/2.1.4.RELEASE/reference/htmlsingle/ 20/300

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.4.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

剩余299页未读，继续阅读

隐分隔符对象

粉丝: 10

Spring Boot 2.1.4.RELEASE 参考指南

spring-boot-reference.pdf（原版本）

spring-boot-reference-guide-zh-中文， spring-boot参考指南

spring-boot-reference.pdf

Spring Boot Reference Guide.pdf 英文

Spring Boot Reference Guide 2.1.0.BUILD

Spring boot中文教程（Spring Boot Reference Guide 1.3.0.BUILD）

spring-boot-reference-guide.pdf

Spring-Boot-Reference-Guide, Spring Boot Reference Guide中文翻译 -《Spring Boot参考指南》.zip

Spring Boot Reference Guide中文翻译 -《Spring Boot参考指南》.zip

spring boot reference guide

最新资源