Java学习笔记38

Java笔记38

注解

什么是注解

• Annotation是从 JDK 5.0 开始引入的新技术。
• Annotation的作用︰
  • 不是程序本身，可以对程序作出解释。（这一点和注释 - comment没什么区别）
  • 可以被其他程序（比如编译器等）读取。
• Annotation的格式︰
  • 注解是以@注释名在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value="unchecked")。
• Annotation在哪里使用？
  • 可以附加在package ，class ，method，field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

内置注解

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

package com.clown.annotation;

//内置注解
public class Test01 {  //默认 extends Object

    //@Override  重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //@Deprecated  表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择
    @Deprecated
    public static void test() {
        System.out.println("Deprecated");
    }

    public static void main(String[] args) {
        test();  //被 @Deprecated注解的方法依旧是能够使用的，只是不推荐使用
    }

    /*
    定义一个方法和一个变量，但不使用它们，正常情况下程序在编译时会提出以下警告：Method 'test020' is never used 和 Variable 'name' is never used。
    但我们加上注解：@SuppressWarnings("all") 后，程序在编译时就不再对此方法和方法内的变量提出警告了。
     */
    //@SuppressWarnings("XXX")  抑制编译时的警告信息
    @SuppressWarnings("all")
    public void test02() {
        String name = null;
    }

}

• 运行结果：

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型，他们被用来提供对其他annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到（@Target，@Retention，@Documented，@lnherited )。
  • @Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。
  • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期。
    • （SOURCE < CLASS < RUNTIME）
  • @Document：说明该注解将被包含在javadoc中。
  • @Inherited：说明子类可以继承父类中的该注解。
• 下面我们使用@interface自己定义一个注解MyAnnotation，然后我们使用元注解对我们定义的注解MyAnnotation进行说明，以此帮助我们更好地理解元注解：

package com.clown.annotation;

import java.lang.annotation.*;

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

    @MyAnnotation
    public void test() {

    }

}


//@Target  表示该注解可以用在哪些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})  //表示：注解 - @MyAnnotation可以用在方法（METHOD）或者类（TYPE）上

//@Retention  表示该注解在什么地方还有效
//RUNTIME > CLASS > SOURCE （通常都使用 RUNTIME）
@Retention(value = RetentionPolicy.RUNTIME)  //表示：注解 - @MyAnnotation在源码时、编译为class时以及运行时都有效

//@Documented  表示会将该注解放进 javadoc文档中
@Documented

//@Inherited  表示子类可以继承父类中的该注解
@Inherited
//自己定义一个注解 - MyAnnotation
@interface MyAnnotation {  //@interface  注解类，用来声明一个注解

}

自定义注解

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

package com.clown.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(age = 18, name = "张三")  //参数没有顺序
    public void test() {

    }

    //因为注解 - @MyAnnotation3中只有一个参数，且我们把此参数命名为了 value，所以此处可以省略 value =
    //如果我们把 @MyAnnotation3中的参数命名为了其他名称，如：String name(); ，则此处只能写 name ="李四"，不能省略 name =
    @MyAnnotation3("李四")
    public void  test2() {

    }

}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    //注解的参数，格式: 参数类型 + 参数名();
    String name() default "";  //default "" - 设置默认值为空字符串
    int age();
    int id() default -1;  //默认值为 -1时，代表不存在

    String[] schools() default {"北京大学", "清华大学"};
}


@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    String value();  //只有一个参数时，建议使用 value来命名
}