参数注入

路径参数

路径参数即指处理请求的Uri部分，不含queryString部分，当使用@RequestMapping URI template样式映射时，即 someUrl/{paramId}，这时的paramId可通过@Pathvariable注解绑定它传过来的值到方法的参数上。

@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中的名称。

请求头

Request Header部分的注解包括了@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上。

请求体

@RequestParam常用来处理简单类型的绑定，类似于通过Request.getParameter()获取的String可直接转换为简单类型的情况，简单类型的转换操作由ConversionService配置的转换器来完成。它可以处理get方式中queryString的值，也可以处理post方式中body data的值；用来处理Content-Type为application/x-www-form-urlencoded编码的内容，提交方式GET、POST。

@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";
    }

    // ...

该注解有两个属性： value、required； value用来指定要传入值的id名称，required用来指示参数是否必须绑定；因为配置有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);
}

@SessionAttributes与@ModelAttribute

该注解用来绑定HttpSession中的attribute对象的值，便于在方法中的参数里使用。该注解有value、types两个属性，可以通过名字和类型指定要使用的attribute对象；

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

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

用于方法上时：通常用来在处理@RequestMapping之前，为请求绑定需要从后台查询的model；
用于参数上时：用来通过名称对应，把相应名称的值绑定到注解的参数bean上；

HttpServletRequest & HttpServletResponse

@Autowired HttpServletRequest request;

注意，HttpServletResponse无法使用自动注入进行插入，如果需要获取该对象，可以在具体的Controller方法中加入HttpServletResponse这个参数，譬如：

public DeferredResult<String> autologin(
        @PathVariable String user_id,//路徑參數,在统一的鉴权的Aspect中完成替换
        @RequestParam("requestData") String requestData,//請求數據,
        HttpServletResponse response//固定写法，把HttpServletResponse放在最后
)

这样的话就可以在AOP中获取到response对象。

最近更新于0001-01-01