专栏名称: OSC开源社区

OSChina 开源中国官方微信账号

Spring Boot 中文文档（一）（官方文档翻译基于1.5.2.RELEASE）

OSC开源社区 · 公众号 · 程序员 · 2017-04-06 08:37

正文

#点击图片报名参加武汉、长沙源创会#

Spring Boot 官方文档中文翻译（更新至 11.5 创建可执行的jar）

Part I. Spring Boot 文档

本节简要介绍了Spring Boot文档，是整个文档的参考指南。您可以完整阅读本参考指南，或者如果您不感兴趣的话可以跳过该部分。

1. 关于文档

Spring Boot参考指南可以以 html，pdf 和 epub 文档的形式获取。最新版本的文档可在 http://docs.spring.io/spring-boot/docs/current/reference 中找到。

2. 获得帮助

如果使用 Spring Boot 时遇到问题，可以在下面获取帮助

● 尝试 How-to’s - 这里为最常见的问题提供解决方案。

● 了解 Spring 的基础知识 - Spring Boot建立在许多其他Spring项目上，请查看 spring.io 网站以获取其他项目的参考文档。如果您刚刚开始使用Spring，请阅读原文查看指南。

● 在stackoverflow上提问题 - 我们会一起关注 stackoverflow.com 上有spring-boot标签的问题。

● 在Github上报告bug。

Spring Boot 所有的东西都是开源的，包括文档！如果您发现文档有问题; 或者如果你想改进他们，欢迎参与。

3. 第一步

如果你刚刚开始使用 Spring Boot，或刚刚开始使用“Spring”，请从这里（阅读原文）开始！

● 从头开始：概述 | 要求 | 安装

● 教程： Part 1 | Part 2

● 运行你的例子： Part 1 | Part 2

4. 使用 Spring Boot

● 构建系统: Maven | Gradle | Ant | Starters

● 最佳做法：代码结构 | @Configuration | @EnableAutoConfiguration | Beans 和依赖注入

● 运行代码： IDE | Packaged | Maven | Gradle

● 打包应用程序： Production jars

● Spring Boot CLI：使用CLI

5. 了解 Spring Boot 功能

需要有关Spring Boots核心功能的更多细节？请看阅读原文

● 核心功能: SpringApplication | External Configuration | Profiles | Logging

● Web 应用: MVC | Embedded Containers

● 数据处理: SQL | NO-SQL

● 消息处理: Overview | JMS

● 测试: Overview | Boot Applications | Utils

● 扩展: Auto-configuration | @Conditions

6. 转移到生产环境

当您准备好将Spring Boot 应用程序放到生产环境时，我们有一些您可能会喜欢的技巧！（阅读原文）

● 部署 Spring Boot 应用程序: Cloud Deployment | OS Service

● 构建工具插件： Maven | Gradle

● 附录: Application Properties | 自动配置类 | 可执行 Jars

Part II. 入门

如果你刚刚开始使用Spring Boot，这是你的一部分内容！在这里我们将会回答一些基本的what?”, “how?” 和 “why?”的问题。在这里你会找到一个详细的介绍Spring Boot和安装说明。然后，我们将构建我们的第一个Spring Boot应用程序，并讨论一些核心原则。

8. Spring Boot 介绍

Spring Boot可以基于Spring轻松创建可以“运行”的、独立的、生产级的应用程序。对Spring平台和第三方类库我们有一个自己看法，所以你最开始的时候不要感到奇怪。大多数Spring Boot应用程序需要很少的Spring配置。

您可以使用Spring Boot创建可以使用java -jar或传统 war 包部署启动的Java应用程序。我们还提供一个运行“spring脚本”的命令行工具。

我们的主要目标是：

● 所有的Spring开发者提供一个更快，更广泛接受的入门体验。

● Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults.

● 提供大量项目中常见的一系列非功能特征（例如嵌入式服务器，安全性，指标，运行状况检查，外部化配置）。

● 绝对没有代码生成，也不需要XML配置。

9. 系统要求

