Spring MVC 文件、cookies的接收与REST响应详解

更新时间：2024年09月27日 11:52:06 作者：想进大厂的小王

在SpringMVC中,使用@RequestPart注解可接收文件并处理多部分请求,同时可以通过@CookieValue和HttpServletResponse来获取和设置Cookies,本文介绍Spring MVC 文件、cookies的接收与REST响应,感兴趣的朋友跟随小编一起看看吧

一、接受文件

在 Spring MVC 中，可以使用 @RequestPart 注解来接收文件。这个注解常用于处理复杂的请求，如同时发送 JSON 数据和文件。@RequestPart 非常适用于多部分请求（multipart requests），这在单个请求中同时发送文件和数据。

import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;
@RestController
public class FileUploadController {
    @PostMapping("/upload")
    public String handleFileUpload(
            @RequestPart("file") MultipartFile file,
            @RequestPart("metadata") Metadata metadata) {
        try {
            // 处理文件，例如保存到服务器
            file.transferTo(new File("/path/to/destination/" + file.getOriginalFilename()));
            // 还可以处理元数据
            System.out.println("Image description: " + metadata.getDescription());
            return "File uploaded successfully: " + file.getOriginalFilename();
        } catch (Exception e) {
            return "Error during file upload: " + e.getMessage();
        }
    }
    static class Metadata {
        private String description;
        public String getDescription() {
            return description;
        }
        public void setDescription(String description) {
            this.description = description;
        }
    }
}

HTML 表单

在前端，您可以创建一个表单来发送文件和 JSON 数据。

<form method="POST" action="/upload" enctype="multipart/form-data">
    <input type="file" name="file">
    <input type="hidden" name="metadata" value='{"description":"A sample image"}'>
    <button type="submit">Upload</button>
</form>

确保表单的 enctype 设置为 multipart/form-data。
使用 @RequestPart 时，Spring 需要能够解析和构造请求中的多部分数据，这通常是通过配置 MultipartResolver 实现的。
在 Spring Boot 中，这通常会自动配置。检查安全性问题，尤其是处理文件类型和内容时。

二、Cookies 与 Session

Cookies 和 Session 是用于存储信息、跟踪用户状态和进行用户身份验证的两个非常重要的概念.

Cookies 是小的数据片段，由服务器发送到用户的浏览器，并由浏览器存储。每当同一用户回到该服务器时，浏览器会将这些数据片段发送回服务器。Cookies 常用于保存用户偏好、购物车内容、身份验证令牌等。

特点：

客户端存储：Cookies 存储在用户的浏览器上。
大小限制：每个 Cookie 的大小限制约为 4KB，并且每个域的 Cookie 数量也有限制。
安全性：Cookies 可以通过设置为 HttpOnly 和 Secure 来增强安全性。HttpOnly 防止客户端脚本访问 Cookie，Secure 标记确保 Cookie 仅通过 HTTPS 发送。
持久性：Cookies 可以设置过期时间，即使浏览器关闭后依然存在，直至到达设定的过期时间。

Session

Session 是另一种在服务器上跟踪用户状态的方法。服务器为每个用户创建一个 Session 对象，通常保存在服务器的内存中。每个 Session 都有一个唯一的标识符（通常称为 Session ID），这个标识符会被存储在 Cookie 中（也可通过 URL 重写等方式传递），以便在后续请求中识别用户。

特点：

服务器端存储：Session 数据存储在服务器上，通常在内存中，也可以持久化到数据库或文件系统。
安全性：由于 Session 数据不在客户端展示，它比 Cookie 更安全。
可存储大量数据：相比于 Cookies，Session 可以存储更多的数据，因为数据存储在服务器上。
依赖于 Cookie：尽管 Session 本身存储在服务器上，但 Session ID 通常通过 Cookie 传输，这意味着如果用户禁用了 Cookie，Session 功能可能会受到影响。

三、Spring MVC 与 Cookie

1）获取 Cookie

使用 @CookieValue 注解，可以直接在控制器的方法参数中捕获 Cookie 值。例如，如果想获取名为 sessionId 的 Cookie：

import org.springframework.web.bind.annotation.CookieValue;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class CookieController {
    @GetMapping("/get-cookie")
    public String readCookie(@CookieValue(name = "sessionId", defaultValue = "No Session") String sessionId) {
        return "Session ID: " + sessionId;
    }
}

在这个例子中，@CookieValue 注解用来指定我们想获取的 Cookie 名称。你也可以设置 defaultValue，这样如果指定的 Cookie 不存在，就会使用这个默认值

2）设置 Cookie

