本文共 5432 字，大约阅读时间需要 18 分钟。

什么是注解?

注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

什么是元注解?

简单来说，就是注解的注解，元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明：

• @Target
• @Retention
• @Documented
• @Inherited

下面我们看一下每个元注解的作用和相应分参数的使用说明。

@Target：

该标识用于描述注解的使用范围（即：被描述的注解可以用在什么地方）： packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

取值(ElementType)有：

• 1.CONSTRUCTOR:用于描述构造器
• 2.FIELD:用于描述域
• 3.LOCAL_VARIABLE:用于描述局部变量
• 4.METHOD:用于描述方法
• 5.PACKAGE:用于描述包
• 6.PARAMETER:用于描述参数
• 7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention：

该标示定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。

取值(ElementType)有：

• 1.SOURCE:在源文件中有效（即源文件保留）
• 2.CLASS:在class文件中有效（即class保留）
• 3.RUNTIME:在运行时有效（即运行时保留）

@Documented：

Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员

@Inherited：

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

注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

自定义注解

定义注解格式：

public @interface 注解名 {定义体}

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

注解参数的可支持数据类型：

• 1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
• 2.String类型
• 3.Class类型
• 4.enum类型
• 5.Annotation类型
• 6.以上所有类型的数组

Annotation类型里面的参数设定:

第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　 　 第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　 第三,如果只有一个参数成员,最好把参数名称设为”value”,后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

下面是一个简单的自定义注解的栗子：

/** * 动物名称注解 * */@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface AnimalName {    String value() default "";}

定义了注解，并在需要的时候给相关类，类属性加上注解信息，如果没有响应的注解信息处理流程，注解可以说是没有实用价值，接下来要介绍的是java的APT(Annotation Process Tool)技术，用于处理自定义注解。

APT技术

APT(Annotation Process Tool)，是一种在代码编译时处理注解，按照一定的规则，生成相应的java文件，多用于对自定义注解的处理，目前比较流行的Dagger2, ButterKnife, EventBus3都是采用APT技术，对运行时的性能影响很小。我们通过自定义注解的方式，来了解一下如何使用APT：

自定义注解：

@Target({ElementType.TYPE})   ---作用范围 Class@Retention(RetentionPolicy.CLASS)  ---生命周期：仅保留到.class文件public @interface Route {    /** Path of route*/    String value();  ---类似于成员变量}

使用方式

@Route(path = "/test/activity2")public class MainActivity extends AppCompatActivity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_test2);    }}

JVM默认只会处理@override等语言自带的注解，对于自定义的注解，需要我们自己处理，java提供了一个名为AbstractProcessor.java的抽象类，我们只要继承该类，就实现自己的注解处理器，来处理自定义的@Route注解

public class RouteProcessor extends AbstractProcessor {    @Override    public synchronized void init(ProcessingEnvironment env){         // 主要做一些初始化操作    }    @Override        public boolean process(Set
    annoations, RoundEnvironment env) {         //具体处理注解的逻辑，控制代码的生成        processAnnotations();    }    @Override    public Set
   
     getSupportedAnnotationTypes() {        // 支持处理的注解类型, 在这里就是@Route    }    @Override    public SourceVersion getSupportedSourceVersion() {      //java版本 如：jdk1.6or jdk1.7   }}
   

自定义Processor

@AutoService(Processor.class)public class HelloProcessor extends AbstractProcessor {    /** 文件相关的辅助类 用于生成新的源文件、class等 */    private Filer mFiler;    @Override    public synchronized void init(ProcessingEnvironment processingEnv) {        super.init(processingEnv);        mFiler = processingEnv.getFiler();    }    @Override    public boolean process(Set
    annotations, RoundEnvironment roundEnv) {        // 构建方法 此处使用到了square公司的javapoet库，用来辅助生成 类的代码        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("show")                .addModifiers(Modifier.PUBLIC);        methodBuilder.addStatement("String test = \"$N\" ","hello annotation world!");        /** 构建类 */        TypeSpec finderClass = TypeSpec.classBuilder("Hello$$Inject")                .addModifiers(Modifier.PUBLIC)                .addMethod(methodBuilder.build())                .build();        try {            JavaFile.builder("com.win.test",finderClass).build().writeTo(mFiler);        } catch (IOException e) {            e.printStackTrace();        }        return true;    }    // 支持的注解类型    @Override    public Set
   
     getSupportedAnnotationTypes() {        Set
    
      types = new LinkedHashSet<>();        types.add(Hello.class.getCanonicalName());        return types;    }    @Override    public SourceVersion getSupportedSourceVersion() {        return super.getSupportedSourceVersion();    }}
    
   

在AS工程中使用

@Hello("MainTest")   //自定义的Hello注解public class MainActivity extends AppCompatActivity {    @Override    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        setContentView(R.layout.activity_main);    }}

在项目App module的build目录下，便会生成对应的java类文件:

这个只是简单的例子，我们可以在process()方法中，加入更多的业务逻辑，以实现特定功能。

转载地址：https://menxindiaolong.blog.csdn.net/article/details/90380191 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！