在编译时使用注释处理器扩展类功能

Question

我有以下Spring Boot类，用自定义注释Counted注释：

@RestController
@RequestMapping("/identity")
public class IdentityController {

    @Autowired
    private IdentityService identityService;

    @PostMapping
    @Counted(value = "post_requests_identity")
    public Integer createIdentity() {
        return identityService.createIdentity();
    }
}

Counted注释定义如下：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface Counted {
    String value();
}

我想要的是编写一个注释处理器，有效地使我的控制器像下面的代码一样工作。

@RestController
@RequestMapping("/identity")
public class IdentityController {

    @Autowired
    private IdentityService identityService;

    @Autowired
    private PrometheusMeterRegistry registry;

    @PostConstruct
    public void init() {
        registry.counter("post_requests_identity");
    }

    @PostMapping
    public Integer createIdentity() {
        registry.counter("post_requests_identity").increment();
        return identityService.createIdentity();
    }
}

我已经能够在运行时通过反射实现这一点，但这大大延长了启动时间。有没有办法只使用注释和自定义注释处理器来实现上述功能？换句话说，我想创建一个注释，将带注释的方法添加到类中，并将任意方法调用添加到现有方法中。

我知道注释处理并不真正支持修改源代码。我有兴趣知道任何其他方法来执行上述操作，而不会将注册表及其相关代码直接放入源代码中。

Answer 1

您完全可以制作自己的拦截器或创建自己的PostProcencer。然而，Spring有一个很好的内置功能（另外，它实际上在框架周围都使用），称为Application Events。这是一个很好的小东西，通过一个很好的小抽象来利用DI和Spring作为总线，完全满足您的需求。（更多信息请参见这篇博客文章）。

从Application ation事件接受端，您可以有一个简单的设置：

// Create an ApplicationEvent type for your "count" event like so...
public class CountEvent extends ApplicationEvent {

    private String counterName;

    ...

}

// Create a class that accepts the count events and meters them...
@Component
public class MeterEventService {

    @Autowired
    private PrometheusMeterRegistry registry;

    @EventListener
    public void createIdentity(CountEvent countEvent) {
        String countedMethod = countEvent.getCounterName();
        registry.counter(countedMethod).increment();
    }
}

从发送端，您可以使用自定义注释轻松地从问题的结束处继续：

@Component
@Aspect
public class Mail {

    // Autowire in ApplicationContext
    private ApplicationContext applicationContext;

    @After("execution (@<package to annotation>.Counted * *(..))")
    public void countMetric(JoinPoint jp){
        MethodSignature signature = (MethodSignature) jp.getSignature();
        String method = signature.getMethod().getName();
        applicationContext.publishEvent(new CountEvent(method));
    }
}

我想这不是太多的代码，因为这样的功能非常方便。

此外，如果您更愿意使用@Counted中的值，而不是方法名称，则可以通过类似的方式提取注释。