Spring MVC：HTTP 请求的参数传递2.0

本篇博客接上文:

Spring MVC：Spring 前置知识 & HTTP 请求的参数传递1.0-CSDN博客

1. 传递 json - @RequestBody

1.1 json

1.1.1 什么是 json

1.1.2 json 的语法

1.1.3 json 和 Java 中对象的转换

1.1.4 json 优点

1.2 传递 json

2. 获取路径参数 - @PathVariable

2.1 路径参数 / 请求参数

2.2 如何获取

3. 接收/上传文件

3.1 重命名 - @RequestPart

4. 获取 Cookie

4.1 HTTP - 无状态协议

4.2 cookie / session

4.2.1 sessionid

4.3 获取 Cookie

4.3.1 方法一: HttpServletRequest

4.3.2 方法二: @CookieValue 注解

5. 存储 session

5.1 getSession 方法

6. 获取 Session

6.1 方法一: HttpServletRequest

6.1.1 手动修改 Sessionid => 服务器查找 Session 失败

6.2 方法二: HttpSession

6.3 方法三: @SessionAttribute

7. 获取 header

7.1 方法一: HttpServletRequest

7.2 方法二: @RequestHeader

1. 传递 json - @RequestBody

1.1 json

1.1.1 什么是 json

关于 json, 已经在前面的博客中介绍过了, 这进行一下简单回顾.

json, 是当下最流行的一种数据组织的格式, 并且采用键值对的形式来存储数据. 键和值之间使用 :(冒号) 分割, 键值对和键值对之间使用 ,(逗号) 分割.

json 在保证可读性高的同时, 也尽可能的削减了冗余信息, 降低了网络带宽的消耗.

1.1.2 json 的语法

json 本质是一个字符串, 只不过对字符串的格式进行了约定. 其次, json 的语法格式类似于编程中对象的表示:

语法如下:

数据存储在键值对(Key/ Value)中
键和值之间使用 , 分割
键值对和键值对间使用 : 分割
对象使用 {} 表示
数组使用 [] 表示
每个键的值可以为数组, 也可以为对象, 数组中也可以包含多个对象

1.1.3 json 和 Java 中对象的转换

常见的 json 和 Java 对象的转换工具如下:

gson(谷歌)
fastjson(阿里)
jackson

以上三个流行的第三方库, 均能完成 JSON 数据格式与 Java 对象之间的转化.
(注意, 以上三种方式均是由第三方提供的 Java 库, 使用时需引入依赖)

由于 Spring boot 项目本身自动引入了 Jackson 的依赖, 所以这里使用 Jackson 进行演示.
(spring-boot-starter-web 依赖会自动传递性地包含 jackson-databind 和其他相关的 Jackson 模块，因此在 Spring MVC 中我们不需要手动添加 Jackson 的依赖)

在 Jackson 中, 需要使用 ObjectMapper 类中的两个方法, 实现 json 和对象之间的转换:

writeValueAsString => Java 对象转 json 字符串
readValue => json 字符串转 Java 对象(需要注意, Java 对象接收时, 底层会调用对象的无参构造方法, 所以一定要提供无参构造)

本次我们在 Test 单元测试包下进行代码的演示:

在测试包中, 可以对方法使用 @Test 注解, 使用注解后, 被注解的方法就是一个独立的进程(程序入口), 可以单独的运行(并且可以同时运行多个含 @Test 注解的方法):

public class JsonTest {

    @Test
    /**
     * 对象转 json
     */
    public void object2Json() throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        UserInfo userInfo = new UserInfo();
        // 构建 Java 对象
        UserInfo userInfo1 = new UserInfo("dings", "123", 23);
        // 对象转 json
        String s1 =objectMapper.writeValueAsString(userInfo);
        System.out.println(s1);
    }
    @Test
    /**
     * json 转对象
     */
    public void json2Object() throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        // 构建 json 字符串
        String s1 = "{\"userName\":\"dings\",\"password\":\"123\",\"age\":23}";
        // 注意, 这里使用 UserInfo 对象接收, 需要提供 UserInfo 的无参构造
        UserInfo userInfo = objectMapper.readValue(s1, UserInfo.class);
        System.out.println(userInfo.toString());
    }

}

