Java注解Annotation解析

概述

Java在1.5版本引入注解Annotation,又称Java标注,注解是一种语法元数据,可以被直接使用到源代码中,类/方法/变量/参数/包名等都可以被注解。和Javadoc标签不同,编译器在生成class文件时候能够保留注解代码,同时,可能为了在程序运行过程中(run-time)可以使用注解,Java虚拟机会把注解保留,这样就可以通过反射获取注解Annotation的相关信息。

内置注解

其实我们平时会经常遇见注解,例如@Override、@Deprecated等等,这些都是JDK中内置的注解,先来看看Java内置的注解主要有哪些。
 •作用于Java代码的注解
◦@Override 检查某个方法是否是复写的方法,如果这个方法在父类或者实现的接口中未找到,编译会出错。
 ◦@Deprecated 标记某个方法或者类被废弃,如果使用该类或者方法,编译过程会报警告
 ◦@SuppressWarnings 通知编译器忽略关于被标注的参数的警告
 ◦@SafeVarargs 忽略关于调用含有泛型参数的方法或者构造器的警告,1.7新增注解
 ◦@FunctionalInterface 表明某一个声明的接口将被用作功能性接口,1.8新增注解

•作于其他注解的注解,被称为元注解(Meta Annotation)
◦@Retention 指明被标注的注解在什么时候使用(也就是注解什么时候会被保留)
■仅仅在源代码中保留,在编译过程中丢弃(RetentionPolicy.RUNTIME)
 ■注解在编译过程中保存到class文件,在class文件被加载时候忽略(RetentionPolicy.CLASS)
 ■注解在class文件加载时候被读取,也就是运行中注解可用,可以通过反射获取注解信息(RetentionPolicy.RUNTIME)

◦@Documented 指明在生成Javadoc时候,被标注的注解将被写入Javadoc文档中
 ◦@Target 指明被标注的注解的作用范围
■ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明
 ■ElementType.FIELD:用于描述域
 ■ElementType.METHOD:用于描述方法
 ■ElementType.PARAMETER:用于描述参数
 ■ElementType.CONSTRUCTOR:用于描述构造器
 ■ElementType.LOCAL_VARIABLE:用于描述局部变量
 ■ElementType.ANNOTATION_TYPE:用于描述注解
 ■ElementType.PACKAGE:用于描述包

◦@Inherited 指明被标注的注解是被继承的,也就是说如果一个@Inherited修饰的annotation类型被用于一个类,则这个annotation也会作用于改类的子类。
 ◦@Repeatable 指明被标注的注解可以多次作用于同一个对象,1.9新增注解

 自定义注解

上面说了那么多注解,大家集中关注元注解,我们自定义注解时候,通常会使用元注解来协助我们。自定义注解格式为public @interface 注解名 {定义体},使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口。自定义注解时,不能继承其他的注解或接口。注解中声明的方法实际上是声明了一个注解参数,方法的名称就是参数的名称,返回值类型就是参数的类型,可以通过default来声明参数的默认值。

自定义注解很简单,使用@interface来定义一个注解,如下。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
public @interface ClassInfo {
 String author() default "Wang";
 String date();
 String comments();
}

自定义了一个名为ClassInfo的注解,根据@Retention可以得知这个注解会一直存在,也就是在程序运行中时候,这个注解还是有效的;@Target(ElementType.TYPE)说明ClassInfo注解的是作用于类、接口或enum声明的;@Documented
说明ClassInfo信息可以被写入Javadoc文档中。

再来看一下自定义注解中的一些注解参数,里面有三个注解参数,注解参数是可以设置默认值,例如author注解参数,默认值为Wang,其他两个参数就没有默认值。

再来看另一个自定义的注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodInfo {
 String description() default "No Description";
 String date();
}

这个自定义的注解MethodInfo是作用于方法的,在程序运行中时候,这个注解也会存在;里面有两个注解参数。

