注解运用与解析

由于本人能力有限,文中若有错误之处,欢迎指正。
转载请注明出处:http://www.jianshu.com/p/f57044b8050c

上一篇 3分钟快速掌握注解(Annotation) 中讲述了注解的基础知识,以及自定义注解。本篇将继续讲解注解的实例应用。

注解解析

注解在使用中一般都需要解析,而解析又分为两种:

  1. 运行时刻解析
    利用 Java 的反射机制,在运行时动态获取注解信息,改变程序的运行状态。
    优点:编码简单
    缺点:反射带来的性能问题

  2. 编译时刻解析
    编译时刻注解解析依靠的是 注解处理工具apt(Annotation Processor Tool),在编译时获取注解信息,动态生成源码或配置文件,改变程序运行状态。
    优点:无反射带来的性能问题
    缺点:编码复杂,使用相对较麻烦


本篇简文主要讲述运行时刻注解解析,文中将以Android中常见的视图注入为例,也是早期的视图注入框架的原理

简单视图注入实例

  1. 首先我们需要自定义注解InjectView
@Retention(RetentionPolicy.RUNTIME) // 在运行时刻能够获取到注解信息
@Target(ElementType.FIELD) // 指定注解作用在属性字段上
public @interface InjectView {

    @IdRes // 指定返回值是一个id资源,IDE会帮我们检查,该注解存在于 com.android.support:support-annotations
    int value();
}
  1. 写一个InjectUtils作为我们视图注入的入口,在这里完成注入操作
public class InjectUtils {

    public static void inject(Activity activity){
        Class<? extends Activity> actClass = activity.getClass();
        // 注入View
        injectView(activity, actClass);
    }

    private static void injectView(Activity activity, Class<?> actClass) {
        if(actClass == null || activity == null){
            return;
        }

        // 递归查找父类中被注解的字段
        injectView(activity, actClass.getSuperclass());

        // 获取Activity中所有的字段,并进行遍历
        Field[] fields = actClass.getDeclaredFields();
        if(fields == null || fields.length <= 0){
            return;
        }

        for (Field field : fields) {
            // 获取字段上标记的注解对象
            InjectView injectView = field.getAnnotation(InjectView.class);
            if(injectView == null){
                continue;
            }

            View view = activity.findViewById(injectView.value());
            try {
                if(view != null){
                    // 给字段赋值,完成注入操作
                    field.setAccessible(true);
                    field.set(activity, view);
                } else {
                    throw new InjectException("Invalid @InjectView for "
                            + actClass.getSimpleName() + "." + field.getName());
                }
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
        }
    }

}
  1. 使用示例
public class MainActivity extends BaseActivity {

    @InjectView(R.id.btn_ok)
    private Button btnOk; // 可以是private修饰

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        
        // 在 setContentView 之后调用完成注入
        InjectUtils.inject(this); 

        btnOk.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                tvHello.setText("ok"); // tvHello可以声明在父类中
            }
        });
    }
}

扩展

既然知道了注入原理,那我们除了可以注入Activity中的视图,当然也可以注入Fragment、Holder...中的视图。甚至也可以像ButterKnife一样注入各种资源、以及事件处理。下面以setContentView()为例,为Activity注入布局资源。其它可以自行尝试扩展。

  1. 在以上基础上增加自定义注解ContentView
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ContentView {

    @LayoutRes
    int value();
}
  1. 修改InjectUtils
public class InjectUtils {

    public static void inject(Activity activity){
        Class<? extends Activity> actClass = activity.getClass();
        // 注入页面布局,注意一定在 injectView()之前调用!!!!      
        injectContentView(activity, actClass);
        // 注入View
        injectView(activity, actClass);
    }
    
    private static void injectContentView(Activity activity, Class<? extends Activity> actClass) {
        ContentView contentView = actClass.getAnnotation(ContentView.class);
        if(contentView == null){
            return;
        }
        try {
            Method setContentViewMethod = actClass.getMethod("setContentView", int.class);
            setContentViewMethod.invoke(activity, contentView.value());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static void injectView(Activity activity, Class<?> actClass) {
          // ... 保持不变
    }

}
  1. 使用示例
@ContentView(R.layout.activity_main)
public class MainActivity extends BaseActivity {

    @InjectView(R.id.btn_ok)
    Button btnOk;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        InjectUtils.inject(this); // 不需要再调用setContentView方法
    }

}

写在最后

这里只是拿视图注入作为切入点,讲解注解在开发中的实例应用,以及剖析了早期视图注入框架的原理。仅作为学习用途,在实际开发中请使用更加稳定、更加高效的开源库。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,835评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,598评论 1 295
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,569评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,159评论 0 213
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,533评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,710评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,923评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,674评论 0 203
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,421评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,622评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,115评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,428评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,114评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,097评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,875评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,753评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,649评论 2 271

推荐阅读更多精彩内容