注解 annotations

注解是一种元数据(meta data),提供程序相关的数据,但并不是程序本身,不会直接影响所注解的代码的操作
相关类位于java.lang.annotation包,每个注解都隐式的扩展了Annotation接口

用途

  • Compiler instructions,编译器的信息(Java三个内置的注解@Deprecated, @Override,@SuppressWarnings),注解被编译器用来探测错误或者抑制警告
  • Build-time instructions,编译期使用注解处理器进行处理,产生代码或者XML文件等
  • Runtime instructions,在运行时使用 Java 反射机制读取并进行处理

注解基础

//使用注解
@Entity  

@符号向编译器表明这是一个注解,接下来是一个注解名称(Entity)

注解元素

注解内可以包含元素信息

@Entity(tableName = "vehicles", primaryKey = "id")

如果注释中只有一个元素,并且名字叫value,那么元素名称可以被省略
@InsertNew(value = "yes")
@InsertNew("yes")

注解位置

可以把注解用在类,接口,方法,方法参数,字段,变量上
同时也可以在同一个声明上使用多个注释

Java内置注解

Java提供了三个内置注释用于给Java编译器指令

  • @Deprecated
  • @Override
  • @SuppressWarnings
@Deprecated

标识类、方法或者字段是废弃的,不应该再被使用,否则编译器会发出警告

@Override

用在重载超类的方法上,如果该方法没有对应超类的方法,编译器会报错

@SuppressWarnings

在给定的方法上抑制编译器警告

@SuppressWarnings({"unchecked", "deprecation",...."path","all"})
void myMethod() { ... }

创建自定义注解

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Documented
@Target(ElementType.METHOD)
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyCustomAnnotation{
    int studentAge() default 18;
    String studentName();
    String stuAddress();
    String stuStream() default "CSE";
}
  • 通过@interface创建注解
  • 注解元素的定义类似接口中的方法,不需要提供实现,数据类型可以使基本数据类型(primitive data types)或者是对应的数组,String,enum等。
  • 通过default定义默认值

有四个元注解(meta-annotation),用来对其他annotation类型做说明

@Documented

使得JavaDoc生成说明文件时加入注解信息

@Target

指定注解修饰的对象

import java.lang.annotation.ElementType;
import java.lang.annotation.Target;

@Target({ElementType.METHOD})
public @interface MyAnnotation {
    String   value();
}
十种类型,后两种是Java8后新增的:
ElementType.METHOD
ElementType.PACKAGE
ElementType.PARAMETER
ElementType.TYPE // 类、接口(包括注释类型)或枚举声明
ElementType.ANNOTATION_TYPE //注释类型声明
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE //局部变量声明
ElementType.FIELD //字段声明(包括枚举常量)
ElementType.TYPE_PARAMETER//类型参数
ElementType.TYPE_USE//类型使用
@Inherited

注释类型会被自动继承。如果一个使用了@Inherited修饰的annotation类型被用于一个class,该class的子类会继承这个注解
只有在注解class的时候才会有用

@Retention

定义了该Annotation被保留的时间长短

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
@interface MyCustomAnnotation { }

某些Annotation仅出现在源代码中,而被编译器丢弃;
而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

RetentionPolicy.RUNTIME被记录到 .class文件中,在运行时被VM保存,通过反射访问
RetentionPolicy.CLASS被保存到 .class 文件中,在运行时不存在,这是默认类型
RetentionPolicy.SOURCE在源代码中存在,在 .class文件中和运行时都不存在

注解处理器

用来处理编译时注解,可以看做是一个Javac编译器插件,可以读取,修改,添加抽象语法树的任意元素。

注解处理器,以Java代码(或者编译过的字节码)作为输入,生成文件(通常是.java文件)作为输出,不会修改已经存在的Java类,例如向已有的类中添加方法。这些生成的Java文件,会同其他手动编写的Java源代码一样被javac编译。

自定义注解处理器需要继承抽象类javax.annotation.processing.AbstractProcessor,重写process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)等方法

参照:
Java注解处理器
ANNOTATION PROCESSING 101

最后是打包注册,使得Java编译器可以找到这个注解处理器

  1. 将注解处理器打包进一个Jar包
  2. 在这个Jar包中要包含一个文件夹META-INF/services
  3. 在这个文件夹中要包含一个名为javax.annotation.processing.Processor的文件
  4. 在这个文件里面将Jar包中所有注解处理器的完整类名写进去,每个类名一行
butterknife

在运行时处理注解是通过反射的方式

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 210,914评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 89,935评论 2 383
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,531评论 0 345
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,309评论 1 282
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,381评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,730评论 1 289
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,882评论 3 404
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,643评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,095评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,448评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,566评论 1 339
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,253评论 4 328
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,829评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,715评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,945评论 1 264
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,248评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,440评论 2 348

推荐阅读更多精彩内容