web-dev-qa-db-ja.com

特定のアノテーションを持つクラスのすべてのメソッドの@AspectJポイントカット

指定した注釈（@Monitorなど）を使用して、すべてのクラスのすべてのパブリックメソッドを監視したい（注：注釈はクラスレベルにあります）。これの可能なポイントカットは何でしょうか？注：@AspectJスタイルのSpring AOPを使用しています。

javaaopaspectjspring-aop
114
Rejeev Divakaran

タイプポイントカットとメソッドポイントカットを組み合わせる必要があります。

これらのポイントカットは、@ Monitorアノテーションでマークされたクラス内のすべてのパブリックメソッドを見つける作業を行います。

@Pointcut("within(@org.rejeev.Monitor *)")
public void beanAnnotatedWithMonitor() {}

@Pointcut("execution(public * *(..))")
public void publicMethod() {}

@Pointcut("publicMethod() && beanAnnotatedWithMonitor()")
public void publicMethodInsideAClassMarkedWithAtMonitor() {}

最初の2つを組み合わせた最後のポイントカットをアドバイスすれば完了です！

興味のある方は、 チートシート を@AspectJスタイルで、対応する サンプルドキュメント をここに書いています。

151
Espen

質問で説明されているように、注釈を使用します。

注釈：@Monitor

クラスの注釈、app/PagesController.Java：

package app;
@Controller
@Monitor
public class PagesController {
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public @ResponseBody String home() {
        return "w00t!";
    }
}

メソッドの注釈、app/PagesController.Java：

package app;
@Controller
public class PagesController {
    @Monitor
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public @ResponseBody String home() {
        return "w00t!";
    }
}

カスタムアノテーション、app/Monitor.Java：

package app;
@Component
@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
public @interface Monitor {
}

注釈のアスペクト、app/MonitorAspect.Java：

package app;
@Component
@Aspect
public class MonitorAspect {
    @Before(value = "@within(app.Monitor) || @annotation(app.Monitor)")
    public void before(JoinPoint joinPoint) throws Throwable {
        LogFactory.getLog(MonitorAspect.class).info("monitor.before, class: " + joinPoint.getSignature().getDeclaringType().getSimpleName() + ", method: " + joinPoint.getSignature().getName());
    }

    @After(value = "@within(app.Monitor) || @annotation(app.Monitor)")
    public void after(JoinPoint joinPoint) throws Throwable {
        LogFactory.getLog(MonitorAspect.class).info("monitor.after, class: " + joinPoint.getSignature().getDeclaringType().getSimpleName() + ", method: " + joinPoint.getSignature().getName());
    }
}

AspectJ、servlet-context.xmlを有効にします。

<aop:aspectj-autoproxy />

AspectJライブラリを含める、pom.xml：

<artifactId>spring-aop</artifactId>
<artifactId>aspectjrt</artifactId>
<artifactId>aspectjweaver</artifactId>
<artifactId>cglib</artifactId>
54
Alex

そんな感じ：

@Before("execution(* com.yourpackage..*.*(..))")
public void monitor(JoinPoint jp) {
    if (jp.getTarget().getClass().isAnnotationPresent(Monitor.class)) {
       // perform the monitoring actions
    }
}

同じクラスについて他のアドバイスを持ってはいけないことに注意してくださいbeforeこれは、プロキシ化後にアノテーションが失われるためです。

13
Bozho

つかいます

@Before("execution(* (@YourAnnotationAtClassLevel *).*(..))")
    public void beforeYourAnnotation(JoinPoint proceedingJoinPoint) throws Throwable {
}
6
Davide Consonni

次のようにポイントカットを定義することもできます

public pointcut publicMethodInsideAClassMarkedWithAtMonitor() : execution(public * (@Monitor *).*(..));
3
Shekhar

次のようにアスペクトメソッドをマークすれば十分です。

@After("@annotation(com.marcot.CommitTransaction)")
    public void after() {

これに関するステップバイステップガイドについては、 this をご覧ください。

3
marcocast

最も簡単な方法は次のようです：

@Around("execution(@MyHandling * com.exemple.YourService.*(..))")
public Object aroundServiceMethodAdvice(final ProceedingJoinPoint pjp)
   throws Throwable {
   // perform actions before

   return pjp.proceed();

   // perform actions after
}

「YourService」クラスの「@MyHandling」で特に注釈が付けられたすべてのメソッドの実行をインターセプトします。すべてのメソッドを例外なくインターセプトするには、クラスに直接アノテーションを配置します。

ここでのプライベート/パブリックスコープに関係なく、spring-aopはこの場合プロキシクラスを使用しないため、同じインスタンス（通常はプライベートインスタンス）のメソッド呼び出しにアスペクトを使用できないことに注意してください。

ここでは@Aroundアドバイスを使用しますが、基本的には@ Before、@ Afterまたはその他のアドバイスと同じ構文です。

ちなみに、@ MyHandlingアノテーションは次のように設定する必要があります。

@Retention(RetentionPolicy.RUNTIME)
@Target( { ElementType.METHOD, ElementType.TYPE })
public @interface MyHandling {

}
2
Donatello

SpringのAnnotationTransactionAspectから：

/**
 * Matches the execution of any public method in a type with the Transactional
 * annotation, or any subtype of a type with the Transactional annotation.
 */
private pointcut executionOfAnyPublicMethodInAtTransactionalType() :
    execution(public * ((@Transactional *)+).*(..)) && within(@Transactional *);
1
xmedeko

SpringのPerformanceMonitoringInterceptorを使用し、beanpostprocessorを使用してプログラムでアドバイスを登録できます。

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Monitorable
{

}


public class PerformanceMonitorBeanPostProcessor extends ProxyConfig implements BeanPostProcessor, BeanClassLoaderAware, Ordered,
    InitializingBean
{

  private Class<? extends Annotation> annotationType = Monitorable.class;

  private ClassLoader beanClassLoader = ClassUtils.getDefaultClassLoader();

  private Advisor advisor;

  public void setBeanClassLoader(ClassLoader classLoader)
  {
    this.beanClassLoader = classLoader;
  }

  public int getOrder()
  {
    return LOWEST_PRECEDENCE;
  }

  public void afterPropertiesSet()
  {
    Pointcut pointcut = new AnnotationMatchingPointcut(this.annotationType, true);
    Advice advice = getInterceptor();
    this.advisor = new DefaultPointcutAdvisor(pointcut, advice);
  }

  private Advice getInterceptor()
  {
    return new PerformanceMonitoringInterceptor();
  }

  public Object postProcessBeforeInitialization(Object bean, String beanName)
  {
    return bean;
  }

  public Object postProcessAfterInitialization(Object bean, String beanName)
  {
    if(bean instanceof AopInfrastructureBean)
    {
      return bean;
    }
    Class<?> targetClass = AopUtils.getTargetClass(bean);
    if(AopUtils.canApply(this.advisor, targetClass))
    {
      if(bean instanceof Advised)
      {
        ((Advised)bean).addAdvisor(this.advisor);
        return bean;
      }
      else
      {
        ProxyFactory proxyFactory = new ProxyFactory(bean);
        proxyFactory.copyFrom(this);
        proxyFactory.addAdvisor(this.advisor);
        return proxyFactory.getProxy(this.beanClassLoader);
      }
    }
    else
    {
      return bean;
    }
  }
}
1
Vikram