如何在Spring Boot中使用Cookies

如何在Spring Boot中使用Cookies

一、 導讀

本文大綱

讀取HTTP Cookie

設定HTTP Cookie

讀取所有Cookie[]

為Cookie設定過期時間

Https與Cookie

HttpOnly Cookie

删除Cookie

HTTP Cookie（也稱為Web cookie，浏覽器cookie）是伺服器在使用者浏覽器中存儲的小部分資料。伺服器端應用程式在傳回浏覽器請求響應的時候設定cookie，浏覽器存儲cookie，并将它們在下一個請求一起發送的時候自動帶回伺服器端應用程式。

Cookies提供了一種在伺服器和浏覽器之間交換資訊的方法，以管理會話（登入，購物車，遊戲得分），記住使用者首選項（主題，隐私政策接受）以及跟蹤整個站點的使用者行為。Cookies在一定程度上解放了伺服器端的壓力，因為将一部分資料放在浏覽器端存儲，是以這部分資料不能是涉及應用安全的資料。在本文中，我們将學習如何在Spring Boot應用程式中讀取、設定和删除HTTP cookie。

二、讀取HTTP Cookie

Spring架構提供@CookieValue注釋來擷取HTTP cookie的值，此注解可直接用在控制器方法參數中。

@GetMapping("/")

public String readCookie(@CookieValue(value = "username",

defaultValue = "Atta") String username) {
return "Hey! My username is " + username;           

}

在上述代碼段中，請注意defaultValue = "Atta"。如果沒有設定預設值，并且沒有找到名稱為username的Cookie，Spring将抛出java.lang.IllegalStateException異常。

三、設定HTTP Cookie

要在Spring Boot中設定cookie，我們可以使用HttpServletResponse類的方法addCookie()。您需要做的就是建立一個新的Cookie對象并将其添加到響應中。

@GetMapping("/change-username")

public String setCookie(HttpServletResponse response) {

// 建立一個 cookie對象
Cookie cookie = new Cookie("username", "Jovan");

//将cookie對象加入response響應
response.addCookie(cookie);

return "Username is changed!";           

四、讀取所有Cookie[]

除了使用@CookieValue注解，我們還可以使用HttpServletRequest類作為控制器方法參數來讀取所有cookie。此類提供了getCookies()方法，該方法以數組形式傳回浏覽器發送的所有cookie。

@GetMapping("/all-cookies")

public String readAllCookies(HttpServletRequest request) {

Cookie[] cookies = request.getCookies();
if (cookies != null) {
    return Arrays.stream(cookies)
            .map(c -> c.getName() + "=" + c.getValue())
            .collect(Collectors.joining(", "));
}

return "No cookies";           

五、為Cookie設定過期時間

如果沒有為cookie指定過期時間，則其生命周期将持續到Session過期為止。這樣的cookie稱為會話cookie。會話cookie保持活動狀态，直到使用者關閉其浏覽器或清除其cookie。但是您可以覆寫此預設行為，并使用類的setMaxAge()方法設定cookie的過期時間。

// 建立一個 cookie對象

Cookie cookie = new Cookie("username", "Jovan");

cookie.setMaxAge(7 24 60 * 60); // 7天過期

//将cookie對象加入response響應

response.addCookie(cookie);

現在，usernameCookie不會因為Seesion結束到期，而是會在接下來的7天保持有效。傳遞給setMaxAge()方法的到期時間以秒為機關。到期日期和時間是相對于設定cookie的用戶端而不是伺服器而言的。

六、Https與Cookie

我們需要了解一個概念：什麼的安全的Cookies？安全的cookie是僅可以通過加密的HTTPS連接配接發送到伺服器的cookie。無法通過未加密的HTTP連接配接将cookie發送到伺服器。也就是說，如果設定了setSecure(true)，該Cookie将無法在Http連接配接中傳輸，隻能是Https連接配接中傳輸。

cookie.setSecure(true); //Https 安全cookie

七、HttpOnly Cookie

HttpOnly cookie用于防止跨站點腳本（XSS）攻擊，也就是說設定了Http Only的Cookie不能通過JavaScript的Document.cookieAPI通路，僅能在服務端由伺服器程式通路。

cookie.setHttpOnly(true); //不能被js通路的Cookie

八、删除Cookie

要删除Cookie，需要将Max-Age設定為0，并且将Cookie的值設定為null。不要将Max-Age指令值設定為-1負數。否則，浏覽器會将其視為會話cookie。

// 将Cookie的值設定為null

Cookie cookie = new Cookie("username", null);

//将

Max-Age

設定為0

cookie.setMaxAge(0);

原文位址

https://www.cnblogs.com/zimug/p/11785225.html