如何在 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
  }
}

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

更新：

我的Springclass注释：

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

    String serviceName();
}

Answer 1

你的情况有点复杂，因为你有几个问题：

您使用 Spring AOP，一个基于动态代理的 "AOP lite" 框架（JDK 代理用于接口，CGLIB 代理用于 classes）。它仅适用于 Spring beans/components，但据我所知，您的 LoanClient 不是 Spring @Component.
即使它是一个 Spring 组件，Feign 也会通过反射创建自己的 JDK 动态代理。它们不受 Spring 的控制。可能有一种方法可以通过编程方式或通过 XML 配置手动将它们连接到 Spring。但是我帮不了你，因为我不使用 Spring.
Spring AOP 仅支持 AspectJ 切入点的子集。具体来说，它不支持call()，只支持execution()。 IE。它只编织到执行方法的地方，而不是调用方法的地方。
但是执行发生在一个实现接口的方法中，接口方法上的注释（例如您的 @MeteredRemoteCall 永远不会被它们的实现 class 继承。事实上，方法注释 never 在 Java 中继承，只有 class-level 注释从 class （不是接口！）到各自的子 class. IE。即使您的注释 class 有一个 @Inherited 元注释，它对 @Target({ElementType.METHOD}) 没有帮助，仅对 @Target({ElementType.TYPE}) 有帮助。 更新： 因为我之前已经多次回答过这个问题，所以我刚刚在 Emulate annotation inheritance for interfaces and methods with AspectJ.

那你能做什么？最好的选择是从 Spring 应用程序中 use full AspectJ via LTW （load-time 编织）。这使您能够使用 call() 切入点而不是 Spring AOP 隐式使用的 execution()。如果您在 AspectJ 中的方法上使用 @annotation() 切入点，它将同时匹配调用和执行，正如我将在 stand-alone 示例中向您展示的那样（没有 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 {}

伪装客户端：

此示例客户端以字符串形式抓取完整的 Whosebug 问题页面（HTML 源代码）。

package de.scrum_master.app;

import feign.Param;
import feign.RequestLine;

public interface WhosebugClient {
    @RequestLine("GET /questions/{questionId}")
    @MeteredRemoteCall
    String getQuestionPage(@Param("questionId") Long questionId);
}

Driver 申请：

此应用程序以三种不同的方式使用 Feign 客户端界面以进行演示：

没有Feign，通过匿名子手动实例化class
与#1 类似，但这次在实现方法中添加了额外的标记注释
通过 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) {
        WhosebugClient soClient;
        long questionId = 41856687L;

        soClient = new WhosebugClient() {
            @Override
            public String getQuestionPage(Long loanId) {
                return "WhosebugClient without Feign";
            }
        };
        System.out.println("  " + soClient.getQuestionPage(questionId));

        soClient = new WhosebugClient() {
            @Override
            @MeteredRemoteCall
            public String getQuestionPage(Long loanId) {
                return "WhosebugClient without Feign + extra annotation";
            }
        };
        System.out.println("  " + soClient.getQuestionPage(questionId));

        // Create WhosebugClient via Feign
        String baseUrl = "http://whosebug.com";
        soClient = Feign
            .builder()
            .decoder(new StringDecoder())
            .target(WhosebugClient.class, baseUrl);
        Matcher titleMatcher = Pattern
            .compile("<title>([^<]+)</title>", Pattern.CASE_INSENSITIVE)
            .matcher(soClient.getQuestionPage(questionId));
        titleMatcher.find();
        System.out.println("  " + titleMatcher.group(1));
    }
}

没有方面的控制台日志：

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

如您所见，在案例 #3 中，它只打印了这个 Whosebug 问题的标题。 ;-) 我正在使用正则表达式匹配器从 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.WhosebugClient.getQuestionPage(Long))
  WhosebugClient without Feign
call(String de.scrum_master.app.WhosebugClient.getQuestionPage(Long))
execution(String de.scrum_master.app.Application.2.getQuestionPage(Long))
  WhosebugClient without Feign + extra annotation
call(String de.scrum_master.app.WhosebugClient.getQuestionPage(Long))
  java - How to use AOP with Feign calls - Stack Overflow

如您所见，三种情况中的每一种都拦截了以下连接点：

只有 call() 因为即使手动实例化，实现 class 也没有接口方法的注释。所以execution()无法匹配到
call() 和 execution() 因为我们手动添加了标记注释到实现 class.
只有call()因为Feign创建的动态代理没有接口方法的注解。所以execution()无法匹配到

我希望这可以帮助您了解发生了什么以及为什么。

底线：使用完整的 AspectJ 以使切入点与 call() 连接点匹配。那么你的问题就解决了。

如何在 Feign 调用中使用 AOP

How to use AOP with Feign calls

java

aop

aspectj

spring-aop

feign