butterknife源码分析：谈一谈Java的注解

butterknife源码分析系列:
谈一谈Java的注解
http://blog.csdn.net/u012933743/article/details/54909590
如何处理注解—反射与注解处理器
http://blog.csdn.net/u012933743/article/details/54972050
代码分析
http://blog.csdn.net/u012933743/article/details/64437988

我们都听过或者用过butterknife，知道butterknife是一款View注入的框架。如果让你从框架源码的角度去学习它，你会怎么做？

如果是我，我会先在项目中使用butterknife，知道它的使用方法。这样我就知道了butterknife通过注解来实现View的注入，紧接着去学习注解的定义、如何自定义注解。然后我们就有一个疑问：butterknife是如何处理这些注解的，是如何通过注解来简化代码的？带着这个疑问，我们学习到了反射、注解处理器。有了这些基础，我们就可以结合butterknife代码去分析原理。

你们可以看到这种学习方法是循序渐进的，水到而渠成。

---

定义

说起注解，大家都很熟悉。不管是Java语言本身自带的@Override、@Override，还是热门的第三方框架butterknife的@BindView、retrofit的@Get等、还是SSH开发的@Autowired。

注解我们经常用到，但是我们是否对注解的定义清晰呢？在Wiki上如此定义道：

an annotation is a form of syntactic metadata that can be added to Java source code

即注解的引入，是向Java代码中引入metadata。那什么是metadata呢？

metadata译为元数据，可以理解为数据的数据，即用来描述其他数据的数据。举些栗子，书的作者、文件的大小、图片的颜色，这些都可以理解为元数据。因此Java语言中的metadata就是为了描述代码而使用的元数据。类、方法、变量、包都可以被注解。

注解的形式为@xxxx，Javadoc和注解都会出现这样的形式。

注解：

    @Override
    protected void onCreate(Bundle savedInstanceState) {

    }

Javadoc：

    /**
     * Returns true if the list is null or 0-length.
     *
     * @param list
     * @return
     */
    public static boolean isEmpty(List list) {
        return list == null || list.size() == 0;
    }

根据上面可以知道，Javadoc的@xxxx是出现在注释中，而注解是直接作为代码的形式出现的，可以用来描述类、方法、变量等。除此之外，注解可以在代码运行或者编译时进行处理。

---

Java自带的注解

Java语言中定义了一些注解。

普通注解-用于描述代码的注解

• @Override - 检查方法是否是重载。如果在父类或者实现的接口里没有找到原型的话，编译器就会报错。
• @Deprecated - 标记该方法已弃用。如果使用的话，编译器会提示。
• @SuppressWarnings - 使编译器忽略编译时的警告，使用如@SuppressWarnings(“unused”)，忽略无用代码的提示。具体的取值如网址：http://stackoverflow.com/questions/2037326/all-suppresswarnings-values

元注解-注解的注解

元注解-meta-annotation，即注解用来注解其他注解的注解，常用来自定义注解。

栗子：

@Document
@Target(ElementType.TYPE)  
@Retention(RetentionPolicy.RUNTIME)  
@Inherited  
public @interface Test {   
    public String name() default "";      
} 

元注解有四种，栗子里都用到，分别为meta-annotation，Document、Target、Retention、Inherited。

@Document

Document标记这个注解应该被 javadoc工具记录。默认情况下，Javadoc是不包括注解的。

@Target

Target描述了这个注解的使用范围，使用方法如@Target(ElementType.TYPE)，ElementType的取值有七种，如下：

• CONSTRUCTOR：用于描述构造器
• FIELD：用于描述域
• LOCAL_VARIABLE：用于描述局部变量
• METHOD：用于描述方法
• PACKAGE：用于描述包
• PARAMETER：用于描述参数
• TYPE：用于描述类、接口(包括注解类型) 或enum声明

@Retention

Retention用来描述这个注解的生命周期，即注解的”存活时间”，使用方法如@Retention(RetentionPolicy.RUNTIME)，RetentionPolicy有三种，如下：

• SOURCE: 将被编译器丢弃（即源文件保留）
• CLASS: 在class文件中可用，但会被JVM丢弃（即class保留）
• RUNTIME: 在运行时有效（即运行时保留）

我们知道，Java代码会由源代码编译成class文件，然后再运行。Retention用来描述注解在这个阶段的存活时间。例如，当一个注解为RUNTIME时，表明我们可以在运行时通过反射获取到注解的内容，然后再去做相应的处理。

@Inherited

Inherited译为可继承的，如果一个使用了@Inherited 修饰的 annotation类型 被用于一个 class，则这个 annotation 将被用于该class的子类。

认识这四个元注解，我们就能定义属于自己的注解！

自定义注解

使用@interface自定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组）。可以通过default来声明参数的默认值。

值得一提的是，如果只有一个参数成员,最好把参数名称设为”value”，这样子，这样做有个好处。例如注解 A，正常调用时这样子：@A(value=”jerry”)，可以简化为@A(“jerry”)。

这里我举两个栗子来进行介绍，一个是butterknife中的BindView注解，一个是项目中使用到的注解。

butterknife的BindView

@Retention(CLASS) @Target(FIELD)
public @interface BindView {
  /** View ID to which the field will be bound. */
  @IdRes int value();
}

BindView注解用来冗杂的findViewById操作，使用如

@BindView(R.id.title) TextView title;

无需再去编写

title = (TextView)findViewById(R.id.title);

@Retention(CLASS)表明了BindView在class文件中保留，在runtime时不存在，这意味着butterknife是在编译时生成绑定View的代码，因此butterknife在运行时不会造成影响，只会影响编译时的速度，这也解释了butterknife受欢迎的原因。

@Target(FIELD)表明该注解是用来修饰域变量的，如上面栗子所示。

@IdRes int value(); @IdRes是android.support.annotation里定义的注解，表示只接受类似R.id.xxx形式(即为int的Id)的参数。

项目中的GenderType注解

假如有这样一种情形，有个方法，入参为用户的性别。该入参有俩种情况。

public static final int MALE = 1;  // 男性
public static final int FEMALE = 2; // 女性

方法名为

public void setGender(int genderType) {

}

一般调用可能这样调用

user.setGender(Constant.MALE);

但是setGender的入参为int，因此我们可以直接传入1作为参数，这样能达到目的，如果传入3呢？这样就会可能出现奇怪的问题，然而编译器并没有提醒我们。

这是我们其实可以通过注解的方式，来让代码更为”安全”。

我们都用过View的setVisibility方法，入参为VISIBLE、INVISIBLE、GONE三种，那我们如果直接传入VISIBLE的int值进去，编译器会报错：Must be one of: View.VISIBLE, View.INVISIBLE, View.GONE的错误。

参考View的setVisibility的方法以及Visibility注解，我们可以定义如下的注解：

@IntDef({GENDER_MALE, GENDER_FEMALE})
@Retention(RetentionPolicy.SOURCE) // 只需在源代码中保存，无需到class文件中
public @interface GenderType {
}

在定义方法时如下：

public void setGender(@GenderType int genderType) {
}

这样子当我们试图使用setGender(3)时就会报错：Must be one of: GenderType.MALE, GenderType.FEMALE的错误。

通过这样子，我们限制入参，让代码更为安全。

后记

如有问题，可以在评论中追问。

• Wiki-Java annotation
  https://en.wikipedia.org/wiki/Java_annotation
• Java中的注解是如何工作的？
  http://www.importnew.com/10294.html