|
对于最新的稳定版本，请使用 Spring Session 3.5.2！ |
Spring Session - 自定义 Cookie
本指南介绍如何配置 Spring Session 以将自定义 cookie 与 Java 配置一起使用。 本指南假设您已经使用所选的数据存储在项目中设置了 Spring Session。例如，使用 Redis 的 HttpSession。
| 您可以在自定义 Cookie 示例应用程序中找到完整的指南。 |
Spring Java 配置
设置 Spring Session 后，您可以通过公开CookieSerializer作为春豆。
春季会话附带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：的值SameSitecookie 指令。 要禁用SameSitecookie 指令，您可以将此值设置为null. 违约：Lax
| 您应该只匹配有效的域字符，因为域名会反映在响应中。 这样做可以防止恶意用户执行 HTTP 响应拆分等攻击。 |
custom-cookie示例应用
本节介绍如何使用custom-cookie示例应用程序。
运行custom-cookie示例应用
您可以通过获取源代码并调用以下命令来运行示例：
$ ./gradlew :spring-session-sample-javaconfig-custom-cookie:tomcatRun
要使示例正常工作，您必须在本地主机上安装 Redis 2.8+ 并使用默认端口 （6379） 运行它。
或者，您可以更新RedisConnectionFactory指向 Redis 服务器。
另一种选择是使用 Docker 在本地主机上运行 Redis。有关详细说明，请参阅 Docker Redis 存储库。 |
您现在应该能够在 localhost：8080/ 访问该应用程序