Java注解解析-基础+运行时注解(RUNTIME)

时间  2019-11-26
标签 java 注解 解析 基础 运行时 runtime 栏目 Java 繁體版
原文   原文链接

写在前面 ：

该文章介绍了注解的一些基础，我相信不少人对注解的基础已经了如执掌，不妨接着往下看。读完该章节你能清楚的认识到一个注解的组成部分以及如何写出想要的注解。该章介绍了咱们熟悉的运行时注解的处理方法，由于Retrofit都用了。文末有下章节预告：有史以来最全面解析CLASS注解，带你实现本身的BufferKnufe（包看包会）。java

一 注解的定义

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及之后版本引入的一个特性，与类、接口、枚举是在同一个层次。它能够声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明 。若是要对于元数据的做用进行分类，尚未明确的定义，不过咱们能够根据它所起的做用，注解不会改变编译器的编译方式，也不会改变虚拟机指令执行的顺序，它更能够理解为是一种特殊的注释，自己不会起到任何做用，须要工具方法或者编译器自己读取注解的内容继而控制进行某种操做。大体可分为三类：git

编写文档：经过代码里标识的元数据生成文档。github

代码分析：经过代码里标识的元数据对代码进行分析。json

编译检查：经过代码里标识的元数据让编译器能实现基本的编译检查。数组

二 用途

由于注解运行在单独的JVM里面，因此咱们可使用JVM提供给咱们的任何依赖。另外CLASS和 SOURCE类型的注解是再编译期间完成对注解的处理，因此能够再代码编译期间帮咱们完成一些复杂的准备工做。就拿BufferKnife来讲，再处理注解的期间生成咱们注解对象相关的***_ViewBinding等类来处理View。bash

三 知识准备

Java JDK中包含了三个注解分别为@Override（校验格式），@Deprecated（标记过期的方法或者类），@SuppressWarnnings（注解主要用于抑制编译器警告）,对于每一个注解的具体使用细节这里再也不论述。咱们能够经过点击这里来看一下专业解释! 来看一下@Override的源码。app

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
复制代码

经过源代码的阅读咱们能够看出生命注解的方式为@interface，每一个注解都须要很多于一个的元注解的修饰，这里的元注解其实就是修饰注解的注解，能够理解成最小的注解单位吧。。。下面详细的看下每一个注释注解的意义吧：ide

  • @Target ：
    说明了注解所修饰的对象范围,也就是咱们这个注解是用在那个对象上面的：注解可被用于 packages、types（类、接口、枚举、注解类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在注解类型的声明中使用了target可更加明晰其修饰的目标。如下属性是多选状态，咱们能够定义多个注解做用域，好比： （1）.CONSTRUCTOR:用于描述构造器。
    （2）.FIELD:用于描述域也就是类属性之类的。
    （3）.LOCAL_VARIABLE:用于描述局部变量。
    （4）.METHOD:用于描述方法。
    （5）.PACKAGE:用于描述包。
    （6）.PARAMETER:用于描述参数。
    （7）.TYPE:用于描述类、接口(包括注解类型) 或enum声明。
