Android注解(annotation)介绍及其应用

2023-05-16

我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版,欢迎购买。点击进入详情

文章目录

  • 介绍
  • 自定义注解
  • 注解的应用:反射
  • 注解的应用:APT
  • 其它

介绍

Annotation,又叫注解,是附加在代码上的元信息(用于标记属性)。
Annotation适用于IDE工具在编译、运行时对其解析和使用,起到配置的作用。
我们最常见的Annotation:

@Override
    public void onCreate() {
        super.onCreate();
    }

Override表明这个方法是一个重写的方法,需要IDE协助检查这个方法是否是父类的方法,如果不是则会报错提醒。如果不加Override,这个方法名不是父类的话,IDE也不会报错提醒。

从上面Override的例子我们可以看到,annotation更像是一个标签,它不仅仅可以附着在方法上面,还可以在包、类、字段、方法的参数、局部变量等上面进行标记。

自定义注解

还是用Override这个注解为例,我们看下源码:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

这里要提到元注解的概念。什么是元注解?元注解就是注解上的注解,也就是注解上的标签。比如我们在自定义注解的时候,@Target、@Retention这些都是元注解。
那元注解有什么用的呢?我看不妨来看一下元注解的作用:
@Retention:注解生命周期范围。
@Target:注解对象的作用范围。
@Inherited:@Inherited标明子类是否可以继承该父类的注解。
@Documented:javadoc工具的文档化。

@Retention的值:
@Retention(RetentionPolicy.SOURCE) :注释仅存在源码中,class文件中不包含;
@Retention(RetentionPolicy.CLASS):默认策略,class文件中包含,运行时遗弃;
@Retention(RetentionPolicy.RUNTIME):class文件包含,运行时通过反射也可以获得;

@Target有很多值,就像上面提到的,注释不仅可以用在方法上,也可以用在包、类、字段等等其它上面。像@Override的@Target(ElementType.METHOD)标明注解的作用范围是方法。

注解的应用:反射

通过反射获取注解是一个很常用的方法,但是需要注意的是,如果通过反射获取Annotation,那么这个Annotation的@Retention策略需要是RUNTIME的。这样就导致了反射获取注解应用范围有限。
定义一个@ByString的注解:

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

在源码中标记这个注解:

@ByString(R.string.annotation_reflection)
    private String text;

通过反射获取field:

Field[] fields = clazz.getDeclaredFields();
if (fields != null) {
    for (Field field : fields) {
	...
		}
}

找到这个注解:

ByString stringById = field.getAnnotation(ByString.class);
        if (stringById != null) {
            int stringId = stringById.value();
}

最后通过field的set方法进行赋值。

注解的应用:APT

APT(Annotation Processing Tool),它可以对源码进行扫描检测,找出其中的Annotation,并且自动生成相应的代码,并且将这些代码保存在额外的文件中(.class文件),最终这些.class文件一并参与apk的编译。
一个完整的APT包含:
1、AbstractProcessor:注解处理器,这是一个抽象类,一般需要自己实现一个。

public class TagBinderProcessor extends AbstractProcessor { ...}

2、处理器注册(AutoService):

@AutoService(Processor.class)
public class TagBinderProcessor extends AbstractProcessor { ...}

我们自定义了一个叫TagBinderProcessor的注解处理器,需要通过@AutoService注册一下。
3、代码自动生成(javaPoet)
根据注解,我们需要生成代码。而 JavaPoet 就是用来生成 Java 代码的一个 Java Library。
使用的时候需要引入:

implementation ‘com.squareup:javapoet:1.10.0’

我们看一段JavaPoet用法:

class AnnotatedClass {

    private ArrayList<BindTagField> mFields;

    AnnotatedClass() {
        mFields = new ArrayList<>();
    }

    void addField(BindTagField field) {
        mFields.add(field);
    }

