Token验证登录状态的简单实现(转)

设计思路

  1. 用户发出登录请求,带着用户名和密码到服务器经行验证,服务器验证成功就在后台生成一个token返回给客户端
  2. 客户端将token存储到cookie中,服务端将token存储到redis中,可以设置存储token的有效期。
  3. 后续客户端的每次请求资源都必须携带token,这里放在请求头中,服务端接收到请求首先校验是否携带token,以及token是否和redis中的匹配,若不存在或不匹配直接拦截返回错误信息(如未认证)。
  • token管理:生成、校验、解析、删除

  • token:这里使用userId_UUID的形式

  • 有效期:使用Redis key有效期设置(每次操作完了都会更新延长有效时间)

  • 销毁token:删除Redis中key为userId的内容

  • token存储:客户端(Cookie)、服务端(Redis)

  • Cookie的存取操作(jquery.cookie插件)

  • Redis存取(StringRedisTemplate)

实现

完整代码可到springboot2.x整合redis实现简单的token登录鉴权中下载
(本demo只是个小例子,还有很多不足,用于实际环境还需要根据实际考虑更多的问题)

【Redis操作类】

package com.bpf.tokenAuth.utils;

import java.util.concurrent.TimeUnit;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

@Component
public class RedisClient {

<span class="hljs-keyword">public</span> <span class="hljs-keyword">static</span> <span class="hljs-keyword">final</span> <span class="hljs-keyword">long</span> TOKEN_EXPIRES_SECOND = <span class="hljs-number">1800</span>;

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> StringRedisTemplate redisTpl;

<span class="hljs-comment">/**
 * 向redis中设值
 * <span class="hljs-doctag">@param</span> key 使用 a:b:id的形式在使用rdm进行查看redis情况时会看到分层文件夹的展示形式,便于管理
 * <span class="hljs-doctag">@param</span> value
 * <span class="hljs-doctag">@return</span>
 */</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">set</span><span class="hljs-params">(String key, String value)</span> </span>{
    <span class="hljs-keyword">boolean</span> result = <span class="hljs-keyword">false</span>;
    <span class="hljs-keyword">try</span> {
        redisTpl.opsForValue().set(key, value);
        result = <span class="hljs-keyword">true</span>;
    } <span class="hljs-keyword">catch</span> (Exception e) {
        e.printStackTrace();
    }
    <span class="hljs-keyword">return</span> result;
}


<span class="hljs-comment">/**
 * 向redis中设置,同时设置过期时间
 * <span class="hljs-doctag">@param</span> key
 * <span class="hljs-doctag">@param</span> value
 * <span class="hljs-doctag">@param</span> time
 * <span class="hljs-doctag">@return</span>
 */</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">set</span><span class="hljs-params">(String key, String value, <span class="hljs-keyword">long</span> time)</span> </span>{
    <span class="hljs-keyword">boolean</span> result = <span class="hljs-keyword">false</span>;
    <span class="hljs-keyword">try</span> {
        redisTpl.opsForValue().set(key, value);
        expire(key, time);
        result =  <span class="hljs-keyword">true</span>;
    } <span class="hljs-keyword">catch</span> (Exception e) {
        e.printStackTrace();
    }
    <span class="hljs-keyword">return</span> result;
}

<span class="hljs-comment">/**
 * 获取redis中的值
 * <span class="hljs-doctag">@param</span> key
 * <span class="hljs-doctag">@return</span>
 */</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> String <span class="hljs-title">get</span><span class="hljs-params">(String key)</span> </span>{
    String result = <span class="hljs-keyword">null</span>;
    <span class="hljs-keyword">try</span> {
        result = redisTpl.opsForValue().get(key);
    } <span class="hljs-keyword">catch</span> (Exception e) {
        e.printStackTrace();
    }
    <span class="hljs-keyword">return</span> result;

}