默认情况下，Spring Boot 1.5.2.RELEASE需要Java 7和Spring Framework 4.3.7.RELEASE或更高版本。您可以进行一些其他配置在Java 6上使用Spring Boot。有关详细信息，请参见第84.11节“如何使用Java 6” 。为Maven（3.2+）和Gradle 2（2.9或更高版本）和3提供了显式构建支持。

虽然您可以在Java 6或7上使用 Spring Boot，但我们通常推荐Java 8。

9.1 Servlet容器

以下嵌入式servlet容器可以直接使用：

您还可以将Spring Boot应用程序部署到任何兼容Servlet 3.0+ 的容器中。

10. 安装 Spring Boot

Spring Boot可以与“经典(classic)”Java开发工具一起使用或作为命令行工具安装。无论如何，您将需要Java SDK v1.6或更高版本。在开始之前检查当前的Java安装：

$ java -version

如果您是Java开发的新手，或者您只想尝试一下 Spring Boot，您可能需要首先尝试使用 Spring Boot CLI，如果想正式使用Spring Boot，请阅读“经典(classic)”安装说明。

虽然Spring Boot 与Java 1.6兼容，但我们建议使用最新版本的Java。

10.1 Java开发程序员安装说明

Spring Boot的使用方式与标准Java库的使用相同，只需在类路径中包含适当的spring-boot-*.jar文件。Spring Boot不需要任何特殊的集成工具，所以可以使用任何IDE或文本编辑器进行开发；并且Spring Boot 应用程序没有什么特殊的地方，因此您可以像其他Java程序一样运行和调试。虽然您可以直接复制Spring Boot 的jar包，但我们通常建议您使用依赖关系管理的构建工具（如Maven或Gradle）。

► 10.1.1 Maven安装

Spring Boot 兼容 Apache Maven 3.2。如果您还没有安装Maven，可以按照 https://maven.apache.org/ 上的说明进行安装。

在许多操作系统上，Maven可以通过软件包管理器进行安装。如果您是OSX Homebrew用户，请尝试使用命令：brew install maven。 Ubuntu用户可以运行命令：sudo apt-get install maven。

Spring Boot 依赖 org.springframework.boot groupId。通常，您的Maven POM文件将从 spring-boot-starter-parent 项目继承，并声明一个或多个“启动器(启动器)”的依赖关系。Spring Boot还提供了一个可选的Maven插件来创建可执行的jar包。

典型的pom.xml文件：

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

4.0.0

com.example

myproject

0.0.1-SNAPSHOT

org.springframework.boot

spring-boot-starter-parent

1.5.2.RELEASE

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-maven-plugin

spring-boot-starter-parent是使用Spring Boot的一个很好的方式，但它并不是所有的时候都适合。有时您可能需要从不同的父POM继承，或者您可能不喜欢我们的默认设置。请参见第13.2.2节“使用不带父POM的Spring Boot”作为使用导入作用域(import scope)的替代解决方案。

► 10.1.2 Gradle 安装

Spring Boot 兼容 Gradle 2（2.9或更高版本）和Gradle 3。如果您尚未安装Gradle，您可以按照 http://www.gradle.org/ 上的说明进行操作。

可以使用org.springframework.boot 组(group)声明Spring Boot 的依赖项。通常，您的项目将声明一个或多个“启动器(Starters)”的依赖。Spring Boot提供了一个有用的Gradle插件，可用于简化依赖关系声明和创建可执行 jar包。

Gradle Wrapper

当您需要构建项目时，Gradle Wrapper提供了一种“获取(obtaining)”Gradle的更好的方式。它是一个小脚本和库，它与代码一起引导构建过程。有关详细信息，请参阅 https://docs.gradle.org/2.14.1/userguide/gradle_wrapper.html 。

典型的 build.gradle 文件：

plugins {

id 'org.springframework.boot' version '1.5.2.RELEASE'

id 'java'

}

jar {

baseName = 'myproject'

version = '0.0.1-SNAPSHOT'

}

repositories {

jcenter()

}

dependencies {

compile("org.springframework.boot:spring-boot-starter-web")

testCompile("org.springframework.boot:spring-boot-starter-test")

}

