与 Actuator 集成
生成构建信息
Spring Boot Actuator 的 info 端点在存在 META-INF/build-info.properties 文件时会自动发布有关构建的信息。提供了一个 BuildInfo 任务用于生成该文件。使用该任务最简单的方式是通过插件的 DSL:
- Groovy
- Kotlin
springBoot {
buildInfo()
}
springBoot {
buildInfo()
}
这将配置一个名为 bootBuildInfo 的 BuildInfo 任务,并且如果存在的话,会使 Java 插件的 classes 任务依赖于它。该任务的目标目录将是主源集资源输出目录(通常为 build/resources/main)中的 META-INF。
默认情况下,生成的构建信息来自项目:
| 属性 | 默认值 |
|---|---|
build.artifact | bootJar 或 bootWar 任务的基名称 |
build.group | 项目的 group |
build.name | 项目的名称 |
build.version | 项目的版本 |
build.time | 项目构建时的时间 |
可以使用 DSL 自定义这些属性:
- Groovy
- Kotlin
springBoot {
buildInfo {
properties {
artifact = 'example-app'
version = '1.2.3'
group = 'com.example'
name = 'Example application'
}
}
}
springBoot {
buildInfo {
properties {
artifact.set("example-app")
version.set("1.2.3")
group.set("com.example")
name.set("Example application")
}
}
}
要从生成的构建信息中排除任何默认属性,请将其名称添加到 excludes 中。例如,可以按如下方式排除 time 属性:
- Groovy
- Kotlin
springBoot {
buildInfo {
excludes = ['time']
}
}
springBoot {
buildInfo {
excludes.set(setOf("time"))
}
}
build.time 的默认值是项目构建时的时间点。这样做的一个副作用是该任务永远不会处于最新(up-to-date)状态,从而导致构建时间变长,因为更多的任务(包括项目的测试)都必须执行。另一个副作用是该任务的输出将始终发生变化,因此构建结果并非真正可重复。如果你更看重构建性能或可重复性,而非 build.time 属性的准确性,可以像前面示例中那样排除 time 属性。
还可以向构建信息中添加额外的属性:
- Groovy
- Kotlin
springBoot {
buildInfo {
properties {
additional = [
'a': 'alpha',
'b': 'bravo'
]
}
}
}
springBoot {
buildInfo {
properties {
additional.set(mapOf(
"a" to "alpha",
"b" to "bravo"
))
}
}
}
可以通过使用 Provider 来延迟计算一个附加属性的值。