首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Android 编译时注解 —— 语法详解

Android 编译时注解 —— 语法详解

作者头像
程序员徐公
发布于 2018-09-17 08:02:51
发布于 2018-09-17 08:02:51
82200
代码可运行
举报
运行总次数:0
代码可运行

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://cloud.tencent.com/developer/article/1340330

为什么要写这一系列的博客呢?

因为在 Android 开发的过程中, 泛型,反射,注解这些知识进场会用到,几乎所有的框架至少都会用到上面的一两种知识,如 Gson 就用到泛型,反射,注解,Retrofit 也用到泛型,反射,注解 。学好这些知识对我们进阶非常重要,尤其是阅读开源框架源码或者自己开发开源框架。

java Type 详解

java 反射机制详解

注解使用入门(一)

Android 自定义编译时注解1 - 简单的例子

Android 编译时注解 —— 语法详解

带你读懂 ButterKnife 的源码

经过前面的介绍,相信大家对注解有了一定的了解了。

根据注解使用方法和用途,我们可以将Annotation分为三类:

  • JDK内置系统注解(如 @SuppressWarnings(“deprecation”),@override 等)
  • 元注解 如(@Documented ,@Retention() ,@Target(),@Documented )
  • 自定义注解 (自己实现的的注解)

元注解

元注解 解析说明

  • @Documented 是否会保存到 Javadoc 文档中
  • @Retention 保留时间,可选值, 默认为 CLASS SOURCE(源码时),CLASS(编译时),RUNTIME(运行时)
  • @Target 可以用来修饰哪些程序元素,如 TYPE, METHOD, CONSTRUCTOR, FIELD, PARAMETER 等,未标注则表示可修饰所有
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
ANONOTATION_TYPE(注解类型声明),
PACKAGE(包)
TYPE (类,包括enum及接口,注解类型)
METHOD (方法)
CONSTRUCTOR (构造方法)
FIFLD (成员变量)
PARAMATER (参数)
LOCAL_VARIABLE (局部 变量)
  • @Inherited 是否可以被继承,默认为 false

需要注意的是注解是不可以继承的,@Inherited 的意思是 假如我们把注解应用到 A 类中,B 类继承 A ,那么 B 可以扫描到 A 的注解。

注解的继承”(依赖倒置?)

这里讲的继承并不是通过@Inherited修饰的注解。

这个“继承”是一个注解的使用技巧,使用上的感觉类似于依赖倒置,来自于ButterKnife源码。

先看代码。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Target(METHOD)
@Retention(CLASS)
@ListenerClass(
    targetType = "android.view.View",
    setter = "setOnClickListener",
    type = "butterknife.internal.DebouncingOnClickListener",
    method = @ListenerMethod(
        name = "doClick",
        parameters = "android.view.View"
    )
)
public @interface OnClick {
      /** View IDs to which the method will be bound. */
      int[] value() default { View.NO_ID };
}

这是ButterKnife的OnClick 注解。特殊的地方在于@OnClick修饰了注解@ListenerClass,并且设置了一些只属于@OnClick的属性。

那这样的作用是什么呢?

凡是修饰了@OnClick的地方,也就自动修饰了@ListenerClass。类似于@OnClick是@ListenerClass的子类。而ButterKnife有很多的监听注解@OnItemClick、@OnLongClick等等。

这样在做代码生成时,不需要再单独考虑每一个监听注解,只需要处理@ListenerClass就OK。如 @interface OnItemClick 等。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Target(METHOD)
@Retention(CLASS)
@ListenerClass(
    targetType = "android.widget.AdapterView<?>",
    setter = "setOnItemClickListener",
    type = "android.widget.AdapterView.OnItemClickListener",
    method = @ListenerMethod(
        name = "onItemClick",
        parameters = {
            "android.widget.AdapterView<?>",
            "android.view.View",
            "int",
            "long"
        }
    )
)
public @interface OnItemClick {
  /** View IDs to which the method will be bound. */
  @IdRes int[] value() default { View.NO_ID };
}

自定义注解

一个简单的自定义注解例子

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Documented()
// 表示是基于编译时注解的
@Retention(RetentionPolicy.CLASS)
// 表示可以作用于成员变量,类、接口
@Target({ElementType.FIELD, ElementType.TYPE}) 
public @interface Seriable {


}

