Java 注解(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")

@SuppressWarnings("all") // 抑制错误信息
public class AnnotationTest extends Object {
    //  @Override 重回的注解
    @Override
    public String toString(){
        return super.toString();
    }

    //Deprecated 不推荐使用,但是可以使用,或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    public static void main(String[] args) {
        test();
    }
}

自定义注解:元注解

  • 元注解的作用就是负责注解其他注解,java定义四个标准的meta-annotation类型。
  • 这些类型和它们所支持的类在java.lang.annotation包中可以找到(@Target,@Retention,@Documented,@Inherited)

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

@Retention:表示需要在什么级别保存该注释信息,用于描述注释的生命周期( OURCE -> CLASS -> RUNTIME)

@Document:说明该注释将被包含在javadoc中

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

@MyAnnotation
public class MeatAnnotationTest {

    @MyAnnotation
    public void test(){
    }
}
// 表示是否将我们的注解生成在javaDoc中
@Documented
//Retention 表示我们的注解在什么地方才有效,runtime运行时有效  runtime》class》source
@Retention(value = RetentionPolicy.RUNTIME)
//描述注解使用范围
@Target(value = {ElementType.METHOD,ElementType.TYPE}) //METHOD方法上使用 ,TYPE 类上使用
//定义一个注解
//定义内部类
@interface MyAnnotation{

}

自定义注解

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

分析:

  • @interface 用来声明一个注解,格式:public @interface 注解名(定义内容)
  • 其中的每一个方法实际上声明了一个配置参数
  • 方法的名称就是参数的名称
  • 返回值类型就是参数的类型(返回值只能时基本类型,class,String, enum)
  • 可以通过default来声明参数的默认值
  • 如果只有一个参数成员,一般参数名为value
  • 注解元素必须要有值,我们定义注解元素时,经常使用空字符,0作为默认值
public class Test03 {
    //注解可以显示赋值,如果没有默认值,w我们必须给注释赋值
    @MyAnnotation2(name = "你好",schools = "湖北")
    public void test(){

    }

    //注解只有一个值“value”可以省略
    @MyAnnotation3("")
    public void test1(){

    }
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数: 参数类型 + 参数名()
    String name();
    //默认值为空的参数
    int age() default 0;
    //如果默认值为-1,代表不存在。
    int id() default -1;

    String[] schools() default {"湖北"};
}

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

最后修改:2022 年 07 月 04 日 09 : 50 PM
如果觉得我的文章对你有用,请随意赞赏