Spinrg WebFlux中Cookie的讀寫
WebFLux與WebMvc的差異
WebFlux讀寫Cookie不像WebMvc那麼直接,最主要的原因是WebMvc是基於Servlet規範的,而WebFlux僅僅遵守的是HTTP協議。所以在使用的時候會發現HttpServletRequest
、HttpServletResponse
這些Servlet層級的介面根本就無法使用。
Cookie與Servlet並沒有太直接的關係,前者是屬於HTTP規範的而後者是一個J2EE的規範,在應用層面僅有的聯絡就是Servlet會讀寫Cookie中的JSESSIONID來標記與前端瀏覽器和服務端的關係。而HttpServletRequest
、HttpServletResponse
WebFlux的Cookie管理
WebFlux目前並沒有為寫Cookie提供任何工具。這就需要開發者按照HTTP的規範來寫Cookie。 在HTTP協議互動的過程中,服務端可以通過在response中新增Set-Cookie頭來讓瀏覽器記錄Cookie,而瀏覽器則在request中使用Cookie頭來傳遞cookie。
寫Cookie
寫cookie使用ResponseEntity
向response頭中新增Set-Cookie即可。CookieBuilder
的程式碼比較長,它是用於構建一個cookie字串,Set-Cookie
@RestController @RequestMapping("/cookie") public class CookieReadAWriteController { @GetMapping("/write") public ResponseEntity<String> cookieWrite() { HttpHeaders headers = new HttpHeaders(); String cookie = new CookieBuilder().setKey("cookie-text") .setValue(cookieText) .setMaxAge(840000) .setPath("/") .build(); headers.add("Set-Cookie", cookie); return new ResponseEntity<String>("hi," + userName, headers, HttpStatus.OK); } } class CookieBuilder { private String key; private String value; private String expires; private String domain; private String path; public CookieBuilder setKey(String key) { this.key = key; return this; } public CookieBuilder setValue(String value) { this.value = value; return this; } public CookieBuilder setMaxAge(long ms) { //cookie的過期日期為GMT格式的時間。 Date date = new Date(new Date().getTime() + ms); SimpleDateFormat sdf = new SimpleDateFormat("EEE d MMM yyyy HH:mm:ss 'GMT'", Locale.US); sdf.setTimeZone(TimeZone.getTimeZone("GMT")); this.expires = sdf.format(date); return this; } public CookieBuilder setDomain(String domain) { this.domain = domain; return this; } public CookieBuilder setPath(String path) { this.path = path; return this; } public String build() { StringBuilder sb = new StringBuilder(); sb.append(this.key); sb.append("="); sb.append(this.value); sb.append(";"); if (null != this.expires) { sb.append("expires="); sb.append(this.expires); sb.append(";"); } if (null != this.domain) { sb.append("domain="); sb.append(this.domain); sb.append(";"); } if (null != this.path) { sb.append("path="); sb.append(this.path); sb.append(";"); } return sb.toString(); } }
讀cookie
獲取cookie就比較直觀,可以直接使用@CookieValue
這個Annotation來獲取:
@RestController
@RequestMapping("/cookie")
public class CookieReadAWriteController {
@GetMapping("/read/annotation")
/**
* @param value
* @return
*/
public String cookieReadAnnotation(@CookieValue("cookie-text") String value) {
return "當前Cookie中的內容" + value;
}
}
也可以直接從Request的Header中獲取:
@RestController
@RequestMapping("/cookie")
public class CookieReadAWriteController {
@GetMapping("/read/annotation")
/**
* @param value
* @return
*/
@GetMapping("/read/entity")
public String cookieReadEntity(RequestEntity<String> entity) {
HttpHeaders headers = entity.getHeaders();
List<String> cookie = headers.get("Cookie");
return "當前Cookie中的內容" + cookie;
}
}
使用Annotatin是直接標記Cookie的key來獲取value。而使用RequestEntity需要從頭中先獲取Cookie的內容,然後再解析key和value,存在一個key對應多個value的情況需要使用RequestEntity。
原文連結:https://my.oschina.net/chkui/blog/2993002