0

0

Spring Boot Actuator /info 端点应用版本信息配置指南

DDD

DDD

发布时间:2025-10-01 10:43:15

|

574人浏览过

|

来源于php中文网

原创

spring boot actuator /info 端点应用版本信息配置指南

本教程详细阐述如何在 Spring Boot 3 应用中配置 Actuator 的 /info 端点,以展示应用程序的版本、名称和描述等核心信息。通过正确配置 pom.xml 依赖、application.yml 文件以及可选的 Spring Security 规则,开发者可以轻松地将 Maven 项目元数据动态集成到 /info 响应中,从而实现应用信息的便捷监控。

1. 理解 Spring Boot Actuator 的 /info 端点

Spring Boot Actuator 提供了一系列生产就绪型功能,帮助监控和管理应用程序。其中 /info 端点用于显示应用程序的通用信息,例如版本、名称、描述等。默认情况下,如果未进行特定配置,访问此端点可能只会返回一个空的 JSON 对象 {}。为了让它显示有用的信息,我们需要进行相应的配置。

2. 添加 Actuator 依赖

首先,确保您的 Maven 项目中已正确引入 Spring Boot Actuator 的依赖。对于 Spring Boot 3 及以上版本,推荐使用 spring-boot-starter-actuator,它包含了 Actuator 的核心功能。


    org.springframework.boot
    spring-boot-starter-actuator

注意事项:

  • 避免同时引入 spring-boot-actuator 和 spring-boot-starter-actuator,后者是前者的一个启动器,包含了所有必要依赖。
  • 确保您的 pom.xml 中配置了正确的 Spring Boot 父项目,以便管理依赖版本。

3. 配置 application.yml 文件

application.yml 是配置 Actuator /info 端点显示内容的关键。我们需要启用 info 端点,并指定要显示的应用元数据。通过使用 Maven 属性占位符,我们可以动态地从 pom.xml 中获取项目信息。

management:
  info:
    env:
      enabled: true # 启用环境信息,通常包含构建和Git信息(如果配置)
  endpoints:
    web:
      exposure:
        include: info # 明确暴露 'info' 端点
      base-path: /public/actuator # (可选) 自定义 Actuator 端点的基础路径

info:
  application:
    name: '@project.name@' # 从 pom.xml 获取项目名称
    description: '@project.description@' # 从 pom.xml 获取项目描述
    version: '@project.version@' # 从 pom.xml 获取项目版本

配置说明:

  • management.info.env.enabled: true:这个配置允许 Actuator 收集并显示一些环境相关的信息,例如构建信息、Git 信息等。
  • management.endpoints.web.exposure.include: info:Spring Boot 默认情况下不暴露所有 Actuator 端点。此配置明确指定要暴露 info 端点。
  • management.endpoints.web.base-path: /public/actuator:这是一个可选配置,用于更改 Actuator 端点的默认基础路径 /actuator。如果您选择更改,请确保后续访问路径与此一致。
  • info.application.*:这是自定义信息部分。@project.name@、@project.description@ 和 @project.version@ 是 Maven 过滤属性的占位符。在 Maven 构建过程中,这些占位符会被 pom.xml 中定义的 字段的值自动替换。

4. Spring Security 配置(如果使用)

如果您的应用程序集成了 Spring Security,并且您自定义了 Actuator 的基础路径(如 /public/actuator),那么您需要明确允许对这些公共 Actuator 端点的访问,否则它们可能会被安全拦截。

BgSub
BgSub

免费的AI图片背景去除工具

下载

以下是一个示例 SecurityFilterChain 配置,允许对 /public/** 路径的 GET 请求进行未认证访问:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpMethod;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.web.SecurityFilterChain;

@Configuration
public class SecurityConfig {

    @Bean
    public SecurityFilterChain filterChain(HttpSecurity httpSecurity) throws Exception {
        httpSecurity
            // ... 其他安全配置
            .authorizeHttpRequests(customizer -> customizer
                // 允许对 /public/** 路径的 GET 请求进行未认证访问
                .requestMatchers(HttpMethod.GET, "/public/**").permitAll()
                // ... 其他授权规则
                .anyRequest().authenticated() // 其他所有请求需要认证
            );
            // ... 其他安全配置,例如 CSRF 禁用等

        return httpSecurity.build();
    }
}

注意事项:

  • 如果您没有使用 Spring Security,或者您的 Actuator 端点仍使用默认路径 /actuator 且未被其他安全机制保护,则可以跳过此步骤。
  • 请根据您的实际安全策略调整 requestMatchers 规则。

5. 测试应用程序

完成上述配置后,重新启动您的 Spring Boot 应用程序。然后,在浏览器或使用 API 工具(如 Postman)访问 Actuator 的 /info 端点。

如果您的 base-path 配置为 /public/actuator 且应用程序运行在 http://localhost:8080,则访问 URL 为: http://localhost:8080/public/actuator/info

您应该会看到一个 JSON 响应,其中包含 pom.xml 中定义的应用程序名称、描述和版本信息,例如:

{
  "application": {
    "name": "My Spring Sample Application",
    "description": "A sample Spring Boot application",
    "version": "1.0.0-SNAPSHOT"
  },
  "env": {
    // ... 其他环境信息,如构建时间、Git commit ID等
  }
}

通过以上步骤,您已经成功配置了 Spring Boot Actuator 的 /info 端点,使其能够动态展示应用程序的核心元数据。这对于应用程序的监控和管理提供了极大的便利。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

98

2025.08.06

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

135

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

384

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

61

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

8

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

101

2025.12.24

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

402

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

vlookup函数使用大全
vlookup函数使用大全

本专题整合了vlookup函数相关 教程,阅读专题下面的文章了解更多详细内容。

28

2025.12.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号