    JavaFile generateFile() {
        //方法参数类型
        ParameterizedTypeName parameterizedTypeName = ParameterizedTypeName.get(
                ClassName.get(Map.class),
                ClassName.get(String.class),
                ClassName.get(TagInfo.class));
        ParameterSpec params = ParameterSpec.builder(parameterizedTypeName, "params").build();

        MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder("load")
                .addModifiers(Modifier.PUBLIC)
                .addAnnotation(Override.class)
                .addParameter(params);

        for (BindTagField item : mFields) {
            String key = item.getTypeName().toString();
            TagInfo.Type type = item.getType();
            String[] value = item.getTag();
            String description = item.getDescription();
            // 添加方法内容
            methodBuilder.addStatement("params.put($S,$T.build($T.$L,$S,$S,$S))",
                    key,
                    ClassName.get(TagInfo.class),
                    ClassName.get(TagInfo.Type.class),
                    type,
                    key,
                    Arrays.toString(value),
                    description);
        }
        //生成类
        TypeSpec finderClass = TypeSpec.classBuilder("TagService")
                .addSuperinterface(ClassName.get("com.androidwind.annotation.core", "ILoad"))
                .addModifiers(Modifier.PUBLIC)
                .addMethod(methodBuilder.build())
                .build();

        return JavaFile.builder("com.androidwind.annotation", finderClass).build();
    }
}

Ctrl+B,项目Build一下,看见在如下目录下有一个TagService文件生成:
在这里插入图片描述
打开看一下里面的内容:

public class TagService implements ILoad {
  @Override
  public void load(Map<String, TagInfo> params) {
    params.put("la.xiong.androidquick.demo.features.architecture.mvc.MVCActivity",TagInfo.build(TagInfo.Type.ACTIVITY,"la.xiong.androidquick.demo.features.architecture.mvc.MVCActivity","[MVC]","Activity + MVC实例"));
    params.put("la.xiong.androidquick.demo.features.architecture.mvp.activity.MVPActivity",TagInfo.build(TagInfo.Type.ACTIVITY,"la.xiong.androidquick.demo.features.architecture.mvp.activity.MVPActivity","[MVP]","Activity + MVP实例"));
}
}

这个就是通过JavaPoet生成的代码内容。

其它

除了上面提到注解的应用,其实注解在很多场景下都能看到它的身影,比如AOP(面向切面编程),后续会有专门的文章来介绍这个。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Android注解(annotation)介绍及其应用 的相关文章