@Target({ElementType.METHOD,ElementType.FIELD})，单个的使用@Target(ElementType.FIELD) 。
复制代码

  • @Retention：
    定义了该注解被保留的时间长短：某些注解仅出如今源代码中，而被编译器丢弃；而另外一些却被编译在class文件中；编译在class文件中的注解可能会被虚拟机忽略，而另外一些在class被装载时将被读取（请注意并不影响class的执行，由于注解与class在使用上是被分离的）。使用这个meta-Annotation能够对 注解的“生命周期”限制。也就是说注解处理器能处理这三类的注解,咱们经过反射的话只能处理RUNTIME类型的注解.来源于java.lang.annotation.RetentionPolicy的枚举类型值：
    （1）.SOURCE:在源文件中有效（即源文件保留）编译成class文件将舍弃该注解。
    （2）.CLASS:在class文件中有效（即class保留） 编译成dex文件将舍弃该注解。
    （3）.RUNTIME:在运行时有效（即运行时保留） 运行时可见。工具

  • @Documented：
    用于描述其它类型的注解应该被做为被标注的程序成员的公共API，所以能够被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。post

  • @Inherited：
    元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。若是一个使用了@Inherited修饰的注解类型被用于一个class，则这个注解将被用于该class的子类。 注意：@Inherited 注解类型是被标注过的class的子类所继承。类并不从它所实现的接口继承注解，方法并不从它所重载的方法继承注解。当被@Inherited类型标注的注解的Retention值为RetentionPolicy.RUNTIME，则反射API加强了这种继承性。若是咱们使用java.lang.reflect去查询一个@Inherited类型的注解时，反射代码检查将展开工做：检查class和其父类，直到发现指定的注解类型被发现，或者到达类继承结构的顶层。

  • @Repeatable ：
    Repeatable可重复性，Java1.8新特性，其实就是把标注的注解放到该元注解所属的注解容器里面。可重复性的意思仍是用demo来解释一下吧：

    //定义了一个 注解里面属性的返回值是其余注解的数组
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCar {
    MyTag[] value();        ----MyTag  这里就是MyTag注解的容器。
}
//另一个注解 就是上一个注解返回的注解
@Target({ElementType.METHOD,ElementType.FIELD})
@Retention(RetentionPolicy.CLASS)
@Repeatable(MyCar.class)    --------这里添加这个属性以后 咱们的这个注解就能够重复的添加到咱们定义的容器中了，注意里面的值时  咱们定义的容器注解的class对象.
public @interface MyTag {       ........MyTag

    String name () default "" ;

    int size () default 0 ;
}
//使用
    @MyTag(name = "BWM", size = 100)
    @MyTag()
    public Car car;
     //若是咱们的注解没有@Repeatable的话,这样写的话是报错的,加上以后就是这样的了
复制代码

    这个注解是很特殊的，咱们的注解中有@Repeatable(MyCar.class)这样的元注解的话，就是说当前标注的注解（MyTag注解）放到咱们的值（MyCar.class）这个注解容器里面。那么咱们再处理注解的时候获取到的是咱们最后的注解容器（MyCar注解）,这样说有点生硬下面看demo：

    使用:
