我想在springboot项目中创建一个aspectJ组件,它可以在存在@Loggable注释的任何地方,方法或类,或者两者都打印日志消息(将考虑方法)。
可记录注释:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface Loggable {
boolean duration() default false;
}
Aspectj类:
@Aspect
@Component
public class LogInterceptorAspect {
@Pointcut("execution(public * ((@Loggable *)+).*(..)) && within(@Loggable *)")
public boolean loggableDefinition(Loggable loggable) {
return loggable.duration();
}
@Around("loggableDefinition(withDuration)")
public void log(ProceedingJoinPoint joinPoint, boolean withDuration) throws Throwable {
getLogger(joinPoint).info("start {}", joinPoint.getSignature().getName());
StopWatch sw = new StopWatch();
Object returnVal = null;
try {
sw.start();
returnVal = joinPoint.proceed();
} finally {
sw.stop();
}
getLogger(joinPoint).info("return value: {}, duration: {}", returnVal, sw.getTotalTimeMillis()));
}
private Logger getLogger(JoinPoint joinPoint) {
return LoggerFactory.getLogger(joinPoint.getSignature().getDeclaringType());
}
}
上面的代码我得到了
java.lang.IllegalArgumentException:切入点处的:: 0正式未绑定错误
出了什么问题?
答案 0 :(得分:1)
基本上,形式参数在PointCut上未绑定。
以下是基于本文详述的方法的替代工作示例:@AspectJ Class level Annotation Advice with Annotation as method argument
由于以下几个原因,我稍微修改了您的方法以避免此问题:
简化了最初的PointCut并赋予它一个单一的责任
将建议分解为两个更简单的方法,每个方法都有一个易于理解的责任
添加了单元测试的开始以验证预期的行为,以便可以负责地对PointCut和Advice表达式进行更改(您应该完成它)
使用PointCut / Advice Expressions时,我通常会尝试尽可能使用最简单,最清晰的解决方案,并对其进行彻底的单元测试,以确保我所期望的行为是我得到的。下一个查看代码的人会很感激。
希望这有帮助。
package com.spring.aspects;
import static org.junit.Assert.assertEquals;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.util.StopWatch;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@RunWith(SpringRunner.class)
@ContextConfiguration(classes = AspectInjectAnnotationTest.TestContext.class)
public class AspectInjectAnnotationTest {
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
public @interface Loggable {
boolean duration() default false;
}
@Aspect
public static class LogInterceptorAspect {
@Pointcut("execution(public * *(..))")
public void anyPublicMethod() {
}
@Around("anyPublicMethod() && @annotation(loggable)")
public Object aroundLoggableMethods(ProceedingJoinPoint joinPoint, Loggable loggable) throws Throwable {
return log(joinPoint, loggable);
}
@Around("(anyPublicMethod() && !@annotation(AspectInjectAnnotationTest.Loggable)) && @within(loggable)")
public Object aroundPublicMethodsOnLoggableClasses(ProceedingJoinPoint joinPoint, Loggable loggable)
throws Throwable {
return log(joinPoint, loggable);
}
public Object log(ProceedingJoinPoint joinPoint, Loggable loggable) throws Throwable {
getLogger(joinPoint).info("start [{}], duration [{}]", joinPoint.getSignature().getName(),
loggable.duration());
StopWatch sw = new StopWatch();
Object returnVal = null;
try {
sw.start();
returnVal = joinPoint.proceed();
} finally {
sw.stop();
}
getLogger(joinPoint).info("return value: [{}], duration: [{}]", returnVal, sw.getTotalTimeMillis());
return returnVal;
}
private Logger getLogger(JoinPoint joinPoint) {
return LoggerFactory.getLogger(joinPoint.getSignature().getDeclaringType());
}
}
// class level annotation - should only proxy public methods
@Loggable(duration = true)
public static class Service1 {
// public - should be proxied
public String testS1M1(String test) {
return testProtectedM(test);
}
// public - should be proxied
public String testS1M2(String test) {
return testProtectedM(test);
}
// protected - should not be proxied
protected String testProtectedM(String test) {
return testPrivateM(test);
}
// private - should not be proxied
private String testPrivateM(String test) {
return test;
}
}
// no annotation - class uses method level
public static class Service2 {
@Loggable
public String testS2M1(String test) {
return protectedMethod(test);
}
// no annotation - should not be proxied
public String testS2M2(String test) {
return protectedMethod(test);
}
// protected - should not be proxied
protected String protectedMethod(String test) {
return testPrivate(test);
}
// private - should not be proxied
private String testPrivate(String test) {
return test;
}
}
// annotation - class and method level - make sure only call once
@Loggable
public static class Service3 {
@Loggable
public String testS3M1(String test) {
return test;
}
}
// context configuration for the test class
@Configuration
@EnableAspectJAutoProxy
public static class TestContext {
// configure the aspect
@Bean
public LogInterceptorAspect loggingAspect() {
return new LogInterceptorAspect();
}
// configure a proxied beans
@Bean
public Service1 service1() {
return new Service1();
}
// configure a proxied bean
@Bean
public Service2 service2() {
return new Service2();
}
// configure a proxied bean
@Bean
public Service3 service3() {
return new Service3();
}
}
@Autowired
private Service1 service1;
@Autowired
private Service2 service2;
@Autowired
private Service3 service3;
@Test
public void aspectShouldLogAsExpected() {
// observe the output in the log, but craft this into specific
// unit tests to assert the behavior you are expecting.
assertEquals("service-1-method-1", service1.testS1M1("service-1-method-1")); // expect logging
assertEquals("service-1-method-2", service1.testS1M2("service-1-method-2")); // expect logging
assertEquals("service-2-method-1", service2.testS2M1("service-2-method-1")); // expect logging
assertEquals("service-2-method-2", service2.testS2M2("service-2-method-2")); // expect no logging
assertEquals("service-3-method-1", service3.testS3M1("service-3-method-1")); // expect logging once
}
}