Java注解Annotation

发布于:2022-12-20 ⋅ 阅读:(417) ⋅ 点赞:(0)


01 注解入门

什么是注解:

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

02 内置注解

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

在这里插入图片描述
没有重写的注释,tostring不报错;
在这里插入图片描述
加上@Override 之后,发现报错了,因为@Override是一种规范,只要规范就会报错。必须得toString()严格遵才行;
在这里插入图片描述
@Deprecated 是建议程序员不要用,但可以用,因为不安全或者有更好的方法;
在这里插入图片描述
在这里插入图片描述
@SuppressWarning(“all”) 镇压全部警告⚠
;不仅可以镇压方法,还可以镇压类…等等;里面可以传递参数,不建议镇压警告;


03 元注解

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

//测试元注解
@MyAnnotation
public class Demo02 {
    @MyAnnotation
    public void test(){}
}

//Target 表示注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE}) //目标作用域为方法和类
//Retention 表示注解在什么地方还有效
@Retention(value = RetentionPolicy.RUNTIME) //RUNTIME 运行的时候都有效
//Documented 表示是否将注解生成在JavaDoc中 
@Documented 
//Inherited 子类可以继承父类的注解
@Inherited
//定义一个注解
@interface MyAnnotation{ //不能加public 因为一个类里面只能有一个public
}

04 自定义注解

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

//自定义注解
public class Demo03 {
    //注解可以显示赋值,如果没有默认值,就必须给注解赋值
    @DiyAnnotation(name = "嗨", high = 180, schools = {"成都理工大学"}) //参数有默认值可以不定义,没有默认值一定要定义
    public void test1() {
    }                             //参数没有顺序,可以任意

    //@TestAnnotation(value="test")
    @TestAnnotation("test") //只有一个参数时,value可以省去,直接输入
    public void test2() {
    }

}

//多参数注解
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface DiyAnnotation{
    //注解的参数:参数类型+参数名();
    String name() default"";//默认值为空
    int age() default 0 ;
    int id() default -1 ;//如果默认值为-1,代表不存在
    int high(); //参数有默认值可以不定义,没有默认值一定要定义
    String[] schools() default{"电子科技大学"};
}

//单参数注解:只有一个参数,用value命名
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface TestAnnotation{
    String value();
}

注解要怎么使用,可以看下一节:反射机制
(可通过反射机制编程实现对这些元数据的访问)


网站公告

今日签到

点亮在社区的每一天
去签到