Java的注解

本次带领大家注解的概念、内置注解、元注解的内容。

什么是注解

• 注解(Annotation)是从JDK 5.0开始引入的新技术。
• Annotation的作用：
  • 不是程序本身，可以对程序做出解释。(这一点和注释(comment)没什么区别)。
  • 可以被其他程序(比如:编译器等)读取。
• Annotation的格式：
  • 注解是以"@注解名"在代码中存在的，还可以添加一些参数值，例如:@SuppressWarnings(value=“unchecked”)。
• Annotation在哪里使用？
  • 可以附加在package,class,method,field 等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

内置注解

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

• @Deprecated：定义在java.lang.Deprecated中，Deprecated的程序元素是程序员不鼓励使用的程序元素，通常是因为它是危险的，或者因为存在更好的替代方法。 编译器在不被弃用的代码中使用或覆盖不推荐使用的程序元素时发出警告。

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

  • @SuppressWarnings(“all”)
  • @SuppressWarnings(“unchecked”)
  • @SuppressWarnings(value={“unchecked”,“deprecation”})

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

    //@Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList();
    }
    public static void main(String[] args) {
        test();
    }
}

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到。(@Target，@Retention，@Documented，@Inherited)
  • @Target：用于描述注解的适用范围(即：被描述的注解可以用在说明地方)
  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期。(SOURCE<CLASS<RUNTIME)
  • @Document：说明该注解将被包含在javadoc中。
  • @Inherited：说明子类可以继承父类中的该注解。

//定义一个注解
//Target 表示我们的注解可以用在哪些地方。
@Target(value = {ElementType.METHOD,ElementType.TYPE})

//Retention 表示我们的注解在什么地方还有效。
// runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)

//Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented

//Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{

}

自定义注解

• 使用@interface 自定义注解时，自动继承了java.lang.annotation.Annotation接口。
• 分析：
  • @interface 用来声明一个注解，格式：public @ interface 注解名 {定义内容}。
  • 其中的每一个方法实际上是声明了一个配置参数。
  • 方法的名称就是参数的名称。
  • 返回值类型就是参数的类型。(返回值只能是基本类型，Class，String，enum)
  • 可以通过default 来声明参数的默认值。
  • 如果只用一个参数成员，一般参数名为value。
  • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值。

//自定义注解
public class Test03 {

    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotatiin2(age = 18)
    public void test(){
    }
    @MyAnnotation3("111")
    public void test2(){
    }
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotatiin2{
    //注解的参数 ：参数类型 + 参数名（）;
    String name() default "";
    int age();
    int id() default -1; // 如果默认值为-1，代表不存在

    String[] schools() default {"华南","华北"};
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}