Android开发之注解

最新推荐文章于 2024-07-16 20:42:44 发布

VitonWen

最新推荐文章于 2024-07-16 20:42:44 发布

阅读量227

点赞数

本文链接：https://blog.csdn.net/qq_36443441/article/details/88843927

版权

注解基础

注解的作用：

降低项目的耦合度。
自动完成一些规律性的代码。
自动生成java代码，减轻开发者的工作。

元注解

元注解	描述
@Retention	注解保留的生命周期。可选的RetentionPolicy参数包括： SOURCE：只在源码中有效，编译时抛弃 CLASS：编译class文件时生效 RUNTIME：运行时生效
@Target	注解对象的作用范围。可选的ElementType参数包括： TYPE：类、接口、枚举、注解类型 FILED：类成员（构造方法、方法、成员变量） METHOD：方法 PARAMETER：参数 CONSTRUCTOR：构造器 LOCAL_VARIABLE：局部变量 ANNOTATION_TYPE：注解 PACKAGE：包声明 TYPE_PARAMETER：类型参数 TYPE_USE：类型使用声明
@Inherited	允许子类继承父类中的注解
@Documented	将此注解包含在Javadoc中

自定义注解

运行时注解

下面我们通过自定义一个运行时注解通过反射的方式将findViewById的到的控件注入到相应的控件中：

//自定义GetViewTo运行时注解
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface GetViewTo {
    int value() default -1;
}

//在Activity中使用注解注入控件
public class AnnotationTestActivity extends AppCompatActivity {
    @GetViewTo(R.id.btn_1)
    private Button btnOne;
    @GetViewTo(R.id.btn_2)
    private Button btnTwo;
    @GetViewTo(R.id.cl_view)
    private CircleView clView;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
       getAllAnnotationView();
        Log.e("tag", btnOne + "---------" + btnTwo + "-----------" + clView);
    }

    /**
     * 解析注解，通过反射将View注入到控件中
     */
    private void getAllAnnotationView() {
        //获取成员变量
        Field[] fields = getClass().getDeclaredFields();
        for (Field f : fields) {
            //确定注解
            if (f.isAnnotationPresent(GetViewTo.class)) {
                //运行修改反射属性
                f.setAccessible(true);
                GetViewTo getViewTo = f.getAnnotation(GetViewTo.class);
                try {
                    //通过findViewById找到注解id的View注入成员变量中
                    f.set(this, findViewById(getViewTo.value()));
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

上述代码就可以通过注解的方式将控件注入到对象中，看起来跟ButterKnife的@BindView功能类似，但是ButterKnife的@BindView功能比这个高级很多，毕竟反射多了影响效率。运行时注解大多数时候都是通过运行时使用反射来实现效果的。

编译时注解

说到编译时注解，就不得不说到注解处理器AbstractProcessor，一般的第三方注解相关的类库，如butterKnife、ARouter等都会有一个Compiler命名的Module，这里面一般都是注解处理器，用于编译时处理对应的注解。

注解处理器是javac的一个工具，它用来在编译时扫描和处理注解。你可以对自定义注解注册相应的注解处理器用于处理你的注解逻辑。实现一个自定义的注解处理器需要重写4个方法并注册你的自定义Processor：

@AutoService(Processor.class)，谷歌提供的自动注册注解，为你生成注册Processor所需的格式文件（com.google.auto相关包）。
init(ProcessingEnvironment env)，初始化处理器，一般在这里获取我们需要的工具类。
getSupportedAnnotationTypes()，指定注解处理器是注册给哪个注解的，返回指定支持的注解类集合。
getSupportSourceVersion()，指定Java版本。
process()，处理实际逻辑入口。

在Processor的处理过程中，会扫描全部的Java源码，代码的每一个部分都是一个特定类型的Element，如类、变量、方法等，每个Element代表一个静态的、语言级别的构件，如下方代码所示：

package android.demo; // PackageElement

// TypeElement
public class DemoClass {

    // VariableElement
    private boolean mVariableType;

    // VariableElement
    private VariableClassE m VariableClassE;

    // ExecuteableElement
    public DemoClass () {
    }

    // ExecuteableElement
    public void resolveData (Demo data   //TypeElement ) {
    }
}

其中，Element代表的是源代码，TypeElement代表的是源代码中的类型元素，例如类。但是，TypeElement并不包含类本身的信息，你可以通过TypeElement获取类的名字，但是你获取不到类的信息，而这个信息就需要通过TypeMirror获取。你可以通过elements.asType()方法获取元素的TypeMirror。

知道Element后，我们就可以通过process中的RoundEnvironment去获取，扫描到所有的元素，通过env.getElementsAnnotatedWith()方法就可以获取到相应注解的元素列表，我们可以通过SuperficiaValidation.validateElement(element)的方法判断元素是否可用。我们也可以通过e.getKind()的方法检查元素的类型。

javapoet是一个根据指定参数，生成java文件的开源库，详细的信息可阅读javapoet——让你从重复无聊的代码中解放出来，在处理器中，根据参数创建出JavaFile后，通过Filer利用JavaFile.writeTo(filer)方法就可以生成你需要的java文件。

在处理器中，我们不能直接抛出一个异常，因为在process中抛出异常会导致运行注解处理器的JVM崩溃。因此，注解处理器提供了Messenger类，通过messenger.printMessage( Diagnostic.Kind.ERROR, StringMessage, element)方法即可正常输出错误信息。

参考资料：