Java – SpringMVC – RequestMapping注解

简介

从注解名称上我们可以看到，@RequestMapping注解的作用就是将请求和处理请求的控制器方法关联起来，建立映射关系。

SpringMVC 接收到指定的请求，就会来找到在映射关系中对应的控制器方法来处理这个请求。

@RequestMapping注解位置

@RequestMapping 可以注解在类上面，也可以注解在方法上面。

@RequestMapping 在方法

设置映射请求请求路径的具体信息

@Controller
public class Hello {
    @RequestMapping("/index")
    public String index(){
        return "index";
    }
}

上面的代码中，index 方法上面增加了注解 @RequestMapping("/index")

这使得我们需要通过 URL 访问 index 方法时，需要访问【/index】才可以

@RequestMapping 在类

设置映射请求的请求路径的初始信息

当@RequestMapping 注解在类上时，其定位的url将是该方法url的上级目录

@Controller
@RequestMapping("/test")
public class Hello {

    @RequestMapping("/index")
    public String index(){
        // 转发 html 文件名，位置与后缀在 SpringMVC-servlet.xml 中的 viewResolver Bean 设置了视图前缀与视图后缀
        return "index";
    }

    @RequestMapping("/hello")
    public String hello(){
        return "success";
    }
}

上面的代码中，类Hello上面增加了注解 @RequestMapping("/test")

这使得访问 index 方法上的 URL 不再是【/index】 ,而是【/test/index】

同理，hello 方法上的 URL 不再是【/hello】 ,而是【/test/hello】

@RequestMapping注解value属性

@RequestMapping 的默认 value 属性是一个 String[] 数组，也就是说，我们可以设定多个 url 匹配同一个处理方法。

@Controller
public class Hello {
    @RequestMapping({"/index","/abc"})
    public String index(){
        return "index";
    }
}

上面的代码中，配置了@RequestMapping({"/index","/abc"}) ，那么我们可以通过这两个 url 地址进行访问

【/index】和【/abc】都可以访问到 index 方法。

@RequestMapping注解method属性

@RequestMapping 的 method 属性是指浏览器请求时的请求方法，Http请求中有8种请求方法，分别如下

    GET,
    HEAD,
    POST,
    PUT,
    PATCH,
    DELETE,
    OPTIONS,
    TRACE

method 属性 是一个 RequestMethod[] 的枚举数组类型，

    @RequestMapping(value = "/index", method = {RequestMethod.GET, RequestMethod.POST})
    public String index() {
        // 转发 html 文件名，位置与后缀在 SpringMVC-servlet.xml 中的 viewResolver Bean 设置了视图前缀与视图后缀
        return "index";
    }

上面代码中配置了 @RequestMapping(value = "/index", method = {RequestMethod.GET, RequestMethod.POST})

当我们访问【/index】时，必须只能通过【GET】或【POST】方法，否则会报 HTTP 405 错误.

@RequestMapping 的派生 Mapping

在@RequestMapping中分离出来的专用于 Method 的 Mapping

处理get请求的映射-->@GetMapping
处理post请求的映射-->@PostMapping
处理put请求的映射-->@PutMapping
处理delete请求的映射-->@DeleteMapping

    @GetMapping("/hello")
    public String hello() {
        return "success";
    }

可以单独设置 @GetMapping,那么 hello 方法只允许通过【GET】方法访问。

但是目前浏览器只支持get和post，若在form表单提交时，为method设置了其他请求方式的字符串（put或delete），则按照默认的请求方式get处理

若要发送put和delete请求，则需要通过spring提供的过滤器HiddenHttpMethodFilter

@RequestMapping注解params属性

params 属性允许用户对 url 接收的参数进行限制，是一个String[]数组，共4种限制方法

"param "：要求请求映射所匹配的请求必须携带param请求参数

"!param "：要求请求映射所匹配的请求必须不能携带param请求参数

"param=value "：要求请求映射所匹配的请求必须携带param请求参数且param=value

"param!=value "：要求请求映射所匹配的请求必须携带param请求参数但是param!=value

    @RequestMapping(value = "/hello",params = {"username","!password","age=20","gender!=女"})
    public String hello() {
        return "success";
    }

上面代码中表示，请求所传递的参数中，必须同时满足上面4个要求，分别是

1.username 参数必须传递

2.password 参数必须不能传递

3.age 参数值必须是20

4.gender 参数必须不为【女】，gender可以不传（不传表示gender参数一定不是【女】）

@RequestMapping注解的headers属性

headers 属性允许用户对 url 接收的headers请求头进行限制，是一个String[]数组，共4种限制方法

"header "：要求请求映射所匹配的请求必须携带header请求头信息

"!header "：要求请求映射所匹配的请求必须不能携带header请求头信息

"header=value "：要求请求映射所匹配的请求必须携带header请求头信息且header=value

"header!=value "：要求请求映射所匹配的请求必须携带header请求头信息且header!=value

若当前请求满足@RequestMapping注解的 value 和 method 属性，但是不满足headers 属性，此时页面显示 HTTP 404 错误，即资源未找到

    @RequestMapping(value = "/hello", headers = {"referer"})
    public String hello() {
        return "success";
    }

上面代码中设定了 headers = {"referer"} 请求头，referer 请求头是指跳转 url 来源，只有从A页面跳转到B页面时，B页面才会有 referer 请求头，因此这里的代码作用是，如果 url 是直接访问的话，请求头中是没有 referer 的，此时会直接报 HTTP 404 错误。

ant风格路径定义

SpringMVC 支持ant风格的路径匹配定义

？：表示任意的单个字符

    @RequestMapping("user/a?a/hello")
    public String hello() {
        return "success";
    }

上面代码可以通过【user/aaa/hello】、【user/a9a/hello】等等，可以是任意单个字符

*：表示任意的0个或多个字符

    @RequestMapping("user/a*a/hello")
    public String hello() {
        return "success";
    }

上面代码可以通过【user/aa/hello】、【user/aaaa/hello】、【user/aaaaa/hello】等等，可以是任意0个或多个字符

**：表示任意层数的任意目录

    @RequestMapping("user/**/hello")
    public String hello() {
        return "success";
    }

上面代码可以通过【user/aa/hello】、【user/aa/aa/hello】、【user/aa/bb/cc/dd/hello】等等，可以是任意目录访问

注意：在使用**时，只能使用/**/xxx的方式

SpringMVC中的路径中的占位符

在RESTful中的URL传递参数有两种方式，一种是 Param 方式，比如  /userAdd?username=admin

另一种是 Query 方式，比如 /user/add/admin

在Query 中，值【admin】没有明显的 key-value 结构，我们可以通过占位符对【admin】定义一个通用占位符。

SpringMVC路径中的占位符常用于RESTful风格中，当请求路径中将某些数据通过路径的方式传输到服务器中，就可以在相应的@RequestMapping注解的value属性中通过占位符{xxx}表示传输的数据，在通过@PathVariable注解，将占位符所表示的数据赋值给控制器方法的形参

    @RequestMapping("user/add/{username}/{age}")
    public String hello(@PathVariable String username, @PathVariable Integer age) {
        System.out.println("username:" + username + ", age:" + age);
        return "success";
    }

@PathVariable 注解的作用是通过获取@RequestMapping上的 {xxx} 占位符的值，并赋给接收参数中，我们可以通过接收参数接收到 @RequestMapping 接收的值，有多个值则设置多个占位符即可。