快速理解spring中的各种注解

spring中的注解大概可以分为两大类：

1）spring的bean容器相关的注解，或者说bean工厂相关的注解；

2）springmvc相关的注解。

spring的bean容器相关的注解，先后有：@required， @autowired, @postconstruct, @predestory，还有spring3.0开始支持的jsr-330标准javax.inject.*中的注解(@inject, @named, @qualifier, @provider, @scope, @singleton).

springmvc相关的注解有：@controller, @requestmapping, @requestparam， @responsebody等等。

要理解spring中的注解，先要理解java中的注解。

1. java中的注解

java中1.5中开始引入注解，我们最熟悉的应该是：@override, 它的定义如下：

/**
 * indicates that a method declaration is intended to override a
 * method declaration in a supertype. if a method is annotated with
 * this annotation type compilers are required to generate an error
 * message unless at least one of the following conditions hold:
 * the method does override or implement a method declared in a
 * supertype.
 * the method has a signature that is override-equivalent to that of
 * any public method declared in object.
 *
 * @author peter von der ahé
 * @author joshua bloch
 * @jls 9.6.1.4 @override
 * @since 1.5
 */
@target(elementtype.method)
@retention(retentionpolicy.source)
public @interface override {
}

从注释，我们可以看出，@override的作用是，提示编译器，使用了@override注解的方法必须override父类或者java.lang.object中的一个同名方法。我们看到@override的定义中使用到了 @target, @retention，它们就是所谓的“元注解”——就是定义注解的注解，或者说注解注解的注解(晕了...)。我们看下@retention

/**
 * indicates how long annotations with the annotated type are to
 * be retained. if no retention annotation is present on
 * an annotation type declaration, the retention policy defaults to
 * retentionpolicy.class.
 */
@documented
@retention(retentionpolicy.runtime)
@target(elementtype.annotation_type)
public @interface retention {
  /**
   * returns the retention policy.
   * @return the retention policy
   */
  retentionpolicy value();
}

@retention用于提示注解被保留多长时间，有三种取值：

public enum retentionpolicy {
  /**
   * annotations are to be discarded by the compiler.
   */
  source,
  /**
   * annotations are to be recorded in the class file by the compiler
   * but need not be retained by the vm at run time. this is the default
   * behavior.
   */
  class,
  /**
   * annotations are to be recorded in the class file by the compiler and
   * retained by the vm at run time, so they may be read reflectively.
   *
   * @see java.lang.reflect.annotatedelement
   */
  runtime
}

retentionpolicy.source 保留在源码级别，被编译器抛弃(@override就是此类)； retentionpolicy.class被编译器保留在编译后的类文件级别，但是被虚拟机丢弃；

retentionpolicy.runtime保留至运行时，可以被反射读取。

再看 @target:

package java.lang.annotation;
/**
 * indicates the contexts in which an annotation type is applicable. the
 * declaration contexts and type contexts in which an annotation type may be
 * applicable are specified in jls 9.6.4.1, and denoted in source code by enum
 * constants of java.lang.annotation.elementtype
 * @since 1.5
 * @jls 9.6.4.1 @target
 * @jls 9.7.4 where annotations may appear
 */
@documented
@retention(retentionpolicy.runtime)
@target(elementtype.annotation_type)
public @interface target {
	/**
   * returns an array of the kinds of elements an annotation type
   * can be applied to.
   * @return an array of the kinds of elements an annotation type
   * can be applied to
   */
	elementtype[] value();
}

@target用于提示该注解使用的地方，取值有：

public enum elementtype {
  /** class, interface (including annotation type), or enum declaration */
  type,
  /** field declaration (includes enum constants) */
  field,
  /** method declaration */
  method,
  /** formal parameter declaration */
  parameter,
  /** constructor declaration */
  constructor,
  /** local variable declaration */
  local_variable,
  /** annotation type declaration */
  annotation_type,
  /** package declaration */
  package,
  /**
   * type parameter declaration
   * @since 1.8
   */
  type_parameter,
  /**
   * use of a type
   * @since 1.8
   */
  type_use
}

分别表示该注解可以被使用的地方：1)类,接口，注解，enum; 2)属性域；3）方法；4）参数；5）构造函数；6）局部变量；7）注解类型；8）包

所以：

@target(elementtype.method)
@retention(retentionpolicy.source)
public @interface override {
}

表示 @override 只能使用在方法上，保留在源码级别，被编译器处理，然后抛弃掉。

还有一个经常使用的元注解 @documented ：

/**
 * indicates that annotations with a type are to be documented by javadoc
 * and similar tools by default. this type should be used to annotate the
 * declarations of types whose annotations affect the use of annotated
 * elements by their clients. if a type declaration is annotated with
 * documented, its annotations become part of the public api
 * of the annotated elements.
 */
@documented
@retention(retentionpolicy.runtime)
@target(elementtype.annotation_type)
public @interface documented {
}

表示注解是否能被 javadoc 处理并保留在文档中。

2. 使用 元注解 来自定义注解 和 处理自定义注解

有了元注解，那么我就可以使用它来自定义我们需要的注解。结合自定义注解和aop或者过滤器，是一种十分强大的武器。比如可以使用注解来实现权限的细粒度的控制——在类或者方法上使用权限注解，然后在aop或者过滤器中进行拦截处理。下面是一个关于登录的权限的注解的实现：

/**
 * 不需要登录注解
 */
@target({ elementtype.method, elementtype.type })
@retention(retentionpolicy.runtime)
@documented
public @interface nologin {
}

