【Java】注解

1.注解入门

Annotation是jdk1.5开始引入的新技术。

Annotation的作用：

• 不是程序本身，可以对程序作出解释；
• 可以被其他程序（例如编译器）读取。

Annotation的格式：“@注解名”。也可以带参数，如：@SuppressWarnings(value=“unchcked”)

Annotation在哪里使用？可以附加在package、class、method、field上，相当于给它们添加了额外的辅助信息，还可以通过反射机制编程实现对这些元数据的访问。

public class Test01 extends Object{
    @Override  // @Override：重写的注解
    public String toString(){
        return super.toString();
    }
}

2.内置注解

@Override：定义在 java.lang.Override中，此注释只适用于修辞方法，表示一个方法打算重写超类中的另一个方法声明。

@Deprecated：定义在 Java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。

@SuppressWarnings：定义在 Java.lang.SuppressWarnings中，用来抑制编译时的警告信息。与前两个注释有所不同，需要添加一个参数才能正确使用，这些参数都是已经定义好了的，选择性的使用就好:

• @SuppressWarnings("all")
• @SuppressWarnings("unchecked)
• @SuppressWarnings(value=f"unchecked"， " deprecation ")
• ...

package github.Annotation.Demo01;
import java.util.ArrayList;
import java.util.List;

public class Test01 extends Object{
    @Deprecated  // @Deprecated不推荐使用，但可以使用，或存在更好的更新方式
    public static void test(){
        System.out.println("Deprecated");
    }

    @SuppressWarnings("all")  // @SuppressWarnings 镇压警告
    public void test01(){
        List<String> list = new ArrayList<>();
    }

    public static void main(String[] args) {
        test();
    }
}

3.元注解

元注解的作用：负责注解其他注解。

Java定义了4个标准的meta-annotation类型，被用来提供对其他 annotation类型的说明。这些类型和它们所支持的类在 java.lang.annotation包中可以找到。如下：

@Target：用于描述注解的使用范围（即被描述的注解可以用在什么地方）。

@Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期。

• SOURCE < CLASS < RUNTIME

@Document：说明该注解将被包含在Javadoc中。

@Inherited：说明子类可以继承父类中的该注解。

package github.Annotation.Demo01;
import java.lang.annotation.*;

public class TestAnnotation {
    @MyAnnotion
    public void test(){}
}

@Target(value = {ElementType.METHOD, ElementType.TYPE})  // 注解可用在ElementType.METHOD方法上、ElementType.TYPE类上
@Retention(value = RetentionPolicy.RUNTIME)  // 在什么地方有效
@Documented  // 表示是否将我们的注解生成在Javadoc中
@Inherited  // 子类可以继承父类的注解
@interface MyAnnotion{}  // 定义注解

4.自定义注解

使用@interface自定义注解，自动继承了java.lang.annotation.Annotation接口。

@interface用来声明一个注解，格式：public @interface注解名{定义内容}

• 其中的每一个方法实际上是声明了一个配置参数；
• 方法的名称就是参数的名称。
• 返回值类型就是参数的类型（返回值只能是基本类型， Class, String,enum）
• 可以通过 defau来声明参数的默认值；
• 如果只有一个参数成员，一般参数名为vaue；
• 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值

package github.Annotation.Demo01;

public class TestCustomAnnotation {
    @MyAnnotation2(name = "王五")  // 注解可以显示赋值,如果没有默认值,就必须给注解赋值
    public void test(){}  
    @MyAnnotion3("subei")  //只有一个参数时，参数名可使用value，这里可直接传值，不需要使用参数名
    public void test2(){}
}

@Target(value = ElementType.METHOD)
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // String name();
    String name() default "";  // 注解的参数:参数类型+参数名()
    int age() default 0;
    int id() default -1;  // -1代表不存在
    String[] schools() default {"清华", "北大"};
}

@Target(value = ElementType.METHOD)
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotion3{
    String value();  //只有一个参数
}