指定默认值

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Documented()
// 表示是基于编译时注解的
@Retention(RetentionPolicy.CLASS)
// 表示可以作用于成员变量,类、接口
@Target({ElementType.FIELD, ElementType.TYPE}) 
public @interface Seriable {
     int id();
     String name() default "test";
}

//使用
@Seriable(id = 1) //name有默认值可以不写
class Test{
}

关于怎样自定义一个注解,可以参看这一篇博客,Android 自定义编译时注解1 - 简单的例子


处理器类Processor编写

自定义注解后,需要编写Processor类处理注解。Processor 继承自 AbstractProcessor 的类。我们主要需要处理以下连个方法。

  • public Set getSupportedAnnotationTypes()
  • public abstract boolean process(Set<? extends TypeElement >annotations,RoundEnvironment roundEnv);

getSupportedAnnotationTypes 方法

重写 getSupportedAnnotationTypes 方法:告知Processor哪些注解需要处理。返回一个Set集合,集合内容为 自定义注解的包名+类名

建议项目中这样编写:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Override
public Set<String> getSupportedAnnotationTypes() {
    Set<String> types = new LinkedHashSet<>();
    //需要全类名
    types.add(Seriable.class.getCanonicalName()); 
    types.add(Println.class.getCanonicalName());
    return types;
}

另外如果注解数量很少的话,可以通过另一种方式实现:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
//在只有一到两个注解需要处理时,可以这样编写:
@SupportedAnnotationTypes({"com.example.Seriable"})
@SupportedSourceVersion(SourceVersion.RELEASE_7)
public class JsonProcessor extends AbstractProcessor {
}

process 方法

process 方法,这个方法是所有方法中最关键的一个方法,他用来处理注解的相关信息,比如提取注解的信息,存进 map 集合或者生成代码等。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {

    return false;
}
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
    //   第一步,根据我们自定义的注解拿到 elememts set 集合
    Set<? extends Element> elememts = roundEnv.getElementsAnnotatedWith(Seriable.class);
    TypeElement typeElement;
    VariableElement variableElement;

    //  第二步: 根据 element 的类型做相应的处理,并存进 map 集合
    for (Element element : elememts) {
        ElementKind kind = element.getKind();
        // 判断该元素是否为类
        if (kind == ElementKind.CLASS) {
            typeElement = (TypeElement) element;
            // 判断该元素是否为成员变量
        } else if (kind == ElementKind.FIELD) {
            variableElement = (VariableElement) element;


        }
    }



    return true;
}

Element

元素,虽有通过注解取得的元素都以 Element 等待处理,它的具体类型与我们通过 @Target 来标记的具有一定的联系。

官方的解释是这样的:

Represents a program element such as a package, class, or method.Each element represents a static, language-level construct (and not, for example, a runtime construct of the virtual machine)

