标签：springmvc   注解   

 林炳文Evankaka原创作品。转载请注明出处http://blog.csdn.net/evankaka

        Spring2.5引入注解式处理器支持,通过@Controller和@RequestMapping注解定义我们的处理器类。并且提供了一组强大的注解需要通过处理器映射DefaultAnnotationHandlerMapping和处理器适配器AnnotationMethodHandlerAdapter来开启支持@Controller和@RequestMapping注解的处理器。

@Controller：用于标识是处理器类；

@RequestMapping：请求到处理器功能方法的映射规则；

@RequestParam：请求参数到处理器功能处理方法的方法参数上的绑定；

@ModelAttribute：请求参数到命令对象的绑定；

一、视图返回

1、返回String对象

	@RequestMapping(value ="/index")//相对于根目录的路径
	public String test(ModelMap model) {
		model.addAttribute("message", "调用FirstController的test方法");
		return "index";//指定页面要跳转的view视图路径
	}

2、返回ModelAndView对象

	@RequestMapping("/index1")
	public ModelAndView test2() {
		ModelAndView modelAndView = new ModelAndView();
		///modelAndView.setView(new RedirectView("index1"));
		modelAndView.setViewName("index1");//指定页面要跳转的view视图路径
		modelAndView.addObject("message", "调用FirstController的test1方法");//第二个参数：指定了要项前台传递的参数，在前台可以这样取值 ${sp_ids }
		return modelAndView;
	}

其中

modelAndView.setViewName("index1");

modelAndView.setView(new RedirectView("index1"));

ModelAndView()

addObject(Object modelObject)
addObject(String modelName, Object modelObject)
addAllObjects(Map modelMap)

二、@RequestMapping

         对于各种注解而言，排第一的当然是“@Controller”,表明某类是一个controller。“@RequestMapping”请求路径映射，如果标注在某个controller的类级别上，则表明访问此类路径下的方法都要加上其配置的路径；最常用是标注在方法上，表明哪个具体的方法来接受处理某次请求。 

@RequestMapping 参数说明

value
定义处理方法的请求的 URL 地址。
method
定义处理方法的 http method 类型，如 GET、POST 等。
params
定义请求的 URL 中必须包含的参数。
headers
定义请求中 Request Headers 必须包含的参数

2.1 拦截路径设置

（1） 方法上的拦截

@Controller
public class FirstController {
	@RequestMapping(value ="/index")//相对于根目录的路径
	public String test(ModelMap model) {
		model.addAttribute("message", "调用FirstController的test方法");
		return "index";//指定页面要跳转的view视图路径
	}
}

（2）类上的拦截

@Controller
@RequestMapping("/user")
public class SecondController {
	@RequestMapping(value ="/index")
	public String test(ModelMap model) {
		model.addAttribute("message", "调用SecondController 的test方法");
		return "index";//指定页面要跳转的view视图路径
	}

	@RequestMapping("/index1")
	public ModelAndView test2() {
		ModelAndView modelAndView = new ModelAndView();
		///modelAndView.setView(new RedirectView("index1"));
		modelAndView.setViewName("index1");//指定页面要跳转的view视图路径
		modelAndView.addObject("message", "调用SecondController 的test1方法");//第二个参数：指定了要项前台传递的参数，在前台可以这样取值 ${sp_ids }
		return modelAndView;
	}	
}

和http://localhost:8080/SpringMVCLearningChapter2/user/index1

即拦截：根目录/user/index和根目录/user/index1

2、param参数

如果想给一个页面设置传递的参数，可以写成如下：

@Controller
@RequestMapping("/third")
public class ThirdController {
	@RequestMapping(value ="/index",params="name")//要求传递参数name,浏览器中输入name后，控制器会自动把参数传递给test中的name
	public String test(ModelMap model,String name) {
		model.addAttribute("message", name);
		return "index";
	}
}

因为它要求你一定要传递一个name参数，所以得这样写：

当然，这里也可以把需要的参数注解到方法的参数上去

	@RequestMapping(value ="/index")//要求传递参数name,浏览器中输入name后，控制器会自动把参数传递给test中的name
	public String test(ModelMap model,@RequestParam("name")String name) {
		model.addAttribute("message", name);
		return "index";
	}

	@RequestMapping(value ="/index")
	public String test(ModelMap model,@RequestParam(value="name",required=false)String name) {
		model.addAttribute("message", name);
		return "index";
	}

	@RequestMapping(value ="/index1",method = RequestMethod.GET,params="name")
	public ModelAndView test2() {
		ModelAndView modelAndView = new ModelAndView();
		///modelAndView.setView(new RedirectView("index1"));
		modelAndView.setViewName("index1");//指定页面要跳转的view视图路径
		modelAndView.addObject("message", "调用SecondController 的test1方法");//第二个参数：指定了要项前台传递的参数，在前台可以这样取值 ${sp_ids }
		return modelAndView;
	}	

method = RequestMethod.POST

