Spring MVC 文件、cookies的接收與REST響應詳解

更新時間：2024年09月27日 11:52:06 作者：想進大廠的小王

在SpringMVC中,使用@RequestPart注解可接收文件并處理多部分請求,同時可以通過@CookieValue和HttpServletResponse來獲取和設置Cookies,本文介紹Spring MVC 文件、cookies的接收與REST響應,感興趣的朋友跟隨小編一起看看吧

一、接受文件

在 Spring MVC 中，可以使用 @RequestPart 注解來接收文件。這個注解常用于處理復雜的請求，如同時發(fā)送 JSON 數(shù)據(jù)和文件。@RequestPart 非常適用于多部分請求（multipart requests），這在單個請求中同時發(fā)送文件和數(shù)據(jù)。

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()));
            // 還可以處理元數(shù)據(jù)
            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 表單

在前端，您可以創(chuàng)建一個表單來發(fā)送文件和 JSON 數(shù)據(jù)。

<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 需要能夠解析和構(gòu)造請求中的多部分數(shù)據(jù)，這通常是通過配置 MultipartResolver 實現(xiàn)的。
在 Spring Boot 中，這通常會自動配置。檢查安全性問題，尤其是處理文件類型和內(nèi)容時。

二、Cookies 與 Session

Cookies 和 Session 是用于存儲信息、跟蹤用戶狀態(tài)和進行用戶身份驗證的兩個非常重要的概念.

Cookies

Cookies 是小的數(shù)據(jù)片段，由服務器發(fā)送到用戶的瀏覽器，并由瀏覽器存儲。每當同一用戶回到該服務器時，瀏覽器會將這些數(shù)據(jù)片段發(fā)送回服務器。Cookies 常用于保存用戶偏好、購物車內(nèi)容、身份驗證令牌等。

特點：

客戶端存儲：Cookies 存儲在用戶的瀏覽器上。
大小限制：每個 Cookie 的大小限制約為 4KB，并且每個域的 Cookie 數(shù)量也有限制。
安全性：Cookies 可以通過設置為 HttpOnly 和 Secure 來增強安全性。HttpOnly 防止客戶端腳本訪問 Cookie，Secure 標記確保 Cookie 僅通過 HTTPS 發(fā)送。
持久性：Cookies 可以設置過期時間，即使瀏覽器關(guān)閉后依然存在，直至到達設定的過期時間。

Session

Session 是另一種在服務器上跟蹤用戶狀態(tài)的方法。服務器為每個用戶創(chuàng)建一個 Session 對象，通常保存在服務器的內(nèi)存中。每個 Session 都有一個唯一的標識符（通常稱為 Session ID），這個標識符會被存儲在 Cookie 中（也可通過 URL 重寫等方式傳遞），以便在后續(xù)請求中識別用戶。

特點：

服務器端存儲：Session 數(shù)據(jù)存儲在服務器上，通常在內(nèi)存中，也可以持久化到數(shù)據(jù)庫或文件系統(tǒng)。
安全性：由于 Session 數(shù)據(jù)不在客戶端展示，它比 Cookie 更安全。
可存儲大量數(shù)據(jù)：相比于 Cookies，Session 可以存儲更多的數(shù)據(jù)，因為數(shù)據(jù)存儲在服務器上。
依賴于 Cookie：盡管 Session 本身存儲在服務器上，但 Session ID 通常通過 Cookie 傳輸，這意味著如果用戶禁用了 Cookie，Session 功能可能會受到影響。

三、Spring MVC 與 Cookie

1）獲取 Cookie

使用 @CookieValue 注解，可以直接在控制器的方法參數(shù)中捕獲 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，需要創(chuàng)建一個 Cookie 對象，并通過 HttpServletResponse 添加到響應中。這里是一個示例方法，展示如何創(chuàng)建和發(fā)送一個新的 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 頭信息。這個注解可以綁定方法參數(shù)到特定的請求頭，從而可以在控制器中直接使用這些頭信息。可以通過將 @RequestHeader 添加到控制器方法的參數(shù)上來獲取指定的請求頭值。例如，如果你想獲取請求中的 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";
    }
}

到此這篇關(guān)于Spring MVC 文件、cookies的接收，REST響應的文章就介紹到這了,更多相關(guān)Spring MVC REST響應內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: