Token的作用、原理及存储

程序员文章站 2022-07-03 08:48:48

...

讲到Token的作用和原理，网上有很多相关的技术文章，通过搜集整理并加入自己的理解体会，做一个总结整理，希望可以帮助到更多有需要的人。

1、token作用及原理

Token，即令牌，是服务器产生的，具有随机性和不可预测性，它主要有两个作用：

（1）防止表单重复提交；

使用Token防表单重复提交步骤：

①在服务器端生成一个唯一的随机标识号，专业术语称为Token(令牌)，同时在当前用户的Session域中保存这个Token；

②将Token发送到客户端的Form表单中，在Form表单中使用隐藏域来存储这个Token，表单提交的时候连同这个Token一起提交到服务器端；

③在服务器端判断客户端提交上来的Token与服务器端生成的Token是否一致，如果不一致，那就是重复提交了，此时服务器端就可以不处理重复提交的表单。如果相同则处理表单提交，处理完后清除当前用户的Session域中存储的标识号。

FromServlet.java

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class FormServlet extends HttpServlet {
	public void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		String token = TokenUtil.getInstance().makeToken();//创建令牌
		System.out.println("在FormServlet中生成的token："+token);
		request.getSession().setAttribute("token", token);  //在服务器使用session保存token(令牌)
		request.getRequestDispatcher("/Form.jsp").forward(request, response);//跳转到form.jsp页面
	}

	public void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		this.doGet(request, response);
	}
}

TokenUtil.java

import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Random;
import sun.misc.BASE64Encoder;

public class TokenUtil {

    /*
     *单例设计模式（保证类的对象在内存中只有一个）
     *1、把类的构造函数私有
     *2、自己创建一个类的对象
     *3、对外提供一个公共的方法，返回类的对象
     */
    private TokenUtil(){
    }
    
    private static final TokenUtil instance = new TokenUtil();
    
    /**
     * 返回类的对象
     * @return
     */
    public static TokenUtil getInstance(){
        return instance;
    }
    
    /**
     * 生成Token
     * Token：Nv6RRuGEVvmGjB+jimI/gw==
     * @return
     */
    public String makeToken(){
    	
        String token = (System.currentTimeMillis() + new Random().nextInt(999999999)) + "";
        //数据指纹   128位长   16个字节  md5
        try {
            MessageDigest md = MessageDigest.getInstance("md5");
            //对于给定数量的更新数据，digest 方法只能被调用一次。digest 方法被调用后，MessageDigest对象被重新设置成其初始状态。
            byte md5[] =  md.digest(token.getBytes());
            //base64编码--任意二进制编码明文字符   adfsdfsdfsf
            BASE64Encoder encoder = new BASE64Encoder();
            return encoder.encode(md5);
        } catch (NoSuchAlgorithmException e) {
            throw new RuntimeException(e);
        }
    }
}

Form.jsp

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<base href="<%=basePath%>">
<title>Form.jsp</title>
<meta http-equiv="pragma" content="no-cache">
<meta http-equiv="cache-control" content="no-cache">
<meta http-equiv="expires" content="0">
<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
<meta http-equiv="description" content="This is my page">
<!--
	<link rel="stylesheet" type="text/css" href="styles.css">
	-->
</head>
<body>
	<form action="DoFormServlet" method="post">
		<%--使用隐藏域存储生成的token--%>
		<%--
            <input type="hidden" name="token" value="<%=session.getAttribute("token") %>">
        --%>
		<%--使用EL表达式取出存储在session中的token--%>
		<input type="hidden" name="token" value="${token}" /> 用户名：<input
			type="text" name="username"> <input type="submit" value="提交">
	</form>
</body>
</html>

DoFormServlet.java

import java.io.IOException;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class DoFormServlet extends HttpServlet {
	public void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		boolean isRepeat = isRepeatSubmit(request);//判断用户是否是重复提交
		if(isRepeat){
			request.setAttribute("MSG", "请不要重复提交");
			System.out.println("请不要重复提交");
			request.getRequestDispatcher("/Msg.jsp").forward(request, response);
			return;
		}
		request.getSession().removeAttribute("token");//移除session中的token
		request.setAttribute("MSG","处理用户提交请求！！");
		request.getRequestDispatcher("/Msg.jsp").forward(request, response);
		System.out.println("处理用户提交请求！！");
	}
	
	/**
	 * 判断客户端提交上来的令牌和服务器端生成的令牌是否一致
	 * @param request
	 * @return 
	 * true 用户重复提交了表单 
	 * false 用户没有重复提交表单
	 */
	private boolean isRepeatSubmit(HttpServletRequest request) {
		String client_token = request.getParameter("token");
		//1、如果用户提交的表单数据中没有token，则用户是重复提交了表单
		if(client_token==null){
			return true;
		}
		//取出存储在Session中的token
		String server_token = (String) request.getSession().getAttribute("token");
		//2、如果当前用户的Session中不存在Token(令牌)，则用户是重复提交了表单
		if(server_token==null){
			return true;
		}
		//3、存储在Session中的Token(令牌)与表单提交的Token(令牌)不同，则用户是重复提交了表单
		if(!client_token.equals(server_token)){
			return true;
		}
		return false;
	}
	
	public void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		this.doGet(request, response);
	}
}

