注解(Annotation)

注解入门

什么是注解

  1. Annotation是从JDK5.0开始引进的技术

  2. Annotation的作用:

    • 不是程序本身,可以对程序做出解释,
    • 可以被其他程序(比如:编译器等)读取
  3. Annotation的格式:注解是以“@注释名”在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")

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

内置注解

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

自定义注解

  1. 使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口
  2. 分析:
    • @interface用来声明一个注解,格式:public @interface 注解名
    • 其中的每一个方法实际上是声明了一个配置参数
    • 方法的名称就是参数的名称
    • 返回值类型就是参数的类型(返回值只能是基本类型,class,String,enum)
    • 可以通过default来声明参数的默认值
    • 如果只有一个参数成员,一般参数名为value
    • 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值
package 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(name="zqq",schools = {"清华","北大"})
    public void test(){}
    
    @MyAnnotation3("zqq")
    public void test2(){}
    
}
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数:参数类型  参数名();
    String name();
    int age() default 0;
    int id() default -1;//如果默认值为-1,代表不存在
    String[] schools();
    
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}

元注解

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

//测试元注解
public class Test02 {
    @MyAnnotation
    public void test(){
        
    }
}
//定义一个注解 
//@Target  表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.ANNOTATION_TYPE})

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

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

//@Inherited 子类可以继承父类的注解
@Inherited

 @interface MyAnnotation{
    
}