注解

110 阅读3分钟

注解入门

什么是注解

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

内置注解

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

元注解

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

import java.lang.annotation.*;

public class Test01 {
    @MyAnnotation1()
    public void test(){

    }
}

//@Target 用来描述当前注解可以使用的位置(类、方法、属性等)
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//@Retention 用来描述当前注解的生命周期
//SOURCE < CLASS < RUNTIME
@Retention(value = RetentionPolicy.RUNTIME)
//@Documented 用来描述当前注解能被包含在javadoc中
@Documented
//@Inherited 用来描述当前注解可以被子类继承
@Inherited
@interface MyAnnotation1{
    String value() default "";
}

自定义注解

  • 使用@interface自定义注解。
  • 使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口。
  • 分析
    1. @interface用来声明一个注解,格式: public @interface 注解名 {定义内容}。
    2. 其中的每一个方法实际上是声明了一个配置参数。 ==参数的格式: 参数类型 + 参数名 + ()==
    3. 方法的名称就是参数的名称。
    4. 返回值类型就是参数的类型(返回值只能是基本类型、Class、String、Enum)。
    5. 可以通过default来声明参数的默认值。 ==如果默认值为-1,代表不存在,注解可以显式赋值,如果没有默认值,就必须给注解赋值==。
    6. 如果只有一个参数成员,一般参数名为value。
    7. 注解元素必须要有值,我们定义注解元素时,经常使用空字符串、0作为默认值。
package com.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

public class Test02 {

    @MyAnnotation2(name = "hdahs")
    public void test() {
    }
    
    @MyAnnotation3("diahdis")
    public void test2(){
    }
}

@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    String name() default "Vecal";
    int id() default 1;
    int age() default 18;
    String[] schools() default {"清华大学","北京大学"};
}

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