@AspectJ pointcut для всех методов класса с определенной аннотацией

127

Я хочу отслеживать все общедоступные методы всех классов с указанной аннотацией (например, @Monitor) (примечание: аннотация находится на уровне класса). Что может быть для этого возможным? Примечание. Я использую Spring AOP в стиле @AspectJ.

Реджив Дивакаран
источник
Нижеследующий работает в большей степени. @Pointcut ("исполнение (* (@ org.rejeev.Monitor *). * (..))") Однако теперь совет выполняется дважды. Есть подсказка?
Rejeev Divakaran
Еще один момент заключается в том, что аннотация @Monitor находится на интерфейсе, и класс реализует это. Приведет ли наличие интерфейса и класса к двойному выполнению такого совета?
Rejeev Divakaran 06
6
Вы должны принять отличный ответ ниже. Это дает ему репутацию. На SO очень мало людей, которые могут ответить на вопросы AspectJ.
fool4jesus

Ответы:

164

Вы должны комбинировать тип pointcut с методом pointcut.

Эти pointcuts выполнят работу по поиску всех общедоступных методов внутри класса, отмеченного аннотацией @Monitor:

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

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

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

Посоветуйте последний pointcut, который объединяет первые два, и готово!

Если вам интересно, я написал шпаргалку со стилем @AspectJ здесь с соответствующим примером документа здесь.

Эспен
источник
Спасибо. Обсуждение точек аннотаций в шпаргалке особенно полезно.
GregHNZ
1
Как мне получить ссылку на класс в совете, как я делаю с обычными подсказками pointcut @Before ("onObjectAction () && this (obj)")
Приядарши Кунал
Шпаргалка была очень полезна, хотя прошло уже 5 лет :)
Яду Кришнан
Просто вопрос, если два метода, которые находятся в иерархии, и оба подпадают под pointcut и принадлежат к одному классу, будет ли это выполняться на обоих? Если да, см. Stackoverflow.com/questions/37583539/… , потому что в моем случае этого не происходит.
HVT7 02
Я считаю, что публичное выполнение является избыточным, потому что у вас не может быть pointcut для частных методов
амстеграф
58

Используя аннотации, как описано в вопросе.

Аннотация: @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>
Alex
источник
1
Хороший пример. Один вопрос: почему аннотация Monitorдолжна быть Spring Component?
mwhs
1
ComponentАннотаций используется , чтобы сообщить пружинный контейнер для применения включают класс в AspectJ ткач вещи. По умолчанию Spring просматривает только Controller, Serviceи другие конкретные аннотации, но не Aspect.
Alex
1
Хорошо, спасибо. Но я говорил об @Componentаннотации @interfaceне к файлу Aspect. Зачем это нужно?
mwhs
2
В @Componentаннотации указано, что Spring скомпилирует его с аспектно-ориентированной системой AspectJ IoC / DI. Не знаю, как сказать по-другому. docs.spring.io/spring/docs/3.2.x/spring-framework-reference/…
Alex
Это относится только к «общедоступным» методам в аннотированных классах или ко всем методам (независимо от уровня доступа)?
Ли Мидор
14

Что-то такое:

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

Обратите внимание, что у вас не должно быть никаких других советов по тому же классу перед этим, потому что аннотации будут потеряны после проксирования.

Bozho
источник
11

использование

@Before("execution(* (@YourAnnotationAtClassLevel *).*(..))")
    public void beforeYourAnnotation(JoinPoint proceedingJoinPoint) throws Throwable {
}
Давиде Консонни
источник
4

этого должно быть достаточно, чтобы пометить ваш метод аспекта следующим образом:

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

Взгляните на это, чтобы получить пошаговое руководство по этому поводу.

marcocast
источник
3

Вы также можете определить pointcut как

public pointcut publicMethodInsideAClassMarkedWithAtMonitor() : execution(public * (@Monitor *).*(..));
Шекхар
источник
execution(public * @Monitor *.*(..))Работает и попроще .
xmedeko
3

Кажется, самый простой способ:

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

   return pjp.proceed();

   // perform actions after
}

Он перехватит выполнение всех методов, специально помеченных @MyHandling в классе YourService. Чтобы перехватить все методы без исключения, просто поместите аннотацию прямо в класс.

Независимо от частной / общедоступной области, но имейте в виду, что spring-aop не может использовать аспект для вызовов методов в одном и том же экземпляре (обычно частные), потому что в этом случае он не использует прокси-класс.

Здесь мы используем совет @Around, но в основном это тот же синтаксис, что и @Before, @After или любой другой совет.

Кстати, аннотацию @MyHandling нужно настроить так:

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

}
Донателло
источник
который не соответствует исходному утверждению, с ElementType.Type
Alex
да, ElementType.TYPE также позволит помещать аннотации непосредственно в классы, что, как я полагаю, приведет к обработке любого метода в этом классе. Я правда? Это действительно работает?
Донателло
// perform actions afterНикогда не дозвонились , так как мы возвращаем значение в строке перед.
josephpconley
1

Вы можете использовать Spring PerformanceMonitoringInterceptor и программно зарегистрировать совет с помощью постпроцессора beanpost.

@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

Из Spring's 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 *);
xmedeko
источник