Android自定義注解與反射

反射

??JAVA反射機制是在運行狀態中,對于任意一個類,都能夠知道這個類的所有屬性和方法;對于任意一個對象,都能夠調用它的任意一個方法和屬性;這種動態獲取的信息以及動態調用對象的方法的功能稱為java語言的反射機制。

1.獲取Class對象

舉個例子,我們要獲取MainActivity的Class對象,有以下幾種方式

1.Class<MainActivity> clazz = MainActivity.class;
2.Class<? extends MainActivity> clazz = this.getClass();
3.Class<?> clazz = Class.forName("utils.utilcode.blankj.com.dongtai.MainActivity");

2.通過Class對象獲取構造方法,成員變量,方法等

構造函數

getConstructor();//獲取本類或父類中public修飾的無參構造函數
getDeclaredConstructor();//獲取本類無參構造函數
getDeclaredConstructor(Class<?>... parameterTypes): 獲取本類中指定參數的構造器

成員變量

getFields(): 獲取本類或父類中所有public屬性
getField(String name): 獲取本類或父類中特定名字的public屬性
getDeclaredFields(): 獲取本類中聲明的所有屬性

獲取方法

getMethods(): 獲取本類或父類中所有public方法(包括構造器方法)
getMethod(String name, Class<?>... parameterTypes): 獲取本類或父類中特定名字和參數的public方法
getDeclaredMethods(): 獲取本類中聲明的所有方法(包括非public但不包括繼承來的)
getDeclaredMethod(String name, Class<?>... parameterTypes): 獲取本類中聲明的特定名字和參數的方法(最常用)

獲取注解

getAnnotation(Class<A> annotationClass): 獲取這個元素上指定類型的注解(常用)
getDeclaredAnnotations(): 獲取直接標注在這個元素上的注解

父類子類(接口)相關

getSuperclass(): 返回本類的父類
getGenericSuperclass(): 以Type的形式返回本類的父類, 帶有范型信息
getInterfaces(): 返回本類直接實現的接口
getGenericInterfaces(): 以Type的形式返回本類直接實現的接口, 帶有范型信息

自定義注解

新建一個InjectView類
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface InjectView {
    int value();
}

Target表示作用范圍,這里表示作用于成員變量

/** Targe表示作用范圍
 * TYPE 作用對象類/接口/枚舉
 * FIELD 成員變量
 * METHOD 成員方法
 * PARAMETER 方法參數
 * ANNOTATION_TYPE 注解的注解
 */

Retention指定了注解有效期直到運行時時期
value就是用來指定id,也就是findViewById的參數

在MainActivity中添加注解
    @InjectView(R.id.bind_view_btn)
    Button mBindView;
    @InjectView(R.id.textView)
    TextView textView;
在MainActivity的OnCreate方法中進行注入
  super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Utils.injectView(this);
新建Utils這個類,創建injectView方法