public class HomeActivity extends AppCompatActivity {
    @MyTag(name = "BWM", size = 100)
    @MyTag(name = "大众"  ,size = 200)  ......这里用了它的重复性.
    Car car;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_home);
        AnnotationProccessor.instance().inject(this);   //这里去处理注解
      //  Log.e("WANG", "HomeActivity.onCreate." + car.toString());
    }
}
处理过程:
Class<?> aClass = o.getClass();
        Field[] declaredFields = aClass.getDeclaredFields();
        for (Field field:declaredFields) {
            if(field.getName().equals("car")){
                Annotation[] annotations = field.getAnnotations();
                for (int i = 0; i <annotations.length; i++) {
                    Annotation annotation = annotations[i];
                    //咱们获取的该字段上面的注解只有一个  那就是 MyCar注解,看结果1的打印.
                    //可是咱们明明标注的是 MyTag. 为何获取的是注解容器呢.
                    //这就是@Repeatable的强大之处.
         
                    Class<? extends Annotation> aClass1 = annotation.annotationType();
                    Log.e("WANG","AnnotationProccessor.MyCar"+aClass1 );
                }
                MyCar annotation = field.getAnnotation(MyCar.class);
                MyTag[] value = annotation.value();
                for (int i = 0; i <value.length; i++) {
                    MyTag myTag = value[i];
                    Log.e("WANG","AnnotationProccessor.MyTag name value is "+myTag.name() );
                }
            }      
            
结果是:
AnnotationProccessor.MyCarinterface cn.example.wang.routerdemo.annotation.MyCar.1
AnnotationProccessor.MyTag   name  value   is  BWM.2
AnnotationProccessor.MyTag   name  value   is  大众.3
复制代码

三 自定义运行时注解

经过以上的学习咱们知道@interface是声明注解的关键字,每一个注解须要注明生命周期以及做用范围.你能够给注解定义值.也就是再注解内部定义咱们须要的方法.这样注解就能够再本身的生命周期内为咱们作事.这里咱们就自定义一个为一个对象属性初始化的注解吧，相似于Dagger的功能。

public @interface MyTag {

}
复制代码

注解里面的定义也是有规定的：

  • 注解方法不能带有参数。

  • 注解方法返回值类型限定为：基本类型、String、Enums、Annotation或者这些类型的数组。

  • 注解方法能够有默认值。

  • 注解自己可以包含元注解，元注解被用来注解其余注解。

咱们就来试一下吧！

public @interface MyTag {
 //声明返回值类型，这里可没有大括号啊，能够设置默认返回值，而后就直接";"了啊。
 String name () default "" ;
 int size () default 0 ；
}
复制代码

定义好了注解咱们就来规定咱们自定义的注解要在哪里用？要什么时候用？由于咱们这里使用了反射来处理注解，反射就是在代码的运行的时候经过class对象反相的去获取类内部的东西，不熟悉反射机制的请移步这里Android开发者必须了解的反射基础，因此咱们定义该注解的生命周期在运行时，而且该注解的的目的是为自定义属性赋值，那么咱们的做用域就是FIELD。这里面定义了咱们要初始化的bean的基本属性，给了默认值。这样咱们就能够用该注解去建立咱们须要的bean对象。

@Target(ElementType.FIELD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
 String name () default "" ;
 int size () default 0 ;
}
复制代码

好了接下来看怎么使用咱们的这个自定义的注解！

public class HomeActivity extends AppCompatActivity {
 @MyTag(name = "BMW",size = 100)
 Car car;
 @Override
 protected void onCreate(Bundle savedInstanceState) {
 super.onCreate(savedInstanceState);
 setContentView(R.layout.activity_home);
 //这里咱们要首先注册一下这个类
 AnnotationCar.instance().inject(this);
 //当程序运行的时候这里将会输出该类Car的属性值。
 Log.e("WANG","Car is "+car.toString());
 }
}
复制代码

注解若是没有注解处理器，那么该注解将毫无心义。这里呢咱们在这个Activity里面定义了一个Car类的属性，而后再car这个变量上面定义咱们的注解，而且给咱们的注解赋值。而后咱们再onCreate方法里面初始化咱们的注解处理器。而后运行代码，log日志将打印Car类的信息，先来看下结果吧！

cn.example.wang.routerdemo E/WANG: Car is Car [name=BMW, size=100]
复制代码

这样咱们的自定义注解就有做用了，下面是”注解处理器“的代码，这里都是咱们本身编写的处理注解的代码，其实系统是自带注解处理器的，不过它通常用来处理源码注释和编译时注释。

//自定义的类
/**
 * Created by WANG on 17/11/21.
 */
public class AnnotationCar {
    private static AnnotationCar annotationCar;
    public static AnnotationCar instance(){
        synchronized (AnnotationCar.class){
            if(annotationCar == null){
                annotationCar = new AnnotationCar();
            }
            return annotationCar;
        }
    }

    public void inject(Object o){
        Class<?> aClass = o.getClass();
        Field[] declaredFields = aClass.getDeclaredFields();
        for (Field field:declaredFields) {
            if(field.getName().equals("car") && field.isAnnotationPresent(MyTag.class)) {
                MyTag annotation = field.getAnnotation(MyTag.class);
                Class<?> type = field.getType();
                if(Car.class.equals(type)) {
                    try {
                        field.setAccessible(true);
                        field.set(o, new Car(annotation.name(), annotation.size()));
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }
}
复制代码

这就说明了为何注解和反射是同时进入咱们的知识圈里面的吧！这里呢咱们先获取到类里面全部的属性，而后去找到被咱们的注解MyTag修饰的那个属性，而后找到以后，先取咱们注解里面的值，而后赋值给咱们类里面的属性！这样咱们就用注解去初始化了一个属性值。就是这么简单！

四 总结

运行时注解是咱们比较好理解的，知道反射和注解基础以后就能够写出来个小demo了。可是运行时注解是是咱们最不经常使用的注解，由于反射再运行时的操做是十分的耗时的，咱们不会由于一些代码的简洁而影响app的性能。因此呢运行时注解只是你们认识注解的一个入口。接下来我将陆续的介绍注解的通用写法。

下一章节预告:
将详细介绍，CLASS注解全面解析，包看包会之完成属于本身的BufferKnife！

欢迎你们评论区留言指出文章错误~ 谢谢各位看官! 欢迎你们持续关注！

个人掘金
个人CSDN
个人简书
Github Demo地址,欢迎start

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程