Java-注解(Annotation)

注解概述

Annotation其实就是代码里的特殊标记，这些标记可以在编译、类的加载、运行时被读取，并执行相应的处理。

可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代 码分析工具、开发工具和部署工具可以通过这些补充信息进行验证 或者进行部署。

Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方 法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在 Annotation 的 “name=value” 对中

 

JDK内置的三个注解

在编译时进行格式检查(JDK内置的三个基本注解)

@Override: 限定重写父类方法, 该注解只能用于方法

@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为 所修饰的结构危险或存在更好的选择

@SuppressWarnings: 抑制编译器警告

class Test{
    public static void main(String[] args) {
        /*printTest printTest = new printTest(76234);
        printTest.PrintOut(printTest.i);*/

        @SuppressWarnings("unused")
        int num = 10;
        
        @SuppressWarnings({"unused","rawtypes"})
        ArrayList arr = new ArrayList();
    }
}

 

生成文档相关的注解

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

package com.annotation.javadoc;
/**
* @author shkstart
* @version 1.0
* @see Math.java
*/
public class JavadocTest {
/**
* 程序的主方法，程序的入口
* @param args String[] 命令行参数
*/
public static void main(String[] args) {
}
/**
* 求圆面积的方法
* @param radius double 半径值
* @return double 圆的面积
*/
public static double getArea(double radius){
return Math.PI * radius * radius;
}

 

自定义注解

定义新的 Annotation 类型使用 @interface 关键字
 自定义注解自动继承了java.lang.annotation.Annotation接口
 Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其
方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能
是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、
以上所有类型的数组。
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始
值可使用 default 关键字
 如果只有一个参数成员，建议使用参数名为value
如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认
值。格式是“参数名 = 参数值”
，如果只有一个参数成员，且名称为value，
可以省略“value=”
 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数
据 Annotation
注意：自定义注解必须配上注解的信息处理流程才有意义

 

元注解：

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

Retention

Target

Documented

Inherited

 自定义注解

package www.fancy.algorithm.exer;

import java.lang.annotation.*;

import static java.lang.annotation.ElementType.*;

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, ElementType.FIELD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE})
public @interface MyAnnotation {
    String value() default "hello";
}

 

java 8 中注解的新特性　　

repeatable注解

在MyAnnotation上声明@Reaptable,成员值为MyAnnotations.class

MyAnnotation的Target和@Reaptable等注解和MyAnnotations相同

 

类型注解

TYPE_PARAMETER

表示该注解能写在类型变量的声明语句中（如：泛型声明）

TYPE_USE

表示该注解能写在使用类型的任何语句中