1.1.4 json 优点

简单易用, 语法简单.
支持跨平台使用.
在保留 xml 可读性高的基础上, 语法更加轻量, 传输时消耗的带宽少
易于扩展, 结构灵活
纯文本格式, 安全性高

1.2 传递 json

若后端接收的是 json 数据, 那么形参需要使用 @RequestBody 注解, 表示该参数与请求 Body 中的数据进行绑定. (json 数据一定是在 body 中进行传输的)

2. 获取路径参数 - @PathVariable

2.1 路径参数 / 请求参数

路径参数:

路径参数是 URL 的一部分，主要用于标识资源.(不包含 IP 和端口号)

请求参数:

存在于 URL 的查询字符串中(? 后面的参数), 以及请求的 Body 中

2.2 如何获取

使用 @PathVariable 来将后端方法上的形参和路径参数进行绑定.

一个 @PathVariable 注解, 绑定一个路径参数, 若想获取多个路径, 需要多次绑定:

并且, 当要获取的路径参数和形参参数的名称不一致时, 可以对 @PathVariable 的 value 重新赋值, 进行重命名操作:

注意:

使用 @PathVariable 后, 对应在 URL 中路径参数必须存在!!(可以理解为必传项).

3. 接收/上传文件

使用 MultipartFile 对象接收文件数据.

接收后, 调用 transferTo 方法可以对该文件进行上传操作:

3.1 重命名 - @RequestPart

当形参名称和前端传递的名称不一致时, 可以使用 @RequestPart 来进行参数绑定:

4. 获取 Cookie

4.1 HTTP - 无状态协议

为什么需要引入 Cookie 和 session 呢??

这是由于 HTTP 是一种无状态协议.

所谓 "无状态", 是指服务器在处理每个请求时不会保存任何关于之前请求的信息, HTTP 协议的 "无状态" 设计, 使得每个请求都是独立的.

简单来说, "无状态", 就是指协议本身不会记录用户信息, 在协议眼中, 每一个用户都是相等的, 不会因为你访问过我, 我就记得你, 我对每一个用户都是公平公正的, 不会因为你访问的多, 我就偏爱你~~

虽然无状态的设计是良好的, 但是在实际开发中, 很多情况下, 我们是需要保留和用户之间的交互信息的, 于是, 便引入了 Cookie.

4.2 cookie / session

在之前的博文中, 已经对 Cookie 和 session 进行了介绍, 这里再进行一下回顾.

Cookie 和 session 的主要区别是: Cookie 存储于客户端(用户的浏览器中), session 存储于服务器端.

Cookie 用来存储用户的偏好设置、会话标识符（如 sessionid ）等信息，以便在用户再次访问网站时, 服务器能够识别用户(例如无需重复登录).

session 中, 保存了用户的详细信息, 存储于服务器中, 并且每一个用户, 都对应着一个唯一的 session 会话.

4.2.1 sessionid

sessionid 是 Cookie 中的一个属性. cookie 和 session 之间通过 sessionid 来进行关联.

最开始, sessionid 是由服务器生成的, 通过 Set-Cookie 发送给客户端. 此后, 客户端发送的请求中都会包含 Cookie(Cookie 中包含了 sessionid), 服务器收到请求后, 就会根据请求中的 sessionid 快速定位到与该用户对应的 session 会话.

