點(diǎn)關(guān)注，不迷路；持續(xù)更新Java架構(gòu)相關(guān)技術(shù)及資訊熱文?。?！

Spring中的注解大概可以分為兩大類：

• spring的bean容器相關(guān)的注解，或者說bean工廠相關(guān)的注解；
• springmvc相關(guān)的注解。

spring的bean容器相關(guān)的注解有：@Required， @Autowired, @PostConstruct, @PreDestory。還有Spring3.0開始支持的JSR-330標(biāo)準(zhǔn)javax.inject.*中的注解(@Inject, @Named, @Qualifier, @Provider, @Scope, @Singleton).

springmvc相關(guān)的注解有：@Controller，@RequestMapping，@RequestParam， @ResponseBody等等。

要理解Spring中的注解，先要理解Java中的注解。

一. Java中的注解

Java中1.5中開始引入注解，我們最熟悉的應(yīng)該是：@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中的一個(gè)同名方法。我們看到@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用于提示注解被保留多長時(shí)間，有三種取值：

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 保留在源碼級(jí)別，被編譯器拋棄(@Override就是此類)； RetentionPolicy.CLASS被編譯器保留在編譯后的類文件級(jí)別，但是被虛擬機(jī)丟棄；

RetentionPolicy.RUNTIME保留至運(yùn)行時(shí)，可以被反射讀取。

再看 @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）參數(shù)；5）構(gòu)造函數(shù)；6）局部變量；7）注解類型；8）包

所以：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

表示 @Override 只能使用在方法上，保留在源碼級(jí)別，被編譯器處理，然后拋棄掉。

還有一個(gè)經(jīng)常使用的元注解 @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 處理并保留在文檔中。

二. 使用 元注解 來自定義注解 和 處理自定義注解

有了元注解，那么我就可以使用它來自定義我們需要的注解。結(jié)合自定義注解和AOP或者過濾器，是一種十分強(qiáng)大的武器。比如可以使用注解來實(shí)現(xiàn)權(quán)限的細(xì)粒度的控制——在類或者方法上使用權(quán)限注解，然后在AOP或者過濾器中進(jìn)行攔截處理。下面是一個(gè)關(guān)于登錄的權(quán)限的注解的實(shí)現(xiàn)：

/**
 * 不需要登錄注解
 */
@Target({
    ElementType.METHOD, ElementType.TYPE
}
)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoLogin {
}

我們自定義了一個(gè)注解 @NoLogin, 可以被用于 方法 和 類 上，注解一直保留到運(yùn)行期，可以被反射讀取到。該注解的含義是：被 @NoLogin 注解的類或者方法，即使用戶沒有登錄，也是可以訪問的。下面就是對(duì)注解進(jìn)行處理了：

/**
 * 檢查登錄攔截器
 * 如不需要檢查登錄可在方法或者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("當(dāng)前操作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("當(dāng)前操作methodName=" + methodName + "不需要檢查登錄情況");
            }
            return true;
        }
        noLogin = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class);
        if (null != noLogin) {
            if (logger.isDebugEnabled()) {
                logger.debug("當(dāng)前操作methodName=" + methodName + "不需要檢查登錄情況");
            }
            return true;
        }
        if (null == request.getSession().getAttribute(CommonConstants.SESSION_KEY_USER)) {
            logger.warn("當(dāng)前操作" + methodName + "用戶未登錄,ip=" + request.getRemoteAddr());
            response.getWriter().write(JsonConvertor.convertFailResult(ErrorCodeEnum.NOT_LOGIN).toString());
            // 返回錯(cuò)誤信息
            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 {
    }
}

上面我們定義了一個(gè)登錄攔截器，首先使用反射來判斷方法上是否被 @NoLogin 注解：

 NoLogin noLogin = handlerMethod.getMethod().getAnnotation(NoLogin.class);

然后判斷類是否被 @NoLogin 注解：

noLogin = handlerMethod.getMethod().getDeclaringClass().getAnnotation(NoLogin.class); 

如果被注解了，就返回 true，如果沒有被注解，就判斷是否已經(jīng)登錄，沒有登錄則返回錯(cuò)誤信息給前臺(tái)和false. 這是一個(gè)簡單的使用 注解 和 過濾器 來進(jìn)行權(quán)限處理的例子。

擴(kuò)展開來，那么我們就可以使用注解，來表示某方法或者類，只能被具有某種角色，或者具有某種權(quán)限的用戶所訪問，然后在過濾器中進(jìn)行判斷處理。

三. spring的bean容器相關(guān)的注解

1. @Autowired 是我們使用得最多的注解，其實(shí)就是 autowire=byType 就是根據(jù)類型的自動(dòng)注入依賴（基于注解的依賴注入），可以被使用再屬性域，方法，構(gòu)造函數(shù)上。

2. @Qualifier 就是 autowire=byName, @Autowired注解判斷多個(gè)bean類型相同時(shí)，就需要使用 @Qualifier("xxBean") 來指定依賴的bean的id：

@Controller
@RequestMapping("/user")
public class HelloController {
    @Autowired
     @Qualifier("userService")
     private UserService userService;

3. @Resource 屬于JSR250標(biāo)準(zhǔn)，用于屬性域和方法上。也是 byName 類型的依賴注入。使用方式：@Resource(name="xxBean"). 不帶參數(shù)的 @Resource 默認(rèn)值類名首字母小寫。

4. JSR-330標(biāo)準(zhǔn)javax.inject.*中的注解(@Inject, @Named, @Qualifier, @Provider, @Scope, @Singleton)。@Inject就相當(dāng)于@Autowired, @Named 就相當(dāng)于 @Qualifier, 另外 @Named 用在類上還有 @Component的功能。

5. @Component， @Controller, @Service, @Repository, 這幾個(gè)注解不同于上面的注解，上面的注解都是將被依賴的bean注入進(jìn)入，而這幾個(gè)注解的作用都是生產(chǎn)bean, 這些注解都是注解在類上，將類注解成spring的bean工廠中一個(gè)一個(gè)的bean。@Controller, @Service, @Repository基本就是語義更加細(xì)化的@Component。

6. @PostConstruct 和 @PreDestroy 不是用于依賴注入，而是bean 的生命周期。類似于 init-method(InitializeingBean) destory-method(DisposableBean)

四. spring中注解的處理

spring中注解的處理基本都是通過實(shí)現(xiàn)接口 BeanPostProcessor 來進(jìn)行的：

public interface BeanPostProcessor {
    Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
    Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
}

相關(guān)的處理類有：

AutowiredAnnotationBeanPostProcessor，
CommonAnnotationBeanPostProcessor，
PersistenceAnnotationBeanPostProcessor，
RequiredAnnotationBeanPostProcessor

這些處理類，可以通過 <context:annotation-config/> 配置隱式的配置進(jìn)spring容器。這些都是依賴注入的處理，還有生產(chǎn)bean的注解(@Component， @Controller, @Service, @Repository)的處理：

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

這些都是通過指定掃描的基包路徑來進(jìn)行的，將他們掃描進(jìn)spring的bean容器。注意 context:component-scan 也會(huì)默認(rèn)將 AutowiredAnnotationBeanPostProcessor，CommonAnnotationBeanPostProcessor 配置進(jìn)來。所以<context:annotation-config/>是可以省略的。另外context:component-scan也可以掃描@Aspect風(fēng)格的AOP注解，但是需要在配置文件中加入 <aop:aspectj-autoproxy/> 進(jìn)行配合。

五. Spring注解和JSR-330標(biāo)準(zhǔn)注解的區(qū)別：