注解详解

Java基础

Java基础

大约 5 分钟

一、什么是注解(Annotation)

Java注解又称Java标注，是Java语言5.0版本开始支持加入源代码的特殊语法元数据。为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便的使用这些数据。 Java语言中的类、方法、变量、参数和包等都可以被标注。和Javadoc不同，Java标注可以通过反射获取注解内容。在编译器生成类文件时，注解可以被嵌入到字节码中。Java虚拟机可以保留注解内容，在运行时可以获取到注解内容。

二、内置注解

java 定义了一套注解，共有 7 个，3 个在 java.lang 中，剩下 4 个在 java.lang.annotation 中。

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

1、作用在代码的注解是

@Override - 检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。
@Deprecated - 标记过时方法。如果使用该方法，会报编译警告。
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。

2、作用在其他注解的注解(或者说元注解)是:

@Retention - 标识这个注解怎么保存，是只在代码中，还是编入class文件中，或者是在运行时可以通过反射访问。
@Documented - 标记这些注解是否包含在用户文档中。
@Target - 标记这个注解应该是哪种 Java 成员。
@Inherited - 标记这个注解是继承于哪个注解类(默认注解并没有继承于任何子类)

3、从 Java 7 开始，额外添加了 3 个注解:

@SafeVarargs - Java 7 开始支持，忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
@FunctionalInterface - Java 8 开始支持，标识一个匿名函数或函数式接口。
@Repeatable - Java 8 开始支持，标识某注解可以在同一个声明上使用多次。

三、元注解

1、@Retention

@Retention annotation指定标记注释的存储方式：

RetentionPolicy.SOURCE - 标记的注释仅保留在源级别中，并由编译器忽略。
RetentionPolicy.CLASS - 标记的注释在编译时由编译器保留，即会生成class文件，但是不会加载到内存中。默认行为。
RetentionPolicy.RUNTIME - 标记的注释由JVM保留**，会生成class文件，也会加载到内存中，可由反射获取。**

2、@Documented

@Documented 注释表明，无论何时使用指定的注释，都应使用Javadoc工具记录这些元素。（默认情况下，注释不包含在Javadoc中。）有关更多信息，请参阅 Javadoc工具页面。

3、@Target

@Target 注释标记另一个注释，以限制可以应用注释的Java元素类型。目标注释指定以下元素类型之一作为其值

ElementType.TYPE 可以应用于类的任何元素。
ElementType.FIELD 可以应用于字段或属性。
ElementType.METHOD 可以应用于方法级注释。
ElementType.PARAMETER 可以应用于方法的参数。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.ANNOTATION_TYPE 可以应用于注释类型。
ElementType.PACKAGE 可以应用于包声明。
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中（如：泛型声明）
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。如：变量修饰，异常修饰

4、@Inherited

@Inherited 注释表明注释类型可以从超类继承。当用户查询注释类型并且该类没有此类型的注释时，将查询类的超类以获取注释类型（默认情况下不是这样）。此注解仅适用于类声明。

5、@Repeatable

Repeatable Java SE 8中引入的，@Repeatable注释表明标记的注释可以多次应用于相同的声明或类型使用(即可以重复在同一个类、方法、属性等上使用)。

@Inherited
@Documented
//用于类和方法上
@Target({ElementType.TYPE,ElementType.METHOD})
//运行时可获取
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {
    MyAnnotaion[] value();
}

@Inherited
@Documented
//用于类和方法上
@Target({ElementType.TYPE, ElementType.METHOD})
//运行时可获取
@Retention(RetentionPolicy.RUNTIME)
//声明当前注解为可重复注解
@Repeatable(value = MyAnnotations.class)
public @interface MyAnnotaion {
    //属性名value  属性类型String  默认值 hi
    String value() default "hi";
}

//jdk1.8之前使用多个相同注解的方式
//@MyAnnotations({@MyAnnotaion(value = "haha"),@MyAnnotaion(value = "xixi")})
//jdk.18之后使用重复注解的方式
@MyAnnotaion("haha")
@MyAnnotaion("xixi")
public class Pserson {
}

四、基本使用

https://www.jianshu.com/p/a7bedc771204open in new window

1、使用于属性上

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyField {
    String descirption();
    int length() default 2;
}

public class Person {
    @MyField(descirption = "姓名",length = 20)
    private String name;
    @MyField(descirption = "年龄")
    private int age;
}

public class Main {
    public static void main(String[] args) {
        //得到应用于注解上的Class类
        Class personClass = Person.class;
        //获取运行时类的所有字段
        Field[] declaredFields = personClass.getDeclaredFields();
        for (Field field : declaredFields) {
            //判断该属性上是否有指定的注解
            if (field.isAnnotationPresent(MyField.class)) {
                //获取当前属性的注解对象
                MyField annotation = field.getAnnotation(MyField.class);
                //获得注解信息
                //name,姓名,20
                //age,年龄,2
                System.out.println(field.getName()+","+annotation.descirption()+","+annotation.length());
            }
        }
    }
}

2、使用于类上

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyClass {
    String description();
}

@MyClass(description = "人")
public class Person {
}

public class Main {
    public static void main(String[] args) {
        Class personClass = Person.class;
        //判断当前类是否有MyClass注解
        if (personClass.isAnnotationPresent(MyClass.class)) {
            MyClass annotation = (MyClass) personClass.getAnnotation(MyClass.class);
            //人
            System.out.println(annotation.description());
        }
    }
}

3、使用于方法上

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyMethod {
    String description();
}

public class Person{
    @MyMethod(description = "打招呼方法...")
    public void say() {
        System.out.println("hello...");
    }

    @MyMethod(description = "获取密码方法...")
    public String getPassword() {
        return "123456";
    }
}

public class Main {
    public static void main(String[] args) throws IllegalAccessException, InstantiationException, InvocationTargetException {
        Class personClass = Person.class;
        Person person = ((Person) personClass.newInstance());
        Method[] declaredMethods = personClass.getMethods();
        for (Method method : declaredMethods) {
            if (method.isAnnotationPresent(MyMethod.class)) {
                MyMethod annotation = method.getAnnotation(MyMethod.class);
                System.out.println(method.invoke(person)+"---"+annotation.description());
            }
        }
    }
}

hello...
null---打招呼方法...
123456---获取密码方法...

注解详解

# 一、什么是注解(Annotation)

# 二、内置注解

# 1、作用在代码的注解是

# 2、作用在其他注解的注解(或者说元注解)是:

# 3、从 Java 7 开始，额外添加了 3 个注解:

# 三、元注解

# 1、@Retention

# 2、@Documented

# 3、@Target

# 4、@Inherited

# 5、@Repeatable

# 四、基本使用

# 1、使用于属性上

# 2、使用于类上

# 3、使用于方法上