我们自定义了一个注解 @nologin, 可以被用于 方法 和 类 上，注解一直保留到运行期，可以被反射读取到。该注解的含义是：被 @nologin 注解的类或者方法，即使用户没有登录，也是可以访问的。下面就是对注解进行处理了：

/**
 * 检查登录拦截器
 * 如不需要检查登录可在方法或者controller上加上@nologin
 */
public class checklogininterceptor implements handlerinterceptor {
	private static final logger logger = logger.getlogger(checklogininterceptor.class);
	@override
	  public boolean prehandle(httpservletrequest request, httpservletresponse response,
	               object handler) throws exception {
		if (!(handler instanceof handlermethod)) {
			logger.warn("当前操作handler不为handlermethod=" + handler.getclass().getname() + ",req="
			            + request.getquerystring());
			return true;
		}
		handlermethod handlermethod = (handlermethod) handler;
		string methodname = handlermethod.getmethod().getname();
		// 判断是否需要检查登录
		nologin nologin = handlermethod.getmethod().getannotation(nologin.class);
		if (null != nologin) {
			if (logger.isdebugenabled()) {
				logger.debug("当前操作methodname=" + methodname + "不需要检查登录情况");
			}
			return true;
		}
		nologin = handlermethod.getmethod().getdeclaringclass().getannotation(nologin.class);
		if (null != nologin) {
			if (logger.isdebugenabled()) {
				logger.debug("当前操作methodname=" + methodname + "不需要检查登录情况");
			}
			return true;
		}
		if (null == request.getsession().getattribute(commonconstants.session_key_user)) {
			logger.warn("当前操作" + methodname + "用户未登录,ip=" + request.getremoteaddr());
			response.getwriter().write(jsonconvertor.convertfailresult(errorcodeenum.not_login).tostring());
			// 返回错误信息
			return false;
		}
		return true;
	}
	@override
	  public void posthandle(httpservletrequest request, httpservletresponse response,
	              object handler, modelandview modelandview) throws exception {
	}
	@override
	  public void aftercompletion(httpservletrequest request, httpservletresponse response,
	                object handler, exception ex) throws exception {
	}
}

上面我们定义了一个登录拦截器，首先使用反射来判断方法上是否被 @nologin 注解：

nologin nologin = handlermethod.getmethod().getannotation(nologin.class);
然后判断类是否被 @nologin 注解：

nologin = handlermethod.getmethod().getdeclaringclass().getannotation(nologin.class);
如果被注解了，就返回 true，如果没有被注解，就判断是否已经登录，没有登录则返回错误信息给前台和false. 这是一个简单的使用 注解 和 过滤器 来进行权限处理的例子。扩展开来，那么我们就可以使用注解，来表示某方法或者类，只能被具有某种角色，或者具有某种权限的用户所访问，然后在过滤器中进行判断处理。

3. spring的bean容器相关的注解

1）@autowired 是我们使用得最多的注解，其实就是 autowire=bytype 就是根据类型的自动注入依赖（基于注解的依赖注入），可以被使用再属性域，方法，构造函数上。

2）@qualifier 就是 autowire=byname, @autowired注解判断多个bean类型相同时，就需要使用 @qualifier("xxbean") 来指定依赖的bean的id：

@controller
@requestmapping("/user")
public class hellocontroller {
  @autowired
  @qualifier("userservice")
  private userservice userservice;

3）@resource 属于jsr250标准，用于属性域额和方法上。也是 byname 类型的依赖注入。使用方式：@resource(name="xxbean"). 不带参数的 @resource 默认值类名首字母小写。

4）jsr-330标准javax.inject.*中的注解(@inject, @named, @qualifier, @provider, @scope, @singleton)。@inject就相当于@autowired, @named 就相当于 @qualifier, 另外 @named 用在类上还有 @component的功能。

5）@component， @controller, @service, @repository, 这几个注解不同于上面的注解，上面的注解都是将被依赖的bean注入进入，而这几个注解的作用都是生产bean, 这些注解都是注解在类上，将类注解成spring的bean工厂中一个一个的bean。@controller, @service, @repository基本就是语义更加细化的@component。

6）@postconstruct 和 @predestroy 不是用于依赖注入，而是bean 的生命周期。类似于 init-method(initializeingbean) destory-method(disposablebean)

4. spring中注解的处理

spring中注解的处理基本都是通过实现接口 beanpostprocessor 来进行的：

public interface beanpostprocessor {
  object postprocessbeforeinitialization(object bean, string beanname) throws beansexception;
  object postprocessafterinitialization(object bean, string beanname) throws beansexception;
}

相关的处理类有： autowiredannotationbeanpostprocessor，commonannotationbeanpostprocessor，persistenceannotationbeanpostprocessor， requiredannotationbeanpostprocessor

这些处理类，可以通过 <context:annotation-config/> 配置隐式的配置进spring容器。这些都是依赖注入的处理，还有生产bean的注解(@component， @controller, @service, @repository)的处理：

<context:component-scan base-package="net.aazj.service,net.aazj.aop" />

这些都是通过指定扫描的基包路径来进行的，将他们扫描进spring的bean容器。注意 context:component-scan 也会默认将 autowiredannotationbeanpostprocessor，commonannotationbeanpostprocessor 配置进来。所以<context:annotation-config/>是可以省略的。另外context:component-scan也可以扫描@aspect风格的aop注解，但是需要在配置文件中加入 <aop:aspectj-autoproxy/> 进行配合。

5. spring注解和jsr-330标准注解的区别：

总结

以上就是本文关于快速理解spring中的各种注解的全部内容，希望对大家有所帮助。感兴趣的朋友可以继续参阅本站其他相关专题，如有不足之处，欢迎留言指出。感谢朋友们对本站的支持！