Java Annotation 注解

首先什么是注解?

最常见的是,在我们使用Eclipse等工具编写java代码的时候,有时候会出现一些比如@Deprecated,@Override,@SuppressWarnings等东东。这个就是常见的几种注解。

在开发Java程序,尤其是Java EE应用的时候,总是免不了与各种配置文件打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架构来说,Spring、Struts和Hibernate这 三个框架都有自己的XML格式的配置文件。这些配置文件需要与Java源代码保存同步,否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发 现。把同一份信息保存在两个地方,总是个坏的主意。理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。JDK 5中引入了源代码中的注解(annotation)这一机制。注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似 于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,用来简化程序 中的配置。

而我们最常见的可能就是上面提到的这三个注解了,简单的介绍一下上面的这三个注解的作用:

1、@Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。 

2、@Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上. 

3、@SuppressWarnings:这一个类型可以来暂时把一些警告信息消息关闭. 

在jdk自带的java.lang.annotation包里,打开如下几个源文件:

Target.java

Retention.java

RetentionPolicy.java

ElementType.java

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
   ElementType[] value();
}
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
   RetentionPolicy value();
}
public enum RetentionPolicy {
 SOURCE,
 CLASS,
 RUNTIME
}
public enum ElementType {
 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
 LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}

在设计annotations的时候必须把一个类型定义为@interface。我们需要注意的是:SOURCE,CLASS 和 RUNTIME.这三个级别。

SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。 

ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些 信息加载到虚拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS. 

RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的.

@Target里面的ElementType是用来指定Annotation类型可以用在哪一些元素上的.说明一下:TYPE(类型), FIELD(属性), METHOD(方法), PARAMETER(参数), CONSTRUCTOR(构造函数),LOCAL_VARIABLE(局部变量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(类型)是指可以用在Class,Interface,Enum和 Annotation类型上.

另外,@Target自己也用了自己来声明自己。如果一个Annotation类型没有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型.

举几个正确的例子:

@Target(ElementType.METHOD) 
@Target(value=ElementType.METHOD) 
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)

@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.

另外一点,如果需要把Annotation的数据继承给子类,那么就会用到@Inherited这一个Annotation类型.

本文只是简单的说了一下注解的常规用法,至于更加深入的注解学习,请参见文章末尾的参考资料。下面我们来看自定义一个注解:源代码有如下几个:

源码分别为:

package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * 类注解
 * */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyAnnotationClass {
    public String msg();
}
package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
/**
 * 方法注解
 * */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotationMethod {
    public String common();
}
package com.java.annotation;
 
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface MyAnnotationField {
    boolean request();
}
package com.java.annotation;
 
@MyAnnotationClass(msg = "这个是一个类注解")
public class MyAnnotationDemo {
 
    public MyAnnotationDemo() {
    }
 
    public MyAnnotationDemo(String hello) {
        this.hello = hello;
    }
 
    @MyAnnotationMethod(common = "这个是一个方法注解")
    public void method() {
        System.out.println(hello);
    }
 
    @MyAnnotationField(request = true)
    private String hello;
}
package com.java.annotation;
 
import java.lang.reflect.Field;
import java.lang.reflect.Method;
 
public class MyAnnotationTest {
    public static void main(String[] args) {
        MyAnnotationDemo demo = new MyAnnotationDemo("hello rollen");
        MyAnnotationClass annotationClass = demo.getClass().getAnnotation(MyAnnotationClass.class);
        System.out.println(annotationClass.msg());
 
        Method method = null;
        try {
            method = demo.getClass().getMethod("method",new Class[0]);
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        }
        MyAnnotationMethod annotationMethod = method.getAnnotation(MyAnnotationMethod.class);
        System.out.println(annotationMethod.common());
         
        Field field = null;
        try {
            field = demo.getClass().getDeclaredField("hello");
        } catch (SecurityException e) {
            e.printStackTrace();
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
        }
        MyAnnotationField annotationField = field.getAnnotation(MyAnnotationField.class);
        System.out.println(annotationField.request());
 
    }
}

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏jianhuicode

Android注解学习(1)

对于注解这个概念刚开始不是很理解,翻阅了其他人博客,参考实现的例子开始理解与运用。以前刚开始的写android项目时,一般找定义控件并初始化控件都是调用find...

17510
来自专栏nnngu

Java监听器Listener的使用详解

监听器用于监听Web应用中某些对象的创建、销毁、增加,修改,删除等动作的发生,然后作出相应的响应处理。当监听范围的对象的状态发生变化的时候,服务器自动调用监听器...

36811
来自专栏Linyb极客之路

Java高级特性——注解,这也许是最简单易懂的文章了

博主在初学注解的时候看到网上的介绍大部分都是直接介绍用法或者功能,没有实际的应用场景,篇幅又很长导致学习的时候难以理解其意图,而且学完就忘QAQ。本篇文章中我将...

542
来自专栏小灰灰

动手实现MVC: 2. bean加载, IoC依赖注入

背景 前面实现了java包的扫描,扫描之后自然就到了bean的加载,以及spring mvc的一大特性 IoC依赖注入的实现; 这里则将在之前的基础上,实现be...

1707
来自专栏程序员的SOD蜜

使用XSD编写具有智能提示的XML文件(以SQL-MAP脚本为实例)

    SQL-MAP是PDF.NET(PWMIS数据开发框架)具有特色的开发技术,它可以将SQL语句映射成DAL代码,而且能够做到无需IDAL和DalFact...

2698
来自专栏Java后端技术

基于Spring的可扩展Schema进行开发自定义配置标签支持

  最近和朋友一起想开发一个类似alibaba dubbo的功能的工具,其中就用到了基于Spring的可扩展Schema进行开发自定义配置标签支持,通过上网查资...

703
来自专栏技术与生活

Annotation 使用案例

Java 的 annotation 自 JDK1.5就拥有了,主要作用就是给代码打标注,这个系列文章将从头到尾进行一个梳理,当然不仅仅是 Annotation,...

571
来自专栏有趣的Python和你

Python数据分析之pandas数据可视化折线图条形图pandas绘图乱码解决

1154
来自专栏编程微刊

前端切图:用正则替换手机号码

1432
来自专栏xingoo, 一个梦想做发明家的程序员

Web监听器导图详解

  监听器是JAVA Web开发中很重要的内容,其中涉及到的知识,可以参考下面导图: ? Web监听器   1 什么是web监听器?   web监听器是一种Se...

1709

扫码关注云+社区