做Java开发过程中,我们常常用到注解,如@Service、@Overrided、@Autowired、@Param等,但这些注解的工作原理是怎么样的恐怕不是每个人都说的清楚,在没了解注解的工作原理之前倒是可以大致推断一下:当注解标注到某个类或者方法或者某个成员变量或者某个输入参数上的时候,一定有一个对应的机制来对注解标注的类、方法、成员变量和参数进行某些处理。比如Bean扫描、编译检查、注入值、约束是否为空等等。
1、注解定义
注解就是用来描述包、类、成员变量、方法或者参数的元数据,注解本身也是一个类(Java里一切都是对象)。配置过Spring的同学肯定很清楚,Spring中的Bean需要在xml里面声明,比如说一个Bean他的构造方法是啥,他依赖哪些其他bean,初始化变量值是多少,这些都是描述性的数据告知Spring按照这个描述去创建这个Bean。我们随便找个例子:
<bean id="Kenny" class="com.springinaction.springidol.Instrumentalist">
<property name="song" value="Jingle Bells"></property>
<property name="age" value="37"></property>
<property name="instrument" ref="saxphone"></property>
<property name="instrument" ref="piano"></property>
<property name="instrument">
<bean class="com.springinaction.springidol.piano"></bean>
</property>
</bean>
这些对类和变量等的描述实际上就是元数据,而这些都可以用注解取代,因为注解也是元数据。比如@Component注解标注在一个类上就可以说明该类是一个bean,@Autowire标注在成员变量上就直接给该成员变量赋值。看起来注解标注在代码上耦合性更强了,但实际上本着约定优于配置的原则,代码更加清晰,也容易维护。
2、注解分类
注解大体上可以分成两类,一类是系统带的如@Override,这类注解对其标注的目标的处理在JVM层面进行;另一类是我们自定义的注解,自己定义的注解自己要进行解析。还有一类是描述注解的注解,共有4个,分别是:
@Documented 注解信息是否添加到javadoc中
@Retention 注解的生命周期
RetentionPolicy.SOURCE(编译结束后失效如@Override)、
RetentionPolicy.CLASS(JVM加载类的时候失效,默认。不能通过反射获取)、
RetentionPolicy.RUNTIME(始终不失效,一般用于自定义注解,可通过反射获取)
@Target 注解用在什么地方,分别有几个地方:
ElementType.TYPE:类上
ElementType.FIELD:成员变量
ElementType.METHOD 方法
ElementType.PARAMETER 参数
ElementType.CONSTRUCTOR 构造方法
ElementType.LOCAL_VARIABLE 本地变量
ElementType.ANNOTATION_TYPE 另一个注释
ElementType.PACKAGE 包上
@Inherited 注解作用被子类继承
3、自定义注解
3.1 定义一个注解需要几步?
首先、@Target肯定要有;
其次、生命周期尽量RUNTIME;
然后、使用@interface声明;
再次、内部只支持基本类型、String类型和枚举类型;
最后、所有属性都必须写成field(),并可提供默认值default;
3.2 如何使用注解?
首先、在对应位置(@Target)标注;
然后、给注解中的属性赋值;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Company {
public enum Status {RUNNING, CLOSED}
String name() default "NETEASE"; //有默认值
Status status() default Status.RIUNNING;
String location();//没有默认值
}
public class Demo{
@Company(name="阿里巴巴",status=Company.Status.RUNNING,location="北京")
public void companyInfo(){}
}
@interface Country{
String value();
}
@Country("中国")
public void method(){};
上面是第一个自定义注解的例子,该注解需要标注在方法上,在运行期间一直存在。如果注解中只有一个属性可以命名为value()这种的好处是注解标注的时候不用写value=xxx而是直接写xxx即可。
3.3 注解标注完如何处理?
首先、定义一个注解处理类和注解处理方法;
然后、通过反射获取注解标注的类或者方法或者变量等等并对其做相应处理;
public class AnnotationProccessor {
public static void process(Demo demo){
Class demoClazz = Demo.class;
for(Method method : demoClazz.getMethods()) {
Company companyAnnotation = (Company)method.getAnnotation(Company.class);
if(companyAnnotation !=null) {
System.out.println(" Method Name : "+ method.getName());
System.out.println(" name : "+ companyAnnotation.name());
System.out.println(" Status : "+ companyAnnotation.status());
}
}
}
上面的类只对特定的类进行了处理,在Spring中一个如@Service这种注解,Spring在启动IOC容器的时候会对每个类进行扫描,把所有标注@Component及其子注解如@Service的类进行Bean处理。