Spring Boot Micrometer：如何为抽象控制器实现类配置动态计时指标名

当然可以为每个实现类生成如modela_controller_search这类自定义的计时指标名称，下面提供几种可行的实现方式：

方案一：利用SpEL动态生成指标名 #

直接在抽象类的@Timed注解中使用Spring表达式语言（SpEL），动态获取子类的类信息来拼接指标名称。修改抽象类的注解配置：

public abstract class GenericController<T> {

    @Timed(value = "#{T(org.springframework.util.StringUtils).uncapitalize(getClass().getSimpleName().replace('Controller', ''))}_controller_get_one", 
           description = "Time taken to getOne")
    public T getOne(ID id) {
        // 业务逻辑实现
    }

    @Timed(value = "#{T(org.springframework.util.StringUtils).uncapitalize(getClass().getSimpleName().replace('Controller', ''))}_controller_search", 
           description = "Time taken to search")
    public Page<T> search(int page, int size) {
        // 业务逻辑实现
    }
}

该方案通过SpEL解析子类类名，去掉Controller后缀并转为小写，再拼接固定后缀生成专属指标名，无需修改子类代码。

方案二：子类重写方法并指定自定义@Timed注解 #

在每个实现控制器中重写抽象类的方法，重新标注@Timed注解并指定自定义指标名称：

@RestController
public class ModelAController extends GenericController<ModelA> {

    @Override
    @Timed(value = "modela_controller_get_one", description = "Time taken to getOne for ModelA")
    public ModelA getOne(ID id) {
        return super.getOne(id);
    }

    @Override
    @Timed(value = "modela_controller_search", description = "Time taken to search for ModelA")
    public Page<ModelA> search(int page, int size) {
        return super.search(page, size);
    }
}

这种方式逻辑直观，但每个子类都需要重复重写方法，适合子类数量较少的场景。

方案三：自定义注解+切面实现动态指标 #

通过自定义注解结合AOP切面，统一处理计时逻辑并动态生成指标名：

1. 定义自定义注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ControllerTimed {
    String operation(); // 指定操作类型：get_one、search等
}

2. 修改抽象类使用自定义注解

public abstract class GenericController<T> {

    @ControllerTimed(operation = "get_one")
    public T getOne(ID id) {
        // 业务逻辑实现
    }

    @ControllerTimed(operation = "search")
    public Page<T> search(int page, int size) {
        // 业务逻辑实现
    }
}

3. 编写切面处理计时逻辑

@Aspect
@Component
public class ControllerTimedAspect {
    private final MeterRegistry meterRegistry;

    public ControllerTimedAspect(MeterRegistry meterRegistry) {
        this.meterRegistry = meterRegistry;
    }

    @Around("@annotation(controllerTimed)")
    public Object timedOperation(ProceedingJoinPoint joinPoint, ControllerTimed controllerTimed) throws Throwable {
        // 解析子类类名并处理格式
        String controllerSimpleName = joinPoint.getTarget().getClass().getSimpleName();
        String controllerName = controllerSimpleName.toLowerCase().replace("controller", "");
        // 拼接指标名称
        String metricName = String.format("%s_controller_%s", controllerName, controllerTimed.operation());
        
        // 创建并注册Timer，执行计时
        Timer timer = Timer.builder(metricName)
                .description("Time taken to " + controllerTimed.operation())
                .register(meterRegistry);
        
        return timer.record(joinPoint::proceed);
    }
}

该方案无需修改子类，通过切面统一管理计时逻辑，扩展性强，适合子类数量较多的场景。

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