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)介绍及其应用 的相关文章

随机推荐

  • 新版studio无法执行git操作

    由于工作需要 xff0c 我最近不得不开捡起以前的只是开发Android代码 但是尴尬的是 xff0c 已经从git同步下来的项目没办法使用studio的git插件 报错是 xff1a 14 22 Git Pull failed Invoc
  • tomcat发布遇到验证码数不出来的问题【sun/awt/X11GraphicsEnvironment异常】

    出现java lang NoClassDefFoundError sun awt X11GraphicsEnvironment异常 内容为站提复制 xff0c 解决问题立竿见影 问题描述 xff1a 项目在window中使用POI导出Exc
  • Windows Terminal美化杂记-Windows Terminal使用与配置

    文章目录 Windows Terminal前言原cmdWindows Terminal安装Terminal配置配置代码部分配置字体部分配置右键添加测试常量命令行中执行管理员权限运行 配置环境变量 最终效果图 结语 Windows Termi
  • mysql 5.7Expression #1 of ORDER BY clause is not in SELECT list

    java sql SQLException Expression 1 of ORDER BY clause is not in SELECT list references column 39 amc ti create time 39 w
  • Android 源码系统添加系统服务

    以下内容基于Android12 源码进行整理 下面内容是基于Camera升降机服务添加过程整理 1 在Context java 中添加服务名称 Context java 在源码中位置 frameworks base core java an
  • sun.misc.Launcher 找不到

    问题 xff1a sun misc Launcher 找不到 xff0c 报错 xff1a Access restriction The type Launcher is not API restriction on required li
  • ubuntu 设置不了分辨率 解决方法

    要设置xorg conf xff0c ubuntu12 04默认没有这个文件 xff0c 所以要生成它 先ctrl xff0b alt xff0b f1切到文字模式 xff0c 停掉Xwindow服务 xff0c 执行 sudo etc i
  • Android Banner2.1.0

    由于最近更新了studio xff0c 好多东西需要更新 xff0c 那就彻底一点吧 xff0c banner原来用的1 4 9的 xff0c 新版的更新了好多 xff0c 之前的方法不能用了 xff0c 不多说直接上代码 依赖 xff1a
  • Ubuntu:如何显示系统托盘图标(systray)

    1 问题说明 Ubuntu 11版本开始 xff0c 默认关闭了托盘图标的显示 xff0c 需要手动执行命令或额外工具配置 xff0c 添加到白名单 Ubuntu 13 04更彻底 xff0c 默认配置根本没有托盘图标 xff0c 除了ja
  • 火锅店连锁企业使用哪款生鲜管理系统软件比较好呢?

    到目前为止 xff0c 餐饮行业的发展越来越好 xff0c 不管是节假日还是平常的日子里 xff0c 基本上餐馆总是会有很多人 xff0c 相比较来说连锁店铺的管理对于一般店铺来说更加的繁琐 xff0c 那是因为大多数的商品都是由总部统一配
  • 2021-10-26OriginPro 2021 v9.8如何修改为中文

    OriginPro 2021 v9 8如何修改为中文 xff1f 知乎 zhihu com https zhuanlan zhihu com p 376311895 按照这个方法亲测有效
  • Android 启动模式singleTask和onNewIntent什么时候调用

    设置启动模式我们不仅可以节省内存的使用 xff0c 还能达到更好的体验 如果IntentActivity处于任务栈的顶端 xff0c 也就是说之前打开过的Activity xff0c 现在处于 onPause onStop 状态的话 其他应
  • Centos7里在gnome桌面创建文件夹快捷方式

    需求 我的home文件夹特别小 xff0c 空间都分配在 data里 xff0c 所以我平常都是到 data路径下 所以我想在桌面上放一个可以直接到 data路径下的快捷键 STEP1 首先是到一个合适的地方 我放在了 data syste
  • 硬盘被格式化重装系统,以前的文件还能恢复吗

    硬盘被格式化重装系统 以前的文件还能恢复吗 今天早上起来就发现电脑有点问题 xff0c 一直提示我有中毒的迹象 xff0c 但是杀毒软件却一直提示我没有问题 xff0c 不知道是不是病毒太过新颖 xff0c 还是免费的杀毒软件不够好用 一阵
  • 聊聊mac系统的 secoclient和iTerm2

    secoclient是啥 xff0c 就是华为出品的VPN网络设置工具 可以连接其他公司的服务器 下载地址 xff1a https secoclient updatestar com 网上百度secoclient下载 xff0c 有很多 x
  • Android Selinux介绍,如何添加selinux 权限

    Selinux简介 SELinux是安全增强型 Linux xff08 Security Enhanced Linux xff09 简称 SELinux 它是一个 Linux 内核模块 xff0c 也是 Linux 的一个安全子系统 优势
  • android 启动app event log

    pid 951 为system server 进程 1 冷启动 Time pid TAG Messag 01 20 33 418 951 wm stack created 22 01 20 33 421 951 wm task create
  • ASP.NET 实现主题切换实例

    通常我们经常看到网页 xff0c 一些软件提供换肤功能 xff0c 各种主题间切换 ASP NET 2 0 中可以用Theme和skin以及CSS轻松实现这个功能 首先简单介绍一下三种技术 xff1a 主题 xff08 Theme xff0
  • MacBook远程控制工具VNC Viewer_亲测使用

    MacBook远程控制工具VNC Viewer 亲测使用 官方下载地址 https www realvnc com en connect download viewer MacBook远程桌面Windows使用Microsoft Remot
  • Android注解(annotation)介绍及其应用

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