学习目标:
1 注解的原理与使用
2 JAVA提供的标准注解分析
3 spring与Junit的常用注解分析
4如何合理的设计和使用注解
注解的原理:是反射的一种,api会扫描指定的JAVA类,找到那些有指定annotation的类或者方法之类的,然后根据特定逻辑来处理。注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,来简化程序中的配置。
定义注解
使用元注解定义注解,元注解有四种:
@Target(ElementType.[type])
[type]={METHOD, FIELD, TYPE(类、接口、枚举声明), CONSTRUCTOR, LOCAL_VARIABLE, PARAMETER}
@Retention(RetentionPolicy.[policy])
[policy]={SOURCE, CLASS, RUNTIME(反射机制可读取)}
@Documented表示将此注解包含到Javadoc中
@Inherited 表示允许子类继承父类的注解
******************************************************************************************************
@Target:
@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
******************************************************************************************************
@Retention:
@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
******************************************************************************************************
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
******************************************************************************************************
@Inherited:
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
******************************************************************************************************
自定义注解:
使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
定义注解格式:
public @interface 注解名 {定义体}
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
Annotation类型里面的参数该怎么设定:
第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号
******************************************************************************************************
注解元素的默认值:
注解元素必须有确定的值,要么在定义注解的默认值中指定,要么在使用注解时指定,非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态,因为每个注解的声明中,所有元素都存在,并且都具有相应的值,为了绕开这个约束,我们只能定义一些特殊的值,例如空字符串或者负数,一次表示某个元素不存在,在定义注解时,这已经成为一个习惯用法。
******************************************************************************************************使用注解:JAVA开发中,最常接触的可能是@Override和@SupressWarning这两个注解了。使用@Override的时候只需要一个简单的声明即可。这种称为标记注解(mark annotation),它的出现就代表了某种配置语义。而其他的注解是可以有自己的配置参数的。配置参数以名值对的方式出现。使用@SupressWarnings的时候需要类似@SupressWarning({"uncheck","unused"})这样的语法。在括号里面的是该注解可供配置的值。由于这个注解只有一个配置参数,该参数的名称默认为value,并且可以省略。而花括号则表示是数组类型。在JPA中的@Table注解使用类似@Table(name="Customer",schema="APP")这样的语法。从这里可以看到名值对的用法。在使用注解时候的配置参数的值必须是编译时刻的常量。
从莫种角度来说,可以把注解看成是一个XML元素,该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行制定的。在代码中使用注解,就相当于把一部分元数据从XML文件移到了代码本身之中,在一个地方管理和维护。
Java提供的标准注解分析。
@Override
注解@Override的代码非常简单,可用于注解类的方法,并在Source级别可用。
@Deprecated
级别为Runtime
@SuppressWarnings
级别为source,经常的使用方式为@SuppressWarnings("unchecked")
使用注解主要是在需要使用spring框架的时候,特别是使用SpringMVC。因为这是我们会发现它的强大之处:预处理
注解实际上相当于一种标记,它允许你在运行时(源码,文档,类文件我们就不讨论了)动态地对拥有该标记的成员进行操作。
实现注解需要三个条件(我们讨论的是类似于Spring自动装配的高级应用):注解声明,使用注解元素,操作使用注解元素的代码。
开发注解
首先是注解声明,注解也是一种类型,注解的定义有点类似接口。
例子:
package 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 SayHiAnnotation {
String paramValue() default "johness";//表示我的注解需要一个参数 名为“paramValue”默认值为“johness”
}
在这里可以看到@Retention和@Target这样的元注解,用来声明注解本身的行为。@Retention用来声明注解的保留策略,有CLASS、RUNTIME和SOURCE这三种,分别表示注解保存在类文件、JVM运行时刻和源代码中。只有当声明为RUNTIME的时候,才能够在运行时刻通过反射API来获取到注解的信息。@Target用来声明注解可以被添加在哪些类型的元素上,如类型、方法和域等。
然后使用注解元素:
package element;
import annotation.SayHiAnnotation;
public class SayHiElement {
//普通方法
public void SayHiDefault(String name){
System.out.println("hi,"+name);
}
//使用注解并传入参数的方法
@SayHiAnnotation(paramValue="Jack")
public void SayHiAnnotation(String name){
System.out.println("hi,"+name);
}
//使用注解并使用默认参数的方法
@SayHiAnnotation
public void SayHiAnnotationDefault(String name){
System.out.println("hi,"+name);
}
}
最后,是我们的操作方法(值得一提的是虽然有一定的规范,但您大可不必去浪费精力,您只需要保证您的操作代码在您希望的时候执行即可):
package Main;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import annotation.SayHiAnnotation;
import element.SayHiElement;
public class AnnotionOperator {
public static void main(String[] args)throws IllegalAccessException,IllegalArgumentException, InvocationTargetException{
SayHiElement element=new SayHiElement();//初始化一个实例,用于方法调用
Method[] methods=SayHiElement.class.getDeclaredMethods();//获得所有方法
for(Method method:methods){
SayHiAnnotation annotationTmp=null;
if((annotationTmp=method.getAnnotation(SayHiAnnotation.class))!=null)//检测是否使用了我们的注解
method.invoke(element, annotationTmp.paramValue());//如果使用了我们的注解,我们就把主街里的“paramValue”参数值作为方法参数来调用方法
else
method.invoke(element,"Rose");//如果没有使用我们的注解,我们就需要使用普通的方式来调用方法了
}
}
}
结果:
可以看到,注解是进行与处理的很好方式(这里的预处理和编译原理有区别)
NEXT
Spring为自动装配要进行的操作,无外乎两种:继承org.springframework.web.context.support.SpringBeanAutowiringSupport类或者添加@Component/@Controller等注解并(只是使用注解方式需要)在Spring配置文件里声明context:component-scan元素。
NEXT
继承方式如何实现自动装配的,我们打开Spring 源代码查看SpringBeanAutoWiringSupport类。我们会发现一下语句:
public SpringBeanAutowiringSupport() {
2 processInjectionBasedOnCurrentContext(this);
3 }
众所周知,Java实力构造时会调用默认父类无参构造方法,Spring正是利用这一点,让“操作元素的代码”得以执行!
注解方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
参考文献:
http://www.cnblogs.com/Johness/archive/2013/04/17/3026689.html