注解参数的定义(方法的定义),只能用public或者default两个访问权限修饰符,参数的类型支持以下几种。
 •八种基本数据类型(byte,int,short,long,float,double,char,boolean)
 •String类型
 •Class类型
 •enum类型
 •Annotation类型
 •以上所有类型的数组

注解的使用

除了上面两个注解,又添加了一个Field作用域的注解。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface FieldInfo {
 String type();
 String name();
}

自定义的注解中的注解参数如果没有声明默认值,在使用自定义注解时候,必须给这些参数赋值,否则编译器会报错。

看一下注解使用的代码:

@ClassInfo(author = "wang",
  date = "2016/9/13",
  comments = "annotation demo")
public class AnnotationDemo {

 @FieldInfo(type = "public", name = "firstField")
 public int firstField;

 @FieldInfo(type = "private", name = "secondField")
 private String secondField;

 @MethodInfo(description = "method in AnnotationDemo", name = "firstMethod")
 public void firstMethod(String value) {
  System.out.printf("first method involved");
 }

 @MethodInfo(description = "method in AnnotationDemo", name="secondMethod")
 private void secondMethod() {
  System.out.printf("first method involved");
 }
}

获取注解信息

要获取注解信息,首先得保证注解在程序运行时候会存在,所以一般会给自定义的注解添加了@Retention(RetentionPolicy.RUNTIME)元注解,这样在程序运行过程中,我们可以通过反射去获取一些注解信息,关于反射的说明,可以查看这篇文章。

public class AnnotationTest {
 public static void main(String[] args) {
  resolveClassAnnotationInfo(AnnotationDemo.class);
  resolveFieldAnnotationInfo(AnnotationDemo.class);
  resolveMethodAnnotationInfo(AnnotationDemo.class);
 }

 private static void resolveClassAnnotationInfo(Class<?> clz) {
  // 判断该类是否有ClassInfo注解
  if(clz.isAnnotationPresent(ClassInfo.class)) {
   ClassInfo classInfo = (ClassInfo) clz.getAnnotation(ClassInfo.class);
   System.out.println(classInfo.author() + " " + classInfo.comments() + " " + classInfo.date());
  }
 }

 private static void resolveFieldAnnotationInfo(Class<?> clz) {
  Field[] fields = clz.getDeclaredFields();
  for (Field field : fields) {
   if(field.isAnnotationPresent(FieldInfo.class)) {
    FieldInfo fieldInfo = (FieldInfo) field.getAnnotation(FieldInfo.class);
    System.out.println(fieldInfo.type() + " " + fieldInfo.name());
   }
  }
 }

 private static void resolveMethodAnnotationInfo(Class<?> clz) {
  Method[] methods = clz.getDeclaredMethods();
  for (Method method : methods) {
   if(method.isAnnotationPresent(MethodInfo.class)) {
    MethodInfo methodInfo = (MethodInfo) method.getAnnotation(MethodInfo.class);
    System.out.println(methodInfo.name() + " " + methodInfo.description());
   }
  }
 }
}

通过反射获取类中的Field/Method等等,通过getAnnotation()或者getAnnotations()获取相关注解,拿到具体注解就可以获取具体的信息了。

运行结果输出如下:

图-1 运行结果图

总结

对于Java的初学者甚至是有一定经验的Java开发人员,对Java注解的接触可能比较少,而在实际中,也很少用到注解,但是会经常会在代码里面看见,这篇文章算是对注解的浅显介绍,最起码在代码层面是阅读无压力的。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。

时间: 2016-09-13

基于Java 注解(Annotation)的基本概念详解

什么是注解(Annotation): Annotation(注解)就是Java提供了一种元程序中的元素关联任何信息和着任何元数据(metadata)的途径和方法.Annotion(注解)是一个接口,程序可以通过反射来获取指定程序元素的Annotion对象,然后通过Annotion对象来获取注解里面的元数据. Annotation(注解)是JDK5.0及以后版本引入的.它可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查.从某些方面看,annotation就像修饰符一样被使用,并应用于包

