自己動手打造一個注解框架,徹底擺脫FindViewById

每次寫代碼的時候,看到一大堆FindViewById()都挺煩的,沒有沒什么方法能幫我擺脫這種煩惱呢?當然是有的,目前比較流行的時注解框架是Xutils3ButterKnife,接下來我們來分析一下它們是如何實現(xiàn)的.

Xutils3注解實現(xiàn)原理

  1. 首先看一下Xutils3的簡單用法
 @ViewInject(R.id.tv_test)
    private TextView mTvTest;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        x.view().inject(this);

        mTvTest.setText("hello ioc");
    }

用法是相當?shù)暮唵?通過@ViewInject綁定id,然后通過inject(this)注入當前對象,就完成了findViewById的過程.

  1. 查看Xutils原碼,看看inject(this)做了什么

        // inject view
        Field[] fields = handlerType.getDeclaredFields();
        if (fields != null && fields.length > 0) {
            for (Field field : fields) {

                Class<?> fieldType = field.getType();
                if (
                /* 不注入靜態(tài)字段 */     Modifier.isStatic(field.getModifiers()) ||
                /* 不注入final字段 */    Modifier.isFinal(field.getModifiers()) ||
                /* 不注入基本類型字段 */  fieldType.isPrimitive() ||
                /* 不注入數(shù)組類型字段 */  fieldType.isArray()) {
                    continue;
                }

                ViewInject viewInject = field.getAnnotation(ViewInject.class);
                if (viewInject != null) {
                    try {
                        View view = finder.findViewById(viewInject.value(), viewInject.parentId());
                        if (view != null) {
                            field.setAccessible(true);
                            field.set(handler, view);
                        } else {
                            throw new RuntimeException("Invalid @ViewInject for "
                                    + handlerType.getSimpleName() + "." + field.getName());
                        }
                    } catch (Throwable ex) {
                        LogUtil.e(ex.getMessage(), ex);
                    }
                }
            }
        } // end inject view

我們發(fā)現(xiàn)這里主要是通過反射,先獲取該類的所有的屬性,然后遍歷,找到ViewInject注解,然后獲取value值,即對應(yīng)的viewId,然后再調(diào)用FindViewById找到對應(yīng)的View,

 field.setAccessible(true);
 field.set(handler, view);

然后通過上述代碼注入屬性,就完成了FindViewById的全過程.仔細一分析,是不是也不是那么難.主要就是利用了java的反射機制,通過動態(tài)獲取Annotation,然后實現(xiàn)View的注入.

屬性注入 : 利用反射去 獲取Annotation --> value --> findViewById --> 反射注入屬性
事件注入 :利用反射去 獲取Annotation --> value --> findViewById --> setOnclickListener --> 動態(tài)代理反射執(zhí)行方法

ButterKnife注解實現(xiàn)原理

  1. 同樣的,我們來看一下ButterKnife的簡單用法
 @Bind(R.id.tv_test)
    private TextView mTvTest;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        mTvTest.setText("hello ioc");
    }

也非常簡潔,兩行代碼完成屬性注入.(這里使用的7.0.1所以是@Bind而不是@BindView);

  1. 查看源碼
    ButterKnife的源碼看起來就比較費勁了,主要是通過ButterKnifeProcessor這個類動態(tài)解析Annotation注解,在編譯時生成xxxxx$$ViewBinder這個類,然后實現(xiàn)FindViewById過程.
public class MainActivity$$ViewBinder<T extends com.example.wenjian.eassyjoke.MainActivity> implements ViewBinder<T> {
  @Override public void bind(final Finder finder, final T target, Object source) {
    View view;
    view = finder.findRequiredView(source, 2131427415, "field 'mTvTest'");
    target.mTvTest = finder.castView(view, 2131427415, "field 'mTvTest'");
  }

  @Override public void unbind(T target) {
    target.mTvTest = null;
  }
}

在這里我們也可以看到為什么聲明屬性的時候不能private

兩者實現(xiàn)的方式有差異,ButterKnife基于編譯時注解,相對較為高效

打造自己的注解框架

看了別人的代碼,自己也可以動手擼一下了

  1. 首先我們得了解javaAnnatation,在這里我們先參考一下java的@Override
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

這里我們可以知道如何自定義注解
@Target指定注解作用目標,以下是ElementType的幾種常用類型

Class, interface (including annotation type), or enum declaration /
TYPE,類
/
* Field declaration (includes enum constants) /
FIELD,屬性
/
* Method declaration /
METHOD,方法
/
* Formal parameter declaration /
PARAMETER,參數(shù)
/
* Constructor declaration /
CONSTRUCTOR,構(gòu)造方法
/
* Local variable declaration /
LOCAL_VARIABLE,本地變量
/
* Annotation type declaration /
ANNOTATION_TYPE,注解類型
/
* Package declaration */
PACKAGE,包

@Retention指定何時生效,有以下三種場景

 * Annotations are to be discarded by the compiler.
 */
