Spring MVC之@RequestMapping 详解 参数化URL
原文:http://blog.csdn.net/kobejayandy/article/details/12690041
引言:
前段时间项目中用到了REST风格来开发程序,但是当用POST、PUT模式提交数据时,发现服务器端接受不到提交的数据(服务器端参数绑定没有加任何注解),查看了提交方式为application/json, 而且服务器端通过request.getReader() 打出的数据里确实存在浏览器提交的数据。为了找出原因,便对参数绑定(@RequestParam、 @RequestBody、 @RequestHeader 、 @PathVariable)进行了研究,同时也看了一下HttpMessageConverter的相关内容,在此一并总结。
简介:
@RequestMapping
RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
RequestMapping注解有六个属性,下面我们把她分成三类进行说明。
1、 value, method;
value: 指定请求的实际地址,指定的地址可以是URI Template 模式(后面将会说明);
method: 指定请求的method类型, GET、POST、PUT、DELETE等;
2、 consumes,produces;
consumes: 指定处理请求的提交内容类型(Content-Type),例如application/json, text/html;
produces: 指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回;
3、 params,headers;
params: 指定request中必须包含某些参数值是,才让该方法处理。
headers: 指定request中必须包含某些指定的header值,才能让该方法处理请求。
示例:
1、value / method 示例
默认RequestMapping("....str...")即为value的值;
- @Controller
- @RequestMapping("/appointments")
- public class AppointmentsController {
- private final AppointmentBook appointmentBook;
- @Autowired
- public AppointmentsController(AppointmentBook appointmentBook) {
- this.appointmentBook = appointmentBook;
- }
- @RequestMapping(method = RequestMethod.GET)
- public Map<String, Appointment> get() {
- return appointmentBook.getAppointmentsForToday();
- }
- @RequestMapping(value="/{day}", method = RequestMethod.GET)
- public Map<String, Appointment> getForDay(@PathVariable @DateTimeFormat(iso=ISO.DATE) Date day, Model model) {
- return appointmentBook.getAppointmentsForDay(day);
- }
- @RequestMapping(value="/new", method = RequestMethod.GET)
- public AppointmentForm getNewForm() {
- return new AppointmentForm();
- }
- @RequestMapping(method = RequestMethod.POST)
- public String add(@Valid AppointmentForm appointment, BindingResult result) {
- if (result.hasErrors()) {
- return "appointments/new";
- }
- appointmentBook.addAppointment(appointment);
- return "redirect:/appointments";
- }
- }
value的uri值为以下三类:
A) 可以指定为普通的具体值;
B) 可以指定为含有某变量的一类值(URI Template Patterns with Path Variables);
C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);
example B)
- @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";
- }
example C)
- @RequestMapping("/spring-web/{symbolicName:[a-z-]+}-{version:\d\.\d\.\d}.{extension:\.[a-z]}")
- public void handle(@PathVariable String version, @PathVariable String extension) {
- // ...
- }
- }
2 consumes、produces 示例
cousumes的样例:
- @Controller
- @RequestMapping(value = "/pets", method = RequestMethod.POST, consumes="application/json")
- public void addPet(@RequestBody Pet pet, Model model) {
- // implementation omitted
- }
方法仅处理request Content-Type为“application/json”类型的请求。
produces的样例:
- @Controller
- @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")
- @ResponseBody
- public Pet getPet(@PathVariable String petId, Model model) {
- // implementation omitted
- }
方法仅处理request请求中Accept头中包含了"application/json"的请求,同时暗示了返回的内容类型为application/json;
3 params、headers 示例
params的样例:
- @Controller
- @RequestMapping("/owners/{ownerId}")
- public class RelativePathUriTemplateController {
- @RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, params="myParam=myValue")
- public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
- // implementation omitted
- }
- }
仅处理请求中包含了名为“myParam”,值为“myValue”的请求;
headers的样例:
- @Controller
- @RequestMapping("/owners/{ownerId}")
- public class RelativePathUriTemplateController {
- @RequestMapping(value = "/pets", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")
- public void findPet(@PathVariable String ownerId, @PathVariable String petId, Model model) {
- // implementation omitted
- }
- }
仅处理request的header中包含了指定“Refer”请求头和对应值为“http://www.ifeng.com/
”的请求;
上面仅仅介绍了,RequestMapping指定的方法处理哪些请求,下面一篇将讲解怎样处理request提交的数据(数据绑定)和返回的数据。
原文:http://jackyrong.iteye.com/blog/1899913
这次继续复习spring mvc中的@requestmapping;
1) 普通path路径
- @RequestMapping(value = "/foos")
- @ResponseBody
- public String getFoosBySimplePath() {
- return "Get some Foos";
- }
然后尝试用curl请求下
curl -i http://localhost:8080/spring-mvc/foos
2) 指定RequestMethod.POST
- @RequestMapping(value = "/foos", method = RequestMethod.POST)
- @ResponseBody
- public String postFoos() {
- return "Post some Foos";
- }
curl i -X POST http://localhost:8080/spring-mvc/foos
3) 指定http请求头
- @RequestMapping(value = "/foos", headers = "key=val")
- @ResponseBody
- public String getFoosWithHeader() {
- return "Get some Foos with Header";
- }
其中在headers可以跟多个了,如:
- @RequestMapping(value = "/foos", headers = { "key1=val1", "key2=val2" })
- @ResponseBody
- public String getFoosWithHeaders() {
- return "Get some Foos with Header";
- }
注意curl的请求为:
curl -i -H "key:val" http://localhost:8080/spring-mvc/foos
4)@RequestMapping中的新的product和consume.
在spring 3.0中,可以指定请求头的media格式,如:
- @RequestMapping(value = "/foos", method = RequestMethod.GET, headers = "Accept=application/json")
- @ResponseBody
- public String getFoosAsJsonFromBrowser() {
- return "Get some Foos with Header Old";
- }
curl测试:
curl -H "Accept:application/json,text/html" http://localhost:8080/spring-mvc/foos
如果在3.1中,则有新的 produces和consume的属性了,如:
- @RequestMapping(value = "/foos", method = RequestMethod.GET, produces = "application/json")
- @ResponseBody
- public String getFoosAsJsonFromREST() {
- return "Get some Foos with Header New";
- }
如果用3.1,但依然用旧的方式,则旧的方式的请求都会自动变成produces和consume了;
@RequestMapping(value="/testMsgConverter",consumes="text/plain",produces="application/json")
表示handlermethod接受的请求的header中的 Content-Type为text/plain;
Accept为application/json
5) @PathVariable
1 单一的
- @RequestMapping(value = "/foos/{id}")
- @ResponseBody
- public String getFoosBySimplePathWithPathVariable(@PathVariable("id") long id) {
- return "Get a specific Foo with id=" + id;
- }
测试:curl http://localhost:8080/spring-mvc/foos/1
2 多个
- @RequestMapping(value = "/foos/{fooid}/bar/{barid}")
- @ResponseBody
- public String getFoosBySimplePathWithPathVariables(@PathVariable long fooid, @PathVariable long barid) {
- return "Get a specific Bar with id=" + barid + " from a Foo with id=" + fooid;
- }
curl http://localhost:8080/spring-mvc/foos/1/bar/2
3 也支持正则表达式
- @RequestMapping(value = "/bars/{numericId:[\\d]+}")
- @ResponseBody
- public String getBarsBySimplePathWithPathVariable(@PathVariable final long numericId) {
- return "Get a specific Bar with id=" + numericId;
- }
则参数只接受数字了
6) requestparam
- http://localhost:8080/spring-mvc/bars?id=100
- @RequestMapping(value = "/bars")
- @ResponseBody
- public String getBarBySimplePathWithRequestParam(@RequestParam("id") long id) {
- return "Get a specific Bar with id=" + id;
- }
- @RequestMapping(value = "/bars", params = "id")
- @ResponseBody
- public String getBarBySimplePathWithExplicitRequestParam(@RequestParam("id") long id) {
- return "Get a specific Bar with id=" + id;
- }
7) RequestMapping支持多个映射路径映射到同一个controller,如:
- @RequestMapping(value = { "/advanced/bars", "/advanced/foos" })
- @ResponseBody
- public String getFoosOrBarsByPath() {
- return "Advanced - Get some Foos or Bars";
- }
curl -i http://localhost:8080/spring-mvc/advanced/foos
curl -i http://localhost:8080/spring-mvc/advanced/bars
甚至还支持put,post同时请求,如:
- @RequestMapping(value = "/foos/multiple", method = { RequestMethod.PUT, RequestMethod.POST })
- @ResponseBody
- public String putAndPostFoos() {
- return "Advanced - PUT and POST within single method";
- }
curl -i -X POST http://localhost:8080/spring-mvc/foos/multiple
curl -i -X PUT http://localhost:8080/spring-mvc/foos/multiple