Spring MVC & 常用注解

过程解析：http://www.cnblogs.com/dreamworlds/p/5396209.html

spring mvc细节笔记：http://starscream.iteye.com/

HandlerMapping：映射处理器，生成处理器执行链，找到相应的Handler。   遍历所有已经注册的HandlerMapping来找到相应的Handler，构建一个HandlerExecutionChain，它包含了handler和handlerMapping本身的一些拦截器。Spring mvc 使用HandlerMapping来找到url对应的处理handler对象（HandlerMethod对象）。

HandlerAdapter：处理器适配，找到合适的HandlerAdapter，然后由它来调度执行handler的方法。  遍历所有的HandlerAdapter，判断他们是否支持这个handler。

HandlerMapping接口的实现:

• BeanNameUrlHandlerMapping：通过对比url和bean的name找到相应的对象

• SimpleUrlHandlerMapping:直接配置url和对应bean，BeanNameURLHandlerMapping功能更多

• DefaultAnnotationHandlerMapping：主要针对注解配置@RequestMapping的，已过时

• RequestMappingHandlerMapping：取代上面一个

HandlerAdapter接口实现：

• HttpRequestHandlerAdapter：要求handler实现HttpRequestHandler接口，该接口的方法为void handlerRequest（HttpServletRequest request，HttpServletResponse response），也就是handler必须有一个handlerRequest方法

• SimpleControllerHandlerAdapter：要求handler实现Controller接口，该接口的方法为ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)，也就是本工程采用的 

• AnnotationMethodHandlerAdapter ：和上面的DefaultAnnotationHandlerMapping配对使用的，也已过时 

• RequestMappingHandlerAdapter : 和上面的RequestMappingHandlerMapping配对使用，针对@RequestMapping 

 Spring MVC工作流程

1. 用户向服务器发送请求，请求被Spring 前端控制Servlet DispatcherServlet捕获；

2. DispatcherServlet对请求URL进行解析，得到请求资源标识符（URI）。然后根据该URI，调用HandlerMapping获得该Handler配置的所有相关的对象（包括Handler对象以及Handler对象对应的拦截器），最后以HandlerExecutionChain对象的形式返回；

3. DispatcherServlet 根据获得的Handler，选择一个合适的HandlerAdapter。（附注：如果成功获得HandlerAdapter后，此时将开始执行拦截器的preHandler(...)方法）

4.提取Request中的模型数据，填充Handler入参，开始执行Handler（Controller)。 在填充Handler的入参过程中，根据你的配置，Spring将帮你做一些额外的工作：

• HttpMessageConveter： 将请求消息（如Json、xml等数据）转换成一个对象，将对象转换为指定的响应信息；
• 数据转换：对请求消息进行数据转换。如String转换成Integer、Double等；
• 数据根式化：对请求消息进行数据格式化。 如将字符串转换成格式化数字或格式化日期等；

• 数据验证： 验证数据的有效性（长度、格式等），验证结果存储到BindingResult或Error中。

 5.Handler执行完成后，向DispatcherServlet 返回一个ModelAndView对象；

 6.根据返回的ModelAndView，选择一个适合的ViewResolver（必须是已经注册到Spring容器中的ViewResolver)返回给DispatcherServlet ；

7. ViewResolver 结合Model和View，来渲染视图；

8. 将渲染结果返回给客户端。

HandlerMapping和HandlerAdapter的来源问题：http://www.cnblogs.com/dreamworlds/p/5396209.html

1、detectAllHandlerMappings是DispatcherServlet的一个属性，可以在web.xml中配置，默认为true。如果为true，则会去从本工程mvc-servlet.xml文件中（当前系统中）去探测所有实现了HandlerMapping的bean，如果有，则加入DispatcherServlet的HandlerMappings中。

2、如果detectAllHandlerMappings为false（只希望spring MVC 加载指定的handlerMapping时），则直接去容器中找id=”handlerMapping”且实现了HandlerMapping的bean（作为当前系统中唯一的HandlerMapping）。

3、如果都没找到（ 没有定义handlerMapping的话，则spring mvc将按照org.springframework.web.servlet.DispatcherServlet所在目录下的DispatcherServlet.properties中所定义的org.springframework.web.servlet.HandlerMapping的内容来加载缺省的handlerMapping（用户没有自定义Strategies的情况下）），则会去加载默认的HandlerMapping。
缺省情况下spring mvc 将加载 当前系统中所有实现了HandlerMapping接口的bean。如果只期望spring mvc加载指定的handlermapping时，可以修改web.xml中的DispatcherServlet的初始参数，将detectAllHandlerMappings的值设置为false。


<mvc:annotation-driver>
代码
@Controller
public class StringAction {
    
    @ResponseBody
    @RequestMapping(value="/string",method=RequestMethod.GET)
    public String testMessageConverter(String name) {
       System.out.println(name);
       return name;
       
    }
}

