欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Java 注解

程序员文章站 2024-01-26 22:28:10
一、概念和基本注解 从JDK1.5开始,引入了源代码中的注解这一机制。注解使得 Java 源代码中不但可以包含功能性的实现代码,还可以包含元数据。 那么什么是元数据呢?所谓元数据,就是描述数据的数据。比如说一张图片,图片内容是它的主体数据,那么像图片的创建时间、修改时间、创建者等等这些数据,就是这张 ......

一、概念和基本注解

    从jdk1.5开始,引入了源代码中的注解这一机制。注解使得 java 源代码中不但可以包含功能性的实现代码,还可以包含元数据。

    那么什么是元数据呢?所谓元数据,就是描述数据的数据。比如说一张图片,图片内容是它的主体数据,那么像图片的创建时间、修改时间、创建者等等这些数据,就是这张图片的元数据。

    那么元数据有什么用呢?我们可以用元数据来创建文档、跟踪代码的依赖性和执行编译时的格式检查,并可以代替系统中原有的配置文件。

    java 注解是 java 代码里的特殊标记,为我们在代码中添加用 java 程序无法表达的额外信息提供了一种格式化方法,使我们可以在编译、类加载、运行时使用这些被注解修饰的程序元素(这些程序元素包括:类、属性、方法等)。

    使用注解时要在其前面加上一个 “@” 符号,表明后面的内容为注解。

    在 java 的 java.lang 包中,预定义了三个注解,它们分别是限定重写父类方法的@override、标记已过时的@deprecated和抑制编译器警告的@suppresswarnings,通常称这三个注解为内建注解或基本注解。

    @override 在我们编程过程中经常遇到,就不细讲了;@deprecated 表示该类成员已经过时,在未来的版本中可能会被删除,不建议使用。@suppresswarnings 和前两个注解有些不同,这个注解带有一个属性,表示要抑制什么样的警告信息,相关属性值的含义如下:

@suppresswarnings(value = "deprecation") //使用了过时的程序元素
@suppresswarnings(value = "unchecked") //执行了未检查的转换
@suppresswarnings(value = "unused") //有程序元素未被使用
@suppresswarnings(value = "fallthrough") //switch 程序块直接通往下一种情况,而没有break
@suppresswarnings(value = "path") //在类路径中有不存在的路径
@suppresswarnings(value = "serial") //在可序列化的类上缺少 serialversionuid 定义
@suppresswarnings(value = "finally") //任何 finally 子句不能正常完成
@suppresswarnings(value = "all") //所有情况

二、自定义注解

    注解之所以强大,能被众多框架所使用的主要原因在于,它可以允许程序员自定义注解,使 java 程序变成自描述的。注解的语法形式和接口差不多,只不过在 interface 前面多了一个 @ 符号。

    我们可以在自定义注解时定义属性,在注解类型的定义中以无参方法的形式来声明,其方法名和返回值分别定义了该属性的名字和类型。另外需要注意的是,使用带属性的注解时,需要给属性赋值,不过可以在定义注解时,给属性赋默认值。

    java中注解成员的类型必须是如下几类: 

1. 基本数据类型(boolean, byte, char, short, int, long, float, double);
2. string;
3. class;
4. 枚举;
5. 其他的注解;
6. 以上类型的数组;

public @interface myannotation {
      string name() default "张三";
      int age() default 22;
}

三、元注解

    上面提到了元数据——描述数据的数据。还有一个元注解的概念,即描述注解的注解——使用不同注解对注解进行注解。java 为注解单独提供了四种元注解,即@target、@retention、@documented和@inherited。下面将分别介绍这四种元注解。

    1、@target

    使用 @target 注解的目的是用于指定被修饰的注解能用于修饰哪些程序元素。如果注解定义中不存在 @target 元注解,则此注解可以用于任意程序元素上,如果存在这样的元注解,则编译器强制实施指定的使用规则。

/**
 * elementtype.annotation_type : 限制此注解用于注解类
 * elementtype.constructor : 限制此注解用于构造方法
 * elementtype.field : 限制此注解用于字段属性(包括枚举变量)
 * elementtype.local_variable : 限制此注解用于局部变量声明
 * elementtype.method : 限制此注解用于方法声明
 * elementtype.package : 限制此注解用于包声明
 * elementtype.parameter : 限制此注解用于参数声明
 * elementtype.type : 限制此注解用于类、接口(包括注解类型)或枚举声明
 */
@target({elementtype.annotation_type, elementtype.constructor, elementtype.field, elementtype.local_variable,
        elementtype.method, elementtype.package, elementtype.parameter, elementtype.type})
public @interface myannotation {

}

    2、@retention

    @retention 用于指定被修饰的注解的生命周期,生命周期分为三种,分别是 retentionpolicy.class、retentionpolicy.runtime 和 retentionpolicy.source。如果注解定义中不存在 @retention 元注解,则生命周期默认为 retentionpolicy.class。

/**
 * retentionpolicy.class : 编译器将把注解记录在 class 文件中,当运行 java 程序时,虚拟机不再保留注解。
 * retentionpolicy.runtime : 编译器将把注解记录在 class 文件中,当运行 java 程序时,虚拟机保留注解,程序可以通过反射获得该注解。
 * retentionpolicy.source : 编译器将直接丢弃被修饰的注解
 */
@retention(retentionpolicy.runtime)
public @interface myannotation {
      string name() default "张三";
      int age() default 22;
}
Java 注解
public class testmyannotation {

    public static void main(string[] args) throws nosuchmethodexception, classnotfoundexception {
        testmyannotation testmyannotation = new testmyannotation();
        testmyannotation.getobjectinfo();
    }

    @myannotation
    @deprecated
    public void getobjectinfo() throws classnotfoundexception, nosuchmethodexception {
        annotation[] annotations = class.forname("annotation.testmyannotation").getmethod("getobjectinfo").getannotations();
        for (annotation annotation : annotations) {
            system.out.println("该注解是" + annotation);
            if (annotation instanceof myannotation) {
                myannotation myannotation = (myannotation) annotation;
                system.out.println(myannotation.name());
                system.out.println(myannotation.age());
            }
        }
    }
    
}
testmyannotation.java

    3、@documented

    在默认的情况下,使用 javadoc 工具自动生成文档时,注解将被忽略掉。如果想在文档中也包含注解,必须使用 @documented 注解。

@documented
public @interface myannotation {
}

    4、@inherited

    默认情况下,父类的注解不被子类继承,如果要想继承父类注解,就必须使用  @inherited 注解。

@inherited
public @interface myannotation {
}

四、总结

    其实,java 注解可以简单理解成一种标记符号、描述信息。强大的并不是注解本身,而是对注解的灵活使用。以 spring 常见的  @component 注解为例。spring 在启动时,上下文利用反射找到包路径下带有 @component 的类,然后把它装载成 spring 的 bean。