Android 注解的一些应用以及原理

在这边文章之前你首先需要对java 的注解部分有一个基本的了解（不需要太过的深入）。

简单来说，注解这个东西就是用于辅助我们开发java代码的，注解本身无法干扰java源代码的执行。

在android 里面 注解主要用来干这么几件事：

1.和编译器一起给你一些提示警告信息。

2.配合一些ide 可以更加方便快捷 安全有效的编写java代码。谷歌出的support-annotations这个库 就是主要干这个的。

3.和反射一起 提供一些类似于spring 可配置的功能，方便简洁（这部分有过j2ee 开发经验的可以直接跳过了）。

 

首先来看一下官方提供的库吧。首先在build文件里 增加一句话

compile 'com.android.support:support-annotations:22.2.0'

这个地方要注意，我现在是取得version22.2的版本，你们引用的时候如果有更新，android studio可能会提示你sync失败，这个时候你要自己去谷歌官网查询一下最新的版本号自己替换。

然后我们就可以看看这个谷歌的注解库 为我们提供了哪些功能。

http://tools.android.com/tech-docs/support-annotations 这个是官方的文档 我也是主要根据这个来讲解这个库的使用。

首先来看 Nullness 注解 这个主要是有两种@Nullable  和 @NonNull。

前者表示可以为空 后者表示不能为空。

我只演示后者（前者可以自己测试）定义一个函数

然后我们去调用他 看看。

 String a=null;
        sayHello(a);

 

这个时候IDE就自动会给我们警告信息了（其实ide 的警告信息多数也是从编译器而来）

Argument 'a' might be null less... (Ctrl+F1) 
This inspection analyzes method control and data flow to report possible conditions that are always true or false, expressions whose value is statically proven to be constant, and situations that can lead to nullability contract violations.
Variables, method parameters and return values marked as @Nullable or @NotNull are treated as nullable (or not-null, respectively) and used during the analysis to check nullability contracts, e.g. report possible NullPointerException errors.
More complex contracts can be defined using @Contract annotation, for example:
@Contract("_, null -> null") — method returns null if its second argument is null @Contract("_, null -> null; _, !null -> !null") — method returns null if its second argument is null and not-null otherwise @Contract("true -> fail") — a typical assertFalse method which throws an exception if true is passed to it 
The inspection can be configured to use custom @Nullable
@NotNull annotations (by default the ones from annotations.jar will be used)

再介绍一下

Resource Type Annotations

定义一个方法

 private String sayHello(@StringRes int resId) {
        return "";
    }

然后调用

        sayHello(R.layout.activity_main);

这个地方这个注解的意思是你只能传string 类型的id进去 而我们传了layout类型的，如果你不加那个注解的话 ide和编译器是没有反应的，到运行期才会有错误。

但是你加了以后就会发现

IDE也是直接报错的！

 

再比如这样一段代码

 class TestAnoataion {

        public void testAnoation() {
            Log.v("main", "test anoation");
        }
    }

    class TestAnoataion2 extends TestAnoataion
    {
        public void testAnoation()
        {

        }
    }

假使我们父类的设计的时候本意是 如果你要重写testAnoation这个方法一定得调用父类的testAnation这个方法。就跟我们activity的oncreate方法一样。

哪如果子类没有写super.testAnoation的话 你根本就不知道 就很容易报错。但是如果你加了注解。那么ide就会很明确的提示你错误

是不是很强大?当你调用了super语句以后 一切就和谐了！

那这个support库 就暂时介绍到这里，个人建议大家有时间一定要自己过一遍一个官方文档。

这里定义的注解 对提高大家的代码质量 会非常非常有帮助。一定要掌握学会。

 

最后再上一个小例子吧，很多android 开发者都喜欢依赖注入的一些开源库，来绑定你的控件id。

这样写法不但优雅而且好用。

Butterknife

这个开源库大家一定很多人都用过，我就写一个小demo 来演示一下这些库的原理，其实还蛮简单的。

需要注意的是 要理解这个小demo 需要你除了知道注解的基础知识以外还需要有反射的基础知识。

关于反射我很久之前也写过一个教程

http://www.cnblogs.com/punkisnotdead/p/3384464.html

不会的可以赶紧补一下。

首先定义一个InjectView注解

package com.example.administrator.testfab;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Created by Administrator on 2015/8/5.
 */

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface InjectView {
    //id就表示哪些控件，-1就表示取不到时候的默认值
    int id() default -1;
}

然后定义一个解释器

package com.example.administrator.testfab;

import android.app.Activity;
import android.view.View;

import java.lang.reflect.Field;

/**
 * Created by Administrator on 2015/8/5.
 */
public class InjectViewParser {

    public static void inject(Object object) {

        try {
            parse(object);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void parse(Object object) throws Exception {
        final Class<?> clazz = object.getClass();
        View view = null;
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(InjectView.class)) {
                InjectView injectView = field.getAnnotation(InjectView.class);
                int id = injectView.id();
                if (id < 0) {
                    throw new Exception("id must not be null");
                } else {
                    field.setAccessible(true);
                    if (object instanceof View) {
                        view = ((View) object).findViewById(id);
                    } else if (object instanceof Activity) {
                        view = ((Activity) object).findViewById(id);
                    }
                    field.set(object, view);
                }

            }

        }

    }
}

最后在actity里使用即可

 

package com.example.administrator.testfab;

import android.os.AsyncTask;
import android.os.Bundle;
import android.support.annotation.CallSuper;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.StringRes;
import android.support.v7.app.AppCompatActivity;
import android.util.Log;
import android.view.Menu;
import android.view.MenuItem;
import android.widget.Button;

public class MainActivity extends AppCompatActivity {

    @InjectView(id = R.id.bt)
    private Button bt;


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        //开始注入
        InjectViewParser.inject(this);
        //这个主要是测试注入id 成功没有 成功了就不会报错~
        bt.setText("inject done");


    }


    @Override
    public boolean onCreateOptionsMenu(Menu menu) {
        // Inflate the menu; this adds items to the action bar if it is present.
        getMenuInflater().inflate(R.menu.menu_main, menu);
        return true;
    }

    @Override
    public boolean onOptionsItemSelected(MenuItem item) {
        // Handle action bar item clicks here. The action bar will
        // automatically handle clicks on the Home/Up button, so long
        // as you specify a parent activity in AndroidManifest.xml.
        int id = item.getItemId();

        //noinspection SimplifiableIfStatement
        if (id == R.id.action_settings) {
            return true;
        }

        return super.onOptionsItemSelected(item);
    }



}