JavaWeb Spring注解Annotation深入学习

一.注解 注解Annotation,是一种类似注释的机制,在代码中添加注解可以在之后某时间使用这些信息.跟注释不同的是,注释是给我们看的,java虚拟机不会编译,注解也是不编译的,但是我们可以通过反射机制去读取注解中的信息.注解使用关键字@interface,继承java.lang.annotition.Annotition 1.javaSE中的注解 先举个例子来回顾一下在javaSE中注解是什么东东,关键是两点,注解的定义与如何通过反射得到注解上面的信息. 1.先定义两个注解一个是在类上有注解

详解Java编程中Annotation注解对象的使用方法

注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据.   1.基本语法 Java SE5内置三种标准注解 @Override:表示当前的方法定义将覆盖超类中的方法.如果你不小心拼写错误,或者方法签名对不上被覆 盖的方法,编译器就会发出错误提示 @Deprecated:如果程序员使用了注解为它的元素,那么编译器就会发出警告信息 @SupperessWarnings:关闭不当的编译器警告信息. Java SE5内置四种元注解 @Targ

基于Java注解(Annotation)的自定义注解入门介绍

要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法. -------------------------------------------------------------------------------- 元注解: 元注解的作用就是负责注解其他注解.Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明.Java5.0定义的元注解:

深入理解Java注解类型(@Annotation)

