青年IT男

个人从事金融行业,就职过易极付、思建科技、某网约车平台等重庆一流技术团队,目前就职于某银行负责统一支付系统建设。自身对金融行业有强烈的爱好。同时也实践大数据、数据存储、自动化集成和部署、分布式微服务、响应式编程、人工智能等领域。同时也热衷于技术分享创立公众号和博客站点对知识体系进行分享。微信公众号:青年IT男。

《spring-boot-in-action》 附录A Spring Boot开发者工具

《spring-boot-in-action》 附录A Spring Boot开发者工具

附录A Spring Boot开发者工具

Spring Boot 1.3引入了一组新的开发者工具,可以让你在开发时更方便地使用Spring Boot,包括如下功能。

  • 自动重启:当Classpath里的文件发生变化时,自动重启运行中的应用程序。
  • LiveReload支持:对资源的修改自动触发浏览器刷新。
  • 远程开发:远程部署时支持自动重启和LiveReload。
  • 默认的开发时属性值:为一些属性提供有意义的默认开发时属性值。

Spring Boot的开发者工具采取了库的形式,可以作为依赖加入项目。如果你使用Gradle来构建项目,可以像下面这样在build.gradle文件里添加开发工具:

compile "org.springframework.boot:spring-boot-devtools"

在Maven POM里添加<dependency>是这样的:

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

当应用程序以完整打包好的JAR或WAR文件形式运行时,开发者工具会被禁用,所以没有必要在构建生产部署包前移除这个依赖。

##A.1 自动重启

在激活了开发者工具后,Classpath里对文件做任何修改都会触发应用程序重启。为了让重启速度够快,不会修改的类(比如第三方JAR文件里的类)都加载到了基础类加载器里,而应用程序的代码则会加载到一个单独的重启类加载器里。检测到变更时,只有重启类加载器重启。

有些Classpath里的资源变更后不需要重启应用程序。像Thymeleaf这样的视图模板可以直接编辑,不用重启应用程序。在/static或/public里的静态资源也不用重启应用程序,所以Spring Boot开发者工具会在重启时排除掉如下目录:/META-INF/resources、/resources、/static、/public和/templates。

可以设置spring.devtools.restart.exclude属性来覆盖默认的重启排除目录。例如,你只排除/static和/templates目录,可以像这样设置spring.devtools.restart.exclude