要在 Spring MVC 中设置 Cookie，需要创建一个 Cookie 对象，并通过 HttpServletResponse 添加到响应中。这里是一个示例方法，展示如何创建和发送一个新的 Cookie：

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class CookieController {
    @GetMapping("/set-cookie")
    public String setCookie(HttpServletResponse response) {
        Cookie cookie = new Cookie("sessionId", "123456789");
        cookie.setMaxAge(7 * 24 * 60 * 60); // 设置 Cookie 有效期为一周
        cookie.setHttpOnly(true); // 增强安全性，防止客户端脚本访问
        cookie.setPath("/"); // 设置 Cookie 适用的路径
        response.addCookie(cookie);
        return "Cookie set";
    }
}

四、获取header

使用 @RequestHeader 注解轻松地从 HTTP 请求中提取 HTTP 头信息。这个注解可以绑定方法参数到特定的请求头，从而可以在控制器中直接使用这些头信息。可以通过将 @RequestHeader 添加到控制器方法的参数上来获取指定的请求头值。例如，如果你想获取请求中的 User-Agent 和 Accept-Language 头信息，可以这样做：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HeaderController {
    @GetMapping("/get-headers")
    public String getHeaders(
            @RequestHeader("User-Agent") String userAgent,
            @RequestHeader("Accept-Language") String language) {
        return "User-Agent: " + userAgent + "\nAccept-Language: " + language;
    }
}

可选头信息

并非所有头信息在每个请求中都是必需的。你可以使用 required=false 属性来标记一个头信息为可选，这样即使没有提供这个头信息，应用也不会报错：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestHeader;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HeaderController {
    @GetMapping("/optional-header")
    public String getOptionalHeader(@RequestHeader(value = "X-Optional-Header", required = false) String optionalHeader) {
        return optionalHeader != null ? "Optional Header: " + optionalHeader : "No Optional Header Provided";
    }
}

到此这篇关于Spring MVC 文件、cookies的接收，REST响应的文章就介绍到这了,更多相关Spring MVC REST响应内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java Runtime类详解_动力节点Java学院整理
Runtime类封装了运行时的环境。每个 Java 应用程序都有一个 Runtime 类实例，使应用程序能够与其运行的环境相连接。下面通过本文给大家分享Java Runtime类详解，需要的朋友参考下吧
2017-04-04
总结Java的Struts框架的异常处理方法
这篇文章主要介绍了Java的Struts框架的异常处理方法,Struts是Java的SSH三大web开发框架之一,需要的朋友可以参考下
2015-12-12
Spring Boot实现文件上传下载
这篇文章主要为大家详细介绍了Spring Boot实现文件上传下载，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-08-08
Spring Boot 与 kotlin 使用Thymeleaf模板引擎渲染web视图的方法
这篇文章主要介绍了Spring Boot 与 kotlin 使用Thymeleaf模板引擎渲染web视图的方法,本文给大家介绍的非常详细，具有参考借鉴价值，需要的朋友可以参考下
2018-01-01
使用Java和高德地图API将经纬度转换为地理位置信息的步骤
这篇文章详细介绍了如何将GPS坐标转换为人类可读的地理位置,介绍了环境准备、代码实现、异常处理及优化步骤,首先创建LocationFinder类,实现getLocationFromCoordinates方法,利用高德逆地理编码API转换坐标,文中通过代码介绍的非常详细,需要的朋友可以参考下
2024-09-09
详解如何为SpringBoot Web应用的日志方便追踪
在Web应用程序领域,有效的请求监控和可追溯性对于维护系统完整性和诊断问题至关重要,SpringBoot是一种用于构建Java应用程序的流行框架,在本文中,我们探讨了在SpringBoot中向日志添加唯一ID的重要性,需要的朋友可以参考下
2023-11-11
SpringBoot中如何统一接口返回与全局异常处理详解
全局异常处理是个比较重要的功能,一般在项目里都会用到,这篇文章主要给大家介绍了关于SpringBoot中如何统一接口返回与全局异常处理的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
2021-09-09
Java实现通过IP获取IP归属地的方法(离线+在线)
我们都知道安全攻击都是在某台客户机上执行某些恶意操作致使服务端响应异常崩溃亦或响应数据被篡改,首先我想到的是对访问的web端做一个IP的校验,那么我们首先得知道客户端的IP是多少,接下来此文重点介绍如何获得,需要的朋友可以参考下
2023-10-10
Java使用ES Client 调用滚动查询及Elasticsearch滚动查询Scrolling机制
Elasticsearch提供了一种称为"滚动查询"（Scrolling）的机制，用于处理大型数据集的分页查询，这篇文章给大家介绍滚动查询的一般步骤及Java使用ESClient调用滚动查询的方法，感兴趣的朋友一起看看吧
2023-08-08
java如何把逗号分隔的String字符串转int集合
这篇文章主要介绍了java实现把逗号分隔的String字符串转int集合，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06