注解/反射/注解处理器(Annotation Processor)解析

1.介绍

  注解处理器是javac(java compiler)编译器内置的一个用于编译时奥妙和处理注解的工具,在我们源代码编译阶段,通过过注解处理器,我们可以获取源文件内注解相关内容。


2.用途/原理

  因为注解处理器可以在程序编译之前工作,通过源码里的注解,去自动生成新的代码,在运行时执行这些新的代码,注意:这也是避免不了反射的,因为新生成的代码,它在运行的时候也是需要反射的。

3.常见三方库

  Dagger,EventBus等

4.注解

  1.注解相当一一种标记,我们通过查找类,方法,变量上的注解(标记)
  2.javac编译器,开发工具和我们代码中都可以通过反射来获取标记信息

例如:

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

 常用注解
  1.@Retention:对Annotation的"声明周期限制",表示需要在什么级别保存该注解信息
    1.RetentionPolicy.SOURCE,在源文件中有效
    2.RetentionPolicy.CLASS,在class文件中有效
    3.RetentionPolicy.RUNTIME,在运行时有效

  2.@Target:表示Annotation所修饰的范围,作用在谁的上边
    1.ElementType.FIELD,作用在成员变量、对象、属性(包括enum实例)上
    2.ElementType.TYPE,作用在类,接口上
    3.ElementType.METHOD,作用在方法上
    ...

我们通过注解来实现Butterknife的BindView。
 1.声明注解:
 2.注解作用在属性上:
 3.通过Binding.bind()进行绑定:

//1.声明注解:
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)         
public @interface BindView {
    int value();
}
  public class AnnotationProcessActivity extends AppCompatActivity {
    //2.注解作用在属性上
    @BindView(R.id.tv_textview)
    TextView tvTextView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_annotation_process);
        //3.通过Binding.bind()进行绑定
        InnerBinding.bind(this);
        tvTextView.setText("哈哈哈");
    }
}
public class InnerBinding {
    public static void bind(AnnotationProcessActivity activity){
        activity.tvTextView = activity.findViewById(R.id.tv_textview);
    }
}

我们也可以通过反射来获取Activity的属性的注解,进行设置。

public class InnerBinding {

    public static void bind(Activity activity){
        //1.通过反射查看activity每一个字段是否有BindView注解
        for (Field field :activity.getClass().getDeclaredFields()){
            BindView bindView =  field.getAnnotation(BindView.class);
            //2.如果有,进行findViewById,进行设置set(设置在谁上边,value)
            if (bindView != null){
                try {
                    field.setAccessible(true); //能够注入所有修饰符  private public
                    //3.设置在View上
                    field.set(activity,activity.findViewById(bindView.value()));
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

反射的好处:使用起来简单
反射的不好地方:影响性能,如果多个属性,那么就会调用多次反射的代码。

问题:那Butterknife算是依赖注入吗?
答:不是,是不是依赖注入,关键不在于你怎么写,而是在于他这个依赖由谁来决定的,是你的依赖决定权交给外部,让它做好处理好,给你拿进来注入进来,比如:Dagger通过DaggerUtils.getMap().inject(this),他是通过外部,getMap来决定,而Butterknife不是,它只是自己懒,不想写findViewById,我交给你来写,我们只能说他是一个绑定库,并不是一个依赖注入库。
  什么是依赖:就比如我们一个类的同属性,就是这个类的依赖。就比如上边的AnnotationProcessActivity中。AnnotationProcessActivity就依赖于tvTextView。


5.注解处理器模型

1.Binding:每一个类的注解进行处理。
2.AnnotationProcessActivity
3.AnnotationProcessActivityBinding:处理Activity内部的事情

 实现自动调用:首先需要已知类名结果的前提下。

/**
 * 已知类名结构的前提下
 */
public class Binding {
    //自动调用,其实就做了一件是事情new AnnotationProcessActivityBinding();
    public static void bind(Activity activity){
        try {
            Class bindingClass =  Class.forName(activity.getClass().getCanonicalName() + "Binding");        //AnnotationProcessActivityBinding
            Class activityClass =  Class.forName(activity.getClass().getCanonicalName());                   //AnnotationProcessActivity
            Constructor constructor = bindingClass.getDeclaredConstructor(activityClass);                   //获取构造方法,进行创建。
            constructor.newInstance(activity);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }
}
public class AnnotationProcessActivity extends AppCompatActivity {

    TextView tvTextView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_annotation_process);

        Binding.bind(this);
        tvTextView.setText("哈哈哈");
    }
}
public class AnnotationProcessActivityBinding {

    public AnnotationProcessActivityBinding(AnnotationProcessActivity activity) {
        activity.tvTextView = activity.findViewById(R.id.tv_textview);
    }
}

需求:那如果我们的
通过Annotation Process来实现ButterKnife。
使用:
1.首先创建一个java.library,将我们的注解类和Binding类拷贝过去,添加依赖

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.FIELD)         
public @interface BindView {
    int value();
}
public class Binding {
    //自动调用,其实就做了一件是事情new AnnotationProcessActivityBinding();
    public static void bind(Activity activity){
        try {
            Class bindingClass =  Class.forName(activity.getClass().getCanonicalName() + "Binding");        //AnnotationProcessActivityBinding
            Class activityClass =  Class.forName(activity.getClass().getCanonicalName());                   //AnnotationProcessActivity
            Constructor constructor = bindingClass.getDeclaredConstructor(activityClass);                   //获取构造方法,进行创建。
            constructor.newInstance(activity);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }
    }
}

2.利用annotation processor通过注解来生成代码,创建java library。
  2.1.在java下创建Director文件名叫resources
  2.2.在resources文件下在创建文件META-INF/services/javax.annotation.processing.Processor

image.png

    其内容是一系列的自定义注解处理器完整有效类名集合,以换行切割:

  com.yc.lib_processor.BindingProcessor

  2.3.创建BindingProcessor类继承AbstractProcessor

public class BindingProcessor extends AbstractProcessor {
    Filer filer;
    @Override
    public synchronized void init(ProcessingEnvironment processingEnvironment) {
        super.init(processingEnvironment);
        filer = processingEnvironment.getFiler();
    }

    /**
     * 处理注解,生成代码    可以使用工具
     * @param set
     * @param roundEnvironment
     * @return
     */
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        return false;
    }

    /**
     * 表示处理那些注解  自己设置
     * @return
     */
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotations = new LinkedHashSet<>();
        annotations.add(BindView.class.getCanonicalName());
        annotations.add(OnClick.class.getCanonicalName());
        return annotations;
    }
}

最后:

会通过process方法内的执行,通过源码里的注解,去自动生成新的代码,在运行时执行这些新的代码。

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