spring:
  devtools:
    restart:
      exclude: /static/**,/templates/**

另一方面,如果你想彻底关闭自动重启,可以将spring.devtools.restart.enabled设置为false

spring:
  devtools:
    restart:
      enabled: false

另外,还可以设置一个触发文件,必须修改这个文件才能触发重启。例如,在修改名为.trigger的文件前你都不希望执行重启,那么你只需像这样设置spring.devtools.restart.trigger-file属性:

spring:
  devtools:
    restart:
      trigger-file: .trigger

如果你的IDE会连续编译修改的文件,那触发文件还是很有用的。没有触发文件的话,每次变更都会触发重启。有触发文件,就能保证只有你想重启时才会发生重启(修改触发文件即可)。

##A.2 LiveReload

在Web应用程序开发过程中,最常见的步骤大致如下。

(1)修改要呈现的内容(比如图片、样式表、模板)。

(2)点击浏览器里的刷新按钮,查看修改的结果。

(3)回到第1步。

虽然这并不难,但如果能不点刷新就直接看到修改结果,那岂不是更好?

Spring Boot的开发者工具集成了LiveReload(http://livereload.com),可以消除刷新的步骤。激活开发者工具后,Spring Boot会启动一个内嵌的LiveReload服务器,在资源文件变化时会触发浏览器刷新。你要做的就是在浏览器里安装LiveReload插件。

如果想要禁用内嵌的LiveReload服务器,可以将spring.devtools.livereload.enabled设置为false

spring:
  devtools:
    livereload:
      enabled: false

##A.3 远程开发

在远程运行应用程序时(比如部署到服务器上或云上),开发者工具的自动重启和LiveReload特性都是可选的。此外,Spring Boot开发者工具还能远程调试Spring Boot应用程序。

在传统的开发过程中,你不会打开远程开发功能,因为这会影响性能。但在一些特殊的场景中,此类工具就很有用。比如,出于开发目的,所开发的应用程序部署在非生产环境里。如果你的应用程序不是在本地开发环境里,而是在云端部署,则尤其如此。

你必须设置一个远程安全码来开启远程开发功能:

spring:
  devtools:
    remote:
      secret: myappsecret

有了这个属性后,运行中的应用程序就会启动一个服务器组件以支持远程开发。它会监听接受变更的请求,可以重启应用程序或者触发浏览器刷新。

为了使用这个远程服务器,你需要在本地运行远程开发工具的客户端。这个远程客户端是一个类,全限定类名是org.springframework.boot.devtools.RemoteSpringApplication。它会运行在IDE里,要求提供一个参数,告知远程应用程序部署在哪里。

例如,假设你正远程运行阅读列表应用程序,部署在Cloud Foundry上,地址是https://readinglist.cfapps.io。如果你正在使用Eclipse或Spring ToolSuite,可以通过如下步骤开启远程客户端。

(1)选择Run > Run Configurations菜单项。 (2)创建一个新的Java Application运行配置。 (3)在Project里选中Reading List项目(可以键入项目名或者点击Browse按钮找到这个项目,见图A-1)。 (4)在Main Class里键入org.springframework.boot.devtools.RemoteSpringApplication(见图A-1)。 (5)切换到Arguments标签页,在Program Arguments里键入https://readinglist.cfapps.io(见图A-2)。

P184图

图A-1 RemoteSpringApplication是远程开发者工具客户端。

图A.2

图A-2 RemoteSpringApplication将远程应用程序的URL作为参数。

客户端启动后,就可以在IDE里修改应用程序了。在检测到变动后,这些修改点会被推送到远端并加以应用。如果修改的内容涉及呈现的Web资源(比如样式表或JavaScript),LiveReload还会触发浏览器刷新。

远程客户端还会开启基于HTTP的远程调试通道,这样就能在IDE里调试部署在远程的应用程序了。你要做的就是确保远程应用程序打开了远程调试功能。这通常可以通过配置JAVA_OPTS来实现。

比方说,你的应用程序部署在Cloud Foundry上,可以像下面这样在应用程序的manifest.yml里设置JAVA_OPTS

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

远程应用程序启动后,会和本地调试服务器建立一个连接。你可以设置断点,一步步执行远程应用程序里的代码,就好像它们运行在本地一样(出于网络原因,速度会有点慢)。

##A.3 默认的开发时属性

有些配置属性通常在开发时设置,从来不用在生产环境里。比如视图模板缓存,在开发时最好关掉,这样你可以立刻看到修改的结果。但在生产环境里,为了追求更好的性能,应该开启视图模版缓存。

默认情况下,Spring Boot会为其支持的各种视图模板(Thymeleaf、Freemarker、Velocity、Mustache和Groovy模板)开启缓存选项。但如果存在Spring Boot的开发者工具,这些缓存就会禁用。

实际上,这就是说在开发者工具激活后,如下属性会设置为false

  • spring.thymeleaf.cache
  • spring.freemarker.cache
  • spring.velocity.cache
  • spring.mustache.cache
  • spring.groovy.template.cache

这样一来,你就不用在开发时自己(在一个开发时使用的Profile配置里禁用)禁用它们了。

##A.4 全局配置开发者工具

你应该已经注意到了,在使用开发者工具时,你通常会在多个项目里使用相同的设置。举个例子,如果你使用了重启触发文件,那么你很可能在多个项目里都使用相同的触发文件名。相比在每个项目里重复开发者工具配置,对开发者工具做全局配置显得更方便一些。

要实现这个目的,可以在你的主目录(home directory)里创建一个名为.spring-boot-devtools.properties的文件。(请注意,文件名用“.”开头。)在那个文件里,你可以设置希望在多个项目里共享的各种开发者工具属性。

例如,假设你想把触发文件的名称设置为.trigger,在所有Spring Boot项目里禁用LiveReload。你可以创建一个.spring-boot-devtools.properties文件,包含如下内容:

spring.devtools.restart.trigger-file=.trigger
spring.devtools.livereload.enabled=false

要是你想覆盖这些配置,可以在每个项目的application.properties或application.yml文件里设置特定于每个项目的属性。

0
青年IT男

个人从事金融行业,就职过易极付、思建科技等重庆一流技术团队,目前就职于某网约车平台负责整个支付系统建设。自身对金融行业有强烈的爱好。同时也实践大数据、数据存储、自动化集成和部署、分布式微服务、响应式编程、人工智能等领域。

评论已关闭。

This site is protected by wp-copyrightpro.com