10.2 安装Spring Boot CLI

Spring Boot CLI是一个命令行工具，如果要使用Spring快速原型(quickly prototype)，可以使用它。它允许您运行Groovy脚本，这意味着会有您熟悉的类似Java的语法，没有太多的样板代码(boilerplate code)。

您也不必要通过CLI来使用Spring Boot，但它绝对是开始Spring应用程序最快方法。

► 10.2.1 手动安装

您可以从Spring软件版本库下载Spring CLI发行版：

● spring-boot-cli-1.5.2.RELEASE-bin.zip

http://repo.spring.io/release/org/springframework/boot/spring-boot-cli/1.5.2.RELEASE/spring-boot-cli-1.5.2.RELEASE-bin.zip

● spring-boot-cli-1.5.2.RELEASE-bin.tar.gz

http://repo.spring.io/release/org/springframework/boot/spring-boot-cli/1.5.2.RELEASE/spring-boot-cli-1.5.2.RELEASE-bin.tar.gz

下载完成后，请按照解压缩后文件中的INSTALL.txt的说明进行操作。总而言之：在.zip文件的bin/目录中有一个spring脚本（Windows的spring.bat），或者你可以使用java -jar（脚本可以帮助您确保类路径设置正确）。

► 10.2.2 使用SDKMAN!安装

SDKMAN!（软件开发套件管理器）可用于管理各种二进制SDK的多个版本，包括Groovy和Spring Boot CLI。从 http://sdkman.io/ 获取SDKMAN！并安装Spring Boot。

$ sdk install springboot

$ spring --version

Spring Boot v1.5.2.RELEASE

如果您正在开发CLI的功能，并希望轻松访问刚创建的版本，请遵循以下额外说明。

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

$ sdk default springboot dev

$ spring --version

Spring CLI v1.5.2.RELEASE

这将安装一个称为dev的spring的本地实例(instance)。它指向您构建位置的target，所以每次重建(rebuild)Spring Boot时，Spring 将是最新的。

你可以看到：

$ sdk ls springboot

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

Available Springboot Versions

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

> + dev

* 1.5.2.RELEASE

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

+ - local version

* - installed

> - currently in use

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

► 10.2.3 OSX Homebrew 安装

如果您在Mac上使用 Homebrew，安装Spring Boot CLI 只需要下面命令：

$ brew tap pivotal/tap

$ brew install springboot

Homebrew会将Spring 安装到 /usr/local/bin。

如果您没有看到公式(formula)，您的安装可能会过期。只需执行brew更新，然后重试。

► 10.2.4 MacPorts安装

如果您在Mac上使用 MacPorts，安装Spring Boot CLI 只需要下面命令：

$ sudo port install spring-boot-cli

► 10.2.5 命令行补全

Spring Boot CLI为BASH和zsh shell提供命令补全的功能。您可以在任何shell中引用脚本（也称为spring），或将其放在您的个人或系统范围的bash完成初始化中。在Debian系统上，系统范围的脚本位于 /shell-completion/bash 中，当新的shell启动时，该目录中的所有脚本将被执行。手动运行脚本，例如如果您使用SDKMAN安装了！

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

$ spring

grab help jar run test version

如果使用Homebrew或MacPorts安装Spring Boot CLI，则命令行补全脚本将自动注册到您的shell。

► 10.2.6 快速启动Spring CLI示例

这是一个非常简单的Web应用程序，可用于测试您的安装是否正确。创建一个名为app.groovy的文件：

@RestController

