@RequestMapping注解详解以及配合@RequestParam和@PathVariable注解的使用

技术交流
1

@RequestMapping注解详解以及配合@RequestParam和@PathVariable注解的使用

@RequestMapping注解

@RequestMapping是一个用来处理请求地址到处理器controller功能方法映射规则的注解，这个注解会将 HTTP 请求映射到 MVC 和 REST 控制器的处理方法controller上，可用于类或方法上。注解在类上，表示类中的所有响应请求的方法都是以该地址作为父路径（模块路径）。

六个基本属性

属性名 描述
value（path） 指定请求的实际访问地址，默认@RequestMapping("url")的值url即为value的值。指定的地址可以是 URI Template 模式。
method 指定请求的method类型，主要有 GET、POST、DELETE、PUT等；
params 指定request中必须包含某些参数值，包含才让该方法处理请求。
headers 指定request中必须包含某些指定的header值，包含才能让该方法处理请求。
consumes 指定处理请求之后返回数据类型，例如application/json，text/html等。
produces 指定返回的内容类型，当且仅当request请求头中的(Accept)类型中包含该指定类型才返回；

@RequestMapping注解的使用

1. @RequestMapping加到类上（给模块命名地址）

访问该类下的所有方法都需要有一个地址前缀 /test+具体方法的path/value才能访问

@Controller
@RequestMapping("test")
public class RequestMappingController {}

2. @RequestMapping写在方法上

2.1 直接写字符串值/value/path，调用当前项目地址/模块/testMapping访问，
	@RequestMapping("testMapping")
    public String testMapping(){
    	return "requestmappingsuccess";//视图解析器前后缀拼接返回页面地址
	}
//或者下面方法都行
@RequestMapping(value = "testMapping")
@RequestMapping(path = "testMapping")
2.2 配置多个链接映射
//通过 /test1 /test2 /test3 和/testurl/下的所有子模块 都能访问
@RequestMapping({"/test1","/test2","/test3","testurl/*"})
@RequestMapping(value = {"/test1","/test2","/test3",,"testurl/*"})
@RequestMapping(path = {"/test1","/test2","/test3",,"testurl/*"})
2.2 method属性的使用

method如果不设置，任何属性都可以访问到，如果设置了，只能访问到设置的提交方式的请求方式。

4中取值：

  • RequestMethod.GET
  • RequestMethod.POST
  • RequestMethod.PUT
  • RequestMethod.DELETE

如果设置了method的值，就只能支持设置值的请求方式，其它请求方式不支持，就会报405错误 – Method Not Allowed

//设置只支持post请求
@RequestMapping(path="testMethod",method = {RequestMethod.POST})
//设置只接收get请求
@RequestMapping(path="testMethod",method = {RequestMethod.GET})
2.3 param属性

指定request中必须包含某些参数值，包含才让该方法处理请求。

//请求中必须要有参数username(页面中的name值)，且参数值要为striveday才执行该方法
@RequestMapping(value="/testParam", params="username = strivedaay")
//请求中必须要有参数username(页面中的name值)，且参数值不为striveday才执行该方法
@RequestMapping(value="/testParam", params="username != strivedaay")
2.4 headers属性

指定request请求作用域中必须包含某些指定的header值，包含才能让该方法处理请求。

    @RequestMapping(value="testHeaders",headers={"context-type=text/plain","context-type=text/html"})
    public String testHeaders(){}
2.5 consumes属性

consumes指定处理请求之后返回数据类型，例如application/json，text/html等

//设置处理请求之后返回值为json数据类型
@RequestMapping(value = "testConsumes",consumes="application/json")
public String testConsumes(@RequestBody User user, Model model) {}
2.6 produces属性

produces用于指定返回的内容类型，当且仅当request请求头中的(Accept)类型中包含该指定类型才返回

//设置请求之后返回数据是json数据类型，且request的请求头中的要有（包含）该类型，才能返回
@RequestMapping(value = "testProduces ",consumes="application/json")
public String testProduces(@RequestBody User user, Model model) {}
2.7 配合使用@RequestParam设置请求参数【***】

使用@RequestParam可以将HTTP请求参数绑定到controller中方法的参数上，实现页面传入参数（name的值）和方法接收参数列表的形式参数名不一致也能进行参数绑定（赋值）

@RequestParam注解有三个属性

  • value：注解中value值要和页面传入的参数名一致。
  • required ： 默认值为true，表示该参数必须给值 ，如果没有给这个值，则出现400页面。
  • defaultValue = “striveday” ：如果给了参数，就获取，如果没有给参数，则默认为striveday。
  • 【小技巧1】@RequestParam默认情况下必须指定参数，可以通过设置required = false，来实现指定参数可选，这样请求不带@RequestParam指定的value参数也可以访问该方法。
  • 【小技巧2】可以设置defaultValue的值，这样就算请求的value参数不带值，就会被defaultValue设置一个默认值，也可以访问该方法。
  • 【小知识1】所有从页面传到后台的数据都是String类型，通过request.getParameter()获取的也是String数据类型，但是Spring会自动的进行String和八大基本数据类型转换。
  • 【小知识2】400错误(HTTP Status 400)：是指错误的请求，url提供的参数和方法指定接收的参数不一致，数类型、个数不一致，参数name名称不一致等等

比如页面传入一个参数username = striveday，可以通过注解@RequestParam()来指定，实现方法参数名和页面传过来的请求参数名不一致也能赋值。

//通过@RequestParam让页面传入的参数username赋值给方法参数列表的name
@RequestMapping("testRequestParam")
    public String getUsername(@RequestParam("username") String name){
    	System.out.println("username = " + name);
 }
2.8 配合使用@PathVariable，实现处理动态URL【***】

@RequestParam和@PathVariable区别：
@RequestMapping是一个用来处理请求URL地址到处理器controller功能方法映射规则的请求参数的值
@PathVariable是请求 URI 中的模版变量部分到处理器功能处理方法的方法参数上的绑定，用来匹配URL路径的规则和模式。

	//testPathVariable/{urlValue} 其中urlValue是占位符
	//以前的url是  /testPathVariable?urlvalue=值  现在变成了/testPathVariable/值
 	@RequestMapping(value = "/testPathVariable/{urlValue}", method = RequestMethod.GET)
    public String getUrlValue (@PathVariable("urlValue") String username){
    	System.out.println("urlValue = " + username);
        return username; 
      }

上面这个方法访问localhost:8080/testPathVariable/参数值 ，不管参数值是什么，都会访问该方法，但是不同的参数值，都会赋值给方法的形式仓鼠username这个。比如你访问localhost:8080/testPathVariable/striveday 和访问localhost:8080/testPathVariable/study 都会访问该方法getUrlValue ，但是他们的赋值给username 不同，输出结果分为urlValue = striveday 和urlValue = study

原文：【SSM - SpringMVC篇】04 - @RequestMapping注解详解，超详细，配合@RequestParam和@PathVariable注解使用_ssm @requestmapping-CSDN博客
作者： strive_day