Java进阶篇1——注解

Java注解

注解基本介绍

• Java 注解是从 Java5 开始添加到 Java 的
• 注解，可以理解为标签。
• 本质像是一种接口。（@interface）
• 英文：Annotation

自定义注解

/**
*自定义接口
*/
public @interface myAnnotation {
}

注解使用方法

@myAnnotation
public class Test {
}

• 可以简单理解为将 myAnnotation 这张标签贴到 Test 这个类上面。

注解怎样实现的它的功能

一、元注解：

• 元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。
• 这样使其他注解有一定功能。
• 共5种。
• @Retention、@Documented、@Target、@Inherited、@Repeatable

二、5种元注解

1. @Retention

• retention 的英文意为保留期的意思.
• 当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。
• 参数：

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

• 用法

@Retention(RetentionPolicy.RUNTIME)
public @interface myAnnotation {
}

@myAnnotation
public class Test {
}

2. @Documented

• 它的作用是能够将注解中的元素包含到 Javadoc 中去。

3. @Target

• Target 是目标的意思，@Target 指定了注解运用的地方。
• 例如：因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。
• 参数：

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

4. @Inherited

• Inherited 是继承的意思
• 代码:B 也拥有 myAnnotation 这个注解。

@Inherited
@interface myAnnotation{}

@myAnnotation
public class A {}
public class B extends A {}

5. @Repeatable

• Repeatable 自然是可重复的意思。
• 被它所标签的注解，可以重复的在一个类使用。
• 它一般与容器注解一起使用。

三、容器注解

• 它里面必须要有一个 value 的属性，属性类型是一个被 @Repeatable 注解过的注解数组，注意它是数组。
• 代码：

import java.lang.annotation.Repeatable;

/**
 * persons容器注解
 */
@interface persons {
	person[] value();
}

/**
 * person注解是被@Repeatable注解过的
 */
@Repeatable(persons.class)
@interface person {
	String type();
}

/**
 * @person注解可以重复使用
 */
@person(type = "man")
@person(type = "child")
public class Test {
}

四、注解的属性

• 注解的属性也叫做成员变量
• 注解只有成员变量，没有方法
• 代码：

@interface myAnnotation {
	int id();
	String name();
}

@myAnnotation(id=1, name="己千之")
public class Test {
}

五、Java 语言本身提供的几个现成的注解

- @Deprecated

• 这个元素是用来标记过时的元素。
• 编译器在编译阶段遇到这个注解时会发出提醒警告。
• 告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

- @Override

• 提示子类要重写父类中被 @Override 修饰的方法

- @SuppressWarnings

• 阻止警告的意思
• 编译器会警告提醒，而有时候开发者会忽略这种警告

@SafeVarargs

• 参数安全类型注解
• 它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告

- @FunctionalInterface

• 函数式接口注解
• 函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。
• 函数式接口可以很容易转换为 Lambda 表达式.

六、注解的使用场景

提供信息给编译器： 编译器可以利用注解来探测错误和警告信息
编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html文档或者做其它相应处理。
运行时的处理： 某些注解可以在程序运行的时候接受代码的提取
值得注意的是，注解不是代码本身的一部分