Java 注解

Java.Annotation

一、Annotation的作用：

• 不是程序本身的一部分，可以对程序作出解释（与注释的作用一致）
• 可以被其他程序（如编译器）读取

二、Annotation的格式：

• 注解以“@+注释名”在代码中存在，还可以添加一些参数值，例如：@SuppressWarinings(value = “unchecked”)

三、Annotation的使用位置

• 可以附加在package、class、method、field等上面，相当于给他们添加了额外的辅助信息，可以通过反射机制编程实现对这些元数据的访问。

四、内置注解：

• @Override: 定义在java.lang.Override中，此注释只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明
• @Deprecated：定义在java.lang.Deprecated中，用于修饰方法，属性，类，表示不鼓励程序员使用被它修饰的元素，通常是因为它比较危险或者存在更好的选择。
• @SuppressWarnings：定义在java.lang.SupressWarings中，用来抑制编译时的警告信息。与前两个注释有所不同，需要添加一个参数才能正常使用该注解，如:@SuppressWarnings(“all”)、@SuppressWarnings(“unchecked”)、@SuppressWarnings(value={“unchecked”, “deprecation”})等

package 内置注解;

import java.util.ArrayList;
import java.util.List;

public class Test01 extends Object{


    @Override//这就是一个重写的注解
    public String toString() {
        return super.toString();
    }

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

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

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

五、元注解：

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

package 元注解;
import java.lang.annotation.*;

public class Test02 {

    @MyAnnotation
    public void test(){

    }
}

//定义一个注解
/*Target表示我们的注解可以用在哪些地方，METHOD表示可以用于修饰方法，TYPE表示可以用于修饰类*/
@Target(value = {ElementType.METHOD, ElementType.TYPE})
/*表示我们的注解在什么地方还能继续有效，一般为RUNTIME，表示在运行时注解仍然保持有效，此外CLASS表示在编译的时候有效，SOURCE表示只需在源码有效*/
@Retention(value = RetentionPolicy.RUNTIME)
/*Documented表示是否将我们的注解生成在JAVAdoc中*/
@Documented
/*Inherited子类可以继承父类的注解*/
@Inherited
@interface MyAnnotation{
    //注解内容
}

六、自定义注解：

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

  • @interface用来声明一个注解，格式为:

  public @interface注解名
  {
  	//注解的定义内容
      //参数类型+参数名();
      String name(); //此注解参数不带默认值，在使用时必须指定参数值，否则报错
      String age() default "24"; //这是一个带默认值的注解参数，
  }
  

  • 其中的每一个方法实际上是声明了一个配置参数

  • 方法的名称就是参数的名称

  • 返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum）

  • 可以通过default来说明参数的默认值

  • 如果只有一个参数成员，一般参数名为value，这样在注解使用时就不需要显示的声明参数名，比如@MyAnnotation3(“大疆”)

  • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值

package 自定义注解;

import java.lang.annotation.*;

public class Test03 {
    @MyAnnotation2(schools = {"清华大学","北京大学"})
    public void test(){

    }

    @MyAnnotation3("大疆")//该注解就一个参数，如果以value命名参数，那么使用时参数可以省略不写
    public void test2(){

    }
}

//自定义注解
@Target(value = {ElementType.TYPE, ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    String name() default "";//这不是一个方法，而是注解的参数
    int age() default 13;//带参数的注解参数
    int id() default -1;//如果默认值为-1.代表不存在
    String[] schools();
}


//自定义注解
@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}