三、使用 Spring Boot

本章节将详细介绍如何使用 Spring Boot。它覆盖了诸如构建系统、自动配置和如何运行应用等主题。我们还介绍一些 Spring Boot 最佳实践。虽然 Spring Boot 并没有什么特别(它只是另一个您可以使用的类库),但仍然有一些建议可以让您的开发工作变得更加容易。

如果您是刚开始使用 Spring Boot,那么在深入本部分之前,您应该先阅读入门部分

13、构建系统

强烈推荐您选择一个支持依赖管理的构建系统, 您可以使用它将 artifact 发布到 Maven Central 仓库。我们建议您选择 Maven 或者 Gradle。虽然可以让 Spring Boot 与其它构建系统(如 Ant)配合工作,但它们不会得到特别好的支持。

13.1、依赖管理

每一次 Spring Boot 发行都提供了一个它所支持的依赖清单。实际上,您不需要为构建配置提供任何依赖的版本,因为 Spring Boot 已经帮您管理这些了。当您升级 Spring Boot 时,这些依赖也将以一致的方式进行升级。

注意

如果您觉得有必要,您仍然可以指定一个版本并覆盖 Spring Boot 所推荐的。

该清单包含了全部可以与 Spring Boot 一起使用的 spring 模块以及第三方类库,可作为标准材料清单(spring-boot-dependencies,并且可以与 MavenGradle 一起使用。

警告

Spring Boot 的每一次发行都会基于一个 Spring Framework 版本,因此我们强烈建议您不要指定指定它的版本。

13.2、Maven

Maven 用户可以继承 spring-boot-starter-parent 项目以获取合适的默认值,父项目提供了以下功能:

  • Java 1.8 作为默认编译器级别。
  • 源代码使用 UTF-8 编码。
  • 依赖管理部分继承自 spring-boot-dependencies 的 POM,允许您省略常见依赖的 <version> 标签。
  • 合理的资源过滤
  • 合适的插件配置(exec pluginGit commit IDshade)。
  • 针对 application.propertiesapplication.yml 资源的合理过滤,包括特定 profile 的文件(例如 application-foo.propertiesapplication-foo.yml

注意:由于 application.propertiesapplication.yml 文件接受 Spring 风格的占位符(${​...}),因此 Maven 过滤改为使用 @..@ 占位符(您可以使用 Maven 的 resource.delimiter 属性重写它)

13.2.1、继承 Starter Parent

要将项目配置继承 spring-boot-starter-parent,只需要按以下方式设置 parent

<!-- 从 Spring Boot 继承默认配置 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.0.0.RELEASE</version>
</parent>

注意

您只需要在此依赖上指定 Spring Boot 的版本号。如果您要导入其它 starter,则可以放心地省略版本号。

通过该设置,您还可以重写自己项目中的配置属性来覆盖个别依赖。例如,要升级到另一个 Spring Data 发行版本,您需要将以下内容添加到 pom.xml 文件中。

<properties>
    <spring-data-releasetrain.version>Fowler-SR2</spring-data-releasetrain.version>
</properties>

提示

查看 spring-boot-dependencies pom 以获取受支持的属性清单。

13.2.2、不使用父 POM

不是每个人都喜欢从 spring-boot-starter-parent 继承 POM。您可能需要使用自己公司标准的父 POM,或者您可能只是希望明确地声明所有 Maven 配置。

如果您不想使用 spring-boot-starter-parent,则仍然可以通过使用 scope=import 依赖来获得依赖管理(但不是插件管理)的好处:

<dependencyManagement>
    <dependencies>
        <dependency>
            <!-- 从 Spring Boot 导入依赖管理 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.0.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

如上所述,上述示例设置不会让您使用属性来覆盖个别依赖。要达到相同的目的,需要在 spring-boot-dependencies之前在项目的 dependencyManagement 中添加一项。例如,要升级到另一个 Spring Data 发行版,您可以将以下元素添加到 pom.xml中:

<dependencyManagement>
    <dependencies>
        <!-- 覆盖 Spring Boot 提供的 Spring Data -->
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-releasetrain</artifactId>
            <version>Fowler-SR2</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.0.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

注意

以上示例中,我们指定了一个 BOM,但是任何的依赖类型都可以用这个方法来重写。

13.2.3、使用 Spring Boot Maven 插件

Spring Boot 包括了一个 Maven 插件,它可以将项目打包成一个可执行 jar。如果要使用它,请将插件添加到您的 <plugins> 中:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

注意

如果您使用了 Spring Boot starter 的父 pom,则只需要添加插件。除非您要修改父级中定义的设置,否则不需要进行配置。

13.3、Gradle

要了解如何使用 Spring Boot 和 Gradle,请参阅 Spring Boot 的 Gradle 插件文档:

13.4、Ant

可以使用 Apache Ant+Ivy 构建 Spring Boot 项目。spring-boot-antlib AntLib 模块也可以帮助 Ant 创建可执行 jar 文件。

要声明依赖,可参考以下一个典型的 ivy.xml 文件内容:

<ivy-module version="2.0">
    <info organisation="org.springframework.boot" module="spring-boot-sample-ant" />
    <configurations>
        <conf name="compile" description="everything needed to compile this module" />
        <conf name="runtime" extends="compile" description="everything needed to run this module" />
    </configurations>
    <dependencies>
        <dependency org="org.springframework.boot" name="spring-boot-starter"
            rev="${spring-boot.version}" conf="compile" />
    </dependencies>
</ivy-module>

一个典型的 build.xml 大概是这样:

<project
    xmlns:ivy="antlib:org.apache.ivy.ant"
    xmlns:spring-boot="antlib:org.springframework.boot.ant"
    name="myapp" default="build">

    <property name="spring-boot.version" value="2.0.0.RELEASE" />

    <target name="resolve" description="--> retrieve dependencies with ivy">
        <ivy:retrieve pattern="lib/[conf]/[artifact]-[type]-[revision].[ext]" />
    </target>

    <target name="classpaths" depends="resolve">
        <path id="compile.classpath">
            <fileset dir="lib/compile" includes="*.jar" />
        </path>
    </target>

    <target name="init" depends="classpaths">
        <mkdir dir="build/classes" />
    </target>

    <target name="compile" depends="init" description="compile">
        <javac srcdir="src/main/java" destdir="build/classes" classpathref="compile.classpath" />
    </target>

    <target name="build" depends="compile">
        <spring-boot:exejar destfile="build/myapp.jar" classes="build/classes">
            <spring-boot:lib>
                <fileset dir="lib/runtime" />
            </spring-boot:lib>
        </spring-boot:exejar>
    </target>
</project>

提示

如果您不想使用 spring-boot-antlib 模块,请参阅第 84.10 节:使用 Ant 构建可执行归档文件,无需使用 spring-boot-antlib

13.5、Starter

Starter 是一组惯例依赖描述资源,可以包含在应用中。从 starter 中,您可以获得所需的所有 Spring 和相关技术的一站式支持,无须通过示例代码和复制粘贴来获取依赖。比如,如果您要使用 Spring 和 JPA 进行数据库访问,那么只需要在项目中包含 spring-boot-starter-data-jpa 依赖项即可。

starter 包含了许多您需要用于使项目快速启动和运行,并且需要一组受支持的可传递依赖关系的依赖。


命名含义

官方的所有 starter 都遵循类似的命名规则:spring-boot-starter-*,其中 * 是特定类型的应用。这个命名结构旨在帮助您找到 starter。许多 IDE 中 Maven 集成允许您按名称搜索依赖。例如,安装了 Eclipse 或者 STS 插件后,您可以简单地在 POM 编辑器中按下 ctrl-space 并输入 spring-boot-starter 来获取完整的列表。

正如创建自己的 starter 章节所述,第三方的 starter 命名不应该以 spring-boot 开头,因为它是官方 Spring Boot 构件所保留的规则。例如,有一个第三方 starter 项目叫做 thirdpartyproject,它通常会命名为 thirdpartyproject-spring-boot-starter


Spring Boot 在 org.springframework.boot group 下提供了以下应用 starter:

表 13.1、Spring Boot 应用类 Starter

名称 描述 POM
spring-boot-starter 核心 starter,包含自动配置支持、日志和 YAML Pom
spring-boot-starter-activemq 提供 JMS 消息支持,使用 Apache ActiveMQ Pom
spring-boot-starter-amqp 提供 Spring AMQP 与 Rabbit MQ 支持 Pom
spring-boot-starter-aop 提供 Spring AOP 与 AspectJ 面向切面编程支持 Pom
spring-boot-starter-artemis 提供 JMS 消息服务支持,使用 Apache Artemis Pom
spring-boot-starter-batch 提供 Spring Batch 支持 Pom
spring-boot-starter-cache 提供 Spring Framework 缓存支持 Pom
spring-boot-starter-cloud-connectors 使用 Spring Cloud Connectors 简单连接到类似 Cloud Foundry 和 Heroku 等云平台 Pom
spring-boot-starter-data-cassandra 提供对 Cassandra 分布式数据库和 Spring Data Cassandra 的支持 Pom
spring-boot-starter-data-cassandra-reactive 提供对 Cassandra 分布式数据库和 Spring Data Cassandra Reactive 的支持 Pom
spring-boot-starter-data-couchbase 提供对 Couchbase 面向文档数据库和 Spring Data Couchbase 的支持 Pom
spring-boot-starter-data-couchbase-reactive 提供对 Couchbase 面向文档数据库和 Spring Data Couchbase Reactive 的支持 Pom
spring-boot-starter-data-elasticsearch 提供对 Elasticseach 搜索与分析引擎和 Spring Data Elasticsearch 的支持 Pom
spring-boot-starter-data-jpa 提供 Spring Data JPA 与 Hibernate 的支持 Pom
spring-boot-starter-data-ldap 提供对 Spring Data LDAP 的支持 Pom
spring-boot-starter-data-mongodb 提供对 MongoDB 面向文档数据库和 Spring Data MongoDB 的支持 Pom
spring-boot-starter-data-mongodb-reactive 提供对 MongoDB 面向文档数据库和 Spring Data MongoDB Reactive 的支持 Pom
spring-boot-starter-data-neo4j 提供对 Neo4j 图数据库与 SPring Data Neo4j 的支持 Pom
spring-boot-starter-data-redis 提供对 Redis 键值数据存储、Spring Data Redis 和 Lettuce 客户端的支持 Pom
spring-boot-starter-data-redis-reactive 提供对 Redis 键值数据存储、Spring Data Redis Reactive 和 Lettuce 客户端的支持 Pom
spring-boot-starter-data-rest 提供使用 Spring Data REST 通过 REST 暴露 Spring Data 资源库的支持 Pom
spring-boot-starter-data-solr 提供对 Apache Solr 搜索平台与 Spring Data Solr 的支持 Pom
spring-boot-starter-freemarker 提供使用 Freemakrer 视图构建 MVC web 应用的支持 Pom
spring-boot-starter-groovy-templates 提供使用 Groovy 模板视图构建 MVC web 应用的支持 Pom
spring-boot-starter-hateoas 提供使用 Spring MVC 与Spring HATEOAS 构建基于超媒体的 RESTful web 应用的支持 Pom
spring-boot-starter-integration 提供对 Spring Integration 的支持 Pom
spring-boot-starter-jdbc 提供 JDBC 与 Tomcat JDBC 连接池的支持 Pom
spring-boot-starter-jersey 提供对使用 JAX-RS 与 Jersey 构建 RESTful web 应用的支持。spring-boot-starter-web 的替代方案 Pom
spring-boot-starter-jooq 提供对使用 JOOQ 访问 SQL 数据库的支持。spring-boot-starter-data-jpaspring-boot-starter-jdbc 的替代方案 Pom
spring-boot-starter-json 提供了读写 json 的支持 Pom
spring-boot-starter-jta-atomikos 提供 Atomikos JTA 事务支持 Pom
spring-boot-starter-jta-bitronix 提供 Bitronix JTA 事务支持 Pom
spring-boot-starter-jta-narayana 提供 Narayana JTA 支持 Pom
spring-boot-starter-mail 提供使用 Java Mail 与 Spring Framework 的邮件发送支持 Pom
spring-boot-starter-mustache 提供使用 Mustache 视图构建 web 应用的支持 Pom
spring-boot-starter-quartz Quartz 支持 Pom
spring-boot-starter-security Spring Security 支持 Pom
spring-boot-starter-test 提供包含了 JUnit、Hamcrest 与 Mockito 类库的 Spring Boot 单元测试支持 Pom
spring-boot-starter-thymeleaf 提供使用 Thymeleaf 视图构建 MVC web 应用的支持 pom
spring-boot-starter-validation 提供 Hibernate Validator 与 Java Bean Validation 的支持 Pom
spring-boot-starter-web 提供使用 Spring MVC 构建 web(包含 RESTful)应用的支持,使用 Tomcat 作为默认嵌入式容器 Pom
spring-boot-starter-web-services Spring Web Services 支持 Pom
spring-boot-starter-webflux 提供使用 Spring Framework 的 Reactive Web 支持构建 WebFlux 应用的支持 Pom
spring-boot-starter-websocket 提供使用 Spring Framework 的 WebSocket 支持构建 WebSocket 应用的支持 Pom

除了应用 starter,以下 starter 可用于添加生产就绪特性:

表 13.2、Spring Boot 生产类 starter

名称 描述 POM
spring-boot-starter-actuator Spring Boot 的 Actuator 支持,其提供了生产就绪功能,帮助您监控和管理应用 Pom

最后,Spring Boot 还包含以下 starter,如果您想要排除或切换特定技术,可以使用以下 starter:

表 13.3、Spring Boot 技术类 starter

名称 描述 POM
spring-boot-starter-jetty 使用 Jetty 作为嵌入式 servlet 容器。可代替 spring-boot-starter-tomcat Pom
spring-boot-starter-log4j2 使用 Log4j2 作为日志组件。可代替 spring-boot-starter-logging Pom
spring-boot-starter-logging 使用 Logback 作为日志组件,此 starter 为默认的日志 starter Pom
spring-boot-starter-reactor-netty 使用 Reactor Netty 作为内嵌响应式 HTTP 服务器 Pom
spring-boot-starter-tomcat 使用 Tomcat 作为嵌入式 servlet 容器,此为 spring-boot-starter-web 默认的 servlet 容器 starter Pom
spring-boot-starter-undertow 使用 Undertow 作为嵌入式 servlet 容器,可代替 spring-boot-starter-tomcat Pom

提示

有关其它社区贡献的 starter 列表,请参阅 GitHub 上的 spring-boot-starters 模块中的 README 文件

14、组织代码

Spring Boot 不需要任何特定的代码布局,但是有一些最佳实践是很有用的。

14.1、使用 default 包

当一个类没有 package 声明时,它就被认为是在 default 包中。通常不鼓励使用 default 包,应该避免使用。对于使用 @ComponentScan@EntityScan 或者 @SpringBootApplication 注解的 Spring Boot 应用,这样可能会导致特殊问题发生,因为每一个 jar 中的每一个类将会被读取到。

提示

我们建议您使用 Java 推荐的包命名约定,并使用域名的反向形式命名(例如 com.example.project)。

14.2、定位主应用类

我们通常建议您将主应用类放在其它类之上的根包中, @EnableAutoConfiguration 注解通常放在主类上,它隐式定义了某些项目的 包搜索的基准起点。例如,如果您在编写一个 JPA 应用程序,则被 @EnableAutoConfiguration 注解的类所属的包将被用于搜索标记有 @Entity 注解的类。

使用根包还可以允许使用没有指定 basePackage 属性的 @ComponentScan 注解。如果您的主类在根包中,也可以使用 @SpringBootApplication 注解。

以下是一个经典的包结构:

com
 +- example
     +- myapplication
         +- Application.java
         |
         +- customer
         |   +- Customer.java
         |   +- CustomerController.java
         |   +- CustomerService.java
         |   +- CustomerRepository.java
         |
         +- order
             +- Order.java
             +- OrderController.java
             +- OrderService.java
             +- OrderRepository.java

Application.java 文件声明了 main 方法,附带了 @Configuration 注解。

package com.example.myapplication;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

15、配置类

Spring Boot 支持基于 Java 的配置。虽然可以在 SpringApplication 中使用 XML 配置源,但我们通常建议主配置源为 @Configuration 类。通常,一个很好的选择是将定义了 main 方法的类作为 @Configuration

提示

许多 Spring 的 XML 配置示例已经在 Internet 上发布了。如果可能的话,您无论如何都应该尝试着使用等效的基于 Java 的配置方式,搜索 Enable* 注解可以帮到您不少忙。

15.1、导入额外的配置类

你不需要把所有的 @Configuration 放在一个类中。@Import 注解可用于导入其他配置类。或者,您可以使用 @ComponentScan 自动扫描所有 Spring 组件,包括 @Configuration 类。

15.2、导入 XML 配置

如果您一定要使用基于 XML 的配置,我们建议您仍然使用 @Configuration 类。您可以使用 @ImportResource 注解来加载 XML 配置文件。

16、自动配置

Spring Boot 自动配置尝试根据您添加的 jar 依赖自动配置 Spring 应用。例如,如果 classpath 下存在 HSQLDB,并且您没有手动配置任何数据库连接 bean,那么 Spring Boot 将自动配置一个内存数据库。

您需要通过将 @EnableAutoConfiguration 或者 @SpringBootApplication 注解添加到其中一个 @Configuration 类之上以启用自动配置。

提示

您应该仅添加一个 @EnableAutoConfiguration 注解。我们通常建议您将其添加到主 @Configuration 类中。

16.1、平滑替换自动配置

自动配置是非入侵的,您可以随时定义自己的配置来代替自动配置的特定部分。例如,如果您添加了自己的 DataSource bean,默认的嵌入式数据库支持将不会自动配置。

如果您需要了解当前正在应用的自动配置,以及为什么使用,请使用 --debug 开关启动应用。这样做可以为核心 logger 启用调试日志,并记录到控制台。

16.2、禁用指定的自动配置类

如果您发现在正在使用不需要的自动配置类,可以通过使用 @EnableAutoConfigurationexclude 属性来禁用它们。

import org.springframework.boot.autoconfigure.*;
import org.springframework.boot.autoconfigure.jdbc.*;
import org.springframework.context.annotation.*;

@Configuration
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
public class MyConfiguration {
}

如果类不在 classpath 下,您可以使用注解的 excludeName 属性并指定完全类名。最后,您还可以通过 spring.autoconfigure.exclude property 控制要排除的自动配置类列表。

提示

您可以同时使用注解和 property 定义排除项

17、Spring Bean 与依赖注入

您可以自由使用任何标准的 Spring Framework 技术来定义您的 bean 以及它们注入的依赖。我们发现使用 @ComponentScan 来寻找 bean 和结合 @Autowired 构造器注入可以很好地工作。

如果您按照上述的建议(将应用类放在根包中)来组织代码,则可以添加无参的 @ComponentScan。所有应用组件(@Component@Service@Repository@Controller 等)将自动注册为 Spring Bean。

以下是一个 @Service Bean,其使用构造注入方式获取一个必需的 RiskAssessor bean。

package com.example.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class DatabaseAccountService implements AccountService {

    private final RiskAssessor riskAssessor;

    @Autowired
    public DatabaseAccountService(RiskAssessor riskAssessor) {
        this.riskAssessor = riskAssessor;
    }

    // ...

}

如果 bean 中只有一个构造方法,您可以忽略掉 @Autowired 注解。

@Service
public class DatabaseAccountService implements AccountService {

    private final RiskAssessor riskAssessor;

    public DatabaseAccountService(RiskAssessor riskAssessor) {
        this.riskAssessor = riskAssessor;
    }

    // ...

}

提示

请注意,构造注入允许 riskAssessor 字段被修饰为 final,这表示以后它不能被更改。

18、使用 @SpringBootApplication 注解

很多 Spring Boot 开发者总是使用 @Configuration@EnableAutoConfiguration@ComponentScan 注解标记在主类上。由于 这些注解经常一起使用(特别是如果您遵循上述的最佳实践)。Spring Boot 提供了一个更方便的 @SpringBootApplication 注解可用来替代这个组合。

@SpringBootApplication 注解相当于使用 @Configuration@EnableAutoConfiguration@ComponentScan 及他们的默认属性:

package com.example.myapplication;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // 相当于使用 @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

注意

@SpringBootApplication 还提供了别名来自定义 @EnableAutoConfiguration@ComponentScan 的属性。

19、运行您的应用

将应用程序打包成 jar 可执行文件并使用嵌入式 HTTP 服务器的最大有点之一就是可以按照您想使用的其它方式来运行应用。调试 Spring Boot 也是很简单,您不需要任何特殊的 IDE 插件或者扩展。

注意

本章节仅涵盖基于 jar 的打包方式,如果您选择将应用打包为 war 文件,则应该参考您的服务器和 IDE 文档。

19.1、使用 IDE 运行

您可以使用 IDE 运行 Spring Boot应用,就像运行一个简单的 Java 应用程序一样,但是首先您需要导入项目,导入步骤取决于您的 IDE 和构建系统。大多数 IDE 可以直接导入 Maven 项目,例如 Eclipse 用户可以从 File 菜单中选择 Import ​ → Existing Maven Projects

如果您无法将项目直接导入到 IDE 中,则可以使用构建插件生成 IDE 元数据(metadata)。Maven 包含了 EclipseIDEA 的插件,Gradle 也为各种 IDE 提供了插件。

提示

如果您不小心运行了两次 web 应用,您将看到一个 Port already in use (端口已经被使用)错误。STS 用户可以使用 Relaunch 按钮运行以确保现有的任何实例都已关闭,而不是使用 Run 按钮。

19.2、作为打包应用运行

如果您使用 Spring Boot Maven 或者 Gradle 插件创建可执行 jar,可以使用 java -jar 命令运行应用。例如:

$ java -jar target/myapplication-0.0.1-SNAPSHOT.jar

也可以在运行打包应用程序时开启远程调试支持。该功能允许您将调试器附加到打包的应用中。

$ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n \
       -jar target/myapplication-0.0.1-SNAPSHOT.jar

19.3、使用 Maven 插件

Spring Boot Maven 插件包含一个可用于快速编译和运行应用程序的 run goal。应用程序以快速形式运行,就像在 IDE 中一样。以下示例展示了运行 Spring Boot 应用程序的典型 Maven 命令:

$ mvn spring-boot:run

您可能还想使用 MAVEN_OPTS 操作系统环境变量,如下例所示:

$ export MAVEN_OPTS=-Xmx1024m

19.4、使用 Gradle 插件

Spring Boot Gradle 插件包含一个 bootRun 任务,可用于以快速形式运行应用程序。每当应用 org.springframework.boot 和 java 插件时都会添加 bootRun 任务:

$ gradle bootRun

您可能还想使用 JAVA_OPTS 操作系统环境变量:

$ export JAVA_OPTS=-Xmx1024m

19.5、热交换

由于 Spring Boot 应用程序只是普通的 Java 应用程序,因此 JVM 热插拔是可以开箱即用。JVM 热插拔在可替换字节码方面有所限制。想要更完整的解决方案,可以使用 JRebel

spring-boot-devtools 模块包含了对快速重新启动应用程序的支持。有关详细信息,请参阅本章后面的第 20 章:开发人员工具部分以及热插拔的 How-to 部分

20、开发者工具

Spring Boot 包含了一套工具,可以使应用开发体验更加愉快。spring-boot-devtools 模块可包含在任何项目中,以提供额外的开发时(development-time)功能。要启用 devtools 支持,只需要将模块依赖添加到您的构建配置中即可:

Maven

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

Gradle

dependencies {
    compile("org.springframework.boot:spring-boot-devtools")
}

注意

当运行完全打包的应用时,开发者工具将会自动禁用。如果您的应用使用了 java -jar 方式或者特殊的类加载器启动,那么它会被认为是一个生产级别应用。将 Maven 的依赖标记为可选或者在 Gradle 中使用 compileOnly 是防止您的项目被其他模块使用时 devtools 被应用到其它模块的最佳方法。

提示

重新打包的归档默认情况下不包含 devtools。如果要使用某些远程 devtools 功能, 你需要禁用 excludeDevtools 构建属性以把 devtools 包含进来。该属性支持 Maven 和 Gradle 插件。

20.1、Property 默认值

Spring Boot 所支持的一些库使用了缓存来提高性能。例如,模板引擎将缓存编译后的模板,以避免重复解析模板文件。此外,Spring MVC 可以在服务静态资源时添加 HTTP 缓存头。

虽然缓存在生产中非常有用,但它在开发过程可能会产生相反的效果,让您不能及时看到刚才在应用中作出的更改。因此,spring-boot-devtools 将默认禁用这些缓存选项。

一般是在 application.properties 文件中设置缓存选项。例如,Thymeleaf 提供了 spring.thymeleaf.cache 属性。您不需要手动设置这些属性,spring-boot-devtools 会自动应用合适的开发时(development-time)配置。

提示

有关应用属性的完整列表,请参阅 DevToolsPropertyDefaultsPostProcessor

20.2、自动重启

使用 spring-boot-devtools 的应用在 classpath 下的文件发生更改时会自动重启。这对于使用 IDE 工作而言可能是一个非常棒的功能,因为它为代码变更提供了非常块的反馈环。默认情况下,将监视 classpath 指向的所有文件夹。请注意,某些资源(如静态资源和视图模板)不需要重启应用


触发重启

当 DevTools 监视 classpath 资源时,触发重启的唯一方式是更新 classpath。使 classpath 更新的方式取决于您使用的 IDE。在 Eclipse 中,保存修改的文件将更新 classpath,从而触发重启。在 IntelliJ IDEA 中,构建项目(Build -> Make Project) 将产生相同的效果。


注意

只要 forking 被开启,您可以使用受支持的构建工具(如 Maven 或 Gradle)来启用应用,因为 DevTools 需要隔离应用类加载器才能正常运行。默认情况下,当在 classpath 下检测到 DevTools 时,Gradle 和 Maven 会这么做。

提示

自动重启功能与 LiveReload(实时重载)一起使用效果更棒。阅读 LiveReload 章节以获取更多信息。如果您使用 JRebel,自动重启将会被禁用,以支持动态类重载,但其他 devtools 功能(如 LiveReload 和 property 覆盖)仍然可以使用。

注意

DevTools 依赖于应用上下文的关闭钩子,以在重启期间关闭自己。如果禁用了关闭钩子(SpringApplication.setRegisterShutdownHook(false)),它将不能正常工作。

注意

当 classpath 下的内容发生更改,决定是否触发重启时,DevTools 会自动忽略名为 spring-bootspring-boot-devtoolsspring-boot-autoconfigurespring-boot-actuatorspring-boot-starter 的项目。

注意

DevTools 需要自定义 ApplicationContext 使用到的 ResourceLoader。如果您的应用已经提供了一个,它将被包装起来,因为不支持在 ApplicationContext 上直接覆盖 getResource 方法。


重启(Restart)与重载(Reload)

Spring Boot 通过使用两个类加载器来提供了重启技术。不改变的类(例如,第三方 jar)被加载到 base 类加载器中。经常处于开发状态的类被加载到 restart 类加载器中。当应用重启时,restart 类加载器将被丢弃,并重新创建一个新的。这种方式意味着应用重启比冷启动要快得多,因为省去 base 类加载器的处理步骤,并且可以直接使用。

如果您觉得重启还不够快,或者遇到类加载问题,您可以考虑如 ZeroTurnaround 的 JRebel 等工具。他们是通过在加载类时重写类来加快重新加载。


20.2.1、条件评估变更日志

默认情况下,每次应用重启时,都会记录显示条件评估增量的报告。该报告展示了在您进行更改(如添加或删除 bean 以及设置配置属性)时对应用自动配置所作出的更改。

要禁用报告的日志记录,请设置以下属性:

spring.devtools.restart.log-condition-evaluation-delta=false

20.2.2、排除资源

某些资源在更改时不一定需要触发重启。例如,Thymeleaf 模板可以实时编辑。默认情况下,更改 /META-INF/maven/META-INF/resources/resources/static/public 或者 /templates 不会触发重启,但会触发 LiveReload。如果您想自定义排除项,可以使用 spring.devtools.restart.exclude 属性。例如,仅排除 /static/public,您可以设置以下内容:

spring.devtools.restart.exclude=static/**,public/**

提示

如果要保留这些默认值并添加其他排除项 ,请改用 spring.devtools.restart.additional-exclude 属性。

20.2.3、监视附加路径

如果您想在对不在 classpath 下的文件进行修改时重启或重载应用,请使用 spring.devtools.restart.additional-paths 属性来配置监视其他路径的更改情况。您可以使用上述spring.devtools.restart.exclude 属性来控制附加路径下的文件被修改时是否触发重启或只是 LiveReload

20.2.4、禁用重启

您如果不想使用重启功能,可以使用 spring.devtools.restart.enabled 属性来禁用它。一般情况下,您可以在 application.properties 中设置此属性(重启类加载器仍将被初始化,但不会监视文件更改)。

如果您需要完全禁用重启支持(例如,可能它不适用于某些类库),您需要在调用 SpringApplication.run(​...) 之前将 System 属性 spring.devtools.restart.enabled System 设置为 false。例如:

public static void main(String[] args) {
    System.setProperty("spring.devtools.restart.enabled", "false");
    SpringApplication.run(MyApp.class, args);
}

20.2.5、使用触发文件

如果您使用 IDE 进行开发,并且时时刻刻在编译更改的文件,或许您只是希望在特定的时间内触发重启。为此,您可以使用触发文件,这是一个特殊文件,您想要触发重启检查时,必须修改它。更改文件只会触发检查,只有在 Devtools 检查到它需要做某些操作时才会触发重启,可以手动更新触发文件,也可以通过 IDE 插件更新。

要使用触发文件,请设置 spring.devtools.restart.trigger-file 属性指向触发文件的路径。

提示

您也许想将 spring.devtools.restart.trigger-file 设置成一个全局配置,以使得所有的项目都能应用此方式。

20.2.6、自定义重启类加载器

正如之前的重启和重载部分所述,重启功能是通过使用两个类加载器来实现的。对于大多数应用而言,这种方式很好,然而,有时可能会导致类加载出现问题。

默认情况下,IDE 中任何打开的项目将使用 restart 类加载器加载,任何常规的 .jar 文件将使用 base 类加载器加载。您如果开发的是多模块项目,而不是每一个模块都导入到 IDE 中,则可能需要自定义。为此,您可以创建一个 META-INF/spring-devtools.properties 文件。

spring-devtools.properties 文件可以包含以 restart.exclude.restart.include. 为前缀的属性。include 元素是加载到 restart 类加载器的项,exclude 元素是加载到 base 类加载器的项。属性值是一个应用到 classpath 的正则表达式。例如:

restart.exclude.companycommonlibs=/mycorp-common-[\\w-]+\.jar
restart.include.projectcommon=/mycorp-myproj-[\\w-]+\.jar

注意

所有属性键名必须是唯一的。只要有一个属性以 restart.include.restart.exclude. 开头,它将会被考虑。

提示

classpath 下的所有 META-INF/spring-devtools.properties 文件将被加载,您可以将它们打包进工程或者类库中为项目所用。

20.2.7、已知限制

重新启动功能对使用标准 ObjectInputStream 反序列化的对象无效。您如果需要反序列化数据,可能需要使用 Spring 的 ConfigurableObjectInputStream 配合 Thread.currentThread().getContextClassLoader()

遗憾的是,一些第三方类库在没有考虑上下文类加载器的情况下使用了反序列化。您如果遇到此问题,需要向原作者提交修复请求。

20.3、LiveReload

spring-boot-devtools 模块包括了一个内嵌 LiveReload 服务器,它可在资源发生更改时触发浏览器刷新。您可以从 livereload.com 上免费获取 Chrome、Firefox 和 Safari 平台下对应的 LiveReload 浏览器扩展程序。

如果您不想在应用运行时启动 LiveReload 服务器,可以将 spring.devtools.livereload.enabled 属性设置为 false

注意

您一次只能运行一个 LiveReload 服务器。在启动应用之前,请确保没有其他 LiveReload 服务器正在运行。如果在 IDE 中启动了多个应用,那么只有第一个应用的 LiveReload 生效。

20.4、全局设置

您可以通过在 $HOME 目录中添加名为 .spring-boot-devtools.properties 的文件来配置全局 devtools 设置(请注意,文件名以“.”开头)。在此文件中添加的任何属性将应用到您的计算机上所有使用了 devtools 的 Spring Boot 应用。例如,始终使用触发文件来配置重启功能,您可以添加以下内容:

~/.spring-boot-devtools.properties.

spring.devtools.reload.trigger-file=.reloadtrigger

注意

.spring-boot-devtools.properties 中激活的 profile 将不会影响指定 profile 的配置文件的加载。

20.5、远程应用

Spring Boot 开发者工具不局限于本地开发。在远程运行应用时也可以使用许多功能。远程支持功能是可选的,如果要启用,您需要确保在重新打包归档文件时包含 devtools

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <excludeDevtools>false</excludeDevtools>
            </configuration>
        </plugin>
    </plugins>
</build>

之后您需要设置一个 spring.devtools.remote.secret 属性,如下:

spring.devtools.remote.secret=mysecret

警告

在远程应用上启用 spring-boot-devtools 是存在安全隐患的。您不应该在生产部署时启用它。

远程 devtools 支持分为两部分:接受请求连接的服务器端端点和在 IDE 中运行的客户端应用。当设置了 spring.devtools.remote.secret 属性时,服务器组件将自动启用。客户端组件必须手启用。

20.5.1、运行远程客户端应用

假设远程客户端应用运行在 IDE 中。您需要在与要连接的远程项目相同的 classpath 下运行 org.springframework.boot.devtools.RemoteSpringApplication。把要连接的远程 URL 作为必须参数传入。

例如,如果您使用的是 Eclipse 或 STS,并且有一个名为 my-app 的项目已部署到了 Cloud Foundry,则可以执行以下操作:

  • Run 菜单中选择选择 Run Configurations...​。
  • 创建一个新的 Java Application launch configuration。
  • 浏览 my-app 项目。
  • 使用 org.springframework.boot.devtools.RemoteSpringApplication 作为主类。
  • https://myapp.cfapps.io 作为 程序参数 (或者任何远程 URL)传入。

运行的远程客户端将如下所示:

  .   ____          _                                              __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _          ___               _      \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` |        | _ \___ _ __  ___| |_ ___ \ \ \ \
 \\/  ___)| |_)| | | | | || (_| []::::::[]   / -_) '  \/ _ \  _/ -_) ) ) ) )
  '  |____| .__|_| |_|_| |_\__, |        |_|_\___|_|_|_\___/\__\___|/ / / /
 =========|_|==============|___/===================================/_/_/_/
 :: Spring Boot Remote :: 2.1.1.RELEASE

2015-06-10 18:25:06.632  INFO 14938 --- [           main] o.s.b.devtools.RemoteSpringApplication   : Starting RemoteSpringApplication on pwmbp with PID 14938 (/Users/pwebb/projects/spring-boot/code/spring-boot-devtools/target/classes started by pwebb in /Users/pwebb/projects/spring-boot/code/spring-boot-samples/spring-boot-sample-devtools)
2015-06-10 18:25:06.671  INFO 14938 --- [           main] s.c.a.AnnotationConfigApplicationContext : Refreshing org.springframework.context.annotation.AnnotationConfigApplicationContext@2a17b7b6: startup date [Wed Jun 10 18:25:06 PDT 2015]; root of context hierarchy
2015-06-10 18:25:07.043  WARN 14938 --- [           main] o.s.b.d.r.c.RemoteClientConfiguration    : The connection to http://localhost:8080 is insecure. You should use a URL starting with 'https://'.
2015-06-10 18:25:07.074  INFO 14938 --- [           main] o.s.b.d.a.OptionalLiveReloadServer       : LiveReload server is running on port 35729
2015-06-10 18:25:07.130  INFO 14938 --- [           main] o.s.b.devtools.RemoteSpringApplication   : Started RemoteSpringApplication in 0.74 seconds (JVM running for 1.105)

注意

由于远程客户端与实际应用使用的是同一个 classpath,因此可以直接读取应用的 properties。这也是 spring.devtools.remote.secret 属性为什么能被读取和传递给服务器进行身份验证的原因。

提示

建议使用 https:// 作为连接协议,以便加密传输并防止密码被拦截。

提示

如果您需要通过代理来访问远程应用,请配置 spring.devtools.remote.proxy.hostspring.devtools.remote.proxy.port 属性。

20.5.2、远程更新

远程客户端使用了与本地重启相同的方式来监控应用 classpath 下发生的更改。任何更新的资源将被推送到远程应用和触发重启(如果要求)。如果您正在迭代一个使用了本地没有的云服务的功能,这可能会非常有用。通常远程更新和重启比完全重新构建和部署的周期要快得多。

注意

文件只有在远程客户端运行时才被监控。如果您在启动远程客户端之前更改了文件,文件将不会被推送到远程服务器。

21、打包生产应用

可执行 jar 可用于生产部署,它们是独立(self-contained,独立、自包含)的,同样也适合云部署。

针对其他生产就绪功能,比如健康、审计和 REST 或者 JMX 端点度量,可以添加 spring-boot-actuator。有关这方面的详细信息,请参见 第五部分:“Spring Boot Actuator:生产就绪功能”

21、下一步

您现在应该知道如何使用 Spring Boot 以及应该遵循哪些最佳实践。接下来您可以深入地了解 Spring Boot 功能,或者您也可以跳过下一部分直接阅读“生产就绪功能”方面的内容。

powered by GitbookFile Modify: 2018-12-20 20:44:01