初学springMVC注解大全

Posted 2020-07-31

请求路径上有个id的变量值，可以通过@PathVariable来获取  @RequestMapping(value = "/page/{id}", method = RequestMethod.GET)
@RequestParam用来获得静态的URL请求入参     spring注解时action里用到。

简介：

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

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

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

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

D、处理attribute类型是注解： @SessionAttributes, @ModelAttribute;

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

示例代码：

[java] view plaincopyprint?
@Controller
@RequestMapping("/owners/{ownerId}")
public class RelativePathUriTemplateController {  

  @RequestMapping("/pets/{petId}")
  public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
    // implementation omitted
  }
}
上面代码把URI template 中变量 ownerId的值和petId的值，绑定到方法的参数上。若方法参数名称和需要绑定的uri template中变量名称不一致，需要在@PathVariable("name")指定uri template中的名称。

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

示例代码：

这是一个Request 的header部分：

Host                    localhost:8080
Accept                  text/html,application/xhtml+xml,application/xml;q=0.9
Accept-Language         fr,en-gb;q=0.7,en;q=0.3
Accept-Encoding         gzip,deflate
Accept-Charset          ISO-8859-1,utf-8;q=0.7,*;q=0.7
Keep-Alive              300
@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@RequestHeader("Accept-Encoding") String encoding,
                              @RequestHeader("Keep-Alive") long keepAlive)  {
}
上面的代码，把request header部分的 Accept-Encoding的值，绑定到参数encoding上了， Keep-Alive header的值绑定到参数keepAlive上。

@CookieValue 可以把Request header中关于cookie的值绑定到方法的参数上。

例如有如下Cookie值：

JSESSIONID=415A4AC178C59DACE0B2C9CA727CDD84
参数绑定的代码：

@RequestMapping("/displayHeaderInfo.do")
public void displayHeaderInfo(@CookieValue("JSESSIONID") String cookie)  {
}
即把JSESSIONID的值绑定到参数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；

C) 该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；

示例代码：

@Controller
@RequestMapping("/pets")
@SessionAttributes("pet")
public class EditPetForm {
    @RequestMapping(method = RequestMethod.GET)
 public String setupForm(@RequestParam("petId") int petId, ModelMap model) {
       Pet pet = this.clinic.loadPet(petId);
   model.addAttribute("pet", pet);
   return "petForm";
   }
@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;

示例代码：

[java] view plaincopyprint?
@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 对象；

示例代码：

[java] view plaincopyprint?
@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的示例代码：

[java] view plaincopyprint?
// Add one attribute
// The return value of the method is added to the model under the name "account"
// You can customize the name via @ModelAttribute("myAccount")   

@ModelAttribute
public Account addAccount(@RequestParam String number) {
    return accountManager.findAccount(number);
}
这种方式实际的效果就是在调用@RequestMapping的方法之前，为request对象的model里put（“account”， Account）；

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

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

}
首先查询 @SessionAttributes有无绑定的Pet对象，若没有则查询@ModelAttribute方法层面上是否绑定了Pet对象，若没有则将URI template中的值按对应的名称绑定到Pet对象的各属性上。

package com.jadyer.controller;

import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.SessionAttributes;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;
import org.springframework.web.servlet.view.InternalResourceViewResolver;

/**
 * UserController
 * @author http://blog.csdn.net/jadyer
 * @create Apr 20, 2012 1:23:29 AM
 */
@Controller //指明这是一个Controller
@RequestMapping(value="/mydemo") //类似于命名空间，即访问该Controller时必须加上"/mydemo"在前面
//只要下面的方法中执行model.addAttribute("loginUser","jadyer")那么"loginUser"便被自动放到HttpSession
@SessionAttributes("loginUser")
public class UserController {
	/**
	 * @see 如果在类上指定@RequestMapping并给了值，而在方法上指定@RequestMapping但不给值
	 * @see 这时，以下的两种请求方式，都会被分发到该方法上
	 * @see 第一种:‘http://127.0.0.1:8088/SpringMVC_study/mydemo‘
	 * @see 第二种:‘http://127.0.0.1:8088/SpringMVC_study/mydemo/‘
	 * @see 但，如果我们在某个方法上明确指定了@RequestMapping(value="/")，则第二种请求会被分发到该方法上
	 */
	@RequestMapping
	public String login(){
		System.out.println("login() is invoked");
		return "addSuccess";
	}