<span class="hljs-comment">/**
 * 设置key的过期时间
 * <span class="hljs-doctag">@param</span> key
 * <span class="hljs-doctag">@param</span> time
 * <span class="hljs-doctag">@return</span>
 */</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">expire</span><span class="hljs-params">(String key, <span class="hljs-keyword">long</span> time)</span> </span>{
    <span class="hljs-keyword">boolean</span> result = <span class="hljs-keyword">false</span>;
    <span class="hljs-keyword">try</span> {
        <span class="hljs-keyword">if</span>(time &gt; <span class="hljs-number">0</span>) {
            redisTpl.expire(key, time, TimeUnit.SECONDS);
            result = <span class="hljs-keyword">true</span>;
        }
    } <span class="hljs-keyword">catch</span> (Exception e) {
        e.printStackTrace();
    }
    <span class="hljs-keyword">return</span> result;
}

<span class="hljs-comment">/**
 * 根据key删除对应value
 * <span class="hljs-doctag">@param</span> key
 * <span class="hljs-doctag">@return</span>
 */</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">remove</span><span class="hljs-params">(String key)</span> </span>{
    <span class="hljs-keyword">boolean</span> result = <span class="hljs-keyword">false</span>;
    <span class="hljs-keyword">try</span> {
        redisTpl.delete(key);
        result = <span class="hljs-keyword">true</span>;
    } <span class="hljs-keyword">catch</span> (Exception e) {
        e.printStackTrace();
    }
    <span class="hljs-keyword">return</span> result;
}

}

【Token管理类】

package com.bpf.tokenAuth.utils.token;

import java.util.UUID;

import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import com.bpf.tokenAuth.utils.RedisClient;

@Component
public class RedisTokenHelp implements TokenHelper {

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> RedisClient redisClient;

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> TokenModel <span class="hljs-title">create</span><span class="hljs-params">(Integer id)</span> </span>{
    String token = UUID.randomUUID().toString().replace(<span class="hljs-string">"-"</span>, <span class="hljs-string">""</span>);
    TokenModel mode = <span class="hljs-keyword">new</span> TokenModel(id, token);
    redisClient.set(id == <span class="hljs-keyword">null</span> ? <span class="hljs-keyword">null</span> : String.valueOf(id), token, RedisClient.TOKEN_EXPIRES_SECOND);
    <span class="hljs-keyword">return</span> mode;
}

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">check</span><span class="hljs-params">(TokenModel model)</span> </span>{
    <span class="hljs-keyword">boolean</span> result = <span class="hljs-keyword">false</span>;
    <span class="hljs-keyword">if</span>(model != <span class="hljs-keyword">null</span>) {
        String userId = model.getUserId().toString();
        String token = model.getToken();
        String authenticatedToken = redisClient.get(userId);
        <span class="hljs-keyword">if</span>(authenticatedToken != <span class="hljs-keyword">null</span> &amp;&amp; authenticatedToken.equals(token)) {
            redisClient.expire(userId, RedisClient.TOKEN_EXPIRES_SECOND);
            result = <span class="hljs-keyword">true</span>;
        }
    }
    <span class="hljs-keyword">return</span> result;
}

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> TokenModel <span class="hljs-title">get</span><span class="hljs-params">(String authStr)</span> </span>{
    TokenModel model = <span class="hljs-keyword">null</span>;
    <span class="hljs-keyword">if</span>(StringUtils.isNotEmpty(authStr)) {
        String[] modelArr = authStr.split(<span class="hljs-string">"_"</span>);
        <span class="hljs-keyword">if</span>(modelArr.length == <span class="hljs-number">2</span>) {
            <span class="hljs-keyword">int</span> userId = Integer.parseInt(modelArr[<span class="hljs-number">0</span>]);
            String token = modelArr[<span class="hljs-number">1</span>];
            model = <span class="hljs-keyword">new</span> TokenModel(userId, token);
        }
    }
    <span class="hljs-keyword">return</span> model;
}

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">delete</span><span class="hljs-params">(Integer id)</span> </span>{
    <span class="hljs-keyword">return</span> redisClient.remove(id == <span class="hljs-keyword">null</span> ? <span class="hljs-keyword">null</span> : String.valueOf(id));
}

}