随机推荐

  • cmake 学习笔记(一)

    最大的Qt4程序群 KDE4 采用cmake作为构建系统Qt4的python绑定 pyside 采用了cmake作为构建系统开源的图像处理库 opencv 采用cmake 作为构建系统 看来不学习一下cmake是不行了 xff0c 一点一点
  • 如何用github创建博客

    1 创建一个仓库 xff0c 设置名称为用户名 github io xff0c 不然会报404 2 在设置中找到github pages选项 xff0c 选择theme 3 将仓库使用github客户端克隆到本地 4 将克隆到本地仓库内容清
  • VS创建的aspx文件下没有设计-拆分-源 并且工具箱中的控件为灰色

    首先在视图中打开工具箱 这时是没有控件的 右键点击全部显示 但是仍然是灰色 没法使用 我的 Master文件夹里有设计 拆分 源 但是aspx文件里没有 解决方法
  • 【支线】输电杆塔识别-YOLO v5在Aidlux的部署

    目录 0 前言1 模型训练1 1 任务描述1 2 输电杆塔数据集采集1 3 输电杆塔数据集标注1 4 数据增强1 5 折腾1 6 训练1 7 测试 2 NX部署2 1 软硬件2 2 Tensor RT 优化推理2 3 ROS Topic发送
  • 程序员与厨师

    不管你信不信 反正我是信了 每一个程序员上辈子都是呆在厨房的厨子 好吧 你不信 我来证明给你看 1 下厨前 你得知道做的是早餐还是中晚餐 中晚餐的话 怎么也得走趟超市 如遇到好友聚会 怎么着也得做出一桌对得起朋友的饭菜 还有你得分析 朋友中
  • 用研扬科技的UP Square做软路由是不是杀鸡用牛刀啊?

    折腾了好几遍终于整踏实了 xff01
  • 炎炎夏日,看小Y重燃烈焰战火——Y450外接显卡

    xfeff xfeff 目录 前言 实际效果 预算VS结算 配件开箱 硬件连接 软件环境配置 xff08 重点 xff09 前言 我家小Y已经陪伴我4年多了 xff0c 四年里 xff0c 她带给我的欢乐是超值的 xff08 联保了4年多
  • 深度学习情感分类常用方法(综述)

    论文原文 xff1a Deep Learning for Sentiment Analysis A Survey 原文地址 xff1a https arxiv org ftp arxiv papers 1801 1801 07883 pdf
  • 嵌入式单片机之stm32串口你懂了多少!!

    stm32作为现在嵌入式物联网单片机行业中经常要用多的技术 xff0c 相信大家都有所接触 xff0c 今天这篇就给大家详细的分析下有关于stm32的出口 xff0c 还不是很清楚的朋友要注意看看了哦 xff0c 在最后还会为大家分享有些关
  • uC/OS-II 学习笔记之:消息邮箱

    更多原创 uC OS II学习笔记之 xff1a 系列 基础及嵌入式相关知识详解 xff0c 请访问可乐虎博客 xff1a http blog csdn net dcx1205 相信不会让您失望 xff01 xff01 一 消息邮箱的概念
  • uC/OS-II 学习笔记之:信号量、消息邮箱、消息队列之间的使用区别

    更多原创 uC OS II学习笔记之 xff1a 系列 基础及嵌入式相关知识详解 xff0c 请访问可乐虎博客 xff1a http blog csdn net dcx1205 相信不会让您失望 xff01 xff01 1 用信号量进行行为
  • Python3抓取糗百、不得姐、kanqu.com

    测试电脑配置有点低 xff0c 正常配置速度会比较快 有问题可以加群 xff1a 544471255 交流 使用必看 1 该代码使用Python3 6 43 版本 2 需要安装依赖库如下 可使用类似 pip install requests
  • 基于STM32F4实现FOC(磁场定向控制)一:电流采样和波形产生

    一 xff0e ADC的配置问题 1 GPIO初始化配置 开始ADC对应的GPIO口 xff0c 本驱动程序使用到五个GPIO xff0c 分别对应U V W三相电流及母线电压和温度采样 xff0c 统一配置为模拟输入 GPIO的配置代码如
  • 基于ADRC的FOC位置环控制

    ADRC位置环控制 ADRC介绍1 非线性跟踪微分器2 非线性ESO观测器3 非线性状态误差反馈控制律原理 NLSEF 4 调参流程 xff1a 1 调TD2 调ESO3 调NLSEF 5 基于ADRC的位置环设计ADRC框图基于ADRC的
  • 结构体和联合体在通信协议解析的应用

    在串口通信中 xff0c 我们往往会解析很多协议 xff0c 而且在协议中会出现不同数据类型的协议 xff1b 当然我们也可以把协议都定义成某一种数据格式 xff0c 但是那样会出现协议的复杂度 xff0c 但是不那样处理的话 xff0c
  • ubuntu14.04 怎么查看哪个串口才是有效的搜索?

    使用以上命令 xff0c 可以看见相对应的芯片型号 比如图中的 xff0c cp210x 对应的 ttyUSB0 FT232RL 对应 ttyUSB1 minicom 命令 xff1a CTRL 43 A 然后 O xff1b
  • 13_STM32Cubeide开发_RS485总线驱动

    一 485总线和硬件电路 典型的串行通讯标准是RS232和RS485 xff0c 它们定义了电压 阻抗等 xff0c 但不对软件协议给予定义 RS 485总线标准规定了总线接口的电气特性标准即对于2个逻辑状态的定义 xff1a 正电平在 4
  • 无人机系列之飞控算法

    一 无人机的分类 按飞行平台构型分类 无人机可分为固定翼无人机 旋翼无人机 无人飞艇 伞翼无人机 扑翼无人机等 图1 无人机平台构型 多轴飞行器multirotor 是一种具有三个以上旋翼轴的特殊的直升机 旋翼的总距固定而不像一般直升机那样
  • Java中==和equals的区别

    Java中 61 61 和equal的区别为 1 61 61 表示 判断2个变量或对象实例是否指向同一个内存空间 xff0c equals 表示 判断2个变量或对象实例所指向的内存空间的值是否相同 2 61 61 表示 对内存地址进行比较
  • Android注解(annotation)介绍及其应用

    我的新书 Android App开发入门与实战 已于2020年8月由人民邮电出版社出版 xff0c 欢迎购买 点击进入详情 文章目录 介绍自定义注解注解的应用 xff1a 反射注解的应用 xff1a APT其它 介绍 Annotation