Java Springboot 如何利用Redis完成Session操作(登录,注销等)
<div class="htmledit_views" id="content_views">
<h1><a name="t0"></a><a name="t0"></a>前沿<button class="cnblogs-toc-button" title="显示目录导航" aria-expanded="false"></button></h1>
在 Java Web 开发中,如果你要做动态网页或者记录用户的相关信息等等,必然会或多或少涉及到 Session 的操作。
Session
session 是什么呢?简单地来说,相当于一个有时间限制的会话“身份 ID”,它维持了一段时间的客户端和服务器的会话,保证服务器知道和它的客户端是谁,客户端是否还在有效期等;具体的专业解释,在网上有很多,请自行查阅
痛点
- 原始的 Session 是存在内存中,如果机器或者进程重启,Session 就会消失,用户在本来的有效期内还是会重新登录
- 如果将 Session 存放在 MySql 之类的数据库中,虽然保证了重启后 session 不会消失,但是管理 Session 将会是很繁琐的,而且还会遇到很多并发的问题
如何解决呢?
Springboot 本身结合了 Redis 这样的缓存数据库,session 的操作都是自动,不用考虑重启和各种管理问题,也可以应对适量的并发(大量的并发问题暂不考虑)
Redis
Redis 众所周知是一个速度很快(可以直接从内存中读取)的 Key-Value 数据结构的数据库,通常用来做缓存,或者存储类型简单的数据,而且它有一套很完善的数据有效期机制。因此,Springboot 就默认采用 Redis 来存储 Session
开工
1. 导入 redis 和 session 所需要的库(pom.xml)
在 pom.xml 文件中,添加
<!--Redis 依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-redis</artifactId>
<version>1.4.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.session</groupId>
<artifactId>spring-session-data-redis</artifactId>
<!--<version>2.0.6</version>-->
</dependency>
2.Redis 数据库的配置(application.properties)
在 application.properties 文件中,添加以下的配置(简化版,甚至都不用配置 Configuration):
#Redis 相关配置
spring.redis.host=localhost
spring.redis.port=6379
3. 定义一个登录注销的 Contoller
因为 Springboot 默认采用 redis 来存储管理 Session,因此,我们也不必手动添加或者移除 session,Springboot 会自动帮我们管理
package com.helang.session;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
/**
- 用户登录注销 Controller
- @author helang
*/
@RequestMapping
@RestController
public class LoginController {
<span class="hljs-comment">/**
* 这里为了能简单在浏览器响应,暂时使用GET请求,
* <span class="hljs-doctag">@return</span>
*/</span>
<span class="hljs-meta">@RequestMapping(value = "login",method = RequestMethod.GET)</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">login</span><span class="hljs-params">(HttpServletRequest request)</span>{
<span class="hljs-type">String</span> <span class="hljs-variable">account</span> <span class="hljs-operator">=</span> request.getParameter(<span class="hljs-string">"account"</span>);
<span class="hljs-type">String</span> <span class="hljs-variable">password</span> <span class="hljs-operator">=</span> request.getParameter(<span class="hljs-string">"password"</span>);
<span class="hljs-keyword">if</span> (<span class="hljs-string">"123"</span>.equals(account) && <span class="hljs-string">"123456"</span>.equals(password)){
<span class="hljs-comment">/*如果已经存在Session的话,直接返回它;没有就创建一个,再返回
* 当然Session是自动放在response中的Header中的,这里不用做其他处理*/</span>
request.getSession();
}<span class="hljs-keyword">else</span> {
<span class="hljs-keyword">return</span> <span class="hljs-string">"failed"</span>;
}
<span class="hljs-keyword">return</span> <span class="hljs-string">"success"</span>;
}
<span class="hljs-comment">/**
* 判断用户的session是否有效(在同一个浏览器中,同一个域中,每次Request请求,都会带上Session)
* <span class="hljs-doctag">@param</span> request
* <span class="hljs-doctag">@return</span>
*/</span>
<span class="hljs-meta">@RequestMapping(value = "isValid",method = RequestMethod.GET)</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">isSessionValid</span><span class="hljs-params">(HttpServletRequest request)</span>{
<span class="hljs-comment">//简化if-else表达式(其实很多地方可以简化的,这里为了方便新手朋友可以看得顺畅点,我尽量不简化)</span>
<span class="hljs-keyword">return</span> request.isRequestedSessionIdValid() ? <span class="hljs-string">"ok"</span>:<span class="hljs-string">"no"</span>;
}
<span class="hljs-comment">/**
* 注销登录
* <span class="hljs-doctag">@param</span> session
* <span class="hljs-doctag">@return</span>
*/</span>
<span class="hljs-meta">@RequestMapping(value = "logout",method = RequestMethod.GET)</span>
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">logout</span><span class="hljs-params">(HttpSession session)</span>{
session.invalidate();<span class="hljs-comment">//使Session变成无效,及用户退出</span>
<span class="hljs-keyword">return</span> <span class="hljs-string">"logout"</span>;
}
}
效果
1. 登录
很明显,session 是放在 response 中的 header 的返回给客户端的;之后客户端的每次请求的 Request 的 header 都会带上这个 session
2. 服务器检查 session 是否有效
默认情况下,session 有效期是 30 分钟,当然你也可以修改,这里就不做演示了;利用 session 的有效期,你可以控制客户端的相关业务的请求操作
3. 注销登录(用户退出登录)
就一行代码:session.invalidate(); 是不是比起其他框架来说,要简单得多呢
4. 再次检查 session 是否有效
可以看到客户端的 session 已经失效了,客户端也可以根据这个结果,做相应的操作,比如让用户回到登录页面,重新登录
扩展
当然,结合 Redis,我们可以很容易分布式 Session,即共享 Session,方便用户能够单点登录
总结
Springboot 确实简化了 JavaWeb 开发的操作;当然,我们也不能停留到表面的业务操作中,在合适的时候,一定要深入 Springboot 中的源码中去,才能解决很多棘手的问题,也才能体会到 Spring 的博大精深
Github
代码很少,也很简单,我也把代码分享到 Github 中,方便新手朋友们学习
原创:https://blog.csdn.net/helang296479893/article/details/83787798