Android中注解的使用

      如果你是一名安卓開發者，你也一定聽過大名鼎鼎的網絡請求框架Retrofit。它將網絡請求的方式以注解的形式展現，極大的提高了代碼的可讀性，同時網絡請求集中寫在一個interface中提高了代碼的可維護性。除此之外，例如Dagger , GreenDao，ButterKnife等等 也是大量運營了注解。為什么這些知名的開源項目如此青睞注解？

       在注解使用之前，xml被廣泛用於描述原數據，但是在使用xml越來越長之后，開發人員意識到使用xml耦合性太高。於是在java 5.0 的版本，注解(Annotation)出現了。目前xml 與 Annotation 共同使用着，發揮着他們的長處。我們該如何使用注解呢？其實注解使用起來非常簡單。一個自定義注解可以被四個java 規定的原注解所描述這四個原注解分別是:@Documented   @Retention  @Target  @Inherited 。

 

 @Documented -表示是否將注解信息添加在java文檔中。

 

 @Retention -定義該注解的生命周期。

 RetentionPolicy.SOURCE – 在編譯階段丟棄。這些注解在編譯結束之后就不再有任何意義，所以它們不會寫入字節碼。@Override, @SuppressWarnings都屬於這類注解。

 RetentionPolicy.CLASS – 在類加載的時候丟棄。在字節碼文件的處理中有用。注解默認使用這種方式。

 RetentionPolicy.RUNTIME– 始終不會丟棄，運行期也保留該注解，因此可以使用反射機制讀取該注解的信息。我們自定義的注解通常使用這種方式。

 

 @Target -表示該注解用於什么地方。如果不明確指出，該注解可以放在任何地方。以下是一些可用的參數。需要說明的是：屬性的注解是兼容的，如果你想給7個屬性都添加注解，

僅僅排除一個屬性，那么你需要在定義target包含所有的屬性。

 ElementType.TYPE:用於描述類、接口或enum聲明
 ElementType.FIELD:用於描述實例變量
 ElementType.METHOD
 ElementType.PARAMETER
 ElementType.CONSTRUCTOR
 ElementType.LOCAL_VARIABLE
 ElementType.ANNOTATION_TYPE 另一個注釋
 ElementType.PACKAGE 用於記錄java文件的package信息

 

 @Inherited  -定義該注釋和子類的關系

 

        話不多說我們來實戰一下。在我們開始寫項目的時候通常都會封裝一個BaseActivity，每個面向界面的Activity中都會指向一個xml 界面文件，也就是Activity 與 xml是綁定關系的。這樣我們的注解就能派上用場了，我們可以通過注解將xml 綁定到對應的Activity中。一個Activity類中綁定一個layout 那么我們的注解描述類型就是TYPE。這個綁定效果一定是作用到運行時的，所以有了如下代碼。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface BindLayout {
    @LayoutRes
    int value();

}

         我們通過反射獲取到這個注解中傳入的xml數據，將他綁定在Activity中。代碼如下：

private static void bindActivityLayout(Activity activity) {
        Class aClass = activity.getClass();
        BindLayout annotation = (BindLayout) aClass.getAnnotation(BindLayout.class);
        if (annotation != null) {
            activity.setContentView(annotation.value());
            ButterKnife.bind(activity);
        }
    }

        我們只要在Activity中的OnCreate初始化一下，就能夠輕松實現綁定。

@BindLayout(R.layout.activity_xx)
public class XXActivity extends Activity {

@Override
    protected void onCreate() {
        MoBind moBind = new MoBind();
        moBind.bindActivity(this);

    }
...

}

       比較正確的做法是將綁定方法放入BaseActivity中，讓我們的子類繼承於他，這樣一對一的關系變的簡潔明了。當然，不只只是這樣，你可以開發新的用途，例如，我們需要在界面中綁定其他View做一下操作，比如顯示一個空的界面或者顯示一個自定義的Dialog。

通過注解，也可以快速的綁定，還記得我們的原注解Targe可以修飾一個變量，於是綁定一個其他View在Activity中就可以這么做：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@Documented
public @interface BindOthersView {
    @LayoutRes int value();
}

      我們一樣通過反射調用：

private static void bindActivityView(Activity activity) {
        Field[] declaredFields = activity.getClass().getDeclaredFields();
        if (declaredFields != null && declaredFields.length > 0) {
            for (Field f : declaredFields) {
                BindOthersView annotation = f.getAnnotation(BindOthersView.class);
                if (annotation != null) {
                    View inflate = LayoutInflater.from(activity).inflate(annotation.value(), null);
                    if (inflate != null) {
                        try {
                            f.setAccessible(true);
                            f.set(activity, inflate);
                        } catch (IllegalAccessException e) {
                            e.printStackTrace();
                        }
                    }
                }
            }
        }

    }

     我們只需要在BaseActivity中的OnCreate 中初始化一次，就可以在它的子類中隨意綁定其他View(代碼中已經做了初始化，請放心使用)。

  @BindOthersView(R.layout.empty_view)

  View emptyView; 

     怎么樣，實現起來是不是非常簡單，總結起來就是三個步驟，定義注解，解析注解，使用注解。快去定義你自己的注解，讓你的代碼變得簡潔且逼格滿滿吧。