	@RequestMapping(value={"/","/add"}) //即访问"/mydemo/"或者"/mydemo/add"，便自动访问该方法
	public String addUser(){
		System.out.println("addUser() is invoked");
		return "addSuccess"; //return逻辑视图
	}

	/**
	 * 简述如何接收前台参数，以及@RequestParam的使用
	 */
	//这里@RequestParam("userID")表明在访问该方法时，必须传个参数过来，并且参数名必须是int型的userID
	//以下三种情况会导致服务器返回HTTP Status 400
	//1)没有传任何参数2)传的参数中没有名为userID的参数3)传了userID参数但其参数值无法转换为int型
	@RequestMapping(value={"/delete"})
	public String deleteUser(@RequestParam("userID") int userID){
		System.out.println("===============" + userID);
		return "addSuccess";
	}
	//这里@RequestParam表明在访问该方法时，至少要把userName参数传过来，否则服务器返回HTTP Status 400
	@RequestMapping("/edit")
	public String editUser(@RequestParam String userName){
		System.out.println("===============" + userName);
		return "addSuccess";
	}
	//这种情况下，无论传不传userName参数，都可以访问到该方法。如果没有传userName，则打印出来的值就是null
	//这里method=RequestMethod.GET用于指定需要以GET方式访问该方法，注意两个以上属性时就要明确value值了
	@RequestMapping(value="/modify", method=RequestMethod.GET)
	public String modifyUser(String userName){
		System.out.println("===============" + userName);
		return "addSuccess";
	}

	/**
	 * 简述如何返回参数给前台，以及前台如何获取参数
	 */
	@RequestMapping("/sayaaa")
	public String sayAaa(String userName, Map<String,Object> map){
		map.put("aaa_name", "aaa_jadyer"); //此时前台使用${aaa_name}即可取值
		return "addSuccess";
	}
	@RequestMapping("/saybbb")
	public String sayBbb(String userName, Model model){
		model.addAttribute("bbb_name", "bbb_jadyer"); //此时前台使用${bbb_name}即可取值
		model.addAttribute("loginUser","jadyer"); //由于@SessionAttributes，故loginUser会被自动放到HttpSession中
		return "addSuccess";
	}
	@RequestMapping("/sayccc")
	public String sayCcc(String userName, Model model){
		model.addAttribute("ccc_jadyer"); //此时默认以Object类型作为key，即String-->string，故前台使用${string}即可取值
		return "addSuccess";
	}

	/**
	 * 简述如何获取javax.servlet.http.HttpServletRequest、HttpServletResponse、HttpSession
	 */
	@RequestMapping("/eat")
	public String eat(HttpServletRequest request, HttpServletResponse response, HttpSession session){
		System.out.println("===============" + request.getParameter("myname"));
		System.out.println("===============" + request.getLocalAddr());
		System.out.println("===============" + response.getLocale());
		System.out.println("===============" + session.getId());
		return "addSuccess";
	}

	/**
	 * 简述客户端跳转时,传参的传递
	 * @see 注意:这种情况下的参数，并不是放到HttpSession中的，不信你可以试一下
	 * @see 注意:即先访问/mydemo/sleep之后，再直接访问/mydemo/eat
	 */
	@RequestMapping("/sleep")
	public String sleep(RedirectAttributes ra){
		ra.addFlashAttribute("redirectName", "redirectValue");
		//等同于return "redirect:/mydemo/eat"; //两种写法都要写绝对路径,而SpringMVC都会为其自动添加应用上下文
		return InternalResourceViewResolver.REDIRECT_URL_PREFIX + "/mydemo/eat";
	}
}