@Controller使得StringAction这个handler纳入RequestMappingHandlerMapping管理，RequestMappingHandlerMapping会将这个Handler和handler中每一个含有@RequestMapping的方法都会构建成一个HandlerMethod对象，该类的构造函数为HandlerMethod（Object bean,Method method），经过这样的包装之后将构造的HandlerMethod对象作为新的handler，然后进行选择适配器，进行方法调用，当RequestMappingHandlerAdapter判断是否support一个类时，是依据当前的handler是否是HandlerMethod类型。若是则由RequestMappingHandlerAdapter来调度执行该handler（handler为HandlerMethod类型）中的Method方法。

第一步要弄清RequestMappingHandlerMapping在初始化时是如何寻找它所管辖的bean：RequestMappingHandlerMapping的父类AbstractHandlerMethodMapping在初始化时，会调用initHandlerMethods，在该方法中，遍历所有的bean然后判断是否含有@Controller或者@RequestMapping注解。
DefaultAnnotationHandlerMapping将扫描当前所有注册的spring bean中的@requestmapping标注以找到url和handler method处理函数的关系并予以关联。

Spring MVC通过HandlerAdapter来实际调用处理函数（匹配到handler的某个处理函数上，然后执行这个函数）。 

以AnnotationMethodHandlerAdapter为例 

DispatcherServlet中根据handlermapping找到对应的handler method后，首先检查当前工程中注册的所有可用的handlerAdapter,根据handlerAdapter中的supports方法找到可以使用的handlerAdapter。通过调用handlerAdapter中的handle方法来处理及准备handler method中的参数及annotation(这就是spring mvc如何将reqeust中的参数变成handle method中的输入参数的地方)，最终调用实际的handle method

 view

Spring MVC使用ViewResolver来根据controller中返回的view名关联到具体的View对象。使用View对象来渲染返回值以生成最终的视图，如html,json或pdf等。

Spring MVC中，通过在servlet context配置文件中配置的ViewResolver Bean对象来注册ViewResolver对象，其在spring mvc的dispatcherServlet中的使用过程其实和之前提到的HandlerMapping和HanderAdapter类似。

DispatcherServlet初始化时，首先根据当前context中注册的Beans中实现了ViewResolver接口的Bean列表来生成ViewResolver对象列表，并根据这些ViewResolver中的order属性进行排序，如果没配置order属性则此ViewResolver的优先级最低。

当HandlerAdapter调用完毕handler method返回view对象时，dispatcherServlet将根据当前已经注册了的ViewResolver列表的顺序去调用其中的resolveViewName方法，以根据viewName找到实际对应的View对象，并根据第一个返回的View对象中的render方法来生成最终的用户视图。

与HandlerMapping和HanderAdapter类似，DispatcherServlet也提供了参数来允许用户指定是否只加载自己的ViewResolver，当属性detectAllViewResolvers设置为false时，则spring mvc将查找名为viewResolver的bean 来作为当前唯一的ViewResolver。

Spring MVC的常用注解

1. @Controller 

@Controller 负责注册一个bean 到spring 上下文中，bean 的ID 默认为类名称开头字母小写,你也可以自己指定，如下 
• 方法一： 
@Controller 
public class TestController {} 
• 方法二：            
@Controller("tmpController") 

public class TestController {} 

2. @Autowired

@Autowired注解是按类型装配依赖对象，默认情况下它要求依赖对象必须存在，如果允许null值，可以设置它required属性为false。如果我们想使用按名称装配，可以结合@Qualifier注解一起使用。如下：
@Autowired  @Qualifier("personDaoBean") 

    private PersonDao  personDao; 

3. @Resource

@Resource注解和@Autowired一样，也可以标注在字段或属性的setter方法上，但它默认按名称装配。名称可以通过@Resource的name属性指定，如果没有指定name属性，当注解标注在字段上，即默认取字段的名称作为bean名称寻找依赖对象，当注解标注在属性的setter方法上，即默认取属性名作为bean名称寻找依赖对象。
@Resource(name=“personDaoBean”) 
 private PersonDao  personDao;//用于字段上 
注意：如果没有指定name属性，并且按照默认的名称仍然找不到依赖对象时， @Resource注解会回退到按类型装配。但一旦指定了name属性，就只能按名称装配了。

当需要在某个类中定义一个属性，并且该属性是一个已存在的bean，要为该属性赋值或注入时在该属性上一行使用@Resource(name="xxx")，相当于为该属性注入一个名称为xxx的bean。

4. @RequestMapping

4.1 @RequestMapping用来定义访问的URL，你可以为整个类定义一个@RequestMapping，或者为每个方法指定一个。 把@RequestMapping放在类级别上，这可令它与方法级别上的@RequestMapping注解协同工作，取得缩小选择范围的效果。 
例如： 
@RequestMapping("/test") 
public class TestController {} 
则，该类下的所有访问路径都在/test之下。 
 
4.2 将@RequestMapping用于整个类不是必须的，如果没有配置，所有的方法的访问路径配置将是完全独立的，没有任何关联。 
 
4.3 完整的参数项为：@RequestMapping(value="",method ={"",""},headers={},params={"",""})，各参数说明如下：
• value :String[] 设置访问地址 ；
• method: RequestMethod[]设置访问方式，字符数组，查看RequestMethod类，包括GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE,常用RequestMethod.GET，RequestMethod.POST ；
• headers:String[] headers一般结合method = RequestMethod.POST使用 ；
• params: String[] 访问参数设置，字符数组 例如：userId=id 。


