我们在Android中经常会看到类似下面的代码
private Button mButton;
mButton = (Button) findViewById(R.id.button);
这是获取Button实例的老套路,看起来还算简单,但是我们每添加一个控件就要调用findViewById方法,很碍眼有某有?
那再来看看下面这个
@ViewInject(R.id.button)
private Button mButton;
这是在定义变量时使用的,并且不用再调用findViewById就得到了Button实例,这就是注解。
下面我们就来看看这是如何实现的。
在Java中,通过反射,可以知道每一个类的详细信息,比如有什么字段、方法、类名等,那么我们通过注解和反射配合,使用反射调用类中的方法,然后读取注解的参数来进行方法的执行。简单的说,我们还是会调用findViewById这个方法,但是,这个方法放到工具类中执行,我们只需要像上面那样给出参数就行了。
那么我们如何自定义注解呢,很简单,看代码
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject{
int value();
}
看起来很眼熟是吧?对的,我们就仅仅在接口的interface关键字前面加一个@而已.
我们看到注解上面还有两行代码,这里分别解释下:
@Target的意思是我们注解作用的目标,这里是ElementType.FIELD,也就是作用于字段的
ElementType的类型有以下几种:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述字段
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Retention的意思是注解的运行级别
RetentionPolicy的类型有以下几种
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
@interface则是表明这个类是一个注解,@号不能漏掉,否则变成了接口了。
注解定义好了,但是我们却不能直接使用,这需要绑定一个工具类,实现的核心就是利用反射,下面上代码:
public class AnnotateUtils {
/**
* 静态方法方便调用
* @param aActivity
*/
public static void annotate(Activity aActivity){
Class<? extends Activity> obj = aActivity.getClass();
//方法返回一个数组的Field对象 包括 public, protected,default(包)访问和private 字段,但不包括继承的字段。
Field[] fileds = obj.getDeclaredFields();
//遍历,获取注解
for(Field field : fileds){
//得到ViewInject注解实例 如果没有就返回null
ViewInject viewInject = field.getAnnotation(ViewInject.class);
if(viewInject != null){
//得到我们使用注解时所输入的值,也就是我们的控件ID
int viewId = viewInject.value();
if(viewId != -1){
try {
//得到Activity的方法findViewById,第二个参数是此方法的形参类型
Method method = obj.getMethod("findViewById",int.class);
//第一个参数是调用此方法的对象,第二个参数是此方法的形参,当然这是一个可变参数
Object resView = method.invoke(aActivity,viewId);
//如果成员变量为private,必须进行此操作
field.setAccessible(true);
//将指定对象变量上此 Field 对象表示的字段设置为指定的新值。
field.set(aActivity,resView);
} catch (NoSuchMethodException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
}
}
注释很详细,这里我就不再解释了。
我们来看下如何使用的
public class Text extends AppCompatActivity {
@ViewInject(R.id.button)
private Button mButton;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_loader_text);
AnnotateUtils.annotate(this);
mButton.setOnClickListener(v ->
Toast.makeText(this, "你点击了按钮", Toast.LENGTH_SHORT).show()
);
}
}
最后,有几点说明:
①如果注解中的值不是value,那么在进行注解是时候,需要给出对应的值的名字,假如我们在注解中做了如下定义:
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface ViewInject{
int id();
}
那么在注解的时候,需要这样:
@ViewInject(id = R.id.button)
private Button mButton;
因为value这个名字是默认的,如果我们定义为value,那么注解的时候可以省略
②注解还可以帮我们注入布局,设置监听等,这是一个很有意思的东西。
③使用注解的时候,句末不能加“;”
笔者能力有限,不足之处欢迎指出。