sessionid 和 session 一一对应, 并且 sessionid 和 session 构成一组键值对, 存于内存的哈希表中.
请求的 Cookie 中包含了 sessionid, 当请求到达服务器后, 服务器就会根据 sessionid(会话的唯一标识符), 查找到与之相对应的 session 会话(通过 key 查找 value).
sessionid本身不存储用户的相关信息. sessionid 是由服务器生成的唯一标识符，其主要作用是作为 session 的 "唯一标识"，用于在服务器端标识和检索特定的用户会话.

4.3 获取 Cookie

进行了上文的铺垫, 可以来讲如何获取客户端中的 Cookie 了.

获取 Cookie 有以下两种方式:

通过 HttpServletRequest 对象来获取 [推荐]
通过 @CookieValue 注解来获取

在获取 Cookie 前, 我们先手动在客户端上设置 Cookie(服务器可以设置用户的 Cookie, 客户端也可以自己设置 Cookie):

在 postman 的客户端设置 Cookie:

方法一:

方法二:

在浏览器的客户端设置 Cookie:

4.3.1 方法一: HttpServletRequest

Http 请求中所有的内容(包括 URL, sessionID, header, ...) 都包含在 HttpServletRequest 对象中.

因此, HttpServletRequest 不仅能获取 Cookie, 还能获取请求中的其他信息:

其中的 getCookies 方法, 就可以获取 Cookie 的所有信息, 返回一个 Cookie[] 类型的数组:

使用 getKey 和 getValue 方法就可以读出 Cookie 中的 key-value 值.

4.3.2 方法二: @CookieValue 注解

除了使用 HttpServletRequest 获取 Cookie 外, 还可以使用 @CookieValue 注解来获取 Cookie.

使用 @CookieValue 注解来获取 Cookie, 是一个简单的方式, 但是一次只能获取一个 Cookie 值.

若想获取多个 Cookie, 则需要多次使用 @CookieValue 注解.

// 方法1 获取 Cookie(推荐)
    @RequestMapping("/r12")
    public String r12(HttpServletRequest request) {
        Cookie[] cookies = request.getCookies();
        if(cookies != null) {
            for(Cookie cookie : cookies) {
                // Cookie => 键值对形式
                System.out.println(cookie.getName() + ":" + cookie.getValue());
            }
        }
        return "返回 Cookie 成功!!";
    }

    // 方法2 获取 Cookie
    @RequestMapping("/r13")
    public String r13(@CookieValue("name") String name,
                      @CookieValue("age") int age) {
        return "从 Cookie 中获取的 name: " + name +"; age: " + age;
    }

5. 存储 session

站在后端代码角度, 要给用户设置 Session, 必须要先拿到 Session 对象, 再对 Session 对象完成赋值操作.

Spring 中, 可以通过 getSession 方法获取 Session 对象.

5.1 getSession 方法

要获取 Session 对象, 首先需要获取 sessionid, 再根据 Sessionid 在服务器中寻找的 Session.

而 Sessionid 存储在客户端的请求中. 因此, 获取 Session 对象, 仍然需要使用 HttpServletRequest 来获取.(HttpServletRequest 可以获取请求中的所有信息, 包括 Sessionid[见上文])

因此, getSession 是 HttpServletRequest 类中的方法.

获取到 Session 对象后(首次获取的 Session 对象肯定是空的), 就可以使用 setAttribute 来填充对象(填写用户的信息).

注意: Session 是存储在内存中的. 当程序启动时, Spring 会给 Session 申请一定的内存空间来保存用户信息, 也就是说, 如果 Spring 进程进行了重启, 那么它之前存储的 Session 信息就会消失.

其实, getSession 方法有两种形式, 一个上图使用的不带参数的版本; 还有一个是带参数的版本, 可以传入 true / false. 而上图使用的不带参数的版本, 默认传的参数是 true.

即 getSession() == getSession(true).

那么传 true 或者传 false 有什么区别??

getSession 方法, 本质上就是 Spring 通过请求中的 sessionid 来获取 session 的. 而请求中 sessionid 对应的 Session 可能是存在的, 也可能是不存在的.

