首页 > 编程语言 > 一篇文章带你入门java注解
2022
01-12

一篇文章带你入门java注解

注解

什么是注解

  • Annotation是从JDK5.0开始引入的新技术
  • Annotation的作用:
    • 1.不是程序本身,可以对程序做出解释(这一点和注释(comment)没什么区别)
    • 2.可以被其他程序(比如:编译器等)读取

Annotation的格式:

​ 注解是以"@注释名"在代码中存在的,还可以添加一些参数值,例如:

​ @SuppressWarnings(value=“unchecked”)

Annotation在哪里使用

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

内置注解

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

public class Test extends Object{
	//@Override 重写注解,必须是重写超类的方法,不然会发生编译器上的错误
    @Override
    public String toString() {
        return super.toString();
    }
}

@Deprecated:定义在Java.lang.Deprecated中,此注释可以用于修饰方法,属性,类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或者存在更好的选择

	@Deprecated   //意思为方法已经过时,存在危险,或者有更好的方法
    public static void test01(){
        System.out.println("过时的");
    }
    public static void main(String[] args) {
        test01();
    }

虽然是过时或存在危险,但是依然可以调用此方法,

在这里插入图片描述

根据上面的图片也会看到,如果被@Deprecated注释上的方法,在调用的时候,会画一点横线

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

​ 与前两个注释有所不同,你需要添加一个参数才能正常使用,这些参数都是已经定义好了的,我们选择性的使 用就好了

√@SuppressWarnings(“all”)

√@SuppressWarnings(“unchecked”)

√@SuppressWarnings(value={“unchecked”,“deprecation”})

√等等

元注解

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

这些类型和它们所支持的类在Java.lang.annotation包中可以找到(@Target@Retention@Documented@Inherited

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

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

(SOURCE<CLASS<RUNTIME)

@Document:说明该注解将被包含在Javadoc中

@Inherited:说明子类可以继承父类中的该注解

//测试元注解
    @MyAnnotation
public class Test02 {
}
//定义一个注解
//Target  表示我们的注解可以用到哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE}) //METHOD注解可以在方法TYPE可以在类
//Retention 表示我们的注解在什么地方还有效
//runtime>class>sources
@Retention(value = RetentionPolicy.RUNTIME)
//Documented 表示是否将我们的注解生成在Javadoc中
@Documented
//子类可以继承父类的注解
@Inherited
 @interface MyAnnotation{
}

自定义注解

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

分析:

@interface用来声明一个注解,格式:public @interface 注解名{ 定义内容 }

其中的每一个方法实际上是声明了一个配置参数

方法的名称就是参数的名称

返回值类型就是参数的类型(返回值只能是基本类型,Class,String,enum)

可以通过default来声明参数的默认值

如果只有一个参数成员,一般参数名为value

注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值

实例

public class Test03 {
    //注解可以显示赋值,如果没有默认值,我们就必须给注解赋值
    @MyAnntotation2(schools = {"河北软件","宽城职教"})
    public void Test(){}
    @MyAnntotation3("ccl")  //可以省略value
    public void Test1(){}
}
//多次参数的注解
@Target({ElementType.TYPE,ElementType.METHOD})  //可以用到哪里
@Retention(RetentionPolicy.RUNTIME)   // 表示在什么地方有效
@interface MyAnntotation2{
    //注解的参数:参数类型+参数名();
    String name() default "";
    int age() default 0;
    int id() default -1; //如果默认值为-1,代表不存在
    String[] schools();
}
//一个参数的注解
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnntotation3{
    String value() ;
}

如果注解的参数只要有一个的时候,可以将参数名设为value,这样在写注解的时候,括号里可以省略value参数名,而别的参数名需要写上

@interface MyAnntotation3{
    String value() ;
}

总结

本篇文章就到这里了,希望能给你带来帮助,也希望您能够多多关注自学编程网的更多内容!

编程技巧