对于最新的稳定版本，请使用 Spring Session 3.4.0！spring-doc.cn

Spring Session - 自定义 Cookie

本指南描述了如何配置 Spring Session 以通过 Java 配置使用自定义 cookie。 本指南假定您已经使用所选的数据存储在项目中设置了 Spring Session。例如，使用 Redis 的 HttpSession。spring-doc.cn

您可以在 Custom Cookie sample application 中找到完整的指南。

设置 Spring Session 后，您可以通过将 a 公开为 Spring bean 来自定义会话 cookie 的编写方式。 Spring Session 附带 。 当您使用 . 下面的示例展示了如何自定义 Spring Session 的 cookie：CookieSerializerDefaultCookieSerializerDefaultCookieSerializer@EnableRedisHttpSessionspring-doc.cn

	@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 的路径自定义为 be（而不是上下文根的默认值）。/
3 我们将域名模式（正则表达式）自定义为 . 这允许跨域和应用程序共享会话。 如果正则表达式不匹配，则不设置域，并使用现有域。 如果正则表达式匹配，则第一个分组将用作域。 这意味着对 child.example.com 的请求会将域设置为 . 但是，对 localhost：8080/ 或 192.168.1.100：8080/ 的请求会取消设置 cookie，因此，它仍然可以在开发中工作，而无需进行任何生产更改。^.?\\.(\\w\\.[a-z]+)$example.com
您只应匹配有效的域字符，因为域名会反映在响应中。 这样做可以防止恶意用户执行 HTTP 响应拆分等攻击。

以下配置选项可用：spring-doc.cn

  • cookieName：要使用的 Cookie 的名称。 违约：。SESSIONspring-doc.cn

  • useSecureCookie：指定是否应使用安全 Cookie。 Default：使用 at the time of creation 的值。HttpServletRequest.isSecure()spring-doc.cn

  • cookiePath：Cookie 的路径。 Default：上下文根。spring-doc.cn

  • cookieMaxAge：指定在创建会话时要设置的 Cookie 的最长期限。 Default： ，这表示在浏览器关闭时应删除 Cookie。-1spring-doc.cn

  • jvmRoute：指定要附加到会话 ID 并包含在 Cookie 中的后缀。 用于标识要路由到哪个 JVM 以实现会话关联性。 对于某些实现（即 Redis），此选项不会提供任何性能优势。 但是，它可以帮助跟踪特定用户的日志。spring-doc.cn

  • domainName：允许指定要用于 Cookie 的特定域名。 此选项易于理解，但通常需要在开发和生产环境之间使用不同的配置。 请参阅 作为替代项。domainNamePatternspring-doc.cn

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

  • sameSite：cookie 指令的值。 要禁用 cookie 指令的序列化，可以将此值设置为 。 违约：SameSiteSameSitenullLaxspring-doc.cn

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

本节介绍如何使用示例应用程序。custom-cookiespring-doc.cn

运行示例应用程序custom-cookie

您可以通过获取源码并调用以下命令来运行该示例：spring-doc.cn

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

您现在应该能够访问 localhost：8080/ 中的应用程序spring-doc.cn

探索示例应用程序custom-cookie

现在您可以使用该应用程序。使用以下信息填写表单：spring-doc.cn

现在单击 Set Attribute 按钮。 您现在应该会看到表中显示的值。spring-doc.cn

如果查看应用程序的 Cookie，则可以看到 Cookie 已保存到 的自定义名称中。JSESSIONIDspring-doc.cn