class ThisWillActuallyRun {

@RequestMapping("/")

String home() {

"Hello World!"

}

然后从shell运行它：

$ spring run app.groovy

因为下载依赖的库，首次运行应用程序需要一些时间，。后续运行将会更快。

在浏览器中打开 http://localhost:8080 ，您应该会看到以下输出：

Hello World!

10.3 从早期版本的Spring Boot升级

如果您从早期版本的 Spring Boot 升级，请检查项目wiki上托管的“发行说明”。您将找到升级说明以及每个版本的“新的和值得注意的”功能的列表。

要升级现有的CLI安装，请使用包管理工具相应的package manager命令（例如brew upgrade），如果您手动安装了CLI，请按照标准说明记住更新PATH环境变量以删除任何旧的引用。

11. 开发您的第一个Spring Boot应用程序

让我们在Java中开发一个简单的“Hello World！”Web应用程序，突显Spring Boot一些主要的功能。我们将使用Maven构建该项目，因为大多数IDE支持它。

https://spring.io/ 包含许多使用Spring Boot的“入门指南”。如果您正在寻求解决一些具体问题; 可以先看一下那里。

您可以在 https://start.spring.io/ 的依赖关系搜索器中选择Web启动器来快速完成以下步骤。这会自动生成一个新的项目结构，方便您立即开始编码。查看文档了解更多详细信息。

在开始之前，打开终端来检查您是否安装了有效的Java和Maven版本。

$ java -version

java version "1.7.0_51"

Java(TM) SE Runtime Environment (build 1.7.0_51-b13)

Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)

$ mvn -v

Apache Maven 3.2.3 (33f8c3e1027c3ddde99d3cdebad2656a31e8fdf4; 2014-08-11T13:58:10-07:00)

Maven home: /Users/user/tools/apache-maven-3.1.1

Java version: 1.7.0_51, vendor: Oracle Corporation

这个示例需要在其自己的文件夹中创建。后面我们假设您在当前目录已经创建了一个正确的文件夹。

11.1 创建POM

我们需要先创建一个Maven pom.xml文件。 pom.xml是用于构建项目的配置文件。打开编辑器并添加以下内容：

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

4.0.0

com.example

myproject

0.0.1-SNAPSHOT

org.springframework.boot

spring-boot-starter-parent

1.5.2.RELEASE

这应该给你一个工作构建(working build)，你可以通过运行 mvn package 进行测试（你可以暂时忽略警告：“jar will be empty - no content was marked for inclusion!”）。

现在，您可以将项目导入到IDE中（最新的Java IDE内置对Maven的支持）。为了简单起见，这个示例我们继续使用纯文本编辑器。

11.2 添加类路径依赖关系

Spring Boot提供了一些“启动器(Starters)”，可以方便地将jar添加到类路径中。我们的示例应用程序已经在POM的父部分使用了spring-boot-starter-parent。spring-boot-starter-parent是一个特殊启动器，提供一些Maven的默认值。它还提供依赖管理 dependency-management 标签，以便您可以省略子模块依赖关系的版本标签。

其他“启动器(Starters)”只是提供您在开发特定类型的应用程序时可能需要的依赖关系。由于我们正在开发Web应用程序，所以我们将添加一个spring-boot-starter-web依赖关系，但在此之前，我们来看看我们目前的依赖。

$ mvn dependency:tree

[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT

mvn dependency:tree：打印项目依赖关系的树形表示。您可以看到spring-boot-starter-parent本身不在依赖关系中。编辑pom.xml并在 parent 下添加spring-boot-starter-web依赖关系：

org.springframework.boot

spring-boot-starter-web

如果您再次运行 mvn dependency:tree ，您将看到现在有许多附加依赖关系，包括Tomcat Web服务器和Spring Boot本身。

11.3 编写代码

要完成我们的应用程序，我们需要创建一个的Java文件。默认情况下，Maven将从src/main/java编译源代码，因此您需要创建该文件夹结构，然后添加一个名为src/main/java/Example.java的文件：

import org.springframework.boot.*;

import org.springframework.boot.autoconfigure.*;

import org.springframework.stereotype.*;

import org.springframework.web.bind.annotation.*;

@RestController

@EnableAutoConfiguration

public class Example {

@RequestMapping("/")

String home() {

return "Hello World!";

}

public static void main(String[] args) throws Exception {

SpringApplication.run(Example.class, args);

}

虽然这里没有太多的代码，但是有一些重要的部分。

Spring Boot 中文文档（一）（官方文档翻译 基于1.5.2.RELEASE）

正文

请到「今天看啥」查看全文

Spring Boot 中文文档（一）（官方文档翻译基于1.5.2.RELEASE）