java Annotation 注解

简介:

首先什么是注解?

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


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

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

    @Override:只能用在方法之上的,用来告诉别人这一个方法是改写父类的。 
    @Deprecated:建议别人不要使用旧的API的时候用的,编译的时候会用产生警告信息,可以设定在程序里的所有的元素上. 
        @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使用在哪些元素上,那么它可以使用在任何元素之上,这里的元素指的是上面的八种类型. 
   举几个正确的例子:

1
2
3
@Target (ElementType.METHOD)
    @Target (value=ElementType.METHOD)
    @Target (ElementType.METHOD,ElementType.CONSTRUCTOR)

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

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

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

源码分别为:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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();
}

  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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();
}

  

1
2
3
4
5
6
7
8
9
10
11
12
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();
}

  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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;
}

  

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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());
 
     }
}

  

参考资料:http://www.infoq.com/cn/articles/cf-java-annotation

              http://tiantian0521.blog.163.com/blog/static/4172088320118243436208/

    

目录
相关文章
|
8天前
|
XML Java 编译器
Java学习十六—掌握注解:让编程更简单
Java 注解(Annotation)是一种特殊的语法结构,可以在代码中嵌入元数据。它们不直接影响代码的运行,但可以通过工具和框架提供额外的信息,帮助在编译、部署或运行时进行处理。
77 43
Java学习十六—掌握注解:让编程更简单
|
3天前
|
Java 开发者 Spring
[Java]自定义注解
本文介绍了Java中的四个元注解(@Target、@Retention、@Documented、@Inherited)及其使用方法,并详细讲解了自定义注解的定义和使用细节。文章还提到了Spring框架中的@AliasFor注解,通过示例帮助读者更好地理解和应用这些注解。文中强调了注解的生命周期、继承性和文档化特性,适合初学者和进阶开发者参考。
28 14
|
3天前
|
前端开发 Java
[Java]讲解@CallerSensitive注解
本文介绍了 `@CallerSensitive` 注解及其作用,通过 `Reflection.getCallerClass()` 方法返回调用方的 Class 对象。文章还详细解释了如何通过配置 VM Options 使自定义类被启动类加载器加载,以识别该注解。涉及的 VM Options 包括 `-Xbootclasspath`、`-Xbootclasspath/a` 和 `-Xbootclasspath/p`。最后,推荐了几篇关于 ClassLoader 的详细文章,供读者进一步学习。
21 12
|
27天前
|
JSON Java 数据库
java 常用注解大全、注解笔记
关于Java常用注解的大全和笔记,涵盖了实体类、JSON处理、HTTP请求映射等多个方面的注解使用。
33 0
java 常用注解大全、注解笔记
|
2月前
|
Arthas Java 测试技术
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
Java字节码文件、组成、详解、分析;常用工具,jclasslib插件、阿里arthas工具;如何定位线上问题;Java注解
Java字节码文件、组成,jclasslib插件、阿里arthas工具,Java注解
|
15天前
|
IDE Java 编译器
java的反射与注解
java的反射与注解
12 0
|
2月前
|
Java 编译器 程序员
Java注解,元注解,自定义注解的使用
本文讲解了Java中注解的概念和作用,包括基本注解的用法(@Override, @Deprecated, @SuppressWarnings, @SafeVarargs, @FunctionalInterface),Java提供的元注解(@Retention, @Target, @Documented, @Inherited),以及如何自定义注解并通过反射获取注解信息。
Java注解,元注解,自定义注解的使用
|
23天前
|
XML Java 数据格式
Java-spring注解的作用
Java-spring注解的作用
18 0
|
2月前
|
Java 数据库连接 数据格式
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
IOC/DI配置管理DruidDataSource和properties、核心容器的创建、获取bean的方式、spring注解开发、注解开发管理第三方bean、Spring整合Mybatis和Junit
【Java笔记+踩坑】Spring基础2——IOC,DI注解开发、整合Mybatis,Junit
|
2月前
|
Java 编译器 测试技术