Java的注解机制——Spring自动装配的实现原理
Java的注解机制——Spring自动装配的实现原理
JDK1.5加入了对注解机制的支持，实际上我学习Java的时候就已经使用JDK1.6了，而且除了@Override和@SuppressWarnings(后者还是IDE给生成的……)之外没接触过其他的。
进入公司前的面试，技术人员就问了我关于注解的问题，我就说可以生成chm手册……现在想起来真囧，注释和注解被我搞得完全一样了。
使用注解主要是在需要使用Spring框架的时候，特别是使用SpringMVC。因为这时我们会发现它的强大之处：预处理。
注解实际上相当于一种标记，它允许你在运行时(源码、文档、类文件我们就不讨论了)动态地对拥有该标记的成员进行操作。
实现注解需要三个条件(我们讨论的是类似于Spring自动装配的高级应用)：注解声明、使用注解的元素、操作使用注解元素的代码。
首先是注解声明，注解也是一种类型，我们要定义的话也需要编写代码，如下：
1 package annotation;
2
3 import java.lang.annotation.ElementType;
4 import java.lang.annotation.Retention;
5 import java.lang.annotation.RetentionPolicy;
6 import java.lang.annotation.Target;
7
8 /**
9 * 自定义注解，用来配置方法
10 *
11 * @author Johness
12 *
13 */
14 @Retention(RetentionPolicy.RUNTIME) // 表示注解在运行时依然存在
15 @Target(ElementType.METHOD) // 表示注解可以被使用于方法上
16 public @interface SayHiAnnotation {
17 String paramValue() default "johness"; // 表示我的注解需要一个参数 名为"paramValue" 默认值为"johness"
18 }
然后是使用我们注解的元素：
1 package element;
2
3 import annotation.SayHiAnnotation;
4
5 /**
6 * 要使用SayHiAnnotation的元素所在类
7 * 由于我们定义了只有方法才能使用我们的注解，我们就使用多个方法来进行测试
8 *
9 * @author Johness
10 *
11 */
12 public class SayHiEmlement {
13
14 // 普通的方法
15 public void SayHiDefault(String name){
16 System.out.println("Hi, " + name);
17 }
18
19 // 使用注解并传入参数的方法
20 @SayHiAnnotation(paramValue="Jack")
21 public void SayHiAnnotation(String name){
22 System.out.println("Hi, " + name);
23 }
24
25 // 使用注解并使用默认参数的方法
26 @SayHiAnnotation
27 public void SayHiAnnotationDefault(String name){
28 System.out.println("Hi, " + name);
29 }
30 }
最后，是我们的操作方法(值得一提的是虽然有一定的规范，但您大可不必去浪费精力，您只需要保证您的操作代码在您希望的时候执行即可)：
1 package Main;
2
3 import java.lang.reflect.InvocationTargetException;
4 import java.lang.reflect.Method;
5
6 import element.SayHiEmlement;
7 import annotation.SayHiAnnotation;
8
9 public class AnnotionOperator {
10 public static void main(String[] args) throws IllegalAccessException, IllegalArgumentException, InvocationTargetException, ClassNotFoundException {
11 SayHiEmlement element = new SayHiEmlement(); // 初始化一个实例，用于方法调用
12 Method[] methods = SayHiEmlement.class.getDeclaredMethods(); // 获得所有方法
13
14 for (Method method : methods) {
15 SayHiAnnotation annotationTmp = null;
16 if((annotationTmp = method.getAnnotation(SayHiAnnotation.class))!=null) // 检测是否使用了我们的注解
17 method.invoke(element,annotationTmp.paramValue()); // 如果使用了我们的注解，我们就把注解里的"paramValue"参数值作为方法参数来调用方法
18 else
19 method.invoke(element, "Rose"); // 如果没有使用我们的注解，我们就需要使用普通的方式来调用方法了
20 }
21 }
22 }
结果为：Hi, Jack
Hi, johness
Hi, Rose
可以看到，注解是进行预处理的很好方式(这里的预处理和编译原理有区别)！
接下来我们看看Spring是如何使用注解机制完成自动装配的：
首先是为了让Spring为我们自动装配要进行的操作，无外乎两种：继承org.springframework.web.context.support.SpringBeanAutowiringSupport类或者添加@Component/@Controller等注解并(只是使用注解方式需要)在Spring配置文件里声明context:component-scan元素。
我说说继承方式是如何实现自动装配的，我们打开Spring源代码查看SpringBeanAutowiringSupport类。我们会发现以下语句：
1 public SpringBeanAutowiringSupport() {
2 processInjectionBasedOnCurrentContext(this);
3 }
众所周知，Java实例构造时会调用默认父类无参构造方法，Spring正是利用了这一点，让"操作元素的代码"得以执行！(我看到第一眼就震惊了！真是奇思妙想啊。果然，高手都要善于用Java来用Java)
后面的我就不就不多说了，不过还是要纠正一些人的观点：说使用注解的自动装配来完成注入也需要setter。这明显是错误的嘛！我们看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.InjectionMetadata#Injection(继承，方法重写)。最后看看Injection方法的方法体：
1 /**
2 * Either this or {@link #getResourceToInject} needs to be overridden.
3 */
4 protected void inject(Object target, String requestingBeanName, PropertyValues pvs) throws Throwable {
5 if (this.isField) {
6 Field field = (Field) this.member;
7 ReflectionUtils.makeAccessible(field);
8 field.set(target, getResourceToInject(target, requestingBeanName));
9 }
10 else {
11 if (checkPropertySkipping(pvs)) {
12 return;
13 }
14 try {
15 Method method = (Method) this.member;
16 ReflectionUtils.makeAccessible(method);
17 method.invoke(target, getResourceToInject(target, requestingBeanName));
18 }
19 catch (InvocationTargetException ex) {
20 throw ex.getTargetException();
21 }
22 }
23 }
虽然不完全，但可以基本判定此种自动装配是使用了java放射机制。
本文将向你介绍J2SE5.0中的新特性之一：注解。本文将从什么是注解；J2SE5.0中预定义的注解；如何自定义注解；如何对注解进行注解以及如何在程序中读取注解5个方面进行讨论。
一、什么是注解
说起注解，得先提一提什么是元数据(metadata)。所谓元数据就是数据的数据。也就是说，元数据是描述数据的。就象数据表中的字段一样，每个字段描述了这个字段下的数据的含义。而J2SE5.0中提供的注解就是java源代码的元数据，也就是说注解是描述java源代码的。在J2SE5.0中可以自定义注解。使用时在@后面跟注解的名字。
二、J2SE5.0中预定义的注解
在J2SE5.0的java.lang包中预定义了三个注解。它们是Override、Deprecated和SuppressWarnings。下面分别解解它们的含义。
Override
这个注解的作用是标识某一个方法是否覆盖了它的父类的方法。那么为什么要标识呢？让我们来看看如果不用Override标识会发生什么事情。
假设有两个类Class1和ParentClass1，用Class1中的myMethod1方法覆盖ParentClass1中的myMethod1方法。
class ParentClass1
{
public void myMethod1() {}
}
class Class1 extends ParentClass1
{
public void myMethod2() {}
}
建立Class1的实例，并且调用myMethod1方法
ParentClass1 c1 = new Class1();
c1.myMethod1();
以上的代码可以正常编译通过和运行。但是在写Class1的代码时，误将myMethod1写成了myMethod2，然而在调用时，myMethod1并未被覆盖。因此，c1.myMethod1()调用的还是ParentClass1的myMethod1方法。更不幸的是，程序员并未意识到这一点。因此，这可能会产生bug。
如果我们使用Override来修饰Class1中的myMethod1方法，当myMethod1被误写成别的方法时，编译器就会报错。因此，就可以避免这类错误。
class Class1 extends ParentClass1
{
@Override // 编译器产生一个错误
public void myMethod2() {}
}
以上代码编译不能通过，被Override注解的方法必须在父类中存在同样的方法程序才能编译通过。也就是说只有下面的代码才能正确编译。
class Class1 extends ParentClass1
{
@Override
public void myMethod1() {}
}
Deprecated
这个注解是一个标记注解。所谓标记注解，就是在源程序中加入这个标记后，并不影响程序的编译，但有时编译器会显示一些警告信息。
那么Deprecated注解是什么意思呢？如果你经常使用eclipse等IDE编写java程序时，可能会经常在属性或方法提示中看到这个词。如果某个类成员的提示中出现了个词，就表示这个并不建议使用这个类成员。因为这个类成员在未来的JDK版本中可能被删除。之所以在现在还保留，是因为给那些已经使用了这些类成员的程序一个缓冲期。如果现在就去了，那么这些程序就无法在新的编译器中编译了。
说到这，可能你已经猜出来了。Deprecated注解一定和这些类成员有关。说得对！使用Deprecated标注一个类成员后，这个类成员在显示上就会有一些变化。在eclipse中非常明显。让我们看看图1有哪些变化。
图1 加上@Deprecated后的类成员在eclipse中的变化
从上图可以看出，有三个地方发生的变化。红色框里面的是变化的部分。
1. 方法定义处
2. 方法引用处
3. 显示的成员列表中
发生这些变化并不会影响编译，只是提醒一下程序员，这个方法以后是要被删除的，最好别用。
Deprecated注解还有一个作用。就是如果一个类从另外一个类继承，并且override被继承类的Deprecated方法，在编译时将会出现一个警告。如test.java的内容如下：
class Class1
{
@Deprecated
public void myMethod(){}
}
class Class2 extends Class1
{
public void myMethod(){}
}
运行javac test.java 出现如下警告：
注意：test.java 使用或覆盖了已过时的 API。
注意：要了解详细信息，请使用 -Xlint:deprecation 重新编译
使用-Xlint:deprecation显示更详细的警告信息：
test.java:4: 警告：[deprecation] Class1 中的 myMethod() 已过时
public void myMethod()
^
1 警告
这些警告并不会影响编译，只是提醒你一下尽量不要用myMethod方法。
SuppressWarnings
这个世界的事物总是成对出现。即然有使编译器产生警告信息的，那么就有抑制编译器产生警告信息的。
SuppressWarnings注解就是为了这样一个目的而存在的。让我们先看一看如下的代码。
public void myMethod()
{
List wordList = new ArrayList();
wordList.add("foo");
}
这是一个类中的方法。编译它，将会得到如下的警告。
注意：Testannotation.java 使用了未经检查或不安全的操作。
注意：要了解详细信息，请使用 -Xlint:unchecked 重新编译。
这两行警告信息表示List类必须使用范型才是安全的，才可以进行类型检查。如果想不显示这个警告信息有两种方法。一个是将这个方法进行如下改写：
public void myMethod()
{
List<String> wordList = new ArrayList<String>();
wordList.add("foo");
}
另外一种方法就是使用@SuppressWarnings。
@SuppressWarnings (value={"unchecked"})
public void myMethod()
{
List wordList = new ArrayList();
wordList.add("foo");
}
要注意的是SuppressWarnings和前两个注解不一样。这个注解有一个属性。当然，还可以抑制其它警告，如@SuppressWarnings(value={"unchecked", "fallthrough"})
三、如何自定义注解
注解的强大之处是它不仅可以使java程序变成自描述的，而且允许程序员自定义注解。注解的定义和接口差不多，只是在interface前面多了一个“@”。
public @interface MyAnnotation
{
}
上面的代码是一个最简单的注解。这个注解没有属性。也可以理解为是一个标记注解。就象Serializable接口一样是一个标记接口，里面未定义任何方法。
当然，也可以定义而有属性的注解。
public @interface MyAnnotation
{
String value();
}
可以按如下格式使用MyAnnotation
@MyAnnotation(“abc”)
public void myMethod()
{
}
看了上面的代码，大家可能有一个疑问。怎么没有使用value，而直接就写”abc”了。那么”abc”到底传给谁了。其实这里有一个约定。如果没有写属性名的值，而这个注解又有value属性，就将这个值赋给value属性，如果没有，就出现编译错误。
除了可以省略属性名，还可以省略属性值。这就是默认值。
public @interface MyAnnotation
{
public String myMethod() default "xyz";
}
可以直接使用MyAnnotation
@MyAnnotation // 使用默认值xyz
public void myMethod()
{
}
也可以这样使用
@MyAnnotation(myMethod=”abc”)
public void myMethod()
{
}
如果要使用多个属性的话。可以参考如下代码。
public @interface MyAnnotation
{
public enum MyEnum{A, B, C}
public MyEnum value1();
public String value2();
}
@MyAnnotation(value1=MyAnnotation.MyEnum.A, value2 = “xyz”)
public void myMethod()
{
}
这一节讨论了如何自定义注解。那么定义注解有什么用呢？有什么方法对注解进行限制呢？我们能从程序中得到注解吗？这些疑问都可以从下面的内容找到答案。
四、如何对注解进行注解
这一节的题目读起来虽然有些绕口，但它所蕴涵的知识却对设计更强大的java程序有很大帮助。
在上一节讨论了自定义注解，由此我们可知注解在J2SE5.0中也和类、接口一样。是程序中的一个基本的组成部分。既然可以对类、接口进行注解，那么当然也可以对注解进行注解。
使用普通注解对注解进行注解的方法和对类、接口进行注解的方法一样。所不同的是，J2SE5.0为注解单独提供了4种注解，即元注解。
它们是Target、Retention、Documented和Inherited。下面就分别介绍这4种注解。
Target
这个注解理解起来非常简单。由于target的中文意思是“目标”，因此，我们可能已经猜到这个注解和某一些目标相关。那么这些目标是指什么呢？大家可以先看看下面的代码。
@Target({ElementType.METHOD})
@interface MyAnnotation {}
@MyAnnotation // 错误的使用
public class Class1
{
@MyAnnotation // 正确的使用
public void myMethod1() {}
}
以上代码定义了一个注解MyAnnotation和一个类Class1，并且使用MyAnnotation分别对Class1和myMethod1进行注解。如果编译这段代码是无法通过的。也许有些人感到惊讶，没错啊！但问题就出在@Target({ElementType.METHOD})上，由于Target使用了一个枚举类型属性，它的值是ElementType.METHOD。这就表明MyAnnotation只能为方法注解。而不能为其它的任何语言元素进行注解。因此，MyAnnotation自然也不能为Class1进行注解了。
说到这，大家可能已经基本明白了。原来target所指的目标就是java的语言元素。如类、接口、方法等。当然，Target还可以对其它的语言元素进行限制，如构造函数、字段、参数等。如只允许对方法和构造函数进行注解可以写成：
@Target({ElementType.METHOD, ElementType.CONSTRUCTOR})
@interface MyAnnotation {}
Retention
既然可以自定义注解，当然也可以读取程序中的注解（如何读取注解将在下一节中讨论）。但是注解只有被保存在class文件中才可以被读出来。而Retention就是为设置注解是否保存在class文件中而存在的。下面的代码是Retention的详细用法。
@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1 { }
@Retention(RetentionPolicy.CLASS)
@interface MyAnnotation2 {}
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {}
其中第一段代码的作用是不将注解保存在class文件中，也就是说象“//”一样在编译时被过滤掉了。第二段代码的作用是只将注解保存在class文件中，而使用反射读取注解时忽略这些注解。第三段代码的作用是即将注解保存在class文件中，也可以通过反射读取注解。
Documented
这个注解和它的名子一样和文档有关。在默认的情况下在使用javadoc自动生成文档时，注解将被忽略掉。如果想在文档中也包含注解，必须使用Documented为文档注解。
@interface MyAnnotation{ }
@MyAnnotation
class Class1
{
public void myMethod() { }
}
使用javadoc为这段代码生成文档时并不将@MyAnnotation包含进去。生成的文档对Class1的描述如下：
class Class1 extends java.lang.Object
而如果这样定义MyAnnotation将会出现另一个结果。
@Documented
@interface MyAnnotation {}
生成的文档：
@MyAnnotation // 这行是在加上@Documented后被加上的
class Class1 extends java.lang.Object
Inherited
继承是java主要的特性之一。在类中的protected和public成员都将会被子类继承，但是父类的注解会不会被子类继承呢？很遗憾的告诉大家，在默认的情况下，父类的注解并不会被子类继承。如果要继承，就必须加上Inherited注解。
@Inherited
@interface MyAnnotation { }
@MyAnnotation
public class ParentClass {}
public class ChildClass extends ParentClass { }
在以上代码中ChildClass和ParentClass一样都已被MyAnnotation注解了。
五、如何使用反射读取注解
前面讨论了如何自定义注解。但是自定义了注解又有什么用呢？这个问题才是J2SE5.0提供注解的关键。自定义注解当然是要用的。那么如何用呢？解决这个问题就需要使用java最令人兴奋的功能之一：反射(reflect)。
在以前的JDK版本中，我们可以使用反射得到类的方法、方法的参数以及其它的类成员等信息。那么在J2SE5.0中同样也可以象方法一样得到注解的各种信息。
在使用反射之前必须使用import java.lang.reflect.* 来导入和反射相关的类。
如果要得到某一个类或接口的注解信息，可以使用如下代码：
Annotation annotation = TestAnnotation.class.getAnnotation(MyAnnotation.class);
如果要得到全部的注解信息可使用如下语句：
Annotation[] annotations = TestAnnotation.class.getAnnotations();
或
Annotation[] annotations = TestAnnotation.class.getDeclaredAnnotations();
getDeclaredAnnotations与getAnnotations类似，但它们不同的是getDeclaredAnnotations得到的是当前成员所有的注解，不包括继承的。而getAnnotations得到的是包括继承的所有注解。
如果要得到其它成员的注解，可先得到这个成员，然后再得到相应的注解。如得到myMethod的注解。
Method method = TestAnnotation.class.getMethod("myMethod", null);
Annotation annotation = method.getAnnotation(MyAnnotation.class);
注：要想使用反射得到注解信息，这个注解必须使用
@Retention(RetentionPolicy.RUNTIME)进行注解。
总结
注解是J2SE5.0提供的一项非常有趣的功能。它不但有趣，而且还非常有用。如即将出台的EJB3.0规范就是借助于注解实现的。这样将使EJB3.0在实现起来更简单，更人性化。还有Hibernate3.0除了使用传统的方法生成hibernate映射外，也可以使用注解来生成hibernate映射。总之，如果能将注解灵活应用到程序中，将会使你的程序更加简洁和强大。
