本次我们将使用Spring boot 和AOP 实现自定义注解,主要功能是自动打日志。
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解:
1.@Target,说明了Annotation所修饰的对象范围
2.@Retention,定义了该Annotation生命周期(编译/运行)
3.@Documented,是一个标记注解,没有成员
4.@Inherited,阐述了某个被标注的类型是被继承的。
这些类型和它们所支持的类在java.lang.annotation包中可以找到。
定义注解格式:
public @interface 注解名 {定义体}
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
我们先整体看一下代码架构:
代码:
/**
* 自定义注释
*/
@Target(ElementType.METHOD)
public @interface Log {
}
面向切面编程,也称为AOP(即Aspect Oriented Programming),指的是将一定的切面逻辑按照一定的方式编织到指定的业务模块中,从而将这些业务模块的调用包裹起来。如下是其结构示意图:
具体代码实现如下:
/**
* 注解实现
*/
@Aspect
@Component
@Slf4j
public class LogImp {
@Around("@annotation(com.nbst.annotation.Log)")
public void around(ProceedingJoinPoint joinPoint){
log.info("执行前1111");
try {
joinPoint.proceed();
}catch (Exception e){
} catch (Throwable throwable) {
throwable.printStackTrace();
}
log.info("执行后22222");
}
}
其中
@Aspect
表示这是一个切面类
@Around("@annotation(com.nbst.annotation.Log)")
里面表示在注解处环绕通知。
@Slf4j
是Lombok的关于slfj的简略写法。
重点及难点在于切点表达式:com.nbst.annotation.Log
由于Spring切面粒度最小是达到方法级别,而execution表达式可以用于明确指定方法返回类型,类名,方法名和参数名等与方法相关的部件,并且在Spring中,大部分需要使用AOP的业务场景也只需要达到方法级别即可,因而execution表达式的使用是最为广泛的。如下是execution表达式的语法:
execution(modifiers-pattern? ret-type-pattern declaring-type-pattern?name-pattern(param-pattern) throws-pattern?)
这里问号表示当前项可以有也可以没有,其中各项的语义如下:
modifiers-pattern:方法的可见性,如public,protected;
ret-type-pattern:方法的返回值类型,如int,void等;
declaring-type-pattern:方法所在类的全路径名,如com.spring.Aspect;
name-pattern:方法名类型,如buisinessService();
param-pattern:方法的参数类型,如java.lang.String;
throws-pattern:方法抛出的异常类型,如java.lang.Exception;
如下是一个使用execution表达式的例子:
execution(public * com.spring.service.BusinessObject.businessService(java.lang.String,..))
上述切点表达式将会匹配使用public修饰,返回值为任意类型,并且是com.spring.BusinessObject类中名称为businessService的方法,方法可以有多个参数,但是第一个参数必须是java.lang.String类型的方法。上述示例中我们使用了…通配符,关于通配符的类型,主要有两种:
如下示例表示返回值为任意类型,在com.spring.service.BusinessObject类中,并且参数个数为零的方法:
execution(* com.spring.service.BusinessObject.*())
下述示例表示返回值为任意类型,在com.spring.service包中,以Business为前缀的类,并且是类中参数个数为零方法:
execution(* com.spring.service.Business*.*())
如下示例表示匹配返回值为任意类型,并且是com.spring.service包及其子包下的任意类的名称为businessService的方法,而且该方法不能有任何参数:
execution(* com.spring.service..*.businessService())
这里需要说明的是,包路径service….businessService()中的…应该理解为延续前面的service路径,表示到service路径为止,或者继续延续service路径,从而包括其子包路径;后面的.businessService(),这里的*表示匹配一个单词,因为是在方法名前,因而表示匹配任意的类。
如下示例是使用…表示任意个数的参数的示例,需要注意,表示参数的时候可以在括号中事先指定某些类型的参数,而其余的参数则由…进行匹配:
execution(* com.spring.service.BusinessObject.businessService(java.lang.String,..))
within表达式的粒度为类,其参数为全路径的类名(可使用通配符),表示匹配当前表达式的所有类都将被当前方法环绕。如下是within表达式的语法:
within(declaring-type-pattern)
within表达式只能指定到类级别,如下示例表示匹配com.spring.service.BusinessObject中的所有方法:
within(com.spring.service.BusinessObject)
args表达式的作用是匹配指定参数类型和指定参数数量的方法,无论其类路径或者是方法名是什么。这里需要注意的是,args指定的参数必须是全路径的。如下是args表达式的语法:
args(param-pattern)
如下示例表示匹配所有只有一个参数,并且参数类型是java.lang.String类型的方法:
args(java.lang.String)
@annotation的使用方式与@within的相似,表示匹配使用@annotation指定注解标注的方法将会被环绕,其使用语法如下:
@annotation(annotation-type)
如下示例表示匹配使用com.spring.annotation.BusinessAspect注解标注的方法:
@annotation(com.spring.annotation.BusinessAspect)
源码地址:
https://gitee.com/xinshuai/AiWeb