Android自定义注解

关联文章:

• 安卓注解使用详解
• 安卓使用注解处理器自动生成代码操作详解(AutoService,JavaPoet,AbstractProcessor)
• 安卓自定义注解实战之从零仿写ButterKnife源码的BindView功能

前言

市面上许多的框架都用到了注解，方便使用的同时还能降低了项目的耦合性，例如butterknife,EventBus等，那么，拿butterknife举例，看起来注解与代码都没啥关联性，它是怎么自动寻找到id并精确给控件赋值的呢，想了解这些，就必须从自定义注解说起。

元注解

元注解你可以把它视为注解配置，他可以申明注解的作用区域，调用时机等，元注解包括以下几个：

@Target

表示我们的注解可以在什么地方申明，java参数是用ElementType类来申明,kotlin是使用AnnotationTarget来申明，kt比java多几个选项，但总体相差不大，这里以java举例

ElementType	作用范围
TYPE	接口、类、枚举、注解
FIELD	字段、枚举的常量
METHOD	方法
PARAMETER	方法参数
CONSTRUCTOR	构造函数
LOCAL_VARIABLE	局部变量
ANNOTATION_TYPE	注解
PACKAGE	包
TYPE_PARAMETER	java 1.8之后，作用于类型声明的语句中
TYPE_USE	java 1.8之后，作用于使用类型的任意语句中

@Retention

可以理解为注解的生命周期，用来申明注解在什么情况下存在或生效，使用RetentionPolicy来申明

RetentionPolicy	作用
SOURCE	只保留源文件，当编译成class文件将被抛弃，通常用于约束注解，例如@IntDef
CLASS	会加载到class文件中，但jvm加载的时候会被抛弃，因此在字节码处理时期有用，例如@NonNull注解
RUNTIME	即保存在源码中，也会被加载到jvm中去，因此可以通过反射获取注解中的值或以此做为标记

@Document

标记的注解可以被文档化

@Inherited

表示这个注解是可以被继承的

实战

上面扯了一堆，接下来进入实战环节，EventBus相信大家都用过吧，通常在使用的时候我们需要初始化它，一般我们会在基类里来实现，但是我们有些界面不需要使用，这是我们可以使用注解来优雅的做一个标记来决定是否初始化它，怎么实现呢，一起来看一下：
首先我们先定义一个注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface UserEventBus {
}

因为我们需要在基类中能够获取到它，所以需要将Retention定义为RUNTIME，而我们是在Activity上标记，Activity是一个类，所以Target为TYPE，这应该没问题吧

随后我们在基类中判断子类是否有这个注解，有的话就注册EventBus：

public abstract class BaseActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        if (getClass().isAnnotationPresent(UserEventBus.class)){
            EventBus.getDefault().register(this);
        }
    }

    @Override
    protected void onDestroy() {
        super.onDestroy();
        if (getClass().isAnnotationPresent(UserEventBus.class)){
            EventBus.getDefault().unregister(this);
        }
    }
}

这里用到了class的相关知识，如果对class不太熟悉的，可以参考我的这篇文章：玩转Class之Class的各种骚操作
子类使用：

@UserEventBus
public class MyActivity extends BaseActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        
    }
}

只需要在头部申明一个UserEventBus注解就自动完成了注册，是不是很方便呢，当然这里只是举一个小小的例子帮助大家理解，注解的使用远未如此，结合注解处理器可以达到一些非常不可思议的效果，理解了这个，自然就理解了框架中注解的神奇之处。关于注解处理器，且听下回分解