【拦截器逻辑】

package com.bpf.tokenAuth.interceptor;

import java.lang.reflect.Method;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import com.bpf.tokenAuth.annotation.NoneAuth;
import com.bpf.tokenAuth.constant.NormalConstant;
import com.bpf.tokenAuth.entity.JsonData;
import com.bpf.tokenAuth.utils.JsonUtils;
import com.bpf.tokenAuth.utils.token.TokenHelper;
import com.bpf.tokenAuth.utils.token.TokenModel;

@Component
public class LoginInterceptor extends HandlerInterceptorAdapter {

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> TokenHelper tokenHelper;

<span class="hljs-meta">@Override</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> <span class="hljs-keyword">boolean</span> <span class="hljs-title">preHandle</span><span class="hljs-params">(HttpServletRequest request, HttpServletResponse response, Object handler)</span>
        <span class="hljs-keyword">throws</span> Exception </span>{
    System.out.println(<span class="hljs-number">11</span>);
    <span class="hljs-comment">// 如果不是映射到方法直接通过</span>
    <span class="hljs-keyword">if</span> (!(handler <span class="hljs-keyword">instanceof</span> HandlerMethod)) {
        <span class="hljs-keyword">return</span> <span class="hljs-keyword">true</span>;
    }
    <span class="hljs-comment">//如果被@NoneAuth注解代表不需要登录验证,直接通过</span>
    HandlerMethod handlerMethod = (HandlerMethod) handler;
    Method method = handlerMethod.getMethod();
    <span class="hljs-keyword">if</span>(method.getAnnotation(NoneAuth.class) != <span class="hljs-keyword">null</span>) <span class="hljs-keyword">return</span> <span class="hljs-keyword">true</span>;       
    <span class="hljs-comment">//token验证</span>
    String authStr = request.getHeader(NormalConstant.AUTHORIZATION);
    TokenModel model = tokenHelper.get(authStr);
    
    <span class="hljs-comment">//验证通过</span>
    <span class="hljs-keyword">if</span>(tokenHelper.check(model)) {
        request.setAttribute(NormalConstant.CURRENT_USER_ID, model.getUserId());
        <span class="hljs-keyword">return</span> <span class="hljs-keyword">true</span>;
    }
    <span class="hljs-comment">//验证未通过</span>
    response.setCharacterEncoding(<span class="hljs-string">"UTF-8"</span>);
    response.setContentType(<span class="hljs-string">"application/json; charset=utf-8"</span>);
    response.getWriter().write(JsonUtils.obj2String(JsonData.buildError(<span class="hljs-number">401</span>, <span class="hljs-string">"权限未认证"</span>)));
    <span class="hljs-keyword">return</span> <span class="hljs-keyword">false</span>;
}

}

【登录逻辑】

package com.bpf.tokenAuth.controller;

import javax.servlet.http.HttpServletRequest;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.bpf.tokenAuth.annotation.NoneAuth;
import com.bpf.tokenAuth.constant.MessageConstant;
import com.bpf.tokenAuth.constant.NormalConstant;
import com.bpf.tokenAuth.entity.JsonData;
import com.bpf.tokenAuth.entity.User;
import com.bpf.tokenAuth.enums.HttpStatusEnum;
import com.bpf.tokenAuth.mapper.UserMapper;
import com.bpf.tokenAuth.utils.token.TokenHelper;
import com.bpf.tokenAuth.utils.token.TokenModel;

