注解
Java 注解学习总结
本章目标
- 了解什么是注解
- 掌握注解的语法
- 了解元注解
- 了解注解的属性
- 了解 Java 预置的注解
- 了解注解的使用场景
- 掌握注解如何编写
什么是注解
注解(Annonation)就是对 Java 代码中类、属性和方法进行标注和解释,但并不影响代码的执行
Java 代码中大量使用注解(特别是框架)
注解的定义
Java 中使用 @interface 关键字定义一个注解
public @interface TestAnnotation { }
- 定义注解与定义接口很类似,不过前面多了一个 @ 符号
- 定义注解好比创建一张名字为 TestAnnotation 的标签
注解的应用
@TestAnnotation
public class Test {
…
}
- 创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类
- 可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面,但是目前该注解只是一个空注解(相当于空标签),没有任何意义和作用
元注解
什么是元注解
元注解是用于定义注解的注解(或者说元注解是一种基本注解,它能够应用到其它的注解上面);元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明
5 种元注解
@Retention
- RetentionPolicy.SOURCE(存活期最短):注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视
- RetentionPolicy.CLASS :注解只被保留到编译进行的时候,它并不会被加载到 JVM 中
- RetentionPolicy.RUNTIME(存活期最长) :注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}
@Retention 的英文意为保留期的意思,当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间
@Documented
@Document 顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
@Target
@Target 用于指定注解运用的地方(当一个注解被 @Target 注解时,这个注解就被限定了运用的场景,如类、方法、方法参数、属性等)
@Target 有如下取值:
- ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
- ElementType.CONSTRUCTOR 可以给构造方法进行注解
- ElementType.FIELD 可以给属性进行注解
- ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
- ElementType.METHOD 可以给方法进行注解
- ElementType.PACKAGE 可以给一个包进行注解
- ElementType.PARAMETER 可以给一个方法内的参数进行注解
- ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
@Inherited
@Inherited 注解指的是使用该注解的类的子类,可以继承该类的注解
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test { }
@Test
public class A {}
public class B extends A { }
- 注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解
@Repeatable
@Repeatable 注解指的是重复,是 Java 1.8 才加进来的新特性(通常用于注解的值可以同时取多个)
@interface Persons {
Person[] value();
}
@Repeatable(Persons.class)
@interface Person{
String role default "";
}
@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}
- Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签
注解属性
什么是注解属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
int id();
String msg();
}
定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}
在使用的时候应该给注解属性进行赋值。赋值的方式是在注解的括号内以 value=””的形式,多个属性之前用逗号隔开
注解属性的默认值
在注解中定义属性时它的类型必须是 8 种基本数据类型外加类、接口、注解及它们的数组。注解中属性可以有默认值,默认值需要用 default 关键值指定。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
public int id() default -1;
public String msg() default "Hi";
}
TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。
@TestAnnotation()
public class Test {}
- 因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。
- 如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。
Java 预置注解
@Deprecated
@Deprecated 注解用来标记过时的类、属性或方法(想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量)
public class Hero {
@Deprecated
public void say(){
System.out.println("Noting has to say!");
}
public void speak(){
System.out.println("I have a dream!");
}
}
say() 方法上面被一条直线划了一条,这其实就是编译器识别后的提醒效果,告诉开发者该方法已过时。
@Override
@Override 注解用于提示子类要复写父类中被 @Override 修饰的方法或是实现接口方法
public class SubClass implements ProducerInterceptor<String,String> {
@Override
public ProducerRecord<String, String> onSend(ProducerRecord<String, String> record) {
return null;
}
@Override
public void close() {
}
}
@SuppressWarnings
@SuppressWarning 注解用于阻止警告(调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的)
@SuppressWarnings("deprecation")
public void test1(){
Hero hero = new Hero();
hero.say(); //不会在提醒
hero.speak();
}
@SafeVarargs
@SuppressWarning 参数安全类型注解,它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。
@SafeVarargs
static void m(List<String>... stringLists) {
Object[] array = stringLists;
List<Integer> tmpList = Arrays.asList(42);
array[0] = tmpList;
String s = stringLists[0].get(0); //运行时将抛出类型转换异常错误
}
@FunctionalInterface
@FunctionalInterface 函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口
@FunctionalInterface
public interface Runnable {
public abstract void run();
}
进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。函数式接口可以很容易转换为 Lambda 表达式
注解实现原理
注解的实现原理使用是通过反射机制获取注解属性
@TestAnnotation()
public class Test {
public static void main(String[] args) {
boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
if ( hasAnnotation ) {
TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
System.out.println(“id:”+testAnnotation.id()); //打印注解属性
System.out.println(“msg:”+testAnnotation.msg()); //打印注解属性
}
}
}
注解使用场景
编译器或者 APT (非开发者)
当开发者使用了 Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。