注解

1. 什么是注解:

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

2. 注解类型

2.1. 内置注解

  • @Override:定义在java.lang.Override中, 此注解只适用于修辞方法,表示一个方法打算重写超类中的另一个方法声明
  • @Deprecated:定义在java.lang.Deprecated中,此注解可以用于修辞方法、属性、类,表示不鼓励程序员使用这样的元素,通常是因为他很危险或者存在更好的选择。标记过时方法。
  • @SuppressWarnings:定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息,指示编译器去忽略注解中声明的警告。
    • 与前两个不同,需要添加一个参数才能够正确使用,这些参数都是已经定义好了的,我们选择性的使用就好了
    • @SupressWarnings(“all”)
    • @SupressWarnings("unchecked")
    • @SupressWarnings(value = { "unchecked", " deprecation"})

2.2. 元注解

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

  • 这些类型和他们所支持的类在java.lang.annotation包中可以找到。(@Target@Retention, @Documented, @Inherited)

    • @Target:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)

      @Target 有下面的取值 @Target(ElementType.TYPE) 可以有多个取值

      • ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
      • ElementType.CONSTRUCTOR 可以给构造方法进行注解
      • ElementType.FIELD 可以给属性进行注解
      • ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
      • ElementType.METHOD 可以给方法进行注解
      • ElementType.PACKAGE 可以给一个包进行注解
      • ElementType.PARAMETER 可以给一个方法内的参数进行注解
      • ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
    • @Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。一般写runtime 。

      它参数的取值如下:@Retention(RetentionPolicy.RUNTIME)只能有一个取值。

      • RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
      • RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
      • RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。

      • (SOURCE < CLASS < RUNTIME)。

    • @Documented:说明该注解将被包含在javadoc中。

    • @Inherited:说明子类可以继承父类中的注解。

      @Inherited 是 Java 中的一个注解(annotation),它表示一个注解会被自动继承。

      如果一个类使用了 @Inherited 注解修饰的注解,并且这个类的子类没有使用这个注解,那么这个子类会自动继承这个注解。

      例如,假设有如下的代码:

      @Inherited
      @interface MyAnnotation {
        // ...
      }
      
      @MyAnnotation
      class A {
        // ...
      }
      
      class B extends A {
        // ...
      }
      

      在这个例子中,类 A 使用了 @MyAnnotation 注解,而类 B 继承了类 A,但是没有使用 @MyAnnotation 注解。由于 @MyAnnotation 使用了 @Inherited 注解修饰,所以类 B 会自动继承 @MyAnnotation 注解。

      注意,@Inherited 注解只能修饰注解,不能修饰其他类型的元素。另外,@Inherited 注解只对类有效,对接口没有效果。

从 Java 7 开始,额外添加了 3 个注解:

  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
@MyAnnotation
public class Test {
    public static void main(String[] args) {

    }
}

@Deprecated
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@interface MyAnnotation {

}

2.3. 自定义注解

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

    @MyAnnotation2("myValue")
    public void test2(){}
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    // 可设置默认值,缺省
    String name() default "";
    // 没有设置默认值则必须在注解的时候给出
    int age();
    int id() default -1;
    String[] address() default {"广东省", "江苏省"};
    String[] account();
}

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // 当只有一个参数且参数名为value时,在注解的时候可以省略参数名,直接写参数值
    String value();
}

3. 注解

  • @PostConstruct这是Java自己的注解,被用来修饰非静态的void方法,被@PostConstruct修饰的方法宕IOC容器内所有定义的bean都注入成功之后调用的方法。只会被服务器政治性一次。在构造函数之后执行,init()方法之前执行。
Copyright © rootwhois.cn 2021-2022 all right reserved,powered by GitbookFile Modify: 2023-03-05 10:55:52

results matching ""

    No results matching ""