SOURCE,源碼
/**
 * Annotations are to be recorded in the class file by the compiler
 * but need not be retained by the VM at run time.  This is the default
 * behavior.
 */
CLASS,編譯時
/**
 * Annotations are to be recorded in the class file by the compiler and
 * retained by the VM at run time, so they may be read reflectively.
 *
 * @see java.lang.reflect.AnnotatedElement
 */
RUNTIME,運行時

2.開始碼自己的注解框架
自定義@ViewById

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)  //什么時候生效:運行時
public @interface ViewById {
    int value();
}

實現(xiàn)ViewUtils兼容各種場景

public class ViewUtils {

    public static void inject(Activity activity) {
        inject(new ViewFinder(activity),activity);

    }

    public static void inject(View view) {
        inject(new ViewFinder(view),view);
    }

    public static void inject(View view, Object object) {
        inject(new ViewFinder(view),object);
    }

    private static void inject(ViewFinder finder, Object object) {
        injectField(finder, object);
        injectEvent(finder, object);
    }

通過反射注入屬性

 /**
     * 注入屬性
     * @param finder
     * @param object
     */
    private static void injectField(ViewFinder finder, Object object) {
        //1.獲取class
        Class<?> clazz = object.getClass();

        //2.獲取所有的屬性
        Field[] fields = clazz.getDeclaredFields();

        for (Field field : fields) {
            ViewById viewById = field.getAnnotation(ViewById.class);
            if (viewById != null) {
                int viewId = viewById.value();
                View view = finder.findViewById(viewId);
                if (view != null) {
                    //設(shè)置可以訪問所有修飾符  包括private
                    field.setAccessible(true);
                    try {
                        //注入屬性
                        field.set(object, view);
                    } catch (IllegalAccessException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
    }

到此已經(jīng)完成了,我們來驗證一下吧

    @ViewById(R.id.tv_test)
    private TextView mTvTest;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ViewUtils.inject(this);
        mTvTest.setText("hello ioc");
    }

Xutils的實現(xiàn)方式差不多,同樣是基于反射,重要的是不必依賴第三方庫了.你也自己動手實現(xiàn)setOnclickListener,原理是一樣的.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末验残,一起剝皮案震驚了整個濱河市哼拔,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖渊涝,帶你破解...
    沈念sama閱讀 216,470評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件谎替,死亡現(xiàn)場離奇詭異,居然都是意外死亡逮栅,警方通過查閱死者的電腦和手機悴势,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,393評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來措伐,“玉大人特纤,你說我怎么就攤上這事〗募樱” “怎么了捧存?”我有些...
    開封第一講書人閱讀 162,577評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我昔穴,道長镰官,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,176評論 1 292
  • 正文 為了忘掉前任吗货,我火速辦了婚禮泳唠,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘宙搬。我一直安慰自己笨腥,他們只是感情好,可當我...
    茶點故事閱讀 67,189評論 6 388
  • 文/花漫 我一把揭開白布勇垛。 她就那樣靜靜地躺著脖母,像睡著了一般。 火紅的嫁衣襯著肌膚如雪窥摄。 梳的紋絲不亂的頭發(fā)上镶奉,一...
    開封第一講書人閱讀 51,155評論 1 299
  • 那天,我揣著相機與錄音崭放,去河邊找鬼哨苛。 笑死,一個胖子當著我的面吹牛币砂,可吹牛的內(nèi)容都是我干的建峭。 我是一名探鬼主播,決...
    沈念sama閱讀 40,041評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼决摧,長吁一口氣:“原來是場噩夢啊……” “哼亿蒸!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起掌桩,我...
    開封第一講書人閱讀 38,903評論 0 274
  • 序言:老撾萬榮一對情侶失蹤边锁,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后波岛,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體茅坛,經(jīng)...
    沈念sama閱讀 45,319評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,539評論 2 332
  • 正文 我和宋清朗相戀三年则拷,在試婚紗的時候發(fā)現(xiàn)自己被綠了贡蓖。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,703評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡煌茬,死狀恐怖斥铺,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情坛善,我是刑警寧澤晾蜘,帶...
    沈念sama閱讀 35,417評論 5 343
  • 正文 年R本政府宣布邻眷,位于F島的核電站,受9級特大地震影響笙纤,放射性物質(zhì)發(fā)生泄漏耗溜。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,013評論 3 325
  • 文/蒙蒙 一省容、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧燎字,春花似錦腥椒、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,664評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至蛉鹿,卻和暖如春滨砍,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背妖异。 一陣腳步聲響...
    開封第一講書人閱讀 32,818評論 1 269
  • 我被黑心中介騙來泰國打工惋戏, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人他膳。 一個月前我還...
    沈念sama閱讀 47,711評論 2 368
  • 正文 我出身青樓响逢,卻偏偏與公主長得像,于是被迫代替她去往敵國和親棕孙。 傳聞我的和親對象是個殘疾皇子舔亭,可洞房花燭夜當晚...
    茶點故事閱讀 44,601評論 2 353

推薦閱讀更多精彩內(nèi)容