Spring Boot Actuator中"templated":false的含义及相关问题

1. "templated":false的含义 #

templated:false表示当前Actuator端点的URL是固定无动态参数的，不存在需要客户端填充的路径占位符（比如{id}、{userId}这类模板变量）。例如默认的/actuator/health、/actuator/info都是固定路径，没有可变部分，所以对应的templated值为false。

2. 该字段的作用 #

这个字段是给调用Actuator的客户端（监控工具、API文档工具、自定义监控脚本等）提供元数据：

• 明确告知客户端该端点的URL无需动态拼接参数，直接使用返回的固定URL即可发起请求
• 避免客户端无效尝试解析不存在的路径变量，减少错误请求
• 帮助自动化工具正确生成请求地址，比如API文档工具可以根据templated值判断是否需要展示参数输入框

3. 该字段的使用与解读场景 #

服务端生成 #

在Spring Boot内部，templated字段由Actuator的端点链接解析组件生成：当端点注册时，框架会检查端点的URL是否包含路径变量，无变量则设为false，有变量则设为true，最终随/actuator端点的链接列表返回给客户端。

客户端解读 #

• 监控工具（如Spring Boot Admin）读取该字段，判断是否需要为端点提供参数输入界面
• 自定义监控客户端根据templated值决定请求方式：false则直接发起GET请求到固定URL，true则需要先填充路径变量再请求
• API文档生成工具利用该字段自动识别端点是否为带参数的模板URL，生成对应的文档描述

4. 如何将其值改为true #

只有当Actuator端点的URL包含路径模板变量时，templated值才会变为true。实现方式是创建带路径变量的自定义Actuator端点：

步骤1：定义自定义端点 #

import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;

@Component
@Endpoint(id = "user-info")
public class UserInfoEndpoint {

    // 定义带路径变量的读取操作
    @ReadOperation(path = "/{userId}")
    public String getUserDetails(String userId) {
        return "User ID: " + userId + ", Status: Active";
    }
}

步骤2：暴露自定义端点 #

在application.properties中配置暴露该端点：

# 暴露自定义的user-info端点及常用默认端点
management.endpoints.web.exposure.include=user-info,health,info

验证 #

启动应用后访问/actuator，会看到user-info端点的链接信息：

{
  "_links": {
    "user-info": {
      "href": "http://localhost:8080/actuator/user-info/{userId}",
      "templated": true
    }
  }
}

内容的提问来源于stack exchange，提问作者Manuel Jordan