- 一、概述
- 二、常见的Annotation示例
- 2.1 生成文档相关的注解
- 2.2 在编译时进行格式检查
- 2.3 其他待补充...
- 三、自定义注解
- 3.1 @Retention
- 3.2 @Target
- 3.3 @documented
- 3.4 @Inherited
1.起源于JDK5.0版本；
2.Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加
载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员
可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代
码分析工具、开发工具和部署工具可以通过这些补充信息进行验证
或者进行部署。
3.Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方
法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation
的 “name=value” 对中
使用 Annotation 时要在其前面增加 @ 符号, 并把该 Annotation 当成
一个修饰符使用。用于修饰它支持的程序元素
| 注解 | 描述 |
|---|---|
| @author | 标明开发该类模块的作者，多个作者之间使用,分割 |
| @version | 标明该类模块的版本 |
| @see | 参考转向，也就是相关主题 |
| @since | 从哪个版本开始增加的 |
| @param | 对方法中某参数的说明，如果没有参数就不能写 |
| @return | 对方法返回值的说明，如果方法的返回值类型是void就不能写 |
| @exception | 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常就不能写 |
备注：
其中
@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求：@param 形参名 形参类型 形参说明
@return 的格式要求：@return 返回值类型 返回值说明
@exception的格式要求：@exception 异常类型 异常说明
@param和@exception可以并列多
代码示例：
public class AnnotationTest {
public static void main(String[] args) {
}
public static double getArea(double radius){
return Math.PI * radius * radius;
}
}
2.2 在编译时进行格式检查
| 注解 | 描述 |
|---|---|
| @Override | 限定重写父类方法, 该注解只能用于方法 |
| @Deprecated | 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择 |
| @SuppressWarnings | 抑制编译器警告 |
代码示例：
public class AnnotationTest{
public static void main(String[] args) {
@SuppressWarnings("unused")
int a = 10;
}
@Deprecated
public void print(){
System.out.println("过时的方法");
}
@Override
public String toString() {
return "重写的toString方法()";
}
}
2.3 其他待补充…
三、自定义注解
JDK5.0提供了4个标准的meta-annotation类型，分别是：
Retention、Target、documented、Inherited
只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用
@Rentention 时必须为该 value 成员变量指定值：
| 枚举 | 描述 |
|---|---|
| RetentionPolicy.SOURCE | 在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释 |
| RetentionPolicy.CLASS | 在class文件中有效（即class保留） ， 当运行 Java 程序时, JVM 不会保留注解。 这是默认值 |
| RetentionPolicy.RUNTIME | 在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释 |
用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于
修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量
| 取值（ElementType） | 描述 |
|---|---|
| CONSTRUCTOR | 用于描述构造器 |
| PACKAGE | 用于描述包 |
| FIELD | 用于描述域 |
| PARAMETER | 用于描述参数 |
| LOCAL_VARIABLE | 用于描述局部变量 |
| TYPE | 用于描述类、接口（包括注解类型）或enum声明 |
| METHOD | 用于描述方法 |
用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。
备注：
定义为documented的注解必须设置Retention值为RUNTIME。
被它修饰的 Annotation 将具有继承性。如果某个类使用了被
@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。
比如：
如果把标有@Inherited注解的自定义的注解标注在类级别上，子类则可以
继承父类类级别的注解
