Java的注解机制-Spring自动装配的实现原理

Java的注解机制——Sprinjg动装配的实现原理阿何的程序人生J加入了对注解机制的支持，实际上我学习Java的时候就已经使用J了，而且除了vrri和Spprarn后者还是给生成的之外没接触过其他的。进入公司前的面试，技术人员就问了我关于注解的问题，我就说可以生成手册现在想起来真囧，注释和注解被我搞得完全一样了。使用注解主要是在需要使用Spring匡架的时候，特别是使用Spring。因为这时我们会发现它的强大之处：预处理。注解实际上相当于一种标记，它允许你在运行时源码、文档、类文件我们就不讨论了动态地对拥有该标记的成员进行操作。实现注解需要三个条件我们讨论的是类似于Spring^动装配的高级应用：注解声明、使用注解的元素、操作使用注解元素的代码。首先是注解声明，注解也是一种类型，我们要定义的话也需要编写代码，如下：packageannotation;imprtjava.langannotation.ElementTimportjava.lang.annotation.Retentionimportjava.langannotation.Retentionimportjava.lang.annotation.Target;自定义注解，用来配置方法*@authorJohness@Retention(Retnin表示注i解在运行时依然存在argn表示注解可以被使用于方法上piinraSainnainSringparaa表示我的注解需要一个参数名为paraa默认值为n然后是使用我们注解的元素：paagnprannainSainnain要使用Sainn的元素所在类由于我们定义了只有方法才能使用我们的注解，我们就使用多个方法来进行测试pilassSayHiEmlement{普通的方/法/publicvoSysidSayHiDefault(Stringnamt.println("Hi,"+na使用注解并传入参数的方法ionn("nana@SayHiAnnotation(paramVapublicvoidSayHiAnnotaionn("nanaSystem.out.print使用注解/并/使用默认参数的方法@SayHiAnnotationpublicvoidSayHiAnnotationDefault(StringnaSystem.out.println("Hi,"+name：;最后，是我们的操作方法值得一提的是虽然有一定的规范，但您大可不必去浪费精力，您只需要保证您的操作代码在您希望的时候执行即可：：packageMain;23importjava.lang.reflect.InvocationTargetException;4importjava.lang.reflect.Method;56importelement.SayHiEmlement;7importannotation.SayHiAnnotation;8publicclassAnnotionOperator{publicstaticvoidmain(String[]args)throwsIllegalAccessException,IllegalArgumentException,InvocationTargetException,ClassNotFoundException{SayHiEmlementelement=newSayHiEmlement();//初始化一个实例，用于方法调用Method]]methods=SayHiEmlement.class.getDeclaredMethods();//获得所有方法13for(Methodmethod:methods){SayHiAnnotationannotationTmp=null;if((annotationTmp=method.getAnnotation(SayHiAnnotation.class))!=null)//检测是否使用了我们的注解method.invoke(element,annotationTmp.paramValue());//如果使用了我们的注解，我们就把注解里的"paramValue"参数值作为方法参数来调用方法elsemethod.invoke(element,"Rose");//如果没有使用我们的注解，我们就需要使用普通的方式来调用方法了}}}结果为：Hi,JackHi,johnessHi,Rose可以看到，注解是进行预处理的很好方式(这里的预处理和编译原理有区别)!接下来我们看看Spring是如何使用注解机制完成自动装配的:首先是为了让Spring为我们自动装配要进行的操作，无外乎两种：继承org.springframework.web.context.support.SpringBeanAutowiringSupport类或者添加@Component/@Controller等注解并(只是使用注解方式需要)在Spring配置文件里声明context:component-scan元素。我说说继承方式是如何实现自动装配的，我们打开Spring源代码查看SpringBeanAutowiringSupport类。我们会发现以下语句：publicSpringBeanAutowiringSupport(){processInjectionBasedOnCurrentContext(this);}众所周知，Java实例构造时会调用默认父类无参构造方法，Spring正是利用了这一点，让"操作元素的代码"得以执行！(我看到第一眼就震惊了！真是奇思妙想啊。果然，咼手都要善于用Java来用Java)后面的我就不就不多说了，不过还是要纠正一些人的观点：说使用注解的自动装配来完成注入也需better。这明显是错误的嘛！我们看Spring注解装配(继承方式)的方法调用顺序：org.springframework.web.context.support.SpringBeanAutowiringSupport#SpringBeanAutowiringSupport=>org.springframework.web.context.support.SpringBeanAutowiringSupport#processInjectionBasedOnCurrentContext=>org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor#processInjection=>org.springframework・beans.factory.annotation.lnjectionMetadata#Injectioi继承，方法重写)。最后看看Injection方法的方法体：1/***Eitherthisor{@link#getResourceToInject}needstobeoverridden.*/protectedvoidinject(Objecttarget,StringrequestingBeanName,PropertyValuespvs)throwsThrowable{if(this.isField){Fieldfield=(Field)this.member;ReflectionUtils.makeAccessible(field);field.set(target,getResourceToInject(target,requestingBeanName));}else{if(checkPropertySkipping(pvs)){return;}try{Methodmethod=(Method)this.member;ReflectionUtils.makeAccessible(method);method.invoke(target,getResourceToInject(target,requestingBeanName));}catch(InvocationTargetExceptionex){throwex.getTargetException();}}}虽然不完全，但可以基本判定此种自动装配是使用了ava放射机制。分类：2011-05-0615:267573人阅读(11)本文将向你介绍J2SE5.0中的新特性之一：注解。本文将从什么是注解；J2SE5.0中预定义的注解；如何自定义注解；如何对注解进行注解以及如何在程序中读取注解5个方面进行讨论。―、什么是注解说起注解，得先提一提什么是元数据(metadata)。所谓元数据就是数据的数据。也就是说，元数据是描述数据的。就象数据表中的字段一样，每个字段描述了这个字段下的数据的含义。而J2SE5.0中提供的注解就是java源代码的元数据，也就是说注解是描述ava源代码的。在J2SE5.0中可以自定义注解。使用时在@后面跟注解的名字。二、J2SE5.0中预定义的注解在J2SE5.0的java.lang包中预定义了三个注解。它们是Override、Deprecated和SuppressWarnings。下面分别解解它们的含义。Override这个注解的作用是标识某一个方法是否覆盖了它的父类的方法。那么为什么要标识呢？让我们来看看如果不用Override标识会发生什么事情。假设有两个类Class1和ParentClass1，用Class1中的myMethod1方法覆盖ParentClass1中的myMethod1方法。classParentClass1{publicvoidmyMethod1(){}}classClass1extendsParentClass1{publicvoidmyMethod2(){}}建立Class1的实例，并且调用myMethod1方法ParentClass1c1=newClass1();c1.myMethod1();以上的代码可以正常编译通过和运行。但是在写Class1的代码时，误将myMethod1写成了myMethod2,然而在调用时，myMethod1并未被覆盖。因此，c1.myMethod1()调用的还是ParentClassl的myMethodl方法。更不幸的是，程序员并未意识到这一点。因此，这可能会产生bug。如果我们使用Override来修饰Class1中的myMethod1方法，当myMethod1被误写成别的方法时，编译器就会报错。因此，就可以避免这类错误。classClass1extendsParentClass1{@Override/编译器产生一个错误publicvoidmyMethod2(){}}以上代码编译不能通过，被Override注解的方法必须在父类中存在同样的方法程序才能编译通过。也就是说只有下面的代码才能正确编译。classClass1extendsParentClass1{@OverridepublicvoidmyMethod1(){}}Deprecated这个注解是一个标记注解。所谓标记注解，就是在源程序中加入这个标记后，并不影响程序的编译，但有时编译器会显示一些警告信息。那么Deprecated注解是什么意思呢？如果你经常使用eclipse等IDE编写java程序时，可能会经常在属性或方法提示中看到这个词。如果某个类成员的提示中出现了个词，就表示这个并不建议使用这个类成员。因为这个类成员在未来的JDK版本中可能被删除。之所以在现在还保留，是因为给那些已经使用了这些类成员的程序一个缓冲期。如果现在就去了，那么这些程序就无法在新的编译器中编译了。说到这，可能你已经猜出来了。Deprecated注解一定和这些类成员有关。说得对！使用Deprecated标注一个类成员后，这个类成员在显示上就会有一些变化。在eclipse中非常明显。让我们看看图1有哪些变化。从上图可以看出，有三个地方发生的变化。红色框里面的是变化的部分。方法定义处方法引用处显示的成员列表中发生这些变化并不会影响编译，只是提醒一下程序员，这个方法以后是要被删除的，最好别用。Deprecated注解还有一个作用。就是如果一个类从另外一个类继承，并且override被继承类的Deprecated方法，在编译时将会出现一个警告。^口test.java的内容如下：classClass1{@DeprecatedpublicvoidmyMethod(){}}classClass2extendsClass1{publicvoidmyMethod(){}}运行javactest.java出现如下警告：注意：test.java使用或覆盖了已过时的API。注意：要了解详细信息，请使用-Xlint:deprecation重新编译使用-Xlint:deprecation显示更详细的警告信息：test.java:4:警告：[deprecation]Class1中的myMethod()已过时publicvoidmyMethod()1警告这些警告并不会影响编译，只是提醒你一下尽量不要用myMethod方法。SuppressWarnings这个世界的事物总是成对出现。即然有使编译器产生警告信息的，那么就有抑制编译器产生警告信息的SuppressWarnings注解就是为了这样一个目的而存在的。让我们先看一看如下的代码。publicvoidmyMethod(){ListwordList=newArrayList();wordList.add("foo");}这是一个类中的方法。编译它，将会得到如下的警告。注意：Testannotation.java使用了未经检查或不安全的操作注意：要了解详细信息，请使用-Xlint:unchecked重新编译。这两行警告信息表示List类必须使用范型才是安全的，才可以进行类型检查。如果想不显示这个警告信息有两种方法。一个是将这个方法进行如下改写：publicvoidmyMethod(){List<String>wordList=newArrayList<String>();wordList.add("foo");}另外一种方法就是使用@SuppressWarnings。@SuppressWarnings(value={"unchecked"})publicvoidmyMethod(){ListwordList=newArrayList();wordList.add("foo");}要注意的是SuppressWarnings和前两个注解不一样。这个注解有一个属性。当然，还可以抑制其它警告，女Q@SuppressWarnings(value={"unchecked","fallthrough"})三、如何自定义注解注解的强大之处是它不仅可以使java程序变成自描述的，而且允许程序员自定义注解。注解的定义和接口差不多，只是在nterface前面多了一个“@”。public@interfaceMyAnnotation{}上面的代码是一个最简单的注解。这个注解没有属性。也可以理解为是一个标记注解。就象Serializable接口一样是一个标记接口，里面未定义任何方法。当然，也可以定义而有属性的注解。public@interfaceMyAnnotation{Stringvalue();}可以按如下格式使用MyAnnotation@MyAnnotation(“abc”)publicvoidmyMethod(){}看了上面的代码，大家可能有一个疑问。怎么没有使用zalue,而直接就写”abc”了。那么”abc”到底传给谁了。其实这里有一个约定。如果没有写属性名的值，而这个注解又有value属性，就将这个值赋给value属性，如果没有，就出现编译错误。除了可以省略属性名，还可以省略属性值。这就是默认值。public@interfaceMyAnnotation{publicStringmyMethod()default"xyz";可以直接使用MyAnnotation@MyAnnotation//使用默认值xyzpublicvoidmyMethod(){}也可以这样使用@MyAnnotation(myMethod=”abc”)publicvoidmyMethod(){}如果要使用多个属性的话。可以参考如下代码。public@interfaceMyAnnotation{publicenumMyEnum{A,B,C}publicMyEnumvalue1();publicStringvalue2();}@MyAnnotation(value1=MyAnnotation.MyEnum.A,value2=“xyz”)publicvoidmyMethod(){}这一节讨论了如何自定义注解。那么定义注解有什么用呢？有什么方法对注解进行限制呢？我们能从程序中得到注解吗？这些疑问都可以从下面的内容找到答案。四、如何对注解进行注解这一节的题目读起来虽然有些绕口，但它所蕴涵的知识却对设计更强大的ava程序有很大帮助。在上一节讨论了自定义注解，由此我们可知注解在J2SE5.0中也和类、接口一样。是程序中的一个基本的组成部分。既然可以对类、接口进行注解，那么当然也可以对注解进行注解。使用普通注解对注解进行注解的方法和对类、接口进行注解的方法一样。所不同的是，J2SE5.0为注解单独提供了4种注解，即元注解。元注解理解：注解可以用于注解类(annotateClasses)可以用于注解接口(annotateInterfaces)可以用于注解枚举类型(annotateEnums)因此注解同样也可以用于注解注解(annotateAnnotations)它们是Target、Retention、Documented和Inherited。下面就分别介绍这4种注解。Target这个注解理解起来非常简单。由于target的中文意思是“目标”，因此，我们可能已经猜到这个注解和某一些目标相关。那么这些目标是指什么呢？大家可以先看看下面的代码。@Target({ElementType.METHOD})@interfaceMyAnnotation{}@MyAnnotation//错误的使用publicclassClass1{@MyAnnotation/正/确的使用publicvoidmyMethod1(){}}以上代码定义了一个注解MyAnnotation和一个类Classi，并且使用MyAnnotation分别对Classi和myMethodl进行注解。如果编译这段代码是无法通过的。也许有些人感到惊讶，没错啊！但问题就出S@Target({ElementType.METHOD})上，由于Target使用了一个枚举类型属性，它的值是ElementType.METHOD。这就表明MyAnnotation只能为分法注解。帚不能为其它的任何语言元素进行注解。因此，MyAnnotation自然也不能为Class1进行注解了。说到这，大家可能已经基本明白了。原来target所指的目标就是java的语言元素。如类、接口、方法等。当然，Target还可以对其它的语言元素进行限制，如构造函数、字段、参数等。如只允许对方法和构造函数进行注解可以写成：@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})@interfaceMyAnnotation{}Retention既然可以自定义注解，当然也可以读取程序中的注解(如何读取注解将在下一节中讨论)。但是注解只有被保存在lass文件中才可以被读出来。而Retention就是为设置注解是否保存在class文件中而存在的。下面的代码是Retention的详细用法。@Retention(RetentionPolicy.SOURCE)@interfaceMyAnnotationi{}@Retention(RetentionPolicy.CLASS)@interfaceMyAnnotation2{}@Retention(RetentionPolicy.RUNTIME)@interfaceMyAnnotation3{}其中第一段代码的作用是不将注解保存在class文件中，也就是说象“//'一样在编译时被过滤掉了。第二段代码的作用是只将注解保存在Dlass文件中，而使用反射读取注解时忽略这些注解。第三段代码的作用是即将注解保存在ilass文件中，也可以通过反射读取注解。Documented这个注解和它的名子一样和文档有关。在默认的情况下在使用avadoc自动生成文档时，注解将被忽略掉。如果想在文档中也包含注解，必须使用Documented为文档注解。@interfaceMyAnnotation{}@MyAnnotationclassClassi{publicvoidmyMethod(){}}使用javadoc为这段代码生成文档时并不〉l^@MyAnnotation包含进去。生成的文档对Class1的描述如下：classClassiextendsjava.lang.Object而如果这样定乂MyAnnotation将会出现另结果。@Documented@interfaceMyAnnotation{}生成的文档：@MyAnnotation//这行是在加±@Documented后被加上的classClass1extendsjava.lang.ObjectInherited继承是java主要的特性之一。在类中的protected和public成员都将会被子类继承，但是父类的注解会不会被子类继承呢？很遗憾的告诉大家，在默认的情况下，父类的注解并不会被子类继承。如果要继承，就必须加上Inherited注解。@Inherited@interfaceMyAnnotation{}@MyAnnotationpublicclassParentClass{}publicclassChildClassextendsParentClass{}在以上代码中ChildClass和Parentclass—样都已被MyAnnotation注解了。五、如何使用反射读取注解前面讨论了如何自定义注解。但是自定义了注解又有什么用呢？这个问题才是J2SE5.0提供注解的关键。自定义注解当然是要用的。那么如何用呢？解决这个问题就需要使用java最令人兴奋的功能之一：反射(reflect)。在以前的JDK版本中，我们可以使用反射得到类的方法、方法的参数以及其它的类成员等信息。那么在J2SE5.0中同样也可以象方法一样得到注解的各种信息。在使用反射之前必须使用importjava.lang.reflect.*来导入和反射相关的类。如果要得到某一个类或接口的注解信息，可以使用如下代码：Annotationannotation=TestAnnotation.class.getAnnotation(MyAnnotation.class);如果要得到全部的注解信息可使用如下语句：Annotation[]annotations=TestAnnotation.class.getAnnotations();或Annotation[]annotations=TestAnnotation.class.getDeclaredAnnotations();getDeclaredAnnotations与getAnnotations类似，但它们不同的是getDeclaredAnnotations得到的是当前成员所有的注解，不包括继承的。而getAnnotations得到的是包括继承的所有注解。如果要得到其它成员的注解，可先得到这个成员，然后再得到相应的注解。如得到myMethod的注解。Methodmethod=TestAnnotation.class.getMethod("myMethod",null);Annotationannotation=method.getAnnotation(MyAnnotation.class);注：要想使用反射得到注解信息，这个注解必须使用@Retention(RetentionPolicy.RUNTIME)进行注解。六、注解的本质：注解是—种类型JDK5.0中的类型：1、类(class)2、接口(interface)3、枚举(enum)4、注解(Annotation)因此，注解与其他3种类型一样，都可以定义、使用，以及包含有自己的属性、方法七、注解的分类：标记注释：注解的内部没有属性，称作标记注解使用方法：@注解名使用例子：@MarkAnnotation单值注解：注解的内部只有一个属性，称作单值注解使用方法：@注解名(属性名=属性值)使用例子：@SingleAnnotation(value="abc")〃也可以写成@SingleAnnotation("abc")*(属性名=属性值)可以简化为(属性值)但是需要满足以下两个条件：1、该注解必须为单值注解2、该注解的属性名必须为value多值注解：注解的内部有多个属性，称作多值注解使用方法：@注解名(属性名1=属性值1,属性名2=属性值2……)使用例子：@MultipliedAnnotation(value1="abc",value2=30)八、自动测试机的写法：自动测试机的原理：使用Annotation来Annotate元素的实质是：每一个ElementType内部的元素都有两个方法，分别为(注：为方便理解，以下使用的TestCase为某个特定的自定义注释)⑴isAnnotationPresent(TestCase.class)//判断该元素是否被TestCase所注释(2)getAnnotation(TestCase.class)/获得TestCase的类对象因此，自动测试机的工作过程是：首先通过反射，获得被测类o中的每一个方法对每一个方法通过使用sAnnotationPresent(TestCase.class)判断其是否被TestCase所注释(注意是.class!)如果某方法method被TestCase所注释，则通过method的getAnnotation(TestCase.class)获得TestCase的类对象tc通过tc的value()方法，获得该类对象的属性value(注：此处使用的value(