講到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