Spring注解入门

随着Annotation的流行，一些主流框架都加入了对Annotation的支持。使用Annotation能够简化很多配置工作，能够很大程度上提高程序开发的效率。本文将 Spring 2.5 新增的 Sping MVC 注解功能，介绍如何使用注解配置替换传统的基于 XML 的 Spring MVC 配置。

Controller 更加灵活
传统方式：当创建一个 Controller 时，我们需要直接或间接地实现org.springframework.web.servlet.mvc.Controller 接口。一般情况下，我们是通过继承 SimpleFormController 或 MultiActionController 来定义自己的 Controller 的。
注解方式： Controller 不必继承任何接口，它仅是一个简单的 POJO，开发人员对Controller的代码实现变得更加灵活。

方便请求和控制器的映射简化配置
传统方式：需通过Spring MVC的配置文件，在XML 配置文件中定义请求和 Controller 的映射关系，以便将两者关联起来。
注解方式：可以通过@Controller注解声明将该类的实例添加到Spring 容器中管理，而无需通过Spring MVC的配置文件来配置，大大简化了Spring MVC相关的配置量。

更加丰富的参数绑定机制
传统方式：我们都使用HttpServletRequest绑定,对于一个对象绑定需要编写bind帮助类来实现。
注解方式：通过注解将某个或者某些参数直接绑定到Controller方法的参数上，从而在方法体内，你可以完全对HttpServletRequest视而不见，直接使用已经绑定好的参数。

细粒度处理各种request请求
传统方式：必须通过HttpServletRequest进行判断。
注解方式：针对最基本的统一请求的GET/POST方式进行不同处理自然不在话下，还可以对拥有不同请求参数的同一request请求分别用不同的方法处理。

来看一下基于注解的 Controller 是如何定义做到这一点的
UserController.java
Java代码
package xxx.user.web;  
…………………………  
@Controller // <——①  
@RequestMapping("/user.html") //<——②  
public class UserController {  
    private String showListUserPage = "user/listUser";   
    ………………………………………  
    @Resource // <——③  
    private UserManager userManger;  
 
    @RequestMapping(params = "method=list") //<——④  
    public String listUser(ModelMap model) {  
        String roleMapJSON = UserConstants.getRoleMapJSON();  
        model.addAttribute("roleMapJSON", roleMapJSON);  
        return showListUserPage;  
    }  
    ………………………  
} 

package xxx.user.web;
…………………………
@Controller // <——①
@RequestMapping("/user.html") //<——②
public class UserController {
private String showListUserPage = "user/listUser";
………………………………………
@Resource // <——③
private UserManager userManger;

@RequestMapping(params = "method=list") //<——④
public String listUser(ModelMap model) {
String roleMapJSON = UserConstants.getRoleMapJSON();
model.addAttribute("roleMapJSON", roleMapJSON);
return showListUserPage;
}
………………………
}
①：@Controller注解标明该类需要Spring容器自动加载，将一个类成为 Spring 容器的 Bean。

②： @RequestMapping 这个注解使得该类具有了Spring MVC Controller 的功能。
@RequestMapping注解标识UserController处理来自/user.html的请求。

@RequestMapping 可以标注在类定义处，将 Controller 和特定请求关联起来；还可以标注在方法签名处(注解4后面详细介绍)。所以在类声明处标注的 @RequestMapping 相当于让 POJO 实现了 Controller 接口，而在方法定义处的 @RequestMapping 相当于让 POJO 扩展 Spring 预定义的 Controller（如 SimpleFormController 等）。

③：注解方式注入 UserManager

④: 此处又用了一个@RequestMapping注解，这里的这个注解是为了细粒度区分各个Controller方法，也就是说 listUser 这个方法来处理 /user.html?method=list的请求。

此外，我们注意到此处返回值是一个String类型，Spring MVC会认为这是你告诉他返回的视图名称，当然此处你也可以返回一个ModelAndView类型，假若你什么也不返回-void,那么Spring会试图查找和你的请求URL同名的视图进行匹配(与配置文件相关)。

