Java——注解

注解

注解（Annotation），是从JDK5.0开始引入的新技术。
注解的性质如下：

• 注解的作用

  • 注解不是程序本身，可以对程序作出解释（这一点和注释（comment）没什么区别）
  • 可以被其他程序（比如：编译器等）读取

• 注解的格式

  • 注解是以“@注解名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=“unchecked”)
    注解的使用范围
  • 注解可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，可以通过反射机制编程实现对这些元数据的访问

内置的注解如下：

• @Override：定义在java.lang.Override中，此注解只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明
• @Deprecated：定义在java.lang.Deprecated中，此注解可以用于修饰方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择
• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。与前两个注解有所不同，需要添加一个参数才能正确使用，这些参数都已经定义好的，只需要有选择性的使用就好

示例如下：

public class Test {
//Override：重写方法的注解
@Override
public String toString() {
    return "Test{}";
}

//Deprecated：不推荐使用，但是可以使用
@Deprecated
public static void stop(){
    System.out.println("123");
}

//SuppressWarnings：抑制警告信息的注解
@SuppressWarnings("all")
public  void test(){

}

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

元注解，就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，它们被用来提供对其他annotation类型作说明，这些类型和它们所支持的类在java.lang.annotation包中可以找到（ @Target,@Retention,@Documented,@Inheriter），它们的说明如下：

• @Target：用于描述注解的使用范围（即被描述的注解可以用在什么地方，例如ElementType.METHOD为作用在方法上，ElementType.TYPE为运用在类上）
• @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（SOURCE < CLASS < RUNTIME）
• @Document：说明该注解被包含在javadoc中
• @Inherited：说明子类可以继承父类中的该注解

示例如下：

//测试元注解
@MyAnnotation
public class Test2 {
}


@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD}) //作用域
@Retention(RetentionPolicy.RUNTIME) //运行时级别
@Documented //生成Doc文档时候使用
@Inherited //子类可以继承父类的注解
@interface  MyAnnotation{
}

自定义注解，就是根据自身的需要，自己定义出来的注解。使用关键字@interface自定义注解时，便自动继承了java.lang.annotation.Annotation接口。自定义注解的说明如下：

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

示例如下：

//测试自定义注解
@SuppressWarnings("all")
public class Test3 {

    @MyAnnotation2(name = "123",age = 3,id = 001,schools = "aa")
    public void test(){
    }


    //注解只有一个参数的时候，默认使用value当做参数名字，使用的时候可以省略参数名
    @MyAnnotation3("a")
    public void test2(){

    }
}

@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD}) //作用域
@Retention(RetentionPolicy.RUNTIME) //运行时级别
@interface MyAnnotation2{
    //参数类型 参数名
    String name() default "";
    int age() default  0;
    // -1 代表不存在，类似于Indexof的返回值
    int id() default -1;
    String[] schools() default {"a","b"};
}

@Target(value = {ElementType.METHOD,ElementType.TYPE,ElementType.FIELD}) //作用域
@Retention(RetentionPolicy.RUNTIME) //运行时级别
@interface MyAnnotation3{
    String value();
}