Android,几分钟教你怎么应用自定义注解

96
DevSiven
0.7 2016.08.19 10:25* 字数 686
相信各位Android程序猿都了解过 **ButterKnife** 这个高效的注解,对于 **InjectView** 高效的替代findViewId更是熟之又熟。以下代码:
@InjectView(R.id.textview)
private TextView textView;
好了,今天目的不是为了介绍 **ButterKnife** 这个框架哈。这次写的文章主要是为了介绍注解基本概念,同时用案例实现注解代替findViewId、setContentView。

一、注解作用

在Java开发中,注解一般有一下功能:
(1) **标识 **
在jdk中,类似我们比较常见的注解有Override,Deprecated,SuppressWarnings,这些作用只是作为标识,删除对程序没影响。他们的作用分别为:
Override 表示这个方法重写了父类的方法
Deprecated 表示jdk中不建议使用这个方法或者属性
SuppressWarnings 表示屏蔽了某些警告

(2)运行时处理
这个编译器默认的做法,编译器会通过class文件,逐个逐个的遍历class的属性和方法,即运行时处理。

(3)编译时处理
在运行之前,有学过C的程序猿就会知道,编译器在运行之前,编译的时候会将include进来的*.h文件进行引入。同理例如你在代码中引入注解,编译器会在编译的时候,在注解的属性引入在进行编译。

二、注解基础

首先

这里先看下定义的一个注解

public @interface ViewInject {  
  int value() default  -1;
}
这上面记得要添加一个@喔,不然就变成了定义了一个接口。在这里,value()不是代表一个方法,而是代表一个属性,其中value是属于整形的属性,默认值为1。
其次

这里先看下定义的一个注解的时候,添加元注解

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

上面的代码举例了在定义注解的时候,常见的元注解Target和Retention,这里说明下:
(一)Target ->注解工表明应用在什么地方
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
(二)Retention ->注解的功能差不多说明的就是你的注解的生命周期
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)

最后

综合上面的说明,以下代码说明:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface LayouyInject {
    int value() default -1;
}
这个注解作用域在类中(待会看实例就知道为什么),并且只要在运行时就有效,定义了一个默认属性value。

三、实战注解

在第一段的时候,我们说过ButterKnife注解可以直接秒杀findViewId,这一瞬间代码简洁了很多。现在我们动手不用框架,自己写一个注解实现这个功能,重在实践嘛~现在贴上代码,注释都写的比较清楚哈。

(一)定义一个基础的Activity

用于初始化解析注解,分别设置布局与初始化view,代码如下:

package cn.wsy.myretrofit.annotation;

import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;

import java.lang.reflect.Field;

/**
 * Created by wsy on 2016/8/18.
 */
public class InjectActivity extends AppCompatActivity {

    private int mLayoutId = -1;

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

    /**
     * 解析注解view id
     */
    private void displayInjectView() {
        if (mLayoutId <=0){return ;}
        Class<?> clazz = this.getClass();
        Field[] fields = clazz.getDeclaredFields();//获得声明的成员变量
        for (Field field : fields) {
            //判断是否有注解
            try {
                if (field.getAnnotations() != null) {
                    if (field.isAnnotationPresent(ViewInject.class)) {//如果属于这个注解
                        //为这个控件设置属性
                        field.setAccessible(true);//允许修改反射属性
                        ViewInject inject = field.getAnnotation(ViewInject.class);
                        field.set(this, this.findViewById(inject.value()));
                    }
                }
            } catch (Exception e) {
//                throw new InterruptedException("not found view id!");
                Log.e("wusy", "not found view id!");
            }
        }
    }

    /**
     * 注解布局Layout id
     */
    private void displayInjectLayout() {
        Class<?> clazz = this.getClass();
        if (clazz.getAnnotations() != null){
            if (clazz.isAnnotationPresent(LayouyInject.class)){
                LayouyInject inject = clazz.getAnnotation(LayouyInject.class);
                mLayoutId = inject.value();
                setContentView(mLayoutId);
            }
        }

    }
}

首先,这里是根据映射实现设置控件的注解。作为程序猿的各位应该知道,java中使用反射的机制,效率性能并不高。所以真正开发的时候,需要根据需求去思考怎么样的实现方式哈,这里笔者只是举例子实现注解。**ButterKnife**官方申明不是通过反射机制,因此效率会高点。
(二)应用注解
package cn.wsy.myretrofit;

import android.os.Bundle;
import android.widget.TextView;

import cn.wsy.myretrofit.annotation.InjectActivity;
import cn.wsy.myretrofit.annotation.LayouyInject;
import cn.wsy.myretrofit.annotation.ViewInject;

@LayouyInject(R.layout.activity_main)
public class MainActivity extends InjectActivity {

    @ViewInject(R.id.textview)
    private TextView textView;

    @ViewInject(R.id.textview1)
    private TextView textview1;

    @ViewInject(R.id.textview2)
    private TextView textview2;

    @ViewInject(R.id.textview3)
    private TextView textview3;

    @ViewInject(R.id.textview4)
    private TextView textview4;

    @ViewInject(R.id.textview5)
    private TextView textview5;

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

       //设置属性
        textView.setText("OK");
        textview1.setText("OK1");
        textview2.setText("OK2");
        textview3.setText("OK3");
        textview4.setText("OK4");
        textview5.setText("OK5");

    }

}

上面直接继承InjectActivity即可,文章上面也有说过:LayouyInject为什么作用域是TYPE,首先在加载view的时候,肯定是优先加载布局啊,**ButterKnife**也不例外。因此选择作用域在描述类,并且存在运行时。

三、总结

今天大概归纳了日常注解常用的元注解,并且用反射机制的方式,实现了控件与布局的注解,希望可以帮到读者理解,谢谢!

傻小孩b mark
共勉,写给在成长路上奋斗的你

喜欢就为我点下喜欢吧:-D,感谢各位读者阅读。

Android
Web note ad 1