Msg.jsp

<%@ page language="java" import="java.util.*" pageEncoding="utf-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <base href="<%=basePath%>">
    <title>result show</title>
	<meta http-equiv="pragma" content="no-cache">
	<meta http-equiv="cache-control" content="no-cache">
	<meta http-equiv="expires" content="0">    
	<meta http-equiv="keywords" content="keyword1,keyword2,keyword3">
	<meta http-equiv="description" content="This is my page">
	<!--
	<link rel="stylesheet" type="text/css" href="styles.css">
	-->
  </head>
  <body>${MSG}</body>
</html>

（2）用来作身份验证

使用基于 Token 的身份验证流程如下：

①用户首次登录，将输入的账号和密码提交给服务器；

②服务器对输入内容进行校验，若账号和密码匹配则验证通过，登录成功，并生成一个token值，将其保存到数据库，并返回给客户端；

③客户端拿到返回的token值将其保存在本地（如cookie/localStorage），作为公共参数，以后每次请求服务器时都携带该token（放在响应头里），提交给服务器进行校验；

④服务器接收到请求后，首先验证是否携带token，若携带则取出请求头里的token值与数据库存储的token进行匹配校验，若token值相同则登录成功，且当前正处于登录状态，此时正常返回数据，让app显示数据；若不存在或两个值不一致，则说明原来的登录已经失效，此时返回错误状态码，提示用户跳转至登录界面重新登录；

⑤注意：用户每进行一次登录，登录成功后服务器都会更新一个token新值返回给客户端；

实现原理图：

Token的作用、原理及存储

引入java-jwt依赖

<dependency>
<groupId>com.auth0</groupId>
    <artifactId>java-jwt</artifactId>
    <version>3.3.0</version>
</dependency>

签名工具JwtUtil.java

import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTVerifier;
import com.auth0.jwt.algorithms.Algorithm;
import com.auth0.jwt.exceptions.JWTDecodeException;
import com.auth0.jwt.interfaces.DecodedJWT;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;

import java.io.UnsupportedEncodingException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

public class JwtUtil {
    /**
     * 过期时间一天，
     * TODO 正式运行时修改为15分钟
     */
    private static final long EXPIRE_TIME = 24 * 60 * 60 * 1000;
    /**
     * token私钥
     */
    private static final String TOKEN_SECRET = "f26e587c28064d0e855e72c0a6a0e618";

    /**
     * 校验token是否正确
     *
     * @param token **
     * @return 是否正确
     */
    public static boolean verify(String token) {
        try {
            Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET);
            JWTVerifier verifier = JWT.require(algorithm)
                    .build();
            DecodedJWT jwt = verifier.verify(token);
            return true;
        } catch (Exception exception) {
            return false;
        }
    }
    
    /**
     * 生成签名,15min后过期
     *
     * @param username 用户名
     * @return 加密的token
     */
    public static String sign(String username,String userId) {
        try {
//            过期时间
            Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME);
//            私钥及加密算法
            Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET);
//            设置头部信息
            Map<String, Object> header = new HashMap<>(2);
            header.put("typ", "JWT");
            header.put("alg", "HS256");
            // 附带username，userId信息，生成签名
            return JWT.create()
                    .withHeader(header)
                    .withClaim("loginName", username)
                    .withClaim("userId",userId)
                    .withExpiresAt(date)
                    .sign(algorithm);
        } catch (UnsupportedEncodingException e) {
            return null;
        }
    }
}

身份认证LoginController.java

import com.joe.entity.ApiResponse;
import com.joe.entity.User;
import com.joe.enums.ApiResponseEnum;
import com.joe.service.IUserService;
import com.joe.util.ApiResponseUtil;
import com.joe.util.JwtUtil;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Map;

@Controller
@RequestMapping("/")
public class LoginController {

    @Autowired
    private IUserService userService;

    /**
     * 登陆接口
     *
     * @return token
     */
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    @ResponseBody
    public ApiResponse login(@RequestBody Map<String, String> map) {
        String loginName = map.get("loginName");
        String password = map.get("password");
        //身份验证是否成功
        boolean isSuccess = userService.checkUser(loginName, password);
        if (isSuccess) {
            User user = userService.getUserByLoginName(loginName);
            if (user != null) {
                //返回token
                String token = JwtUtil.sign(user.getName(), user.getId());
                if (token != null) {
                    return ApiResponseUtil.getApiResponse(token);
                }
            }
        }
        //返回登陆失败消息
        return ApiResponseUtil.getApiResponse(ApiResponseEnum.LOGIN_FAIL);
    }
}

