Day23Java学习笔记——认识注解

注解

注解定义

注解定义

注解：一种代码级别的说明。Annotation是从JDK5.0开始引入的新技术。它与类、接口、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明、注释。

Annotation的作用

• 不是程序本身，可以对程序做出程序做出解释（与注释(comment)没什么区别）
• 可以被其他程序（如：编译器）读取

Annotation的格式

• 注解是以"@注释名"在代码中存在的 , 还可以添加一些参数值 , 例如：@override 重新方法时

Annotation使用范围

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

---

内置注解

@Override

• 定义在 java.lang.Override 中 , 此注释只适用于修辞方法 , 表示一个方法声明打算 重写超类中的另一个方法声明。

@Deprecated

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

public class Test1{

    public static void main(String[] args) {
        int year = new Date().getYear();//getYear()这个方法过时，但还是可用
        System.out.println(year);
    }

    //标注这个方法，过时的，或者危险的，不建议使用，但是可以使用！
    @Deprecated
    public int test(){  //不建议使用
        System.out.println("aaaaaa");
        return 1;
    }

    public String hello(){ //没有被使用
       List list = new ArrayList<>();
       return "hello,world!";
    }

    @Override //标注了这个注解，就代表子类重写了父类的方法，而且必须保持一致
    public String toString() {
        return "Test1{}";
    }
}

@SuppressWarnings

• 定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。
  • 与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的, 我们选择性的使用就好了
  • @SuppressWarnings(“all”)-抑制所有类型的警告
  • @SuppressWarnings(“unchecked”)-告诉编译器忽略 unchecked 警告信息，如使用List，ArrayList等未进行参数化产生的警告信息
  • @SuppressWarnings(value={“unchecked”,“deprecation”})- 告诉编译器同时忽略unchecked和deprecation的警告信息。

如：在程序中有一些未使用的变量名，变量名会有不同颜色显示，用@SuppressWarnings(“all”)可将颜色变化的地方去掉，但不建议使用

元注解

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

public class Test2 {

    private int age;

    @MyAnnotation
    public int getAge() {
        return age;
    }
}
//除了这四个注解之外的所有注解，都叫做自定义注解！
@Target(ElementType.METHOD) //表示我这个注解，能够注解谁！ (方法，字段，类)
@Retention(RetentionPolicy.RUNTIME) //自定义注解我们都会使用RetentionPolicy.RUNTIME 在运行时生效 
@Documented //表示L可以在Javadoc中生成信息，没什么用！
@Inherited //表示子类可以继承父类的注解，一般也不用！
@interface MyAnnotation{
}

自定义注解

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

public class Test3 {

    private int age;

    @MyAnnotation3("aaa") //value="aaa"
    public int getAge() {
        return age;
    }

}

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

    String[] value(); //只有一个参数的一般名字叫做value， 可以省略！
}

@Target(value={ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{

    String name() default "";
    int age() default 0;
    int id() default -1; // String indexOf("abc")   -1, 找不到，不存在

    String[] schools();
}