JavaSE中的注解

一、说明

1. jdk 5.0 新增的功能
2. Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,程序员可以在不改变原逻辑的情况下, 在源文件中嵌入一些补充信息。
3. Annotation可以像修饰符一样使用，可以用来修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在Annotation的“name = value”对中。
4. 在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android 中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁冗 代码和XML配置等。
5. 框架 = 注解 + 反射机制 + 设计模式

二、使用示例

使用 Annotation时要在其前面增加@符号，并把该 Annotation当成个修饰符使用。用于修饰它支持的程序元素

1、生成文档的相关注解

• @author标明开发该类模块的作者，多个作者之间使用","分割
• @version标明该类模块的版本
• @see参考转向，也就是相关主题
• @since从哪个版本开始增加的
• @param对方法中某参数的说明，如果没有参数就不能写
• @return对方法返回值的说明，如果方法的返回值类型是void就不能写
• @exception对方法可能抛出的异常进行说明，如果方法没有用 throws显式抛出的异常就不能写 其中
• @param @return和@exception这三个标记都是只用于方法的。
• @param的格式要求：@param形参名形参类型形参说明
• @return的格式要求：@return返回值类型返回值说明
• @exception的格式要求：@exception异常类型异常说明
• @param和@ exception可以并列多个

2、编译时的格式检查

• @Override: 限定重写父类方法, 该注解只能用于方法
• @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的择
• @SuppressWarnings: 抑制编译器警告

三、自定义注解

参照@SuppressWarnings定义

1. 注解声明为：@interface
2. 内部定义成员，通常使用value表示
3. 可以指定成员的默认值，使用default定义
4. 如果自定义注解没成员，表明是一个标识作用。

说明：

如果注解有成员，在使用注解时，需要指明成员的值。

自定义注解必须配上注解的信息处理流程(使用反射)才意义。

自定义注解通过都会指明两个元注解：Retention、Target

代码举例：

@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}

四、元注解

对现有的注解进行解释说明的注解。

JDK 5.0 提供的4种元注解：

• Retention：指定所修饰的 Annotation 的生命周期：SOURCE、CLASS（默认行为）、RUNTIME，SOURCE表示编译时，编译后不保留；CLASS表示编译为.class文件后仍然保留；只有声明为RUNTIME生命周期的注解，才能对其进行处理。
• Target:用于指定被修饰的 Annotation 能用于修饰哪些程序元素，传入的值为ElementType枚举类中的值，其中有：

1. TYPE：类，接口（包括注释类型）或枚举声明
2. FIELD：字段声明（包括枚举常数）
3. METHOD：方法声明
4. PARAMETER：正式参数声明
5. CONSTRUCTOR：构造函数声明
6. LOCAL_VARIABLE：局部变量声明
7. ANNOTATION_TYPE：注解类型声明
8. PACKAGE：包声明
9. TYPE_PARAMETER：JDK8新增，可重复注解，表示该注解能写在类型变量的声明语句中
10. TYPE_USE：JDK8新增，类型注解，表示该注解能写在使用类型的任何语句中

• Documented:表示所修饰的注解在被javadoc解析时，保留下来。
• Inherited:被它修饰的 Annotation 将具继承性。