java annotation (注解)之我见(一)

来源:互联网 发布:pc6软件下载中心 编辑:程序博客网 时间:2024/03/29 22:16

自从java 1.5(代号tiger,1.6代号为mustang)引入annotation以后,java annontation就被广泛的使用了,很多java框架也紧跟潮流,在各自的新版本中都引入了annotation,比如Spring,从2.5提供了完全基于注释配置Bean、装配Bean 的功能。jax-ws and jax-rs规范也提供了基于注释的配置,还有jaxb。本文分为以下几个部分

第一部分简要介绍一下annotation基本概念和一个入门级的example;第二部分介绍一下spring注解,第三部分介绍jax-ws和jax-rs以及jaxb注解。

 

一,annotation基本概念

annotation(注解)在java语言中是一种语法上的元数据(metadata),可以作为源代码的一部分,java类,方法,变量,参数,还有包都可以被注解,注解不同于javadoc的标签,注解是可以被编译近class文件的,也可以在运行时被虚拟机获得,从而影响运行时行为。简而言之, 注解为我们在代码中添加配置信息提供了一种形式化的方法,是我们可以在稍后某个时刻方便地使用这些数据(通过解析注解来使用这些数据)。

注解的语法比较简单,除了@符号的使用以外,它基本上与java的固有语法一致,java内置了三种注解,定义在java.lang包中。 

@Override 表示当前方法是覆盖父类的方法。 
@Deprecated 表示当前元素是不赞成使用的。 
@SuppressWarnings表示关闭一些不当的编译器警告信息。 

 

以下是@Deprecated的源代码,从注释中我们可以知道如果引用被Deprecated注解的方法,在编译时会有warning

 

/*

 * @(#)Deprecated.java1.5 05/11/17

 *

 * Copyright 2006 Sun Microsystems, Inc. All rights reserved.

 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.

 */

 

package java.lang;

 

import java.lang.annotation.*;

 

/**

 * A program element annotated @Deprecated is one that programmers

 * are discouraged from using, typically because it is dangerous,

 * or because a better alternative exists.  Compilers warn when a

 * deprecated program element is used or overridden in non-deprecated code.

 *

 * @author  Neal Gafter

 * @version 1.5, 11/17/05

 * @since 1.5

 */

@Documented

@Retention(RetentionPolicy.RUNTIME)

public @interface Deprecated {

}

以下是一个入门级的annotation例子,
通过以下链接可以看到我们定义了一个注解,叫anno1
http://code.google.com/a/eclipselabs.org/p/javaexample/source/browse/trunk/src/net/seotour/java/example/annotation/type/anno1.java
定义注解用@interface,修饰注解的元注解有@Target,@Retention,@Documented,@Inherited,具体含义如下:
@Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括:
          ElemenetType.CONSTRUCTOR 构造器声明
          ElemenetType.FIELD 域声明(包括 enum 实例)
          ElemenetType.LOCAL_VARIABLE 局部变量声明
          ElemenetType.METHOD 方法声明
          ElemenetType.PACKAGE 包声明
          ElemenetType.PARAMETER 参数声明
          ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
          
 @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括:
          RetentionPolicy.SOURCE 注解将被编译器丢弃
          RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
          RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
          
 @Documented 将此注解包含在 javadoc 中
      
 @Inherited 允许子类继承父类中的注解
通过以下链接可以看到我们使用注解和解析注解的实例
http://code.google.com/a/eclipselabs.org/p/javaexample/source/browse/trunk/src/net/seotour/java/example/annotation/test/test1.java
这个简单的例子就只是想说明在运行时,我们是如何可以得到注解所对应的配置信息,在实际应用中,可能会根据不通的配置,应用程序就会走不通的逻辑。
二,Spring 注解
Spring 2.5提供了完全基于注释配置 Bean、装配 Bean 的功能,您可以使用基于注释的 Spring IoC 替换原来基于 XML 的配置

注释配置相对于 XML 配置具有很多的优势:

--它可以充分利用 Java 的反射机制获取类结构信息,这些信息可以有效减少配置的工作。如使用 JPA 注释配置 ORM 映射时,我们就不需要指定 PO 的属性名、类型等信息,如果关系表字段和 PO 属性名、类型都一致,您甚至无需编写任务属性映射信息——因为这些信息都可以通过 Java 反射机制获取。