启用Spring MVC 功能
传统方式一样, Spring MVC 真正工作起来，需要在 Spring MVC 对应的 xxx-servlet.xml 配置文件进行配置。在此之前，还是先来看一下 web.xml 的配置:

web.xml
Xml代码
……………………….  
<!-- Spring MVC的Servlet，它将加载WEB-INF/annomvc-servlet.xml的配置文件，以启动Spring MVC模块 --> 
<servlet> 
    <servlet-name>annomvc</servlet-name> 
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 
    <load-on-startup>1</load-on-startup> 
</servlet> 
 
<servlet-mapping> 
    <servlet-name>annomvc</servlet-name> 
    <url-pattern>*.html</url-pattern> 
</servlet-mapping> 
………………………… 

……………………….
<!-- Spring MVC的Servlet，它将加载WEB-INF/annomvc-servlet.xml的配置文件，以启动Spring MVC模块 -->
<servlet>
<servlet-name>annomvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>

<servlet-mapping>
<servlet-name>annomvc</servlet-name>
<url-pattern>*.html</url-pattern>
</servlet-mapping>
…………………………

启用Spring MVC 注解功能
web.xml 中定义了一个名为 annomvc的 Spring MVC 模块，按照 Spring MVC 的契约，需要在 WEB-INF/annomvc-servlet.xml 配置文件中定义 Spring MVC 模块的具体配置。

Spring MVC 会自动加载 annomvc-servlet.xml 配置文件，要使用注解功能，主要对其进行配置。

annomvc-servlet.xml

Xml代码
<?xml version="1.0" encoding="UTF-8"?> 
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" 
    xmlns:context="http://www.springframework.org/schema/context" 
    xsi:schemaLocation="http://www.springframework.org/schema/beans     
    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd    
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd"> 
 
<!-- Initializing Spring FrameworkServlet 'annomvc'时实例化bean，并自动依赖注入 --> 
 
<!--①：规约所有进行扫描的类，以完成Bean创建和自动依赖注入的功能--> 
<context:component-scan base-package=" xxx.user.web" /> 
 
<!-- ②：启动Spring MVC的注解功能，完成请求和注解POJO的映射  --> 
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" /> 
 
<!-- ③：对模型视图名称的解析，即在模型视图名称添加前后缀  --> 
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/jsps/" p:suffix=".jsp" /> 
 
</beans> 

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans  
    http://www.springframework.org/schema/beans/spring-beans-2.5.xsd 
    http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd">

<!-- Initializing Spring FrameworkServlet 'annomvc'时实例化bean，并自动依赖注入 -->

<!--①：规约所有进行扫描的类，以完成Bean创建和自动依赖注入的功能-->
<context:component-scan base-package=" xxx.user.web" />

<!-- ②：启动Spring MVC的注解功能，完成请求和注解POJO的映射  -->
<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter" />

<!-- ③：对模型视图名称的解析，即在模型视图名称添加前后缀  -->
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" p:prefix="/WEB-INF/jsps/" p:suffix=".jsp" />

</beans>

首先我们要引用 Spring 2.5 命名空间

① 因为Spring 所有功能都在 Bean 的基础上演化而来，所以必须事先将 Controller 变成 Bean，这是通过在类中标注 @Controller 并在 annomvc-servlet.xml 中启用组件扫描机制来完成的。这里定义对哪些类进行扫描，以便使用注解功能。各个类或包之间使用“，”分割。

② 配置了一个 AnnotationMethodHandlerAdapter，它负责根据 Bean 中的 Spring MVC 注解对 Bean 进行加工处理，使这些 Bean 变成控制器并映射特定的 URL 请求。如果你想要自定义映射策略，显式的定义一个DefaultAnnotationHandlerMapping。

③ 定义模型视图名称的解析规则，这里我们使用了 Spring 2.5 的特殊命名空间，即 p 命名空间，它将原先需要通过 <property> 元素配置的内容转化为 <bean> 属性配置，在一定程度上简化了 <bean> 的配置。

启动服务器，发送 xxxxxx/user/list.html?method=list URL 请求，UserController的 listUser () 方法将响应这个请求，并转向 WEB-INF/jsp/user/listUser.jsp 的视图页面。