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

2020-11-16  本文已影响0人  如愿以偿丶

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方法内的执行,通过源码里的注解,去自动生成新的代码,在运行时执行这些新的代码。

上一篇下一篇

猜你喜欢

热点阅读