--注释和 Java 代码位于一个文件中,而 XML 配置采用独立的配置文件,大多数配置信息在程序开发完成后都不会调整,如果配置信息和 Java 代码放在一起,有助于增强程序的内聚性。而采用独立的 XML 配置文件,程序员在编写一个功能时,往往需要在程序文件和配置文件中不停切换,这种思维上的不连贯会降低开发效率。

以下简要介绍以下spring中的注解,具体详细信息可以参考spring官网的文档

http://static.springsource.org/spring/docs/2.5.x/reference/beans.html#beans-annotation-config

http://static.springsource.org/spring/docs/2.5.x/reference/mvc.html#mvc-annotation

 

1, @Required ,应用于bean属性setter方法上,标识该属性必须被配置

2,@Autowired,可用于解决bean依赖

3,@Resource(JSR-250标准注解,推荐使用它来代替Spring专有的@Autowired注解) 

Spring 不但支持自己定义的@Autowired注解,还支持几个由JSR-250规范定义的注解,它们分别是@Resource、@PostConstruct以及@PreDestroy。
@Resource的作用相当于@Autowired,只不过@Autowired按byType自动注入,而@Resource默认按byName自动注入罢了。@Resource有两个属性是比较重要的,分别是name和type,Spring将@Resource注解的name属性解析为bean的名字,而type属性则解析为bean的类型。所以如果使用name属性,则使用byName的自动注入策略,而使用type属性时则使用byType自动注入策略。如果既不指定name也不指定type属性,这时将通过反射机制使用byName自动注入策略。
@Resource装配顺序

如果同时指定了name和type,则从Spring上下文中找到唯一匹配的bean进行装配,找不到则抛出异常

如果指定了name,则从上下文中查找名称(id)匹配的bean进行装配,找不到则抛出异常

如果指定了type,则从上下文中找到类型匹配的唯一bean进行装配,找不到或者找到多个,都会抛出异常

如果既没有指定name,又没有指定type,则自动按照byName方式进行装配;如果没有匹配,则回退为一个原始类型(UserDao)进行匹配,如果匹配则自动装配;

@PostConstruct(JSR-250)
在方法上加上注解@PostConstruct,这个方法就会在Bean初始化之后被Spring容器执行(注:Bean初始化包括,实例化Bean,并装配Bean的属性(依赖注入))。
它的一个典型的应用场景是,当你需要往Bean里注入一个其父类中定义的属性,而你又无法复写父类的属性或属性的setter方法时,如:

Java代码 
  1. public class UserDaoImpl extends HibernateDaoSupport implements UserDao {   
  2.     private SessionFactory mySessionFacotry;   
  3.     @Resource  
  4.     public void setMySessionFacotry(SessionFactory sessionFacotry) {   
  5.         this.mySessionFacotry = sessionFacotry;   
  6.     }   
  7.     @PostConstruct  
  8.     public void injectSessionFactory() {   
  9.         super.setSessionFactory(mySessionFacotry);   
  10.     }   
  11.     ...   
  12. }  
public class UserDaoImpl extends HibernateDaoSupport implements UserDao {private SessionFactory mySessionFacotry;@Resourcepublic void setMySessionFacotry(SessionFactory sessionFacotry) {this.mySessionFacotry = sessionFacotry;}@PostConstructpublic void injectSessionFactory() {super.setSessionFactory(mySessionFacotry);}...}


这里通过@PostConstruct,为UserDaoImpl的父类里定义的一个sessionFactory私有属性,注入了我们自己定义的sessionFactory(父类的setSessionFactory方法为final,不可复写),之后我们就可以通过调用super.getSessionFactory()来访问该属性了。  

4,@Component(不推荐使用)、@Repository、@Service、@Controller

@Component是所有受Spring管理组件的通用形式,Spring还提供了更加细化的注解形式:@Repository、@Service、@Controller,它们分别对应存储层Bean,业务层Bean,和展示层Bean。2.5中,这些注解与@Component的语义是一样的,完全通用,在Spring以后的版本中可能会给它们追加更多的语义。所以,我们推荐使用@Repository、@Service、@Controller来替代@Component。

原创粉丝点击