@requestMapping参数详解

Posted m0_69523172

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了@requestMapping参数详解相关的知识,希望对你有一定的参考价值。

对应项目jsp位置则是一级路径对应一级文件目录。

如url为/default/index对应项目中webapp/default/index.jsp


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||path

  • JSP 页面

Test RequestMapping

  • controller

@RequestMapping(value=“/testRequestMapping” )

public String testRequestMapping()

System.out.println(“testRequestMapping”);

return SUCCESS;

成功返回success.jsp 。

**Tips :**若 href 属性值,不等于value值,则将提示404错误。


value的uri值为以下三类:

A) 可以指定为普通的具体值;

如下:

@RequestMapping(“/testRequestMapping”)


B) 可以指定为含有某变量的一类值(URI Template Patterns with Path Variables)–restful风格;

@RequestMapping(“/testPathVariable/id”)

public String testPathVariable(@PathVariable Integer id2)

System.out.println("testPathVariable: " + id2);

return SUCCESS;


除了value还有path,二者效果等同,可以参考源码如下图:


其中关于@PathVariable 有如下说明:

① 如果路径中的变量与方法中的变量名一致,可直接使用@PathVariable;

② 如果二者不一致,则使用@PathVariable(Variable)显示指定要绑定的路径中的变量 。

@PathVariable只能绑定路径中的占位符参数,且路径中必须有参数。

@PathVariable用法参考[路径参数绑定参考](()

@RequestMapping(“/testPathVariable/id”)

public String testPathVariable(@PathVariable(“id”) Integer id2)

System.out.println("testPathVariable: " + id2);

return SUCCESS;

//路径中的 id 与 方法中的 id2 绑定

C) 可以指定为含正则表达式的一类值( URI Template Patterns with Regular Expressions);

@RequestMapping(“/spring-web/symbolicName:[a-z-]+-version:\\d.\\d.\\d.extension:.[a-z]”)

public void handle(@PathVariable String version, @PathVariable String extension)

// …


【2】method

  • JSP 页面

Test Method

//href 默认为get 请求。

  • controller–限制接收post 请求。

@RequestMapping(value = “/testMethod”, method = RequestMethod.POST)

public String testMethod()

System.out.println(“testMethod”);

return SUCCESS;

  • result as follows :

HTTP Status 405 - Request method ‘GET’ not supported 。

【状态码405表示:请求 《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》无偿开源 威信搜索公众号【编程进阶路】 中指定的方法不被允许。】

将method 改为method = RequestMethod.GET正常跳转页面。


【3】consumes

  • JSP 页面

仍以testMethod为例,提交表单。

默认contentType为Content-Type:application/x-www-form-urlencoded。


  • controller–限制接收post 请求以及consumes="application/json"

@RequestMapping(value = “/testMethod”, method = RequestMethod.POST,consumes=“application/json”)

public String testMethod()

System.out.println(“testMethod”);

return SUCCESS;

  • result as follows :

【状态码415表示:由于媒介类型不被支持,服务器不会接受请求。。】

去掉 consumes属性,页面正常跳转 !


【4】produces

@RequestMapping 用法详解之地址映射(转)

引言:

前段时间项目中用到了RESTful模式来开发程序,但是当用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 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提交的数据(数据绑定)和返回的数据。

 

 

参考资料:

1、 Spring Web Doc: 

spring-3.1.0/docs/spring-framework-reference/html/mvc.html

以上是关于@requestMapping参数详解的主要内容,如果未能解决你的问题,请参考以下文章

@requestMapping参数详解

Spring MVC之@RequestMapping 详解

@RequestMapping 用法详解之地址映射

[SSM]SpringMVC 详解 @RequestMapping 注解获取请求参数和域数据共享

@RequestMapping 用法详解之地址映射(转)

@RequestMapping 用法详解之地址映射(转)