Spring Session - 自定义 Cookie

本指南介绍如何使用 Java 配置将 Spring Session 配置为使用自定义 cookie。本指南假定您已在项目中使用您选择的数据存储设置了 Spring Session。例如，带有 Redis 的 HttpSession。

您可以在自定义 Cookie 示例应用程序中找到完整的指南。

设置 Spring Session 后，您可以通过将 CookieSerializer 公开为 Spring bean 来定制 session cookie 的写入方式。Spring Session 附带 DefaultCookieSerializer。当您使用 @EnableRedisHttpSession 等配置时，将 DefaultCookieSerializer 公开为 Spring bean 会增强现有配置。以下示例演示了如何定制 Spring Session 的 cookie

	@Bean
	public CookieSerializer cookieSerializer() {
		DefaultCookieSerializer serializer = new DefaultCookieSerializer();
		serializer.setCookieName("JSESSIONID"); (1)
		serializer.setCookiePath("/"); (2)
		serializer.setDomainNamePattern("^.+?\\.(\\w+\\.[a-z]+)$"); (3)
		return serializer;
	}
1 我们将 cookie 的名称自定义为 JSESSIONID。
2 我们将 cookie 的路径自定义为 /（而不是默认的上下文根路径）。
3 我们将域名模式（一个正则表达式）自定义为 ^.?\\.(\\w\\.[a-z]+)$。这允许在不同域和应用程序之间共享 session。如果正则表达式不匹配，则不设置 domain，并使用现有 domain。如果正则表达式匹配，则第一个分组将用作 domain。这意味着对 child.example.com 的请求会将 domain 设置为 example.com。但是，对 localhost:8080/ 或 192.168.1.100:8080/ 的请求不会设置 cookie 的 domain，因此在开发环境中仍然可以工作，无需为生产环境进行任何更改。
您应该只匹配有效的域名字符，因为域名会反映在响应中。这样做可以防止恶意用户执行诸如 HTTP 响应拆分之类的攻击。

以下配置选项可用

  • cookieName：要使用的 cookie 名称。默认值：SESSION。

  • useSecureCookie：指定是否应使用安全 cookie。默认值：创建时使用 HttpServletRequest.isSecure() 的值。

  • cookiePath：cookie 的路径。默认值：上下文根路径。

  • cookieMaxAge：指定在创建 session 时设置的 cookie 的最大生存期。默认值：-1，表示在浏览器关闭时应移除 cookie。

  • jvmRoute：指定要附加到 session ID 并包含在 cookie 中的后缀。用于识别要路由到哪个 JVM 以实现 session 亲和性。对于某些实现（例如 Redis），此选项不提供性能优势。但是，它可以帮助追踪特定用户的日志。

  • domainName：允许指定用于 cookie 的特定域名。此选项易于理解，但通常需要在开发和生产环境之间进行不同的配置。请参阅 domainNamePattern 作为替代方案。

  • domainNamePattern：一个不区分大小写的模式，用于从 HttpServletRequest#getServerName() 中提取域名。该模式应提供一个单独的分组，用于提取 cookie 域的值。如果正则表达式不匹配，则不设置 domain，并使用现有 domain。如果正则表达式匹配，则第一个分组将用作 domain。

  • sameSite：SameSite cookie 指令的值。要禁用 SameSite cookie 指令的序列化，您可以将此值设置为 null。默认值：Lax

您应该只匹配有效的域名字符，因为域名会反映在响应中。这样做可以防止恶意用户执行诸如 HTTP 响应拆分之类的攻击。

本节介绍如何使用 custom-cookie 示例应用程序。

运行 custom-cookie 示例应用程序

您可以通过获取源代码并执行以下命令来运行示例

$ ./gradlew :spring-session-sample-javaconfig-custom-cookie:tomcatRun
为了使示例工作，您必须在本地主机上安装 Redis 2.8+ 并使用默认端口 (6379) 运行它。或者，您可以更新 RedisConnectionFactory 指向 Redis 服务器。另一种选择是使用Docker 在本地主机上运行 Redis。有关详细说明，请参阅Docker Redis repository。

您现在应该可以通过 localhost:8080/ 访问应用程序。

探索 custom-cookie 示例应用程序

现在您可以使用该应用程序了。填写以下信息到表单中

  • 属性名称： username

  • 属性值： rob

现在点击设置属性按钮。您应该能看到表中显示的值。

如果您查看应用程序的 cookie，您可以看到 cookie 已保存为自定义名称 JSESSIONID。