SpringMVC之控制器注解、请求映射注解、请求参数注解

1391 字

7 分钟

SpringMVC之控制器注解、请求映射注解、请求参数注解

2022-03-02

Java

/

SpringMVC

/

Http

SpringMVC之控制器注解、请求映射注解、请求参数注解#

控制器注解 `@Controller`#

这是一个普通的类

1
class Normal {
2
    public String getHtml() {
3
        return "Hello World!";
4
    }
5
}

在类名前一行加上控制器注解

1
@Controller
2
class Normal {
3
    public String getHtml() {
4
        return "Hello World!";
5
    }
6
}

SpringMVC 将此类识别为控制器。

请求映射注解 `@RequestMapping`#

但这样只加一个控制器注解是不能正常使用的,程序需要知道它接收什么路径的请求，再调用这个方法 (getHtml)。

1
@Controller
2
class Normal {
3
    @RequestMapping("/")
4
    public String getHtml() {
5
        return "Hello World!";
6
    }
7
}

此时我们可以访问 http://localhost:8080/ 浏览器显示的却是

Whitelabel Error Page

This application has no explicit mapping for /error, so you are seeing this as a fallback.

Wed Mar 02 17:14:22 CST 2022 There was an unexpected error (type=Not Found, status=404). No message available

那是因为没有添加 @ResponseBody 注解，所以程序不能返回内容。但此时方法体依然是执行了的。

响应体注解 `@ResponseBody`#

如果你修改为

1
@Controller
2
class Normal {
3
    @RequestMapping("/")
4
    public String getHtml() {
5
        System.out.println("test1");
6
    }
7
}

我们可以在控制台看到 test1 ，可以证明方法是执行了的。

那好，我们再在方法前加上 @ResponseBody

1
@Controller
2
class Normal {
3
    @RequestMapping("/")
4
    @ResponseBody
5
    public String getHtml() {
6
        return "Hello World!";
7
    }
8
}

再去访问 http://127.0.0.1:8080/，就可以看到浏览器显示的是 Hello World!，使用了改方法的返回值作为网页 (html)。

由于是网页，我们可以在其中构造（写入）html,css,js 等代码，但不在本文讨论范围内。

详细解释#

我们可以注意到@RequestMapping注解中有一个参数,它指定了当用户访问的路径是何值时，调用被此 @RequestMapping 注解的方法。它是一个默认参数，这个参数名是 value (或 path) 也就是说

1
@RequestMapping("/a")
2
等价于
3
@RequestMapping(value = "/a")
4
等价于
5
@RequestMapping(path = "/a")

@RequestMapping 的 value 属性还可以是一个 String[] 类型的字符串列表

假设有如下代码

1
@Controller
2
class Normal {
3
    @RequestMapping(value={
4
        "/",
5
        "/www",
6
        "/my"
7
    })
8
    @ResponseBody
9
    public String getHtml() {
10
        return "Hello World!";
11
    }
12
}

那么我们可以访问三个网址，指向同一个页面

1
http://127.0.0.1:8080/
2
http://127.0.0.1:8080/www/
3
http://localhost:8080/my/

127.0.0.1 == localhost

类似的，我们可以在类的前一行加上这个注解，这就相当于在每个方法前的”请求映射注解的路径”前加上类前注解的路径，比如

1
@Controller
2
@RequestMapping("/home")
3
class Normal {
4
    @RequestMapping("/my")
5
    @ResponseBody
6
    public String getHtml() {
7
        return "Hello World!";
8
    }
9
}

这样我们需要访问 http://127.0.0.1:8080/home/my 才能访问到该网页。

RequestMapping 的 value 值大小写敏感。

将以上三点组合起来…

1
@Controller
2
@RequestMapping(path = {"A","B"})
3
public class MyController {
4
    @RequestMapping(value = {"1","2"})
5
    @ResponseBody
6
    public String getHtml() {
7
        System.out.println("1");
8
        return "Hello World!";
9
    }
10
}

则以下链接都可以访问到该网页,它是两个路径参数的有序组合

1
http://127.0.0.1:8080/A/1
2
http://127.0.0.1:8080/B/1
3
http://127.0.0.1:8080/A/2
4
http://127.0.0.1:8080/B/2

@RequestMapping 的 params 参数#

params参数用于缩小请求的匹配范围

例如，在访问同一路径时

1
@RequestMapping(value = "/",params = "id")

意味着该参数 id 必须存在于请求中。

1
@RequestMapping(value = "/",params = "id=114514")

意味着该参数 id 必须存在于请求中，并且值为 114514 。

注意：访问同一路径下，不能同时有两种歧义的判定

例如

1
package io.github.siltal.web;
2

3
import org.springframework.stereotype.Controller;
4
import org.springframework.web.bind.annotation.RequestMapping;
5
import org.springframework.web.bind.annotation.ResponseBody;
6

7

