Spring Session - 自定义 Cookie

本指南介绍如何使用 Java 配置来配置 Spring Session 以使用自定义 Cookie。本指南假设您已使用所选数据存储在项目中设置了 Spring Session。例如，使用 Redis 的 HttpSession。

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

设置 Spring Session 后，您可以通过将 CookieSerializer 作为 Spring bean 公开来自定义会话 Cookie 的写入方式。Spring Session 附带 DefaultCookieSerializer。将 DefaultCookieSerializer 作为 Spring bean 公开会在您使用 @EnableRedisHttpSession 等配置时增强现有配置。以下示例展示了如何自定义 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]+)$。这允许跨域和应用程序共享会话。如果正则表达式不匹配，则不设置任何域，并使用现有域。如果正则表达式匹配，则使用第一个 分组 作为域。这意味着对 child.example.com 的请求将域设置为 example.com。但是，对 localhost:8080/ 或 192.168.1.100:8080/ 的请求不会设置 Cookie，因此在开发中仍然有效，无需对生产进行任何更改。
您应该只匹配有效的域名字符，因为域名会反映在响应中。这样做可以防止恶意用户执行诸如HTTP 响应拆分之类的攻击。

以下配置选项可用

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

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

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

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

  • jvmRoute: 指定要附加到会话 ID 并包含在 cookie 中的后缀。用于标识要路由到的 JVM 以进行会话亲和性。对于某些实现（例如 Redis），此选项不会带来性能优势。但是，它可以帮助跟踪特定用户的日志。

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

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

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

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

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

运行 custom-cookie 示例应用程序

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

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

您现在应该能够在 localhost:8080/ 访问应用程序。

探索 custom-cookie 示例应用程序

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

  • 属性名称： username

  • 属性值： rob

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

如果您查看应用程序的 cookie，您会看到 cookie 被保存到 JSESSIONID 的自定义名称中。