@RestController
@RequestMapping("/token")
public class TokenController {

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> UserMapper userMapper;

<span class="hljs-meta">@Autowired</span>
<span class="hljs-keyword">private</span> TokenHelper tokenHelper;

<span class="hljs-meta">@NoneAuth</span>
<span class="hljs-meta">@GetMapping</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> Object <span class="hljs-title">login</span><span class="hljs-params">(String username, String password)</span> </span>{
    User user = userMapper.findByName(username);
    <span class="hljs-keyword">if</span>(user == <span class="hljs-keyword">null</span> || !user.getPassword().equals(password)) {
        <span class="hljs-keyword">return</span> JsonData.buildError(HttpStatusEnum.NOT_FOUND.getCode(), MessageConstant.USERNAME_OR_PASSWORD_ERROR);
    }
    <span class="hljs-comment">//用户名密码验证通过后,生成token</span>
    TokenModel model = tokenHelper.create(user.getId());
    <span class="hljs-keyword">return</span> JsonData.buildSuccess(model);    
}

<span class="hljs-meta">@DeleteMapping</span>
<span class="hljs-function"><span class="hljs-keyword">public</span> Object <span class="hljs-title">logout</span><span class="hljs-params">(HttpServletRequest request)</span> </span>{
    Integer userId = (Integer) request.getAttribute(NormalConstant.CURRENT_USER_ID);
    <span class="hljs-keyword">if</span>(userId != <span class="hljs-keyword">null</span>) {
        tokenHelper.delete(userId);
    }
    <span class="hljs-keyword">return</span> JsonData.buildSuccess();
}

}

测试

【login.html】


<!DOCTYPE html>
<html>  
<head>
<title>Login</title>
<link rel="stylesheet" href="../res/css/login.css">
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
<script src="https://cdn.bootcss.com/jquery-cookie/1.4.1/jquery.cookie.js"></script>
</head>
<body>
    <form>
        <input type="text" name="username" id="username">
        <input type="password" name="password" id="password">
    </form>
    <input type="button" value="Login" onclick="login()">
</body>
<script type="text/javascript">
function login(){
    $.ajax({
        url: "/tokenAuth/token",
        dataType: "json",
        data: {'username':$("#username").val(), 'password':$("#password").val()},
        type:"GET",
        success:function(res){
            console.log(res);
            if(res.code == 200){
                var authStr = res.data.userId + "_" + res.data.token;
                //把生成的token放在cookie中
                $.cookie("authStr", authStr);
                window.location.href = "index.html";
            }else alert(res.msg);
        }
    });
}
</script>
</html>

【index.html】


<!DOCTYPE html>
<html>  
<head>
<title>Index</title>
<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
<script src="https://cdn.bootcss.com/jquery-cookie/1.4.1/jquery.cookie.js"></script>
</head>
<body>
    <input type="button" value="Get" onclick="get()">
    <input type="button" value="logout" onclick="logout()">
</body>
<script type="text/javascript">

function get(){
$.ajax({
url: “/tokenAuth/user/bpf”,
dataType: “json”,
type:“GET”,
beforeSend: function(request) {
//将cookie中的token信息放于请求头中
request.setRequestHeader(“authStr”, $.cookie(‘authStr’));
},
success:function(res){
console.log(res);
}
});
}

function logout(){
$.ajax({
url: “/tokenAuth/token”,
dataType: “json”,
type:“DELETE”,
beforeSend: function(request) {
//将cookie中的token信息放于请求头中
request.setRequestHeader(“authStr”, $.cookie(‘authStr’));
},
success:function(res){
console.log(res);
}
});
}
</script>
</html>

测试环境中两个页面login.html和index.html均当做静态资源处理
【未登录状态】

【登录状态】

  • 访问登录网站http://localhost:8080/tokenAuth/page/login.html,输入username和password进行点击Login按钮登录
  • 登录成功并跳转到index页面,并且生成cookie,这里没有设置cookie有效期,默认关闭浏览器失效


  • 再次点击get按钮请求数据,请求成功


  • 点击logout按钮销毁登录状态,然后再次请求数据


      </div>
    </div>
  • 3
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值