@RequestMapping(headers)
headers 的作用也是用于细化映射。只有当请求的 Request Headers 中包含与 heanders 值相匹配的参数，处理方法才会被调用。
@RequestMapping(value = "/specify", headers = "accept=text/*")
public String specify(){
return "example_specify_page";
}
请求的 Request Headers 中 Accept 的值必须匹配 text/* ( 如 text/html )，方法才会被调用。

三、其它常用注解

handler method 参数绑定常用的注解,我们根据他们处理的Request的不同内容部分分为四类：（主要讲解常用类型）

A、处理requet uri 部分（这里指uri template中variable，不含queryString部分）的注解：   @PathVariable;

B、处理request header部分的注解：   @RequestHeader, @CookieValue;

C、处理request body部分的注解：@RequestParam,  @RequestBody;

1、 @PathVariable 

当使用@RequestMapping URI template 样式映射时， 即 /fourth/{num}, 这时的num可通过 @Pathvariable注解绑定它传过来的值到方法的参数上。

示例代码：

@Controller
@RequestMapping("/fourth/{num}")
public class FourthController {
	@RequestMapping(value ="/index/{string}")
	public String test(ModelMap model,@PathVariable("num") int num,@PathVariable("string") String string) {
		model.addAttribute("message", "num="+String.valueOf(num)+"  string="+string);
		return "index";
	}
}

上面代码把URI template 中变量num的值和string的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("num")指定uri template中的名称。

2、 @RequestHeader、@CookieValue

@RequestHeader 注解，可以把Request请求header部分的值绑定到方法的参数上。

	@RequestMapping(value = "/index", method = RequestMethod.GET)  
	   public String  getHello(@RequestHeader ("host") String hostName,  
	        @RequestHeader ("Accept") String acceptType,  
	        @RequestHeader ("Accept-Language") String acceptLang,  
	        @RequestHeader ("Accept-Encoding") String acceptEnc,  
	        @RequestHeader ("Cache-Control") String cacheCon,  
	        @RequestHeader ("Cookie") String cookie,  
	        @RequestHeader ("User-Agent") String userAgent)  
	   {  
	    System.out.println("Host : " + hostName);  
	    System.out.println("Accept : " + acceptType);  
	    System.out.println("Accept Language : " + acceptLang);  
	    System.out.println("Accept Encoding : " + acceptEnc);  
	    System.out.println("Cache-Control : " + cacheCon);  
	    System.out.println("Cookie : " + cookie);  
	    System.out.println("User-Agent : " + userAgent);  
	       return "index";  
	   }

如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {

  //...

}

3、@RequestParam, @RequestBody

@RequestParam

A） 常用来处理简单类型的绑定，通过Request.getParameter() 获取的String可直接转换为简单类型的情况（ String--> 简单类型的转换操作由ConversionService配置的转换器来完成）；因为使用request.getParameter()方式获取参数，所以可以处理get 方式中queryString的值，也可以处理post方式中 body data的值；

B）用来处理Content-Type: 为 application/x-www-form-urlencoded编码的内容，提交方式GET、POST；

@RequestBody

该注解常用来处理Content-Type: 不是application/x-www-form-urlencoded编码的内容，例如application/json, application/xml等；

它是通过使用HandlerAdapter 配置的HttpMessageConverters来解析post data body，然后绑定到相应的bean上的。

因为配置有FormHttpMessageConverter，所以也可以用来处理 application/x-www-form-urlencoded的内容，处理完的结果放在一个MultiValueMap<String, String>里，这种情况在某些特殊需求下使用，详情查看FormHttpMessageConverter api;

示例代码：

@RequestMapping(value = "/something", method = RequestMethod.PUT)
public void handle(@RequestBody String body, Writer writer) throws IOException {
  writer.write(body);
}

4、@SessionAttributes, @ModelAttribute

@SessionAttributes:

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。

该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute 对象；

示例代码：

@Controller
@RequestMapping("/editPet.do")
@SessionAttributes("pet")
public class EditPetForm {
    // ...
}

@ModelAttribute

该注解有两个用法，一个是用于方法上，一个是用于参数上；

用于方法上时：  通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；

用于参数上时： 用来通过名称对应，把相应名称的值绑定到注解的参数bean上；要绑定的值来源于：

A） @SessionAttributes 启用的attribute 对象上；

B） @ModelAttribute 用于方法上时指定的model对象；

C） 上述两种情况都没有时，new一个需要绑定的bean对象，然后把request中按名称对应的方式把值绑定到bean中。

用到方法上@ModelAttribute的示例代码：

@ModelAttribute
public Account addAccount(@RequestParam String number) {
    return accountManager.findAccount(number);
}

用在参数上的@ModelAttribute示例代码：

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet) {
   
}

四、补充讲解

问题： 在不给定注解的情况下，参数是怎样绑定的？

通过分析AnnotationMethodHandlerAdapter和RequestMappingHandlerAdapter的源代码发现，方法的参数在不给定参数的情况下：

若要绑定的对象时简单类型：  调用@RequestParam来处理的。 

若要绑定的对象时复杂类型：  调用@ModelAttribute来处理的。

这里的简单类型指java的原始类型(boolean, int 等)、原始类型对象（Boolean, Int等）、String、Date等ConversionService里可以直接String转换成目标对象的类型；

 林炳文Evankaka原创作品。转载请注明出处http://blog.csdn.net/evankaka

【SpringMVC】注解驱动的控制器详解

标签：springmvc   注解   

原文地址：http://blog.csdn.net/evankaka/article/details/45562951