一、自定义注解的基本使用
java.lang.annotation 提供了四种元注解,专门注解其他的注解(在自定义注解的时候,需要使用到元注解):
@Documented – 注解是否将包含在JavaDoc中
@Retention – 什么时候使用该注解
@Target – 注解用于什么地方
@Inherited – 是否允许子类继承该注解
1.)@Retention – 定义该注解的生命周期
● RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。
● RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式
● RetentionPolicy.RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
2.)Target – 表示该注解用于什么地方。默认值为任何元素,表示该注解用于什么地方。可用的ElementType 参数包括
● ElementType.CONSTRUCTOR: 用于描述构造器
● ElementType.FIELD: 成员变量、对象、属性(包括enum实例)
● ElementType.LOCAL_VARIABLE: 用于描述局部变量
● ElementType.METHOD: 用于描述方法
● ElementType.PACKAGE: 用于描述包
● ElementType.PARAMETER: 用于描述参数
● ElementType.TYPE: 用于描述类、接口(包括注解类型) 或enum声明
3.)@Documented – 一个简单的Annotations 标记注解,表示是否将注解信息添加在java 文档中。
4.)@Inherited – 定义该注释和子类的关系
@Inherited 元注解是一个标记注解,@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited 修饰的annotation 类型被用于一个class,则这个annotation 将被用于该class 的子类。
编写规则
- Annotation 型定义为@interface, 所有的Annotation 会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
- 参数成员只能用public 或默认(default) 这两个访问权修饰
- 参数成员只能用基本类型byte、short、char、int、long、float、double、boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.
- 要获取类方法和字段的注解信息,必须通过Java的反射技术来获取 Annotation 对象,因为你除此之外没有别的获取注解对象的方法
- 注解也可以没有定义成员,,不过这样注解就没啥用了
PS:自定义注解需要使用到元注解
示例
AOP
使用
执行结果
二、编写实例
定义一个注解类接口
添加四个元注解
定义属性-返回类型类Class<?>、返回类型是否可为空boolean-可以赋默认值default false
定义一个切面
添加注解@Aspect @Component
定义一个切面方法,返回值为void,添加注解@Pointcut("@annotation(注解接口的全类名路径)"),
定义一个环绕方法,参数为ProceedingJoinPoint,注解接口类,添加@Around(切面方法() && @annotation(参数注解接口类的自定义名称)),内部实现:获得切点的方法名和类名,通过注入的配置类获取配置的值,如果为Y则return point.proceed(),表示进入方法的执行,如果注解接口类的boolean属性为true,则返回null,获取注解接口类的返回类型类,return clazz.newInstance;
定义一个配置类
添加注解@Component @RefreshScope @Data
定义私有属性 类名
方
法
名
,
添
加
添
加
注
解
@
V
a
l
u
e
(
"
方法名,添加添加注解@Value("
方法名,添加添加注解@Value("{类名.方法名}")
提供一个get方法,参数为类名和方法名
return 配置工具类.getValueByKeyAndObj(className,methodName,this)
定义一个配置工具类
提供一个静态的getValueByKeyAndObj方法,参数为(String key,String value,Object objc)
String str = key + "$" + value;
Fields[] declaredFields = objc.getClass().getDeclaredFields();
for (Field declaredField: declaredFields) {
boolean equals = str. equals (declaredField. getName ());
if (equals)
try {
declaredField.setAccessible(true);
return declaredField.get (obje);
} catch (IllegalAccessException e) {
return null;
使用注解
@JudgeCallable(resultClass = ArrayList.class, isNull = false)
注意只能用到control类以及impl实现类上,不能用于接口上
其中resultClass只能用List的实现类ArrayList,不能使用接口类
思考:为什么自定义的注解不能用于接口上?
前置知识点:注解的继承问题
“对于接口,在接口中的注解无论如何都不能被继承,不论是子接口继承父接口的情况还是接口的实现类的情况,不论是对接口上还是接口中的方法上的注解,都不能被继承。
一个类用上了 @Inherited 修饰的注解,那么其子类也会继承这个注解,与方法上的注解的继承性无关
总结:
接口用上个 @Inherited 修饰的注解,其实现类不会继承这个注解
父类的方法用了 @Inherited 修饰的注解,子类也不会继承这个注解
为什么自定义的注解不能用于接口上?
因为我们使用了AOP特性,即Spring动态代理,Spring 的动态代理主要分为两种,一种是JDK 动态代理 ;一种是CGLIB 动态代理
- JDK 动态代理主要是针对实现了某个接口的类。该方式基于反射的机制实现,会生成一个实现相同接口的代理类,然后通过对方法的重写,实现对代码的增强。
在该方式中接口中的注解无法被实现类继承
,AOP 中的切点无法匹配上实现类,所以也就不会为实现类创建代理,所以我们使用的类其实是未被代理的原始类,自然也就不会被增强了。 - 使用 CGLIB 动态代理
在不存在切点注解继承的情况
(在类上注解,子类可继承),AOP 可进行有效拦截(CGLIB动态代理)。但是还要考虑以下存在注解继承的情况:
有父类 Parent,和子类 Sub ,切点注解在父类方法
。则根据上边提到的只有方法的重写问题,可知,被重写的方法
(不继承父类的注解)将不会被拦截,而未重写的方法
(继承父类的注解)则走 Parent 路线,可以被 AOP 感知拦截。