如何在Feign调用中使用AOP

Question

我对如何在AOP中使用Feign客户端很感兴趣。例如：

API：

public interface LoanClient {
@RequestLine("GET /loans/{loanId}")
@MeteredRemoteCall("loans")
Loan getLoan(@Param("loanId") Long loanId);
}

配置：

@Aspect
@Component // Spring Component annotation
public class MetricAspect {
@Around(value = "@annotation(annotation)", argNames = "joinPoint, annotation")
public Object meterRemoteCall(ProceedingJoinPoint joinPoint, 
MeteredRemoteCall annotation) throws Throwable {
// do something
}
}

但是我不知道如何"拦截"api方法调用。我哪里错了？

更新：

My Spring类注释：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface MeteredRemoteCall {
String serviceName();
}

Answer 1

您的情况有些复杂，因为您有几个问题：

• 您使用Spring AOP，这是一个基于动态代理的"AOP lite"框架(JDK代理用于接口，CGLIB代理用于类)。它只适用于Springbeans/组件，但据我所见，您的LoanClient不是Spring@Component
• 即使是Spring组件，Feign也会通过反射创建自己的JDK动态代理。他们超出了斯普林的控制范围。可能有一种方法可以通过编程或XML配置手动将它们连接到Spring中。但在那里我不能帮助你，因为我不使用弹簧
• Spring AOP只支持AspectJ切入点的一个子集。具体来说，它不支持call()，而只支持execution()。也就是说，它只进入执行方法的地方，而不是调用方法的地方
• 但是执行发生在实现接口的方法中，并且接口方法(如@MeteredRemoteCall)上的注释永远不会被它们的实现类继承。事实上，方法注释在Java中从未继承过，只是从类(而不是接口！)到相应子类的类级注释。也就是说，即使注释类有一个@Inherited元注释，它对@Target({ElementType.METHOD})也没有帮助，只对@Target({ElementType.TYPE})有帮助更新：因为我以前已经回答过这个问题好几次了，所以我刚刚记录了这个问题，以及在使用AspectJ模拟接口和方法的注释继承中的一个解决方法

那么你能做什么呢？最好的选择是在Spring应用程序中通过LTW(加载时编织)使用完整的AspectJ。这使您能够使用call()切入点，而不是Spring AOP隐式使用的execution()。如果在AspectJ中的方法上使用@annotation()切入点，它将匹配调用和执行，正如我将在一个独立的示例中向您展示的那样(没有Spring，但效果与Spring中带有LTW的AspectJ相同)：

标记注释：

package de.scrum_master.app;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MeteredRemoteCall {}

Feign客户端：

这个示例客户端获取完整的StackOverflow问题页(HTML源代码)作为字符串。

package de.scrum_master.app;
import feign.Param;
import feign.RequestLine;
public interface StackOverflowClient {
@RequestLine("GET /questions/{questionId}")
@MeteredRemoteCall
String getQuestionPage(@Param("questionId") Long questionId);
}

驱动程序应用程序：

该应用程序以三种不同的方式使用Feign客户端接口进行演示：

1. 没有Feign，通过匿名子类手动实例化
2. 与#1类似，但这次在实现方法中添加了一个额外的标记注释
3. Feign的规范用法

package de.scrum_master.app;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import feign.Feign;
import feign.codec.StringDecoder;
public class Application {
public static void main(String[] args) {
StackOverflowClient soClient;
long questionId = 41856687L;
soClient = new StackOverflowClient() {
@Override
public String getQuestionPage(Long loanId) {
return "StackOverflowClient without Feign";
}
};
System.out.println("  " + soClient.getQuestionPage(questionId));
soClient = new StackOverflowClient() {
@Override
@MeteredRemoteCall
public String getQuestionPage(Long loanId) {
return "StackOverflowClient without Feign + extra annotation";
}
};
System.out.println("  " + soClient.getQuestionPage(questionId));
// Create StackOverflowClient via Feign
String baseUrl = "http://stackoverflow.com";
soClient = Feign
.builder()
.decoder(new StringDecoder())
.target(StackOverflowClient.class, baseUrl);
Matcher titleMatcher = Pattern
.compile("<title>([^<]+)</title>", Pattern.CASE_INSENSITIVE)
.matcher(soClient.getQuestionPage(questionId));
titleMatcher.find();
System.out.println("  " + titleMatcher.group(1));
}
}

没有方面的控制台日志：

StackOverflowClient without Feign
StackOverflowClient without Feign + extra annotation
java - How to use AOP with Feign calls - Stack Overflow

正如您所看到的，在案例#3中，它只是打印这个StackOverflow问题的问题标题我使用正则表达式匹配器是为了从HTML代码中提取它，因为我不想打印完整的网页。

方面：

这基本上是您使用附加连接点日志记录的方面。

package de.scrum_master.aspect;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import de.scrum_master.app.MeteredRemoteCall;
@Aspect
public class MetricAspect {
@Around(value = "@annotation(annotation)", argNames = "joinPoint, annotation")
public Object meterRemoteCall(ProceedingJoinPoint joinPoint, MeteredRemoteCall annotation)
throws Throwable
{
System.out.println(joinPoint);
return joinPoint.proceed();
}
}

带有方面的控制台日志：

call(String de.scrum_master.app.StackOverflowClient.getQuestionPage(Long))
StackOverflowClient without Feign
call(String de.scrum_master.app.StackOverflowClient.getQuestionPage(Long))
execution(String de.scrum_master.app.Application.2.getQuestionPage(Long))
StackOverflowClient without Feign + extra annotation
call(String de.scrum_master.app.StackOverflowClient.getQuestionPage(Long))
java - How to use AOP with Feign calls - Stack Overflow

正如您所看到的，对于三种情况中的每一种，都会截获以下连接点：

1. 只有call()，因为即使手动实例化，实现类也没有接口方法的注释。因此execution()无法匹配
2. call()和execution()都是因为我们手动将标记注释添加到实现类中
3. 只有call()，因为Feign创建的动态代理没有接口方法的注释。因此execution()无法匹配

我希望这能帮助你理解发生了什么以及为什么。

一句话：使用完整的AspectJ，让您的切入点与call()连接点相匹配。然后你的问题就解决了。

Answer 2

也许已经太晚了，但可以用一种更简单的方法来完成。你的代码是正确的，只是有一个小错误。您应该使用@inner而不是@annotation。我的意思是正确的代码是这样的：

@Aspect
@Component // Spring Component annotation
public class MetricAspect {
@Around(value = "@within(package.path.MeteredRemoteCall)", argNames = "joinPoint")
public Object meterRemoteCall(ProceedingJoinPoint joinPoint) throws Throwable {
// do something
}
}