代碼中的每一行都有詳細的注釋

    public static void injectView(Activity activity) {
        if (null == activity) return;
        //獲取activity的.class對象
        Class<? extends Activity> activityClass = activity.getClass();
//        獲取所有成員變量集合
        Field[] declaredFields = activityClass.getDeclaredFields();
        for (Field field : declaredFields) {
            //找到有@InjectView注解的成員變量
            if (field.isAnnotationPresent(InjectView.class)) {
                //得到注解類的對象
                InjectView annotation = field.getAnnotation(InjectView.class);
                //找到VIew的id
                int value = annotation.value();
                try {
                    //找到findViewById方法
                    Method findViewByIdMethod = activityClass.getMethod("findViewById", int.class);
                   //暴力訪問,可獲取私有方法
                    findViewByIdMethod.setAccessible(true);
                    View view = (View) findViewByIdMethod.invoke(activity, value);
                    //將結果賦值給成員變量
                    field.set(activity, view);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }

首先是獲取activity的.class對象,通過Class對象找到該類中所有的成員變量。繼而找到有InjectView注解的成員變量,然后得到注解類的對象,找到VIew的id,通過反射獲取Activity的findViewById方法,然后將結果傳給成員變量。

注解onClick點擊事件

新建一個onClick類

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@EventType(listenerType = View.OnClickListener.class, listenerSetter = "setOnClickListener", methodName = "onClick")
public @interface onClick {
    int[] value();
}
   Target指定了onClick注解作用對象是成員方法
   Retention指定了onClick注解有效期直到運行時時期
   value就是用來指定id,也就是findViewById的參數
新建一個EventType類
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface EventType {
    Class listenerType();
    String listenerSetter();
    String methodName();
}
Target指定了EventType注解作用對象是注解,也就是注解的注解
Retention指定了EventType注解有效期直到運行時時期
listenerType用來指定點擊監聽類型,比如OnClickListener
listenerSetter用來指定設置點擊事件方法,比如setOnClickListener
methodName用來指定點擊事件發生后會回調的方法,比如onClick

MainActivity中添加注解

    @onClick({R.id.button})
    public void onclick(View view) {
        AlertDialog.Builder builder = new AlertDialog.Builder(this);
        switch (view.getId()) {
            case R.id.button:
                Toast.makeText(this, "click", Toast.LENGTH_SHORT).show();
                break;
        }
    }

記得注入onClick事件

  setContentView(R.layout.activity_main);
  Utils.injectView(this);
  Utils.injectEvent(this);

創建injectEvent方法

    public static void injectEvent(Activity activity) {
        if (null == activity) {
            return;
        }
        //獲取activity的.class對象
        Class<? extends Activity> activityClass = activity.getClass();
        // 獲取所有方法
        Method[] declaredMethods = activityClass.getDeclaredMethods();
        for (Method method : declaredMethods) {
       //找到有@onClick注解的方法
            if (method.isAnnotationPresent(onClick.class)) {
                //得到注解類的對象
                onClick annotation = method.getAnnotation(onClick.class);
                //獲取控件id的集合
                int[] value = annotation.value();
                //獲取注解類中的注解
                EventType eventType = annotation.annotationType().getAnnotation(EventType.class);
               //得到注解類中的注解的屬性
                Class listenerType = eventType.listenerType();
                String listenerSetter = eventType.listenerSetter();
                String methodName = eventType.methodName();
                //創建InvocationHandler和動態代理(代理要實現listenerType,這個例子就是處理onClick點擊事件)
                ProxyHandler proxyHandler = new ProxyHandler(activity);
                //得到實現類的接口對象(1:實現類的類加載器2:實現類的接口數組3:proxyHandler對象(當執行接口的方法時會先執行里面的invoke,再執行實際方法,實現動態代理)
                Object listener = Proxy.newProxyInstance(listenerType.getClassLoader(), new Class[]{listenerType}, proxyHandler);
                // 將Activity中被注解的方法傳至ProxyHandler 中
                proxyHandler.mapMethod(methodName, method);
                try {
                    for (int id : value) {
                        //找到Button
                        Method findViewByIdMethod = activityClass.getMethod("findViewById", int.class);
                        findViewByIdMethod.setAccessible(true);
                        View btn = (View) findViewByIdMethod.invoke(activity, id);
                        //根據listenerSetter方法名和listenerType方法參數找到method
                        Method listenerSetMethod = btn.getClass().getMethod(listenerSetter, listenerType);
                        listenerSetMethod.setAccessible(true);
                        //反射執行setOnclickListener
                        listenerSetMethod.invoke(btn, listener);
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }

ProxyHandler代碼如下

public class ProxyHandler implements InvocationHandler {

    private WeakReference<Activity> mHandlerRef;

    private HashMap<String, Method> mMethodHashMap;

    public ProxyHandler(Activity activity) {
        mHandlerRef = new WeakReference<>(activity);
        mMethodHashMap = new HashMap<>();
    }

    public void mapMethod(String name, Method method) {
        mMethodHashMap.put(name, method);
    }


    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        Log.i("TAG", "method name = " + method.getName() + " and args = " + Arrays.toString(args));

        Object handler = mHandlerRef.get();

        if (null == handler) return null;

        String name = method.getName();

        //得到injectEvent中傳遞過來的被@onClick注解的方法
        Method realMethod = mMethodHashMap.get(name);
        if (null != realMethod){
       //反射執行Activity中onClick方法
            return realMethod.invoke(handler, args);
        }

        return null;
    }
}

重點是動態代理。這里簡單分析一下ProxyHandler 類,它主要是用于動態代理。這里為什么要用動態代理呢!是因為當我們點擊按鈕時,會觸發onClick方法,而我們需要在onClick里面執行我們注解的方法,所以必須對Activity動態代理。

Object listener = Proxy.newProxyInstance(listenerType.getClassLoader(), new Class[]{listenerType}, proxyHandler);

第一個參數為接口的加載器(本例中為Activity的接口View.OnclickListener),第二個參數為Activity的接口數組(View.OnclickListener),第三個參數為ProxyHandler 對象。返回一個實現類(View.OnclickListener)的對象。由于在injectEvent中我們反射執行了setOnClickListener,當用戶觸發點擊事件時,會執行
接口中的方法(setOnClickListener的onClick方法)然后會執行ProxyHandler 類中的invoke方法,然后反射得到Activity中被@onClick注解的方法即onClick方法,然后反射調用它,執行注解中的方法。因此

    @onClick({R.id.button})
    public void onclick(View view) {
        AlertDialog.Builder builder = new AlertDialog.Builder(this);
        switch (view.getId()) {
            case R.id.button:
                Toast.makeText(this, "click", Toast.LENGTH_SHORT).show();
                break;
        }
    }

不管方法名是什么,當用戶點擊后,都會反射執行對應方法體

注解類對象

這次我們通過注解得到Animal 的對象


public class Animal implements Fly, Run {

    public static final String TAG = "ProxyTest";

    public Animal() {
    }

    @Override
    public void fly() {
        System.out.println("Animal fly");
    }

    @Override
    public void run() {
        System.out.println("Animal run");

    }
}

同理新建一個自定義注解

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Inject {
}

在MainActivity中進行注解

   @Inject
    Animal mAnimal;

然后注入

  setContentView(R.layout.activity_main);
  Utils.injectView(this);
  Utils.injectEvent(this);
  InjectUtils.inject(this);

InjectUtil

public class InjectUtils {
    public static void inject(Activity activity) {
        if (null == activity) {
            return;
        }
        //獲取activity的.class對象
        Class<? extends Activity> activityClass = activity.getClass();
        //        獲取所有成員變量集合
        Field[] declaredFields = activityClass.getDeclaredFields();
        for (Field field : declaredFields) {
            //找到有Inject注解的成員變量
            if (field.isAnnotationPresent(Inject.class)) {
                //得到成員變量的類型的字節碼文件
                Class<?> clazz = field.getType();
                Constructor con = null;
               try {
                    //得到無參構造
                   con = clazz.getConstructor();
                    //獲取Animal其對象
                   Object instance = con.newInstance();
                    //賦值給field
                  field.set(activity,instance);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

本文中所有Demo的GitHub地址為https://github.com/zhonghongwen/Custom-Annotation

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 229,117評論 6 537
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,860評論 3 423
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 177,128評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,291評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,025評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,421評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,477評論 3 444
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,642評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,177評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,970評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,157評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,717評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,410評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,821評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,053評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,896評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,157評論 2 375

推薦閱讀更多精彩內容