Version: Next

注解

JDK 5.0引入

Annotation的作用

  • 注解不是程序本身，可以对程序做出解释，这一点上和注释没有任何区别
  • 可以被其他程序（如 编译器）读取

Annotation的格式

  • 注解是以@注释名在代码中存在的，还可以添加一些参数值。例如：@SuppressWarnings(value="unchecked")

Annotation在哪里使用

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

内置注解

@Deprecated

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

@SuppressWarnings

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

  • @SuppressWarnings("all")
  • @SuppressWarnings("unchecked")
  • @SuppressWarnings(value="unchecked","deprecation)

元注解

元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型做说明

这些类型和她们所支持的类在java.lang.annotation包中可以找到：

  • @Target: 用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
  • @Retention:表示需要在什么级别保存该注释信息，用于描述注释的生命周期
    • SOURCE < CLASS < RUNTIME
  • @Document: 说明该注解将被包含在JavaDoc中
  • @Inherited: 说明子类可以继承父类中的该注解

自定义注解

步骤

  1. 先写一个@Target,参数value来自ElementType的枚举类型，指明了注解的作用域
  2. @Retention表示注解在什么地方有效，
    • SOURCE:源代码
    • CLASS：编译期
    • RUNTIME:运行期
  3. @Documented:是否将我们的注解生成在Javadoc中
  4. @Inherited:说明子类可以继承父类中的该注解
@Target(value = {ElementType.METHOD, ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
@Inherited
@interface MyAnnotation {
}

原理

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

分析

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

定义自定义注解

  • 其中可以定义注解的参数，可以无序
  • 格式为：参数类型 参数名() default 默认值
  • 定义注解MyAnnotation2
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
//这不是方法，是注解的参数 ， 可以无序
//参数类型 参数名() default 默认值
String name() default "";
int age() default 0;
// -1代表不存在
int id() default -1;
String[] schools() default {"长安大学"};
}
  • 定义注解MyAnnotation3
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
String value();
}

  • 测试使用自定义注解

    只有一个属性且叫value时，value可以省略

public class DIYAnnotation {
//如果没有默认值，必须显式赋值
@MyAnnotation2(name = "班", age = 26, schools = {"西北大学，西北工业大学"})
public void test() {
}
//只有一个属性且叫value时，value可以省略
@MyAnnotation3("我的名字")
public void test2() {
}
}