Java注解

Posted 2023-02-02 巧克力爱王子

定义：Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation, 程序员可以在不改变原逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

说明：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可以并列多个

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;
    

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

package com.annotation.javadoc;
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方法()";
    

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

JDK中的元注解：
定义：JDK 的元 Annotation 用于修饰其他 Annotation 定义 
JDK5.0提供了4个标准的meta-annotation类型，分别是： 
Retention 
Target 
Documented 
Inherited

@Retention: 只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值: 
RetentionPolicy.SOURCE:在源文件中效（即源文件保留，编译器直接丢弃这种策略的注释 
RetentionPolicy.CLASS:在class文件中效（即class保留 ， 当运行 Java 程序时, JVM不会保留注解。 这是默认值 
RetentionPolicy.RUNTIME:在运行时效（即运行时保留，当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

@Target: 用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。定义为Documented的注解必须设置Retention值为RUNTIME。 

@Inherited: 被它修饰的 Annotation 将具继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具该注解。 
比如：如果把标@Inherited注解的自定义的注解标注在类级别上，子类则可以继承父类类级别的注解 
实际应用中，使用较少

Java 8对注解处理提供了两点改进：可重复的注解及可用于类型的注解。此外，反射也得到了加强，在Java8中能够得到方法参数的名称。这会简化标注在方法参数上的注解

@Repeatable(MyAnnotations.class)//可重复的注解
@Inherited//可继承
@Target(TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE)//能修饰哪些结构
@Retention(RetentionPolicy.RUNTIME)//生命周期
public @interface MyAnnotation 

    String value() default "clf";//属性


@Inherited//可继承
@Target(TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE)//能修饰哪些结构
@Retention(RetentionPolicy.RUNTIME)//生命周期
public  @interface MyAnnotations 
        MyAnnotation[] value();



public class AnnotationTest 
    public static void main(String[] args) 
        @SuppressWarnings("unused")
        int num = 10;

        @MyAnnotation("money")
        @MyAnnotation("ok")
        int my = 10;