Android自定义注解

关联文章:

前言

市面上许多的框架都用到了注解,方便使用的同时还能降低了项目的耦合性,例如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注解就自动完成了注册,是不是很方便呢,当然这里只是举一个小小的例子帮助大家理解,注解的使用远未如此,结合注解处理器可以达到一些非常不可思议的效果,理解了这个,自然就理解了框架中注解的神奇之处。关于注解处理器,且听下回分解

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,063评论 6 510
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,805评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,403评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,110评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,130评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,877评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,533评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,429评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,947评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,078评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,204评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,894评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,546评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,086评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,195评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,519评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,198评论 2 357

推荐阅读更多精彩内容