Java注解是在JDK5时引入的新特性,鉴于目前大部分框架(如spring)都使用了注解简化代码并提高编码的效率,因此掌握并深入理解注解对于一个Java工程师是来说是很有必要的事.本篇我们将通过以下几个角度来分析注解的相关知识点 理解Java注解 实际上Java注解与普通修饰符(public.static.void等)的使用方式并没有多大区别,下面的例子是常见的注解: public class AnnotationDemo { //@Test注解修饰方法A @Test public static

Java Annotation详解及实例代码

一.Annotation简介 从Java1.5开始,Java增加了元数据(MetaData)的支持,也就是Annotation(注释): Annotation能被用来为程序元素(类.方法.成员变量等)设置元数据: Annotation不能影响程序代码的执行,无论添加.删除Annotation,代码始终如一的执行: 如果希望让程序中的Annotataion能在 运行时其一定作用,只有通过某种配套的工具对Annotation中的信息进行访问和处理,这些工具统称APT(Annotion Process

java教程之java注解annotation使用方法

1.概述 注解可以定义到方法上,类上,一个注解相当与一个类,就相当于实例了一个对象,加上了注解,就相当于加了一个标志. 常用的注解:@Override:表示重新父类的方法,这个也可以判断是否覆盖的父类方法,在方法前面加上此语句,如果提示的错误,那么你不是覆盖的父类的方法,要是提示的没有错误,那么就是覆盖的父类的方法.@SuppressWarnings("deprecation"):取消编译器的警告(例如你使用的方法过时了)@Deprecated:在方法的最上边也上此语句,表示此方法过时

Java Annotation(Java 注解)的实现代码

如果你想知道java annotation是什么?你可以先看看:"http://www.infoq.com/articles/Annotation-Hammer" 下面是我做的一个demo: 项目结构: 运行效果: ==================================================== 代码部分: 注:很多人会考虑这个问题,"这样做的目的是什么?我们可以做一个配置文件(xml,properties等),不是比这个跟方便...或者说 直接把我们

Java annotation元注解原理实例解析

元注解是指注解的注解.包括 @Retention @Target @Document @Inherited四种. 1. Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口. 2. 参数成员只能用public或默认(default)这两个访问权修饰 3. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型

Java Annotation注解相关原理代码总结

Java.lang 中自带的注解 @Override:表示当前的方法定义将覆盖基类的方法.如果你不小心拼写错误,或者方法签名被错误拼写的时候,编译器就会发出错误提示. @Deprecated:如果使用该注解的元素被调用,编译器就会发出警告信息. @SuppressWarnings:关闭不当的编译器警告信息. @SafeVarargs:在 Java 7 中加入用于禁止对具有泛型varargs参数的方法或构造函数的调用方发出警告. @FunctionalInterface:Java 8 中加入用于表

Java 中的注解详解及示例代码

在Java中,注解(Annotation)引入始于Java5,用来描述Java代码的元信息,通常情况下注解不会直接影响代码的执行,尽管有些注解可以用来做到影响代码执行. 注解可以做什么 Java中的注解通常扮演以下角色 编译器指令 构建时指令 运行时指令 其中 Java内置了三种编译器指令,本文后面部分会重点介绍 Java注解可以应用在构建时,即当你构建你的项目时.构建过程包括生成源码,编译源码,生成xml文件,打包编译的源码和文件到JAR包等.软件的构建通常使用诸如Apache Ant和Mav

Java Annotation Overview详解

JAVA注解概述: 1. 注解是给编译器看的,这不同于注释 2. 三个基本的注解: @Override  告诉编译器这是在覆写方法@Deprecated 告诉编译器该方法过时了@SuppressWarnings("unchecked")  不要警告= (value={"unchecked"})3. 注解可以用来替代传统的配置文件4. JDK5 开始,Java增加了对元数据(MetaData)的支持,即Annotation. 自定义注解和反射注解 自定义注解:1. 新

详解spring 配置的两种方式:JAVA配置和注解配置

众所周知,spring自从3.0开始以后,就全面推荐使用配置的方式进行代码编写了,这种方式确实可以避免了之前一个项目里面一大堆XML的情况,毕竟XML的可读性实在不怎么样,而且一会写JAVA,一会写XML,确实还是蛮麻烦的 就目前来说spring的配置方式一般为两种:JAVA配置和注解配置.那么什么的是注解配置呢?什么是JAVA配置呢? //注解配置: @Service @Component @Repository @Controlle //JAVA配置 @Confirguration 相当于s

java 中@Deprecated 注解的实例详解

java 中@Deprecated 注解的实例详解 1 简介 Deprecated 同 SuppressWarnings 一样,都是 J2SE 5.0 中定义在Java.lang包中的标准 Annotation 之一,其可以标注在类.字段和方法上,其作用为:不鼓励程序员使用被 @Deprecated 注释的程序元素,因为被 @Deprecated 注释的元素很危险(例如,现阶段 JDK 提供的带有 @Deprecated 注释的元素在以后的 JDK 版本中可能被删除)或存在更好的选择.在使用不被

全面解析Java中的注解与注释

注解 一.什么是 Annotation? (注解 or 注释) Annotation, 准确的翻译应该是 -- 注解. 和注释的作用完全不一样. Annotation 是JDK5.0及以后版本引入的一个特性. 与类.接口.枚举是在同一个层次,可以成为java 的一个类型. 语法是以@ 开头 简单来说, 注释是程序员对源代码的类,方法,属性等做的一些记忆或提示性描述(比如这个方法是做什么用的),是给人来看的. 注解则是Java 编译器可以理解的部分,是给编译器看的. 举个简单的例子来看一下注解的使

Java利用自定义注解、反射实现简单BaseDao实例

在常见的ORM框架中,大都提供了使用注解方式来实现entity与数据库的映射,这里简单地使用自定义注解与反射来生成可执行的sql语句. 这是整体的目录结构,本来是为复习注解建立的项目^.^ 好的,首先我们来确定思路. 1. 自定义@Table @Column注解, 我们稍微模仿hibernate,让@Table作用于类上,来表明实体类与数据表的映射关系,且让@Table中的属性value映射为数据表的名称tableName:让@Column作用于属性上(这里没实现作用于set方法上),表明属性与