20. Developer tools

Spring Boot 包括一组额外的工具，这些工具可以使应用程序开发体验更加愉快。 spring-boot-devtools模块可以包含在任何项目中，以提供其他开发时功能。要包含 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")
}

20.1 属性默认值

Spring Boot 支持的一些库使用缓存来提高性能。例如，template engines将缓存编译的模板，以避免重复分析模板文件。而且，Spring MVC 可以在提供静态资源时向响应添加 HTTP 缓存 Headers。

尽管缓存在 Producing 非常有用，但在开发过程中可能适得其反，从而使您无法看到自己刚刚在应用程序中所做的更改。因此，默认情况下，spring-boot-devtools 将禁用这些缓存选项。

缓存选项通常由application.properties文件中的设置配置。例如，Thymeleaf 提供了spring.thymeleaf.cache属性。无需手动设置这些属性，spring-boot-devtools模块将自动应用合理的开发时配置。

20.2 自动重启

每当 classpath 上的文件更改时，使用spring-boot-devtools的应用程序将自动重新启动。在 IDE 中工作时，这可能是一个有用的功能，因为它为代码更改提供了非常快速的反馈循环。默认情况下，将监视 Classpath 上指向文件夹的任何条目的更改。请注意，某些资源(例如静态资产和视图模板不需要重新启动应用程序)。

20.2.1 排除资源

某些资源在更改时不一定需要触发重新启动。例如，Thymeleaf 模板只能就地编辑。默认情况下，更改/META-INF/maven，/META-INF/resources，/resources，/static，/public或/templates中的资源不会触发重新启动，但会触发live reload。如果要自定义这些排除项，可以使用spring.devtools.restart.exclude属性。例如，要仅排除/static和/public，可以设置以下内容：

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

20.2.2 观看其他路径

当您对不在 Classpath 上的文件进行更改时，您可能希望重新启动或重新加载应用程序。为此，使用spring.devtools.restart.additional-paths属性配置其他路径以监视更改。您可以使用spring.devtools.restart.exclude属性described above来控制其他路径下的更改将触发完全重启还是仅触发live reload。

20.2.3 禁用重新启动

如果您不想使用重新启动功能，则可以使用spring.devtools.restart.enabled属性将其禁用。在大多数情况下，您可以在application.properties中进行设置(这仍会初始化重新启动类加载器，但不会监视文件更改)。

例如，如果您需要完全禁用重启支持，因为它不适用于特定的库，则需要在调用SpringApplication.run(…)之前设置System属性。例如：

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

20.2.4 使用触发文件

如果使用持续编译更改文件的 IDE，则可能更喜欢仅在特定时间触发重新启动。为此，您可以使用“触发文件”，这是一个特殊文件，当您要实际触发重新启动检查时必须对其进行修改。更改文件只会触发检查，并且只有在 Devtools 检测到必须执行某些操作时才会重新启动。触发文件可以手动更新，也可以通过 IDE 插件更新。

要使用触发文件，请使用spring.devtools.restart.trigger-file属性。

20.2.5 自定义重启类加载器

如上面的重新启动与重新加载部分所述，重新启动功能是通过使用两个类加载器实现的。对于大多数应用程序，此方法效果很好，但是有时可能会导致类加载问题。

默认情况下，将使用“重新启动”类加载器加载 IDE 中任何打开的项目，而使用“基本”类加载器加载任何常规.jar文件。如果您在一个多模块项目上工作，并且没有将每个模块都导入到 IDE 中，则可能需要自定义内容。为此，您可以创建一个META-INF/spring-devtools.properties文件。

spring-devtools.properties文件可以包含restart.exclude.和restart.include.前缀的属性。 include元素是应上拉到“重新启动”类加载器中的项目，而exclude元素是应下推到“基本”类加载器中的项目。该属性的值是一个将应用于 Classpath 的正则表达式模式。

For example:

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

20.2.6 已知限制

重新启动功能不适用于使用标准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。

20.4 全局设置

您可以通过将名为.spring-boot-devtools.properties的文件添加到$HOME文件夹中来配置全局 devtools 设置(请注意，文件名以“.”开头)。添加到该文件的所有属性将应用于使用 devtools 的机器上的全部 Spring Boot 应用程序。例如，要将重新启动配置为始终使用trigger file，则应添加以下内容：

~/.spring-boot-devtools.properties.

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

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

远程 devtools 支持分为两个部分：有一个服务器端端点接受连接，还有一个在 IDE 中运行的 Client 端应用程序。设置spring.devtools.remote.secret属性后，将自动启用服务器组件。Client 端组件必须手动启动。

20.5.1 运行远程 Client 端应用程序

远程 Client 端应用程序旨在在您的 IDE 中运行。您需要使用与要连接到的远程项目相同的 Classpath 来运行org.springframework.boot.devtools.RemoteSpringApplication。传递给应用程序的* non-option *参数应该是您要连接的远程 URL。

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

• 从Run菜单中选择Run Configurations…。

• 创建一个新的Java Application“启动配置”。

• 浏览my-app项目。

• 使用org.springframework.boot.devtools.RemoteSpringApplication作为主要类。

• 将https://myapp.cfapps.io添加到Program arguments(或任何远程 URL)。

正在运行的远程 Client 端将如下所示：

.   ____          _                                              __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _          ___               _      \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` |        | _ \___ _ __  ___| |_ ___ \ \ \ \
 \\/  ___)| |_)| | | | | || (_| []::::::[]   / -_) '  \/ _ \  _/ -_) ) ) ) )
  '  |____| .__|_| |_|_| |_\__, |        |_|_\___|_|_|_\___/\__\___|/ / / /
 =========|_|==============|___/===================================/_/_/_/
 :: Spring Boot Remote :: 1.5.9.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.spring[emailprotected]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)

20.5.2 远程更新

远程 Client 端将以与local restart相同的方式监视应用程序 Classpath 中的更改。任何更新的资源将被推送到远程应用程序，并且*(如果需要)*会触发重新启动。如果您要迭代使用本地没有的云服务的功能，这将非常有用。通常，远程更新和重新启动比完整的重建和部署周期要快得多。

20.5.3 远程调试隧道

诊断远程应用程序中的问题时，Java 远程调试非常有用。不幸的是，当您的应用程序部署在数据中心之外时，并非总是能够启用远程调试。如果您使用的是基于容器的技术(例如 Docker)，则设置远程调试也很棘手。

为了解决这些限制，devtools 支持通过 HTTP 构建远程调试流量的隧道。远程 Client 端在端口8000上提供了本地服务器，您可以将远程调试器连接到该本地服务器。构建连接后，调试流量将通过 HTTP 发送到远程应用程序。如果要使用其他端口，可以使用spring.devtools.remote.debug.local-port属性。

您需要确保在启用了远程调试的情况下启动了远程应用程序。通常，这可以通过配置JAVA_OPTS来实现。例如，使用 Cloud Foundry，您可以将以下内容添加到manifest.yml：

---
    env:
        JAVA_OPTS: "-Xdebug -Xrunjdwp:server=y,transport=dt_socket,suspend=n"