当 Session 存在时: 不管传 true 还是 false, getSession 返回的都是保存了用户信息的 Session 对象.
当 Session 不存在时: 若 getSession 参数为 false ==> 返回 null; 若 getSession 参数为 true ==> 返回空的 Session 对象.

所以, 存储 Session,时应使用参数为 true 的版本来获取是 Session 对象, 不管 Sessionid 存不存在, 都可以保存用户信息:

当 Sessionid 不存在时, 则创建一个新对象, 后续使用 setAttribute 来初始化
当 Sessionid 存在时, 则获取该 Session, 后续使用 setAttribute 进行替换

// 存储 session ==> session 存储在服务端
    @RequestMapping("/setSession")
    public String setSession(HttpServletRequest request) {
        // 从请求的 Cookie 中获取 sessionID
        // 再根据 sessionID 在服务器端获取 session

        // HttpSession session = request.getSession(true); // 不存在, 返回空的 Session 对象
        // HttpSession session2 = request.getSession(false); // 不存在, 返回 null
        HttpSession session = request.getSession(); // 不存在, 返回空的 Session 对象(默认为 true)
        // 在 Session 中存用户信息
        // 存储在内存中
        session.setAttribute("userName", "丁帅彪");
        session.setAttribute("age", "19");

        return "session 设置并存储成功!!";
    }

6. 获取 Session

上文, 我们只是将用户的信息保存在了服务器的 Session 中, 我们是看不见的.

但是, 我们也可以通过程序来获取 Session 中的信息.

6.1 方法一: HttpServletRequest

方法一,

仍然是通过 HttpServletRequest 中的 getSession 获取 Session 对象.

如果获取成功, 就可以通过 getAttruibute 方法获取 Session 中的信息

6.1.1 手动修改 Sessionid => 服务器查找 Session 失败

之前提到, Session 保存在服务器上, Sessionid 保存在客户端的 Cookie 的上, 我们可以在各个客户端中查看他们的 Sessionid 值(postman 和浏览器属于两个不同的用户, 不同的客户端, 具有不同的 Sessionid):

如果我们手动将客户端保存的 Sessionid 修改成错误的, 那么后续用户发起请求时, 服务器查找 Session 就会查找失败:

6.2 方法二: HttpSession

方法二是方法一的简化, 可以使用 HttpSession 直接接收 session 对象.
(相当于 request.getSession() / request.getSession(true))

6.3 方法三: @SessionAttribute

方法三是方法二的进一步简化, 使用 @SessionAttribute 注解, 直接获得 session 中的信息.
(相当于 session.getAttribute("key 值"))

以上三个获取 Session 的方法, 可以说是一步步进行了简化:

7. 获取 header

获取 header 也有两个方式:

通过 HttpServletRequest 获取
通过 @RequestHeader 获取

7.1 方法一: HttpServletRequest

header 也是请求中的内容, 因此, 也可以通过 HttpServletRequest 中的 getHeader 方法来获取.

因为 header 中也是采用的键值对的形式来存储信息的, 因此, getHeader 也是输入 key 值, 获取对应的 value 值.

一般来说, 一个 http 请求的 header 中, 都会有 User-Agent. 因此, 我们通过代码来获取请求中的 User-Agent:

7.2 方法二: @RequestHeader

方法二, 就是通过注解来获取 header 中的信息.

通过注解获取来 header, 就相当与 request.getHeader("key 值")

    // 方法1 获取 header
    @RequestMapping("/getHeader")
    public String getHeader(HttpServletRequest request) {
        String userAgent = request.getHeader("User-Agent");
        return "获取 header 中的 User-Agent: " + userAgent;
    }

    // 方法2 获取 header
    @RequestMapping("/getHeader2")
    public String getHeader2(@RequestHeader("User-Agent") String userAgent) {
        return "获取 header 中的 User-Agent: " + userAgent;
    }

END