Java之注解

注解

- 1.1 注解的概念
- 1.2 内置注解
- 1.3 元注解
- 1.4 自定义注解

1.1 注解的概念

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

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

// 什么是注解
public class Demo01_Annotation extends Object{
  
  // @Override 就是一个注解
  @Override
  public String toString() {
      return super.toString();
  }
  
}

1.2 内置注解

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

// 什么是注解
public class Demo01_Annotation extends Object{
    
    // @Override 就是一个注解
    @Override
    public String toString() {
        return super.toString();
    }

    // @Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的更新方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    // @SuppressWarning 抑制警告
    @SuppressWarnings("all")
    public void test01(){
        ArrayList<String> strings = new ArrayList<>();
    }

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

1.3 元注解

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

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

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

// 测试元注解
@MyAnnotation
public class Demo02_MetaAnnotation {

    @MyAnnotation
    public void test(){

    }

}


// 定义一个注解
// @Target 可以用在什么地方
// ElementType.METHOD方法上有效 ElementType.TYPE类上有效
@Target(value={ElementType.METHOD,ElementType.TYPE})
// 在什么地方生效
// RUNTIME>CLASS>SOURCES
@Retention(value= RetentionPolicy.RUNTIME)
// 表示是否将我们的注解生成在Javadoc中
@Documented
// 子类可以竭诚父类的注解
@Inherited
@interface MyAnnotation{}

1.4 自定义注解

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

分析：

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

// 自定义注解
public class Demo03_CustomAnnotation {
    // 注解可以显示赋值，如果没有默认值，就必须给注解赋值
    @MyAnnotation2(name = "张三")
    public void test(){
        
    }
}

@Target(value = {ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    // 注解的参数：参数类型+参数名()
    // String name();
    String name() default "";
    int age() default 0;
    int id() default -1;// -1代表不存在
    String[] schools() default {"清华大学","北京大学"};
}