8
@Controller
9
public class MyController {
10
    static void log(Integer i) {
11
        log(String.valueOf(i));
12
    }
13

14
    static void log(String message) {
15
        System.out.println(message);
16
    }
17

18
    @RequestMapping(value = "/")
19
    @ResponseBody
20
    public String getHtml_default(String id) {
21
        //没有参数限制，不出现参数中不含键id即可进入此方法
22
        log("default");
23
        return "default";
24
    }
25
    @RequestMapping(value = "/",params = "id")
26
    @ResponseBody
27
    public String getHtml0(String id) {
28
        //参数中含有id就会进入此方法
29
        log("has 'id' parameter");
30
        return "has 'id' parameter";
31
    }
32

33

34
    @RequestMapping(value = "/",params = "id=1")
35
    @ResponseBody
36
    public String getHtml1(String id) {
37
        //参数中含有id并且值为1就会进入此方法,与参数中含有id就会进入方法 getHtml0 冲突
38
        log("parameter 'id' = 1 ");
39
        return "parameter 'id' = 1 ";
40
    }
41

42
}

@RequestMapping 的 Method#

当@RequestMapping含有 method 属性，则该方法只能接收指定的 Http Method ，可以在相同的映射路径值下，区分不同的 method 。

1
@Controller
2
public class MyController {
3
    @RequestMapping(value="/",method = RequestMethod.GET)
4
    @ResponseBody
5
    public String getHtml(@RequestParam("uname") String username,@RequestParam("pwd")String password){
6
        return String.format("Username: [%s]<br>Password: [%s]",username,password);
7
    }
8
}

可以指定请求过滤以下请求方法

1
public enum RequestMethod {
2
    GET,
3
    HEAD,
4
    POST,
5
    PUT,
6
    PATCH,
7
    DELETE,
8
    OPTIONS,
9
    TRACE;
10

11
    private RequestMethod() {
12
    }
13
}

Http 请求方式与 GET 请求的传参方式#

什么是Http请求方式 HTTP 定义了一组请求方法，以表明要对给定资源执行的操作。指示针对给定资源要执行的期望动作。虽然他们也可以是名词, 但这些请求方法有时被称为HTTP动词。

wikipeidia

MDN

常用的 GET 方法，和 POST 方法：

GET:
- 使用 http://url[:port]/path/to/site?key1=value1&key2=value2 的形式发送数据，数据长度不大，大约为 2000 个字符（取决于浏览器和服务器）
- 暴露于URL的参数，不安全
POST:
- POST的数据在 RequestBody 中，数据长度大，1MB 到 4GB（取决于浏览器和服务器）
- 比GET数据安全一些，取决于请求体的数据加密

被 @RequestMapping与@ResponseBody 注解的方法处理传入的数据，并返回网页文档字符串

1
@Controller
2
public class MyController {
3
    @RequestMapping("/")
4
    @ResponseBody
5
    public String getHtml(String username,String password){
6
        return String.format("你输入的用户名是%s<br>你输入的密码是%s",username,password);
7
    }
8
}

GET 参数中的字段名与方法的形参名相同,浏览器访问http://127.0.0.1:8080/?username=45&password=114514即可。

我们可以使用 @RequestParam 注解来给参数做映射，从GET参数的字段名映射到方法的形参名

1
@Controller
2
public class MyController {
3
    @RequestMapping("/")
4
    @ResponseBody
5
    public String getHtml(@RequestParam("uname") String username,@RequestParam("pwd")String password){
6
        return String.format("Username: [%s]<br>Password: [%s]",username,password);
7
    }
8
}

则我们应该访问 http://127.0.0.1:8080/?uname=45&pwd=114514

@PathVariable#

RESTful 风格使用占位符获取参数

组合注解#

一个注解，两个功能

1
@Getmapping("/demo3_3")
2
等价于
3
@RequestMapping(value="/demo3",method = RequestMethod.GET)

类似的还有

1
@RequestMapping
2
@DeleteMapping
3
@PutMapping
4
@GetMapping
5
@PatchMapping
6
@PostMapping

SpringMVC之控制器注解、请求映射注解、请求参数注解

https://siltal.github.io/posts/springmvc之控制器注解请求映射注解请求参数注解/

作者

Siltal

发布于

2022-03-02

许可协议

CC BY-NC-SA 4.0

MagicNet

node-media-server + OBS + SakuraFrp 自建推流服务器

1

SpringMVC之控制器注解、请求映射注解、请求参数注解

控制器注解 @Controller

请求映射注解 @RequestMapping

响应体注解 @ResponseBody

详细解释

@RequestMapping 的 params 参数

@RequestMapping 的 Method

Http 请求方式与 GET 请求的传参方式

@PathVariable

组合注解

SpringMVC之控制器注解、请求映射注解、请求参数注解#

控制器注解 @Controller#

请求映射注解 @RequestMapping#

响应体注解 @ResponseBody#

详细解释#

@RequestMapping 的 params 参数#

@RequestMapping 的 Method#

Http 请求方式 与 GET 请求的传参方式#

@PathVariable#

组合注解#

控制器注解 `@Controller`#

请求映射注解 `@RequestMapping`#

响应体注解 `@ResponseBody`#

Http 请求方式与 GET 请求的传参方式#