表示程序元素如包、类或者方法。每个元素代表一个静态语言级构造(例如,而不是运行时构建的虚拟机

例如:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    // 第一步,根据我们自定义的注解拿到 elememts set 集合
    Set<? extends Element> elememts = roundEnv.getElementsAnnotatedWith(Seriable.class);
    TypeElement typeElement;
    VariableElement variableElement;

    //  第二步: 根据 element 的类型做相应的处理,并存进 map 集合
    for (Element element : elememts) {
        ElementKind kind = element.getKind();
        // 判断该元素是否为类
        if (kind == ElementKind.CLASS) {
            typeElement = (TypeElement) element;
            // 判断该元素是否为成员变量
        } else if (kind == ElementKind.FIELD) {
            variableElement = (VariableElement) element;


        }
    }

Element 的子类

Element 的子类有:

  • ExecutableElement

表示某个类或接口的方法、构造方法或初始化程序(静态或实例),包括注释类型元素。

对应@Target(ElementType.METHOD) @Target(ElementType.CONSTRUCTOR)

  • PackageElement;

表示一个包程序元素。提供对有关包极其成员的信息访问。

对应@Target(ElementType.PACKAGE)

  • TypeElement;

表示一个类或接口程序元素。提供对有关类型极其成员的信息访问。

对应@Target(ElementType.TYPE)

注意:枚举类型是一种类,而注解类型是一种接口。

  • TypeParameterElement;

表示一般类、接口、方法或构造方法元素的类型参数。

对应@Target(ElementType.PARAMETER)

  • VariableElement;

表示一个字段、enum常量、方法或构造方法参数、局部变量或异常参数。

对应 @Target(ElementType.LOCAL_VARIABLE)

判断 Element 具体属于哪一种子类

我们可以通过 element.getKind(); 来得到 Element 到底是哪一种类别,该方法返回 ElementKind 类型,我们在根据 ElementKind 即可得出 Element 到底是哪种类别。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
ElementKind kind = element.getKind();
// 判断该元素是否为类
if (kind == ElementKind.CLASS) {
    typeElement = (TypeElement) element;
} else if (kind == ElementKind.FIELD) {
   variableElement = (VariableElement) element;
}

看到这里,想起前面的一篇博客 java Type 详解 ,我们需要注意 Type 与 Element 的区别。

Type 是用来处理泛型的,Element 是用来处理注解的。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2017年04月26日,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
提高10倍开发效率?APT如何让Android开发变得更轻松
在Android开发中,APT(Annotation Processing Tool)是一种强大的工具,它可以让开发者在编译期间处理注解,生成额外的代码。通过APT,我们可以实现很多高级功能,比如自动生成代码、实现依赖注入、生成路由表等。本文将深入探讨APT的运用以及背后的原理。
Rouse
2024/03/18
1970
提高10倍开发效率?APT如何让Android开发变得更轻松
Android注解快速入门和实用解析
文章较长,欢迎收藏后浅斟慢酌。主要介绍和分析了 RUNTIME 和 CLASS 下两种注解的使用,也欢迎讨论留言。
GSYTech
2018/08/22
4550
Android注解快速入门和实用解析
@lombok注解背后的原理是什么,让我们走近自定义Java注解处理器
本文介绍了如何自定义Java注解处理器及涉及到的相关知识,看完本文可以很轻松看懂并理解各大开源框架的注解处理器的应用。
程序员黄小斜
2021/11/23
8350
Android 自定义编译时注解1 - 简单的例子
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gdutxiaoxu/article/details/70244169
程序员徐公
2018/09/17
4340
Android 自定义编译时注解1 - 简单的例子
聊聊AbstractProcessor和Java编译流程
我:我写过一个路由跳转库,我通过了AbstractProcessor生成了路由表的注册类。
逮虾户
2020/10/15
4.8K0
聊聊AbstractProcessor和Java编译流程
编译时注解(一)AbstractProcessor实战
Java中的注解(Annotation)是一个很神奇的东西,特别现在有很多Android库都是使用注解的方式来实现的。 我们并不讨论那些在运行时(Runtime)通过反射机制运行处理的注解,而是讨论在编译时(Compile time)处理的注解。下面便入手学习下Java注解处理器。
提莫队长
2019/02/21
7.5K1
自定义注解和解析器实现ButterKnife
相信绝大部分的Android开发者都曾使用过ButterKnife, 利用ButterKnife开发者可以快速的实现实体view与xml的绑定,此外还能绑定各种资源、动画、字符串甚至是点击事件等。ButterKnife内部的原理就是通过自定义注解+自定义注解解析器来动态生成代码并为我们的view绑定id的。本文通过实现一个demo性质的ButterKnife项目来展示如何自定义注解+注解解析器。 关于注解本身本文不多做介绍,这里给出一篇讲解注解的文章一小时搞明白自定义注解(Annotation),对注解
用户1269200
2018/03/26
1.2K0
【Android APT】注解处理器 ( 根据注解生成 Java 代码 )
Android APT 学习进阶路径 : 推荐按照顺序阅读 , 从零基础到开发简易 ButterKnife 注解框架的学习路径 ;
韩曙亮
2023/03/29
3180
Android 注解与注解处理器简述
  在Android开发中,注解是非常多的,如果不去了解,你可能感受不到注解的存在,一些框架用到的注解是很多的,例如Butterknife、Retrofit、Dagger2、Hilt、ViewBinding、DataBinding等等,下面简单的来了解一下注解。
晨曦_LLW
2022/10/24
7450
Android 注解与注解处理器简述
自定义Android注解Part2:代码自动生成
上一期我们已经把butterknife-annotations中的注解变量都已经定义好了,分别为BindView、OnClick与Keep。
Rouse
2019/07/16
6400
自定义Android注解Part2:代码自动生成
【Android APT】注解处理器 ( Element 注解节点相关操作 )
Android APT 学习进阶路径 : 推荐按照顺序阅读 , 从零基础到开发简易 ButterKnife 注解框架的学习路径 ;
韩曙亮
2023/03/29
2680
【Android APT】注解处理器 ( Element 注解节点相关操作 )
ButterKnife源码分析
在程序开发的过程中,总会有一些场景需要去写重复冗余的代码。而程序员一般都是懒惰了(懒惰促使人进步 ο ),所以就出现了很多可以减少重复工作的框架或者工具。比如今天要分析的主角—— ButterKnife ,如果你做 Android 开发却没有听说过 ButterKnife 那就 Out 啦。ButterKnife 使用依赖注入的方式来减少程序员去编写一堆 findViewById 的代码,使用起来很方便。那么接下来就一步步地带你深入理解 ButterKnife 框架。PS:最近写的博客篇幅都有点长,请耐心阅读!Logo 图镇楼!
俞其荣
2022/07/28
3710
ButterKnife源码分析
Retrofit解析4之注解
由于Retrofit里面大量的用到了注解,为了让大家更好的学习Retrofit,特意准备了一篇Java注解,如果大家已经对Java注解已经很熟悉了,就略过,看下一篇文章 本篇文章主要讲解
隔壁老李头
2018/08/30
1.4K0
Retrofit解析4之注解
Android APT(编译时代码生成)最佳实践
越来越多第三方库使用apt技术,如DBflow、Dagger2、ButterKnife、ActivityRouter、AptPreferences。在编译时根据Annotation生成了相关的代码,非常高大上但是也非常简单的技术,可以给开发带来了很大的便利。
用户1269200
2018/07/30
1.4K0
Android开源框架源码解析系列(3)——ButterKnife源码解析
ButterKnife是一个专注于Android系统的View注入框架,有了ButterKnife可以很轻松的省去findViewById,ButterKnife用到的注解并不是在运行时反射的,而是在编译的时候生成新的class,对运行时性能没有影响,本篇我们来详细学习一下它的源码。
老马的编程之旅
2022/06/22
1.1K0
自定义Android注解Part1:注解变量
对于Android注解,或多或少都有一点接触,但相信大多数人都是在使用其它依赖库的时候接触的。因为有些库如果你想使用它就必须使用它所提供的注解。例如:ButterKnife、Dagger2、Room等等。
Rouse
2019/07/16
4910
自定义Android注解Part1:注解变量
ButterKnife原理解析看这篇文章就够了
ButterKnife 算是一款知名老牌 Android 开发框架了,通过注解绑定视图,避免了 findViewById() 的操作,广受好评!由于它是在编译时对注解进行解析完成相关代码的生成,所以在项目编译时会略耗时,但不会影响运行时的性能。接下来让我们从使用到原理一步步深入了解这把黄油刀的故事! 以下内容基于 butterknife:8.8.1 版本,主要包括如下几个方面的内容:
用户1269200
2018/08/14
2.4K0
butterknife 源码分析
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/gdutxiaoxu/article/details/71512754
程序员徐公
2018/09/17
1K0
butterknife 源码分析
ActivityRouter源码解析HeaderActivityRouter使用方法源码解析Footer
ActivityRouter :https://github.com/mzule/ActivityRouter
俞其荣
2019/01/03
1K0
Java Annotation 及几个常用开源项目注解原理简析
PDF 版: Java Annotation.pdf, PPT 版:Java Annotation.pptx, Keynote 版:Java Annotation.key 一、Annotation 示例 Override Annotation Java 1 2 3 @Override public void onCreate(Bundle savedInstanceState); Retrofit Annotation Java 1
庞小明
2018/03/08
1.2K0
推荐阅读
相关推荐
提高10倍开发效率?APT如何让Android开发变得更轻松
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档