一、注解

1.1、什么是注解

  • Annotation 是从 JDK5.0 开始引入的新技术。
  • Annotation 的作用：
  • 不是程序本身，可以对程序作出解释。（这一点和注释(comment)没什么区别）
  • 可以被其他程序（比如：编译器等）读取。
  • Annotation 的格式：
  • 注解是以 "@注释名" 在代码中存在的，还可以添加一些参数值，例如:@SuppressWarnings(value="unchecked")。

1.2、内置注解

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

1.3、元注解

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

import java.lang.annotation.*;

// 测试元注解
public class Test02 {

    @MyAnnotation
    public void test() {
    }
}

// 定义一个注解
// Target 表示我们的注解可以用在哪些地方。
@Target(value = {ElementType.METHOD, ElementType.TYPE})

// Retention 表示我们的注解在什么地方还有效。
@Retention(value = RetentionPolicy.RUNTIME)

// Documented 表示是否将我们的注解生成在 Javadoc 中
@Documented

// Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation {
}

1.4、自定义注解

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

代码：

package com.kuang.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(schools = {"西工大学","西北大学"})
    public void test(){ }


    @MyAnnotation1("秦将")
    public void test1(){ }
}

// 注解定义一个参数
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation1{
    //只有一个参数建议 参数名为 value，这样传递参数可以不用写参数名
    String value();
}

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