Spring Boot 的更多 DevOps

一则或许对你有用的小广告

欢迎加入小哈的星球 ,你将获得:专属的项目实战 / Java 学习路线 / 一对一提问 / 学习打卡/ 赠书活动

目前,正在 星球 内带小伙伴们做第一个项目:全栈前后端分离博客项目,采用技术栈 Spring Boot + Mybatis Plus + Vue 3.x + Vite 4手把手,前端 + 后端全栈开发,从 0 到 1 讲解每个功能点开发步骤,1v1 答疑,陪伴式直到项目上线,目前已更新了 204 小节,累计 32w+ 字,讲解图:1416 张,还在持续爆肝中,后续还会上新更多项目,目标是将 Java 领域典型的项目都整上,如秒杀系统、在线商城、IM 即时通讯、权限管理等等,已有 870+ 小伙伴加入,欢迎点击围观

我认为 Spring Boot 带来了一些新的东西,尤其是关于 DevOps 的——我已经写了一篇 关于它的文章 。然而,不仅仅是指标和健康检查。

在我之前的 一篇博文中,我描述了如何为 Maven 构建的应用程序提供版本控制信息。本文将描述如何在使用 Spring Boot 时不需要这篇文章。

提醒一下,只需在 POM 中添加 spring-boot-starter-actuator 依赖项,即可启用许多端点,其中包括:

  • /metrics 用于监控应用程序
  • /health 检查应用程序是否可以提供预期的服务
  • /bean 列出上下文中的所有 Spring bean
  • /configprops 列出有关运行配置文件的所有属性(如果有)

其中,其中一个特别令人感兴趣: /info 。默认情况下,它不显示任何内容——或者更准确地说,是一个空 JSON 对象的字符串表示形式。

但是,在 application.properties 文件中设置的任何属性(或其配置文件风格之一)都将找到进入页面的方式。例如:

属性文件
输出
钥匙 价值
信息.应用程序名称 我的演示应用

 {
  "application" : {
    "name" : "My Demo App"
  }
}



设置静态信息当然很好,但我们的目标是在 Spring Boot 中获取我的应用程序的版本。 application.properties 文件在 process-resources 构建阶段由 Spring Boot 自动过滤。可以使用 POM 中的任何属性:它只需要设置在 @ 字符之间。例如:


属性文件
输出
钥匙 价值
信息.应用.版本 @项目.版本@

 {
  "application" : {
    "name" : "My Demo App"
  }
}






请注意,Spring Boot Maven 插件将删除生成的资源,因此应用程序将使用源中 未过滤的 资源属性文件。为了保留(和使用)生成的资源,请像这样在 POM 中配置插件:


 {
  "application" : {
    "name" : "My Demo App"
  }
}

至此,我们有了与上一篇文章相同的内容,但我们可以走得更远。 maven-git-commit-id-plugin 将生成一个 git.properties 填充所有可能的 git 相关信息。以下片段是生成文件的示例:


 {
  "application" : {
    "name" : "My Demo App"
  }
}

从所有这些数据中,端点中仅使用了以下内容:


钥匙 输出
git.分支

 {
  "application" : {
    "name" : "My Demo App"
  }
}


git.commit.id
git.commit.time


由于路径和格式是一致的,您可以设计一个 cronjob 来解析您的所有应用程序,并为每个服务器/环境生成一个包含所有这些信息的 wiki 页面。不再需要通过 ssh 服务器并深入文件系统来发现版本。

因此, /info 端点可以成为您组织中非常强大的资产,无论您自己是 DevOps 还是只愿意帮助您的 Ops。可以在 Spring Boot 文档 中找到更多详细信息。