摘要：基本語法我們通過注解的定義來切入注解的語法。跟定義接口差不多，就是用到的是，然后加上了元注解。那么元注解的作用是什么呢元注解元注解說明了注解所修飾對(duì)象的類型。也就是標(biāo)識(shí)該注解可以被繼承。的內(nèi)置注解重寫了父類的方法表示已過時(shí)，不推薦使用。

在Android開發(fā)中我們經(jīng)常會(huì)用到注解，例如@Override Butterknife中的BindView等。這里主要記錄下注解怎么寫和簡單的使用。

我們通過Override注解的定義來切入注解的語法。

    @Target(ElementType.METHOD)
    @Retention(RetentionPolicy.SOURCE)
    public @interface Override {
    }

在java源碼中，通過上面的幾行代碼就定義了一個(gè)Override的注解，定義注解的時(shí)候用到了兩個(gè)元注解Target,Retention。什么是元注解？注解注解的注解就是元注解。跟定義接口差不多，就是用到的是@interface，然后加上了元注解。那么元注解的作用是什么呢？

元注解：@Target,@Retention,@Documented,@Inherited

@Target說明了注解所修飾對(duì)象的類型。由EelmentType所描述

public enum ElementType {
    TYPE, //class interface enum
    FIELD, //域
    METHOD, //方法
    PARAMETER, //參數(shù)
    CONSTRUCTOR, //構(gòu)造
    LOCAL_VARIABLE, //局部變量
    ANNOTATION_TYPE, //注解
    PACKAGE, //包
}

實(shí)例：

/**
 * 這樣我們就定義了一個(gè)作用在類型和域上面的注解
 */
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface Entity {
}

@Retention 表明注解作用的時(shí)間。由RetentionPolicy所描述

public enum RetentionPolicy {
    /**
     * 只在源碼顯示，編譯時(shí)丟棄;
     */
    SOURCE,

    /**
     * 編譯時(shí)記錄到.class中，運(yùn)行時(shí)忽略;默認(rèn)值
     */
    CLASS,

    /**
     * 運(yùn)行時(shí)保留，運(yùn)行中可以處理。（我們用的較多的就是這個(gè)）
     */
    RUNTIME
}

含有該注解類型的元素(帶有注釋的)會(huì)通過javadoc或類似工具進(jìn)行文檔化。
我們來對(duì)比一下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface NoDocumented {
}

@Documented
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestDocumented {
}
    
    @TestDocumented
    public void funTestDocumented(){
        System.out.println("有@Documented");
    }

    @NoDocumented
    public void funNoDocucmented(){
        System.out.println("無@Documented");
    }

定義以上兩個(gè)注解并測試，利用javadoc生成文檔后顯示如下：

根據(jù)字面意思是繼承。也就是標(biāo)識(shí)該注解可以被繼承。只作用在類上面。

@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Entity {
    String value() default "";
    int name() default 0;
}

我們在定義注解的時(shí)候，可以添加相關(guān)的參數(shù)。定義了參數(shù)之后我們就可以通過反射的方式獲取到注解，然后獲取該參數(shù)了。如下所示：

        Class cClass = TestInheritedC.class;
        Entity annotation = cClass.getAnnotation(Entity.class);
        if (annotation != null) {
            String value = annotation.value();
            int name = annotation.name();
            System.out.println("value = " + value + "  name = " + name);
        }

注解參數(shù)的類型包括：基本數(shù)據(jù)類型，String,Class,Enum,Annotation,及前邊這些類型的數(shù)組類型。

@Override 重寫了父類的方法
@Deprecated 表示已過時(shí)，不推薦使用。一般在使用被標(biāo)注的方法、類等時(shí)編輯器會(huì)出現(xiàn)刪除線。
@@SuppressWarnnings 用于通知Java編譯器關(guān)閉對(duì)特定類、方法、成員變量、變量初始化的警告

compile "com.android.support:support-annotations:24.2.0"

support-annotations包為我們提供了很多實(shí)用的注解，來方便代碼的檢查，例如 @Nullable ,@NonNull等，具體的使用參考Android官方文檔。

這里說一下類型的定義IntDef和StringDef,在開發(fā)中經(jīng)常要使用Enum類型。不過Enum在開發(fā)中性能不如常量。我們可以使用注解的方式進(jìn)行替換。例如下面是View源碼中的一個(gè)栗子

    @IntDef({VISIBLE, INVISIBLE, GONE})
    @Retention(RetentionPolicy.SOURCE)
    public @interface Visibility {}

借用官方文檔上的栗子，是這么使用的：

    // Define the list of accepted constants and declare the NavigationMode annotation
    @Retention(RetentionPolicy.SOURCE)
    @IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})
    public @interface NavigationMode {}

    // Declare the constants
    public static final int NAVIGATION_MODE_STANDARD = 0;
    public static final int NAVIGATION_MODE_LIST = 1;
    public static final int NAVIGATION_MODE_TABS = 2;

    // Decorate the target methods with the annotation
    @NavigationMode
    public abstract int getNavigationMode();