Java注解

什么是注解

• Annotation是从JDK5.0开始引入的新技术

• Annotation的作用：

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

• Annotation的格式：

  • 注解是以“@注释名”在代码中存在的，还可以添加一些参数值

    例如：@SuppressWarnings(value=“unchecked”)

• Annotation在哪里使用：

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

package com.yang.annotation;

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

//什么是注解
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();
    }
}

内置注解

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

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

• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息

  • 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都已经定义好了，我们选择性的使用就好了

  • @SuppressWarnings(“all”)

  • @SuppressWarnings(“unchecked”)

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

    ……

元注解

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

package com.yang.annotation;

import java.lang.annotation.*;

//测试注解元素
@MyAnnotation
public class Test02 {
    public void test(){

    }

}
//定义一个注解
//@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作为默认值

package com.yang.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//
public class Test03 {
    //注解可以显示赋值，如果没有默认值，我们必须给注解赋值
    @MyAnnotation2(name = "你好",age = 10)
    public void test1(){}

    @MyAnnotation3("你好")
    public void test2(){}

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

    String[] schools() default {"爱你","很爱你"};

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