讲到Token的作用和原理,网上有很多相关的技术文章,通过搜集整理并加入自己的理解体会,做一个总结整理,希望可以帮助到更多有需要的人。
1、token作用及原理
Token,即令牌,是服务器产生的,具有随机性和不可预测性,它主要有两个作用:
(1)防止表单重复提交;
使用Token防表单重复提交步骤:
①在服务器端生成一个唯一的随机标识号,专业术语称为Token(令牌),同时在当前用户的Session域中保存这个Token;
②将Token发送到客户端的Form表单中,在Form表单中使用隐藏域来存储这个Token,表单提交的时候连同这个Token一起提交到服务器端;
③在服务器端判断客户端提交上来的Token与服务器端生成的Token是否一致,如果不一致,那就是重复提交了,此时服务器端就可以不处理重复提交的表单。如果相同则处理表单提交,处理完后清除当前用户的Session域中存储的标识号。
FromServlet.java
1 import java.io.IOException; 2 import javax.servlet.ServletException; 3 import javax.servlet.http.HttpServlet; 4 import javax.servlet.http.HttpServletRequest; 5 import javax.servlet.http.HttpServletResponse; 6 7 public class FormServlet extends HttpServlet { 8 public void doGet(HttpServletRequest request, HttpServletResponse response) 9 throws ServletException, IOException { 10 String token = TokenUtil.getInstance().makeToken();//创建令牌 11 System.out.println("在FormServlet中生成的token:"+token); 12 request.getSession().setAttribute("token", token); //在服务器使用session保存token(令牌) 13 request.getRequestDispatcher("/Form.jsp").forward(request, response);//跳转到form.jsp页面 14 } 15 16 public void doPost(HttpServletRequest request, HttpServletResponse response) 17 throws ServletException, IOException { 18 this.doGet(request, response); 19 } 20 }
TokenUtil.java
1 import java.security.MessageDigest; 2 import java.security.NoSuchAlgorithmException; 3 import java.util.Random; 4 import sun.misc.BASE64Encoder; 5 6 public class TokenUtil { 7 8 /* 9 *单例设计模式(保证类的对象在内存中只有一个) 10 *1、把类的构造函数私有 11 *2、自己创建一个类的对象 12 *3、对外提供一个公共的方法,返回类的对象 13 */ 14 private TokenUtil(){ 15 } 16 17 private static final TokenUtil instance = new TokenUtil(); 18 19 /** 20 * 返回类的对象 21 * @return 22 */ 23 public static TokenUtil getInstance(){ 24 return instance; 25 } 26 27 /** 28 * 生成Token 29 * Token:Nv6RRuGEVvmGjB+jimI/gw== 30 * @return 31 */ 32 public String makeToken(){ 33 34 String token = (System.currentTimeMillis() + new Random().nextInt(999999999)) + ""; 35 //数据指纹 128位长 16个字节 md5 36 try { 37 MessageDigest md = MessageDigest.getInstance("md5"); 38 //对于给定数量的更新数据,digest 方法只能被调用一次。digest 方法被调用后,MessageDigest对象被重新设置成其初始状态。 39 byte md5[] = md.digest(token.getBytes()); 40 //base64编码--任意二进制编码明文字符 adfsdfsdfsf 41 BASE64Encoder encoder = new BASE64Encoder(); 42 return encoder.encode(md5); 43 } catch (NoSuchAlgorithmException e) { 44 throw new RuntimeException(e); 45 } 46 } 47 }
Form.jsp
1 <%@ page language="java" import="java.util.*" pageEncoding="utf-8"%> 2 <% 3 String path = request.getContextPath(); 4 String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/"; 5 %> 6 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 7 <html> 8 <head> 9 <base href="<%=basePath%>"> 10 <title>Form.jsp</title> 11 <meta http-equiv="pragma" content="no-cache"> 12 <meta http-equiv="cache-control" content="no-cache"> 13 <meta http-equiv="expires" content="0"> 14 <meta http-equiv="keywords" content="keyword1,keyword2,keyword3"> 15 <meta http-equiv="description" content="This is my page"> 16 <!-- 17 <link rel="stylesheet" type="text/css" href="styles.css"> 18 --> 19 </head> 20 <body> 21 <form action="DoFormServlet" method="post"> 22 <%--使用隐藏域存储生成的token--%> 23 <%-- 24 <input type="hidden" name="token" value="<%=session.getAttribute("token") %>"> 25 --%> 26 <%--使用EL表达式取出存储在session中的token--%> 27 <input type="hidden" name="token" value="${token}" /> 用户名:<input 28 type="text" name="username"> <input type="submit" value="提交"> 29 </form> 30 </body> 31 </html>
DoFormServlet.java
1 import java.io.IOException; 2 import javax.servlet.ServletException; 3 import javax.servlet.http.HttpServlet; 4 import javax.servlet.http.HttpServletRequest; 5 import javax.servlet.http.HttpServletResponse; 6 7 public class DoFormServlet extends HttpServlet { 8 public void doGet(HttpServletRequest request, HttpServletResponse response) 9 throws ServletException, IOException { 10 boolean isRepeat = isRepeatSubmit(request);//判断用户是否是重复提交 11 if(isRepeat){ 12 request.setAttribute("MSG", "请不要重复提交"); 13 System.out.println("请不要重复提交"); 14 request.getRequestDispatcher("/Msg.jsp").forward(request, response); 15 return; 16 } 17 request.getSession().removeAttribute("token");//移除session中的token 18 request.setAttribute("MSG","处理用户提交请求!!"); 19 request.getRequestDispatcher("/Msg.jsp").forward(request, response); 20 System.out.println("处理用户提交请求!!"); 21 } 22 23 /** 24 * 判断客户端提交上来的令牌和服务器端生成的令牌是否一致 25 * @param request 26 * @return 27 * true 用户重复提交了表单 28 * false 用户没有重复提交表单 29 */ 30 private boolean isRepeatSubmit(HttpServletRequest request) { 31 String client_token = request.getParameter("token"); 32 //1、如果用户提交的表单数据中没有token,则用户是重复提交了表单 33 if(client_token==null){ 34 return true; 35 } 36 //取出存储在Session中的token 37 String server_token = (String) request.getSession().getAttribute("token"); 38 //2、如果当前用户的Session中不存在Token(令牌),则用户是重复提交了表单 39 if(server_token==null){ 40 return true; 41 } 42 //3、存储在Session中的Token(令牌)与表单提交的Token(令牌)不同,则用户是重复提交了表单 43 if(!client_token.equals(server_token)){ 44 return true; 45 } 46 return false; 47 } 48 49 public void doPost(HttpServletRequest request, HttpServletResponse response) 50 throws ServletException, IOException { 51 this.doGet(request, response); 52 } 53 }
Msg.jsp
1 <%@ page language="java" import="java.util.*" pageEncoding="utf-8"%> 2 <% 3 String path = request.getContextPath(); 4 String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/"; 5 %> 6 7 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 8 <html> 9 <head> 10 <base href="<%=basePath%>"> 11 <title>result show</title> 12 <meta http-equiv="pragma" content="no-cache"> 13 <meta http-equiv="cache-control" content="no-cache"> 14 <meta http-equiv="expires" content="0"> 15 <meta http-equiv="keywords" content="keyword1,keyword2,keyword3"> 16 <meta http-equiv="description" content="This is my page"> 17 <!-- 18 <link rel="stylesheet" type="text/css" href="styles.css"> 19 --> 20 </head> 21 <body>${MSG}</body> 22 </html>
(2)用来作身份验证
使用基于 Token 的身份验证流程如下:
①用户首次登录,将输入的账号和密码提交给服务器;
②服务器对输入内容进行校验,若账号和密码匹配则验证通过,登录成功,并生成一个token值,将其保存到数据库,并返回给客户端;
③客户端拿到返回的token值将其保存在本地(如cookie/localStorage),作为公共参数,以后每次请求服务器时都携带该token(放在响应头里),提交给服务器进行校验;
④服务器接收到请求后,首先验证是否携带token,若携带则取出请求头里的token值与数据库存储的token进行匹配校验,若token值相同则登录成功,且当前正处于登录状态,此时正常返回数据,让app显示数据;若不存在或两个值不一致,则说明原来的登录已经失效,此时返回错误状态码,提示用户跳转至登录界面重新登录;
⑤注意:用户每进行一次登录,登录成功后服务器都会更新一个token新值返回给客户端;
实现原理图:
引入java-jwt依赖
<dependency> <groupId>com.auth0</groupId> <artifactId>java-jwt</artifactId> <version>3.3.0</version>
</dependency>
签名工具JwtUtil.java
1 import com.auth0.jwt.JWT; 2 import com.auth0.jwt.JWTVerifier; 3 import com.auth0.jwt.algorithms.Algorithm; 4 import com.auth0.jwt.exceptions.JWTDecodeException; 5 import com.auth0.jwt.interfaces.DecodedJWT; 6 import com.fasterxml.jackson.annotation.ObjectIdGenerators; 7 8 import java.io.UnsupportedEncodingException; 9 import java.util.Date; 10 import java.util.HashMap; 11 import java.util.Map; 12 13 public class JwtUtil { 14 /** 15 * 过期时间一天, 16 * TODO 正式运行时修改为15分钟 17 */ 18 private static final long EXPIRE_TIME = 24 * 60 * 60 * 1000; 19 /** 20 * token私钥 21 */ 22 private static final String TOKEN_SECRET = "f26e587c28064d0e855e72c0a6a0e618"; 23 24 /** 25 * 校验token是否正确 26 * 27 * @param token 密钥 28 * @return 是否正确 29 */ 30 public static boolean verify(String token) { 31 try { 32 Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET); 33 JWTVerifier verifier = JWT.require(algorithm) 34 .build(); 35 DecodedJWT jwt = verifier.verify(token); 36 return true; 37 } catch (Exception exception) { 38 return false; 39 } 40 } 41 42 /** 43 * 生成签名,15min后过期 44 * 45 * @param username 用户名 46 * @return 加密的token 47 */ 48 public static String sign(String username,String userId) { 49 try { 50 // 过期时间 51 Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME); 52 // 私钥及加密算法 53 Algorithm algorithm = Algorithm.HMAC256(TOKEN_SECRET); 54 // 设置头部信息 55 Map<String, Object> header = new HashMap<>(2); 56 header.put("typ", "JWT"); 57 header.put("alg", "HS256"); 58 // 附带username,userId信息,生成签名 59 return JWT.create() 60 .withHeader(header) 61 .withClaim("loginName", username) 62 .withClaim("userId",userId) 63 .withExpiresAt(date) 64 .sign(algorithm); 65 } catch (UnsupportedEncodingException e) { 66 return null; 67 } 68 } 69 }
身份认证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
1 import com.alibaba.fastjson.JSONObject; 2 import com.joe.entity.ApiResponse; 3 import com.joe.enums.ApiResponseEnum; 4 import com.joe.util.ApiResponseUtil; 5 import com.joe.util.JwtUtil; 6 import org.springframework.web.servlet.HandlerInterceptor; 7 import org.springframework.web.servlet.ModelAndView; 8 import javax.servlet.http.HttpServletRequest; 9 import javax.servlet.http.HttpServletResponse; 10 import java.io.PrintWriter; 11 12 public class TokenInterceptor implements HandlerInterceptor { 13 14 @Override 15 public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 16 response.setCharacterEncoding("utf-8"); 17 String token = request.getHeader("access_token"); 18 //token不存在 19 if (null != token) { 20 //验证token是否正确 21 boolean result = JwtUtil.verify(token); 22 if (result) { 23 return true; 24 } 25 } 26 ApiResponse apiResponse = ApiResponseUtil.getApiResponse(ApiResponseEnum.AUTH_ERROR); 27 responseMessage(response,response.getWriter(),apiResponse); 28 return false; 29 } 30 31 @Override 32 public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 33 34 } 35 36 @Override 37 public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { 38 39 } 40 41 /** 42 * 返回信息给客户端 43 * 44 * @param response 45 * @param out 46 * @param apiResponse 47 */ 48 private void responseMessage(HttpServletResponse response, PrintWriter out, ApiResponse apiResponse) { 49 response.setContentType("application/json; charset=utf-8"); 50 out.print(JSONObject.toJSONString(apiResponse)); 51 out.flush(); 52 out.close(); 53 } 54 }
spring-mvc.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4 xmlns:context="http://www.springframework.org/schema/context" 5 xmlns:mvc="http://www.springframework.org/schema/mvc" 6 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd 7 http://www.springframework.org/schema/context 8 http://www.springframework.org/schema/context/spring-context.xsd 9 http://www.springframework.org/schema/mvc 10 http://www.springframework.org/schema/mvc/spring-mvc.xsd"> 11 <!--此文件负责整个mvc中的配置--> 12 <!--启用spring的一些annotation --> 13 <context:annotation-config/> 14 15 <!-- 配置注解驱动 可以将request参数与绑定到controller参数上 --> 16 <mvc:annotation-driven/> 17 18 <mvc:interceptors> 19 <mvc:interceptor> 20 <mvc:mapping path="/**" /> 21 <mvc:exclude-mapping path="/login/"/> 22 <bean class="com.joe.interceptor.TokenInterceptor"></bean> 23 </mvc:interceptor> 24 </mvc:interceptors> 25 26 <!-- 自动扫描装配 --> 27 <context:component-scan base-package="com.joe"/> 28 </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