萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> 程式語言綜合

Java Servlet 讀寫 Cookie 完整實戰:寫入、讀取與最佳實踐

Cookie 基本觀念

Cookie 是伺服器儲存在客戶端(瀏覽器)的小型資料片段,隨每次請求自動送回伺服器。Java Servlet API 提供 javax.servlet.http.Cookie 類別進行操作。

寫入 Cookie:關鍵屬性設定

/**
 * 寫入 Cookie 範例
 * @param response HttpServletResponse
 * @param schoolId 學校 ID(用於區分多租戶)
 * @param username 使用者名稱
 * @param userId 使用者 ID
 */
public void writeCookies(HttpServletResponse response, String schoolId, String username, String userId) {
    // 1. 建立 Cookie(名稱、值)
    // 注意:值若包含特殊字元需 URLEncoder.encode
    String encodedUsername = URLEncoder.encode(username, StandardCharsets.UTF_8);
    
    Cookie usernameCookie = new Cookie("username_" + schoolId, encodedUsername);
    Cookie userIdCookie = new Cookie("userId_" + schoolId, userId);
    
    // 2. 設定存活時間(秒):365 天
    int maxAge = 60 * 60 * 24 * 365;
    usernameCookie.setMaxAge(maxAge);
    userIdCookie.setMaxAge(maxAge);
    
    // 3. 設定路徑:整個網域可存取(預設為當前路徑)
    usernameCookie.setPath("/");
    userIdCookie.setPath("/");
    
    // 4. 安全性設定(生產環境強烈建議)
    // usernameCookie.setSecure(true);     // 僅 HTTPS 傳輸
    // usernameCookie.setHttpOnly(true);   // 防止 XSS,JavaScript 無法讀取
    // usernameCookie.setDomain(".example.com"); // 跨子域共享(可選)
    
    // 5. 寫入回應
    response.addCookie(usernameCookie);
    response.addCookie(userIdCookie);
}

讀取 Cookie:從請求中解析

/**
 * 讀取指定名稱的 Cookie 值
 * @param request HttpServletRequest
 * @param schoolId 學校 ID
 * @return 使用者 ID,找不到回傳 null
 */
public String readUserIdCookie(HttpServletRequest request, String schoolId) {
    Cookie[] cookies = request.getCookies();
    if (cookies == null) {
        return null; // 無任何 Cookie
    }
    
    String targetName = "userId_" + schoolId;
    for (Cookie cookie : cookies) {
        if (targetName.equals(cookie.getName())) {
            return cookie.getValue(); // 找到即返回
        }
    }
    return null; // 未找到
}

/**
 * 批次讀取所有 Cookie 並轉為 Map(常用工具方法)
 */
public Map getAllCookiesAsMap(HttpServletRequest request) {
    Map map = new HashMap<>();
    Cookie[] cookies = request.getCookies();
    if (cookies != null) {
        for (Cookie cookie : cookies) {
            map.put(cookie.getName(), cookie.getValue());
        }
    }
    return map;
}

Spring MVC 中的優雅寫法

Spring 提供 @CookieValue 註解簡化讀取:


public class CookieController {
    
    // 自動綁定,required=false 避免缺失時拋例外
    @GetMapping("/profile")
    public String profile(@CookieValue(value = "userId_{schoolId}", required = false) String userId,
                          @PathVariable String schoolId) {
        if (userId == null) {
            return "redirect:/login";
        }
        return "userProfile";
    }
    
    @PostMapping("/login")
    public String login(HttpServletResponse response, 
                        @RequestParam String username,
                        @RequestParam String schoolId) {
        // 寫入
        Cookie cookie = new Cookie("userId_" + schoolId, username);
        cookie.setMaxAge(60*60*24*365);
        cookie.setPath("/");
        cookie.setHttpOnly(true);
        response.addCookie(cookie);
        return "redirect:/dashboard";
    }
}

安全性最佳實踐清單

風險防護措施
XSS 竊取 Cookie設定 HttpOnly=true(預設 false)
中間人攻擊竊取設定 Secure=true,強制 HTTPS
CSRF 攻擊關鍵操作需驗證 CSRF Token,Cookie 設定 SameSite=Strict/Lax(Servlet 3.1+ 支援)
敏感資料洩漏勿直接存放密碼、Token,改存 Session ID 或加密 Token
超大 Cookie 影響效能單一 Cookie ≤ 4KB,總數 ≤ 20~50 個/域名,盡量精簡

常見問題排查

  • Cookie 不見了:檢查 setPath("/")、setDomain 是否與讀取路徑一致;瀏覽器開發者工具 Application 分頁查看實際儲存狀態。
  • 中文亂碼:寫入前 URLEncoder.encode(value, "UTF-8"),讀取後 URLDecoder.decode(value, "UTF-8")。
  • 跨子域共享:設定 cookie.setDomain(".example.com")(前綴點號),子域 a.example.com、b.example.com 皆可存取。

總結

Cookie 操作核心在於:正確設定 MaxAge、Path、HttpOnly、Secure 四大屬性,搭配編碼處理與安全防護。Spring MVC 的 @CookieValue 讓讀取更簡潔,建議優先使用。

copyright © 萬盛學電腦網 all rights reserved