value的配置还可以采用模版变量的形式 ，例如：@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)，这点将在介绍@PathVariable中详细说明。 
 @RequestMapping params的补充说明，你可以通过设置参数条件来限制访问地址，例如params="myParam=myValue"表达式，访问地址中参数只有包含了该规定值"myParam=myValue"才能匹配得上，类似"myParam"之类的表达式也是支持的，表示当前请求的地址必须有该参数(参数的值可以是任意)，"!myParam"之类的表达式表明当前请求的地址不能包含具体指定参数"myParam"。 
 

4.4有一点需要注意的，如果为类定义了访问地址为*.do,*.html之类的，则在方法级的@RequestMapping，不能再定义value值，否则会报错。

5. @PathVariable 

5.1 @PathVariable用于方法中的参数，表示方法参数绑定到地址URL的模板变量。 
例如： 
Java代码  
@RequestMapping(value="/owners/{ownerId}", method=RequestMethod.GET)  
public String findOwner(@PathVariable String ownerId, Model  model) {  
  Owner owner = ownerService.findOwner(ownerId);    
  model.addAttribute("owner", owner);    
  return "displayOwner";  
}  
 
5.2 @PathVariable用于地址栏使用{xxx}模版变量时使用。 
如果@RequestMapping没有定义类似"/{ownerId}" ，这种变量，则使用在方法中@PathVariable会报错。

6. @ModelAttribute

6.1 应用于方法参数,参数可以在页面直接获取，相当于request.setAttribute(,) ；
6.2 应用于方法,将任何一个拥有返回值的方法标注上 @ModelAttribute，使
其返回值将会进入到模型对象的属性列表中；
6.3 应用于方法参数时@ModelAttribute("xx"),须关联到Object的数据类型，基本数据类型 如：int,String不起作用 。
例如： 
Java代码  
@ModelAttribute("items")//<——①向模型对象中添加一个名为items的属性  
public List<String> populateItems() {  
        List<String> lists = new ArrayList<String>();  
        lists.add("item1");  
        lists.add("item2");  
        return lists;  
}  
@RequestMapping(params = "method=listAllBoard")  
public String listAllBoard(@ModelAttribute("currUser")User user,  ModelMap model) {  
        bbtForumService.getAllBoard();  
        //<——②在此访问模型中的items属性  
        System.out.println("model.items:" + ((List<String>)model.get("items")).size());  
        return "listBoard";  
}  
在 ① 处，通过使用 @ModelAttribute 注解，populateItem() 方法将在任何请求处理方法执行前调用，Spring MVC 会将该方法返回值以“items”为名放入到隐含的模型对象属性列表中。 
ModelMap: ModelMap对象主要用于传递控制方法处理数据到结果页面，把结果页面上需要的数据放到ModelMap对象中。不需要用户手动创建。
所以在 ② 处，我们就可以通过 ModelMap 入参访问到 items 属性，当执
行 listAllBoard() 请求处理方法时，② 处将在控制台打印出“model.items:2”的信息。当然我们也可以在请求的视图中访问到模型对象中的 items 属性。

7. @ResponseBody 

这个注解可以直接放在方法上，表示返回类型将会直接作为HTTP响应字节流输出(不被放置在Model，也不被拦截为视图页面名称)。可以用于ajax。 

8. @RequestParam 

@RequestParam是一个可选参数，例如：@RequestParam("id") 注解，所以
它将和URL所带参数 id进行绑定 。如果入参是基本数据类型（如 int、long、float 等），URL 请求参数中一定要有对应的参数，否则将抛出 org.springframework.web.util.NestedServletException 异常，提示无法将 null 转换为基本数据类型。
@RequestParam包含3个配置 @RequestParam(required = ,value="", defaultValue = "") 
  required :参数是否必须，boolean类型,可选项，默认为true 
  value: 传递的参数名称，String类型,可选项，如果有值，对应到设置方法的参数 
  defaultValue:String类型,参数没有传递时为参数默认指定的值 

9. @SessionAttributes session管理 

Spring 允许我们有选择地指定 ModelMap 中的哪些属性需要转存到 session 中，以便下一个请求所对应的 ModelMap 的属性列表中还能访问到这些属性（ModelMap中的属性作用域是request级别的，当本次请求结束后，ModelMap中的属性将销毁）。这一功能是通过类定义处标注 @SessionAttributes 注解来实现的。@SessionAttributes 只能声明在类上，而不能声明在方法上。
  @SessionAttributes("currUser") // 将ModelMap中属性名为currUser 的属性放入session中
  @SessionAttributes({"attr1","attr2"}) ，通过字符串数组的方式指定多个属性
  @SessionAttributes(types = User.class) ，通过属性类型指定要session化的ModelMap属性
  @SessionAttributes(types = {User.class,Dept.class}) ，指定多个类型
  @SessionAttributes(types = {User.class,Dept.class},value={"attr1","attr2"}) ，联合属性名和属性类型指定

10.  @CookieValue 获取cookie信息 

@RequestHeader 获取请求的头部信息