Java注解

47 阅读3分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第25天,点击查看活动详情

注解

Annotation作用

不是程序本身,可以对程序作出解释

可以被其他程序(编译器等)读取

格式

注解是以"@注解名“在代码中存在的,还可以添加一些参数值,例:@SuppressWarnings(value="unchecked")

在哪使用

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

内置注解

@Override

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

@Deprecated

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

 

@SuppressWarnings

定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息

与前两个注解有所不同,该注解需要添加一个参数才能正常使用

SuppressWarnings("all")

SuppressWarnings("unchecked")

SuppressWarnings(value={"unchecked","deprecation"})

使用前

使用后

元注解

作用

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

  • @Target:用于描述注解的使用范围(即:被描述的注解可以在什么地方使用)

属性:ElementType

TYPE:当前注解可以用于类声明

METHOD:当前注解可以用于方法声明位置

FIELD:当前注解可以用于成员变量声明位置

例:定义参数为METHOD时,注解在方法外可行

在类外就编译出错

此时可以加上参数TYPE即可

@Target(value = {ElementType.METHOD,ElementType.TYPE})

@Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期

RetentionPolicy.RUNTIME:当前注解会编译生成对应的.class字节码文件,并且可以加载到JVM中,参与代码执行

RetentionPolicy.CLASS

RetentionPolicy.SOURCE:注解将被编译器丢弃(该类型的注解信息只会保留在源码里,源码经过编译后,注解信息会被丢弃,不会保留在编译好的class文件里

  • RUNTIME>CLASS>SOURCE
  • @Doucument:说明该注解将被包含在Javadoc中
  • @Inherited:说明子类可以继承父类中的该注解
import java.lang.annotation.*;
​
//测试元注解
@MyAnnotation
public class Test02 {
    public void test(){}
}
//定义注解
//Target 表示我们的注解可以在何处使用
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//Retention 表示注解在什么地方还有效 runtime>class>source
@Retention(value = RetentionPolicy.RUNTIME)
//Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented
// Inherited 子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
​
}

自定义注解

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

规则

  • @interface用来声明一个注解,格式:public @interface 注解名 (定义内容)
  • 其中的每个方法实际上是声明了一个配置参数 (例:String value();),方法的名字就是参数的名字
  • 返回值类型是参数的类型(只能是基本类型:Class、String、enum)
  • 注解的参数:参数类型 参数名(); 若需要默认值则用default;
  • 如果只有一个参数成员,一般参数名为value
import java.lang.annotation.*;
​
public class Test03 {
    //注解可以显示赋值,若没有默认值(default),则需要我们手动传参
    @MyAnnotation2(schools="QLNU")
    public void test(){
    }
    @MyAnnotation3("Sentiment")
    public void test2(){
​
    }
}
​
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    // 注解的参数:参数类型 参数名(); 若需要默认值则用default;
    String name() default "";
    int age() default 0;
    int id() default -1;
    String[] schools();
}
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    String value();
}