Java学习之注解Annotation实现原理

xiaoxiao2021-02-27  235

什么是注解?

Annontation是Java5开始引入的新特征,中文名称叫注解。它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata)与程序元素(类、方法、成员变量等)进行关联。为程序的元素(类、方法、成员变量)加上更直观更明了的说明,这些说明信息是与程序的业务逻辑无关,并且供指定的工具或框架使用。Annontation像一种修饰符一样,应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

注解的用处:

1、生成文档。这是最常见的,也是java 最早提供的注解。常用的有@param @return 等 2、跟踪代码依赖性,实现替代配置文件功能。比如Dagger 2依赖注入,未来java开发,将大量注解配置,具有很大用处; 3、在编译时进行格式检查。如@override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

元注解:

java.lang.annotation提供了四种元注解,专门注解其他的注解: @Documented –注解是否将包含在JavaDoc中 @Retention –什么时候使用该注解 @Target –注解用于什么地方 @Inherited – 是否允许子类继承该注解

1.)@Retention– 定义该注解的生命周期

RetentionPolicy.SOURCE : 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义,所以它们不会写入字节码。@Override, @SuppressWarnings都属于这类注解。

RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式

RetentionPolicy.RUNTIME : 始终不会丢弃,运行期也保留该注解,因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式

举例:bufferKnife 8.0 中@BindView 生命周期为CLASS

@Retention(CLASS) @Target(FIELD) public @interface BindView { /** View ID to which the field will be bound. */ @IdRes int value(); }

2.)Target – 表示该注解用于什么地方。默认值为任何元素,表示该注解用于什么地方。可用的ElementType参数包括

ElementType.CONSTRUCTOR:用于描述构造器ElementType.FIELD:成员变量、对象、属性(包括enum实例)ElementType.LOCAL_VARIABLE:用于描述局部变量ElementType.METHOD:用于描述方法ElementType.PACKAGE:用于描述包ElementType.PARAMETER:用于描述参数ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

举例Retrofit 2 中@Field 作用域为参数

@Documented @Target(PARAMETER) @Retention(RUNTIME) public @interface Field { String value(); /** Specifies whether the {@linkplain #value() name} and value are already URL encoded. */ boolean encoded() default false; }

3.)@Documented–一个简单的Annotations标记注解,表示是否将注解信息添加在java文档中。

4.)@Inherited – 定义该注释和子类的关系

@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。

自定义注解:

@ReqType 请求类型

@Documented @Target(METHOD) @Retention(RUNTIME) public @interface ReqType { /** * 请求方式枚举 * */ enum ReqTypeEnum{ GET,POST,DELETE,PUT}; /** * 请求方式 * @return */ ReqTypeEnum reqType() default ReqTypeEnum.POST; }

@ReqUrl 请求地址

@Documented @Target(METHOD) @Retention(RUNTIME) public @interface ReqUrl { String reqUrl() default ""; }

@ReqParam 请求参数

@Documented @Target(PARAMETER) @Retention(RUNTIME) public @interface ReqParam { String value() default ""; }

2.)如何使用自定义注解

public interface IReqApi { @ReqType(reqType = ReqType.ReqTypeEnum.POST)//声明采用post请求 @ReqUrl(reqUrl = "www.xxx.com/openApi/login")//请求Url地址 String login(@ReqParam("userId") String userId, @ReqParam("pwd") String pwd);//参数用户名 密码 }

3.)如何获取注解参数

这里强调一下,Annotation是被动的元数据,永远不会有主动行为,但凡Annotation起作用的场合都是有一个执行机制/调用者通过反射获得了这个元数据然后根据它采取行动。

通过反射机制获取函数注解信息

Method[] declaredMethods = IReqApi.class.getDeclaredMethods(); for (Method method : declaredMethods) { Annotation[] methodAnnotations = method.getAnnotations(); Annotation[][] parameterAnnotationsArray = method.getParameterAnnotations(); }

也可以获取指定的注解

ReqType reqType =method.getAnnotation(ReqType.class);
转载请注明原文地址: https://www.6miu.com/read-9137.html

最新回复(0)