Android自定义注解(一)

为什么要写这个,因为前段时间看了一下AOP相关的一些内容,然后也是太久没写注解,看得有点那啥不顺畅,所以想对注解做个总结。

一.JAVA自带的注解

(1)Override 覆盖
(2)Deprecated 标记过期方法
(3)SuppressWarnings 屏蔽警告

二.自定义注解

1.定义

我这里写个demo自定义一个注解

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface BindView {
    int value() default -1;
}

可以看出注解用@interface来标志。

2.元注解

可以看出在上边的定义中,上面还有两个注解,这些被称为元注解,什么是元注解,简单来说就是描述注解的注解
还有什么元数据的,元什么什么的,这个元其实不太好解释,我记得之前看过一个元数据的描述,英文是 data about data,这个元有这个about的那种感觉

元注解有4种
(1)@Retention 用来描述周期,Retention 有“保持时间”的意思,这个属性可以选三个值
SOURCE表示只在源码中有用,编译就没用了。
CLASS表示在编译中可用,运行就没用了。
RUNTIME表示运行时可用。
这三种的区别解释起来很麻烦,总之一搬我们都是使用RUNTIME

(2)@Target 用来描述作用域,Target有目标的意思,你这个注解要给哪个目标修饰,这个属性可以选以下的值
CONSTRUCTOR用于描述构造器
FIELD用于描述域
LOCAL_VARIABLE用于描述局部变量
METHOD用于描述方法
PACKAGE用于描述包
PARAMETER用于描述参数
这个就是说,你允许把注解写在什么地方。这个属性是可以多选的,比如@Target({ElementType.FIELD, ElementType.METHOD})

(3)@Inherited 描述是否可以为继承,默认是false

(4)@Documented 描述是否会保存到 Javadoc 文档中

一般我们只会用到前面两个,所以后面两个我就不解释了。

3.注解的值

可以给注解设置值,比如说我上面的代码,就在注解里写了个

int value() default -1;

表示在使用注解时需要传一个整形的值

@BindView(R.id.tv)
TextView textView;

我这传了个R.id.tv就是一个整形的值。只有一个值的时候,必须以** value()**来命名,然后调用时就直接传就行。我还是分情况来说吧。

(1)不需要传值的情况

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface BindView {

}

调用

@BindView
TextView textView;

(2)传一个值的情况
就是我上面写的代码

(3)传多个值的情况

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface BindView {
    int age;
    String name;
}

调用

@BindView(age = 18, name = "JackMa")
TextView textView;

最后,这个default 表示设置默认值的意思。

三.调用注解

上面我们创建出了注解并定义好,然后我们需要调用这个注解,那怎么调用呢,一般我们调用一个类或接口都是new 出来,但是这东西怎么看都觉得new不出来吧,所以我们需要用反射来获取到注解的对象,然后进行调用

我不想去讲反射的内容,不然就没完了。就说个思路,需要用到哪个方法可以去查api。
注解在Java中就是Annotation懂吧,所以在反射中和Annotation相关的方法都是和注解相关的方法。

比如说获取注解,我就可以调用.getAnnotation(BindView.class)
再比如说我判断注解存在不,可以调用isAnnotationPresent()
总之你只要记住注解是Annotation,之后你不管是在反射中还是在哪里找和注解相关的方法,都先往Annotation这个名词相关的地方找准没错。

如果你不懂反射这里说再多也没有。

四.案例

其实说了这么多,到底哪里需要使用到注解呢,如果不使用到,讲它有啥用,我个人是目前接触到AOP涉及注解比较频繁,其它时候,比如说ButterKnife,Dagger,Retrofit等等这些主流的框架都会用到注解,包括java后台,我接触过spring会涉及到IOC啊AOP啊这些思想用java来实现也是用到注解比较多,所以可以来写个小demo试试。

不如就仿照ButterKnife吧,我之前没看过ButterKnife的源码啊,我就按照我学会的注解的知识和ButterKnife的调用方法来仿写个ButterKnife

1.首先定义注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface BindView {
    int value() default -1;
}

定义注解,要求传个资源进来,默认是-1

2.按照ButterKnife的调用的样子来写调用的地方
public class MainActivity extends AppCompatActivity {

    @BindView(R.id.tv)
    TextView textView;
    @BindView(R.id.btn)
    Button btn;

    String yyy = "aasdasdas";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);

        textView.setText("wwwwwwwwwwwwww");
        btn.setText("btn");
    }
}

发现ButterKnife调用的地方使用这 ButterKnife.bind(this); 那我就推测findViewById就在这个ButterKnife类的bind方法中进行。

3.定义ButterKnife
public class ButterKnife {

    public static void bind(Activity activity){
        Class<?> cls = activity.getClass();
        Field[] fields = cls.getDeclaredFields();
        for (Field field : fields) {
            BindView bindView = field.getAnnotation(BindView.class);
            if (bindView != null) {
                int ids = bindView.value();
                try {
                    field.set(activity, activity.findViewById(ids));
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }

}

我这里就用了反射来操作,调用bind方法后,先用cls.getDeclaredFields();获取所有的全局变量,然后再对每个变量用field.getAnnotation(BindView.class);来获取这个变量上面的注解,如果存在的话 int ids = bindView.value(); 来获取我们传入的资源,最后调用findViewById

field.set(activity, activity.findViewById(ids));

很简单吧,三个类这样就能实现了ButterKnife的效果


image.png

注意判空一定要写,即使你全部的变量都用了注解,但是如果你DeBug看看,你会发现,变量中不仅仅只有你定义的,还存在其他的。

其实上面都是瞎写的,ButterKnife的原理根本不是这样,虽然我没看过源码,但我听别人说过ButterKnife的实现并不是这样的,我这的demo只是仿照了这个功能,具体ButterKnife的原理以后如果有时间我会单独写。

通过上面的讲解就能简单的实现注解,我也顺便复习加总结了一遍。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念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

推荐阅读更多精彩内容