Cookie 是 HTTP 無狀態特性下的經典解方,在 iOS 開發中則由 NSHTTPCookie 與 NSHTTPCookieStorage 兩個類別負責。本文從伺服器端設定開始,一路談到客戶端的存取與刪除。
// 設定 cookie
function cookie(req, res) {
// 印出客戶端上傳的 cookie
console.log("client cookie: " + req.headers.cookie);
var today = new Date();
var time = today.getTime() + 60 * 1000;
var time2 = new Date(time);
var timeObj = time2.toGMTString();
// 設定三個 cookie,其中 f 帶有過期時間
res.setHeader("Set-Cookie", [
'd=001;maxAge=10*1000',
'e=1112',
'f=2222;Expires=' + timeObj
]);
var msg = { "status": 1, "msg": "succeed" };
res.write(JSON.stringify(msg));
res.end();
}
這段程式碼有兩個重點:伺服器如何設定 cookie 並回傳,以及如何讀取客戶端上傳的 cookie。
主要是透過 response.writeHead 或 response.setHeader 寫入 Set-Cookie 標頭。單筆格式如下:
Set-Cookie: cookieName=cookieValue; [expires=] [;domain=] [;path=] [;secure=] [;httpOnly=]
多筆則以陣列一次送出:
res.setHeader("Set-Cookie", ['a=001', 'b=1112', 'c=2222']);
參數說明
expires:以 GMT 格式字串指定過期時間。
maxAge:同樣指定過期時間,但單位為毫秒,與 expires 擇一設定即可。正值代表 cookie 的存活秒數,負值則表示只在瀏覽器關閉前存在於記憶體中,預設為 -1。
domain:指定可存取該 cookie 的主機名。預設情況下,某主機建立的 cookie 無法被另一主機讀取;設為 .google.com 之後,該網域下的所有子網域都能存取,這就是所謂的跨子域。
path:指定可存取的目錄,例如 path=/default 表示僅在該目錄下有效,預設為 / 即根目錄。
secure:設為 true 時,cookie 只會在 HTTPS 連線中傳輸,HTTP 下不傳遞,避免內容在傳輸過程被側錄;同時客戶端的 document.cookie 也讀不到它。可以把它理解為比 httpOnly 更嚴格的存取控制。
httpOnly:微軟提出的擴充屬性。設定後,JavaScript、applet 等程式無法讀取 cookie,可有效降低 XSS 攻擊風險。
讀取客戶端上傳的 cookie:
console.log("client cookie: " + req.headers.cookie);
刪除與修改本質相同——把原本的值清空即為刪除,換成新值即為修改。實務上多會使用成熟的 cookie 套件,此處示範的是最底層的 http 模組寫法。
// 取得 cookie
NSDictionary *headers = [((NSHTTPURLResponse *)resp) allHeaderFields];
NSLog(@"headers:%@", headers);
NSDictionary *cookies = [NSHTTPCookie cookiesWithResponseHeaderFields:headers
forURL:[NSURL URLWithString:@"https://localhost/"]];
for (NSHTTPCookie *cookie in cookies) {
NSLog(@"cookie:%@", cookie);
}
伺服器設定的三個 cookie 會出現在回應標頭的 Set-Cookie 欄位中,key 分別為 d、e、f,其中 f 設有過期時間。
收到 cookie 之後,後續請求會由系統自動把 cookie 附加到請求標頭中送出。若再請求一個沒有設定 cookie 的路徑,伺服器端印出的請求標頭會長這樣:
{
host: 'localhost:8001',
accept: '*/*',
cookie: 'd=001; e=1112',
'user-agent': 'network-demo/1 CFNetwork/758.0.2 Darwin/14.5.0',
connection: 'keep-alive'
}
可以注意到 key 為 f 的 cookie 消失了,因為它已經過期。另外,伺服器與模擬器印出的時間存在時區落差,這是兩邊時間制式不同所致,不影響判斷。
透過 NSHTTPCookieStorage 的單例即可取得:
NSHTTPCookieStorage *storage = [NSHTTPCookieStorage sharedHTTPCookieStorage];
NSDictionary *cookies = [storage cookiesForURL:[NSURL URLWithString:@"https://localhost/"]];
for (NSHTTPCookie *cookie in cookies) {
NSLog(@"cookie:%@", cookie);
}
- (void)clientSetCookie {
NSDictionary *prop1 = [NSDictionary dictionaryWithObjectsAndKeys:
@"a", NSHTTPCookieName,
@"aaa", NSHTTPCookieValue,
@"/", NSHTTPCookiePath,
[NSURL URLWithString:@"https://localhost/"], NSHTTPCookieOriginURL,
[NSDate dateWithTimeIntervalSinceNow:60], NSHTTPCookieExpires, nil];
NSHTTPCookie *cookie1 = [NSHTTPCookie cookieWithProperties:prop1];
// 單筆設定
// [[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookie:cookie1];
// 批量設定
NSArray *cookies = @[cookie1];
[[NSHTTPCookieStorage sharedHTTPCookieStorage] setCookies:cookies
forURL:[NSURL URLWithString:@"https://localhost/"]
mainDocumentURL:nil];
NSLog(@"設定完成");
}
幾點說明:設定完成後,後續請求會自動帶上這些資料;dateWithTimeIntervalSinceNow:60 代表一分鐘後過期;可單筆或批量設定;mainDocumentURL 用於判定 cookie 是否應被接受,若為 nil 則不套用主文件網域限制。
// 依 url 與名稱刪除
- (void)deleteCookie:(NSString *)cookieName url:(NSURL *)url {
NSArray *cookies = [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookiesForURL:url];
for (NSHTTPCookie *cookie in cookies) {
if ([cookie.name isEqualToString:cookieName]) {
[[NSHTTPCookieStorage sharedHTTPCookieStorage] deleteCookie:cookie];
NSLog(@"刪除 cookie:%@", cookieName);
}
}
}
// 刪除全部
- (void)deleteCookies {
for (NSHTTPCookie *cookie in [[NSHTTPCookieStorage sharedHTTPCookieStorage] cookies]) {
[[NSHTTPCookieStorage sharedHTTPCookieStorage] deleteCookie:cookie];
}
NSLog(@"刪除完成");
}
// NSHTTPCookieAcceptPolicyAlways:保存所有 cookie(預設值) // NSHTTPCookieAcceptPolicyNever:不保存任何回應標頭中的 cookie // NSHTTPCookieAcceptPolicyOnlyFromMainDocumentDomain:只保存網域相符的 cookie
把策略設為 Never 之後再測試,會發現客戶端完全印不出任何 cookie,因為所有回應標頭中的 cookie 都被丟棄了。改回 Always 或 OnlyFromMainDocumentDomain,則伺服器端與客戶端設定的 cookie 都會正常出現,差別在後者會依網域做選擇性保存。
由於 cookie 的實作機制,除非過期,否則每次請求都會附帶送出。一旦 cookie 數量與大小失控,請求標頭就會膨脹,白白浪費帶寬。常見的優化方向有三個:
・控制 cookie 的內容大小
・為不需要 cookie 的靜態資源換一個網域,減少無效傳輸
・減少 DNS 查詢次數
此外,若資料敏感,務必搭配 secure 與 httpOnly,並在伺服器端做好 SameSite 設定,才能兼顧功能與安全。