配置拦截器TokenInterceptor.java

import com.alibaba.fastjson.JSONObject;
import com.joe.entity.ApiResponse;
import com.joe.enums.ApiResponseEnum;
import com.joe.util.ApiResponseUtil;
import com.joe.util.JwtUtil;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.PrintWriter;

public class TokenInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        response.setCharacterEncoding("utf-8");
        String token = request.getHeader("access_token");
        //token不存在
        if (null != token) {
            //验证token是否正确
            boolean result = JwtUtil.verify(token);
            if (result) {
                return true;
            }
        }
        ApiResponse apiResponse = ApiResponseUtil.getApiResponse(ApiResponseEnum.AUTH_ERROR);
        responseMessage(response,response.getWriter(),apiResponse);
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

    /**
     * 返回信息给客户端
     *
     * @param response
     * @param out
     * @param apiResponse
     */
    private void responseMessage(HttpServletResponse response, PrintWriter out, ApiResponse apiResponse) {
        response.setContentType("application/json; charset=utf-8");
        out.print(JSONObject.toJSONString(apiResponse));
        out.flush();
        out.close();
    }
}

spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="http://www.springframework.org/schema/beans   http://www.springframework.org/schema/beans/spring-beans.xsd 
http://www.springframework.org/schema/context 
http://www.springframework.org/schema/context/spring-context.xsd 
http://www.springframework.org/schema/mvc 
http://www.springframework.org/schema/mvc/spring-mvc.xsd">
    <!--此文件负责整个mvc中的配置-->
    <!--启用spring的一些annotation -->
    <context:annotation-config/>

    <!-- 配置注解驱动 可以将request参数与绑定到controller参数上 -->
    <mvc:annotation-driven/>

    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**" />
            <mvc:exclude-mapping path="/login/"/>
            <bean class="com.joe.interceptor.TokenInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>

    <!-- 自动扫描装配 -->
    <context:component-scan base-package="com.joe"/>
</beans>

2、token优点

①支持跨域访问，将token置于请求头中，而cookie是不支持跨域访问的；

②无状态化，服务端无需存储token，只需要验证token信息是否正确即可，而session需要在服务端存储，一般是通过cookie中的sessionID在服务端查找对应的session；

③无需绑定到一个特殊的身份验证方案（传统的用户名密码登陆），只需要生成的token是符合我们预期设定的即可；

④适用于移动端（Android，iOS，小程序等等），若原生平台不支持cookie（比如说微信小程序），每一次请求都是一次会话，当然我们可以手动为他添加cookie；

⑤可避免CSRF跨站伪造攻击；

⑥适用于RESTful API，这样可以与各种后端（java，.net，python......）相结合。

3、token存储

（1）本地通过DB数据库或txt文本保存

①通过数据库保存

a.获取access_token时，把当前系统时间和access_token保存到数据表(t_access_token)中;

b.再次获取时，把上次获取时间(getTime)与当前系统时间作比较，看时间是否超过2小时;

c.超过2h时间限制，再获取一个access_token，然后更新数据表的accessToken和getTime;

②通过txt文本保存

a.创建 access_token.text文件;

b.读取get_time；

c.读取txt判断时间是否超过2个小时；

d.超过则重写access_token.text文件；

（2）Client通过Cookie或Form表单的隐藏域存储，Server可存储在Session（单机系统）或者其他缓存系统（分布式系统）中。

（3）本地通过cookie或 localStorage存储，作为公共参数，以后每次请求服务器时都携带该token（放在响应头里），提交给服务器进行校验。

参考文档：

https://blog.csdn.net/cuiyaoqiang/article/details/50960787

https://blog.csdn.net/kkkun_joe/article/details/81878231

https://www.runoob.com/jsref/prop-win-localstorage.html

相关标签： Java Token 身份校验重复提交

上一篇：动态CSS语言框架less

下一篇： CentOS 配置静态IP

Token的作用、原理及存储

SQL SERVER数据库的作业的脚本及存储过程

浅析点击对搜索引擎排名产生的影响及点击原理

彻底理解cookie，session，token的使用及原理

ASP.NET Core 2.2 : 二十六. 应用JWT进行用户认证及Token的刷新

spring5 源码深度解析----- 被面试官给虐懵了，竟然是因为我不懂@Configuration配置类及@Bean的原理

Spring HttpMessageConverter的作用及替换解析

黑帽SEO行业被敲诈的原理分析及解决办法

雪莲果怎么吃，雪莲果的功效及作用有哪些！

vue响应式原理及项目中常见的坑

理解文章中锚文本的概述、形式及作用