設(shè)計思路
- 用戶發(fā)出登錄請求您朽,帶著用戶名和密碼到服務(wù)器經(jīng)行驗證铸史,服務(wù)器驗證成功就在后臺生成一個token返回給客戶端
- 客戶端將token存儲到cookie中举庶,服務(wù)端將token存儲到redis中怒坯,可以設(shè)置存儲token的有效期掀淘。
- 后續(xù)客戶端的每次請求資源都必須攜帶token旬蟋,這里放在請求頭中,服務(wù)端接收到請求首先校驗是否攜帶token革娄,以及token是否和redis中的匹配倾贰,若不存在或不匹配直接攔截返回錯誤信息(如未認證)。
token管理:生成拦惋、校驗匆浙、解析、刪除
token:這里使用userId_UUID的形式
有效期:使用Redis key有效期設(shè)置(每次操作完了都會更新延長有效時間)
銷毀token:刪除Redis中key為userId的內(nèi)容
token存儲:客戶端(Cookie)厕妖、服務(wù)端(Redis)
Cookie的存取操作(jquery.cookie插件)
Redis存仁啄帷(StringRedisTemplate)
實現(xiàn)
完整代碼可到springboot2.x整合redis實現(xiàn)簡單的token登錄鑒權(quán)中下載
(本demo只是個小例子,還有很多不足,用于實際環(huán)境還需要根據(jù)實際考慮更多的問題)
【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 {
public static final long TOKEN_EXPIRES_SECOND = 1800;
@Autowired
private StringRedisTemplate redisTpl;
/**
* 向redis中設(shè)值
* @param key 使用 a:b:id的形式在使用rdm進行查看redis情況時會看到分層文件夾的展示形式,便于管理
* @param value
* @return
*/
public boolean set(String key, String value) {
boolean result = false;
try {
redisTpl.opsForValue().set(key, value);
result = true;
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 向redis中設(shè)置言秸,同時設(shè)置過期時間
* @param key
* @param value
* @param time
* @return
*/
public boolean set(String key, String value, long time) {
boolean result = false;
try {
redisTpl.opsForValue().set(key, value);
expire(key, time);
result = true;
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 獲取redis中的值
* @param key
* @return
*/
public String get(String key) {
String result = null;
try {
result = redisTpl.opsForValue().get(key);
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 設(shè)置key的過期時間
* @param key
* @param time
* @return
*/
public boolean expire(String key, long time) {
boolean result = false;
try {
if(time > 0) {
redisTpl.expire(key, time, TimeUnit.SECONDS);
result = true;
}
} catch (Exception e) {
e.printStackTrace();
}
return result;
}
/**
* 根據(jù)key刪除對應(yīng)value
* @param key
* @return
*/
public boolean remove(String key) {
boolean result = false;
try {
redisTpl.delete(key);
result = true;
} catch (Exception e) {
e.printStackTrace();
}
return 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 {
@Autowired
private RedisClient redisClient;
@Override
public TokenModel create(Integer id) {
String token = UUID.randomUUID().toString().replace("-", "");
TokenModel mode = new TokenModel(id, token);
redisClient.set(id == null ? null : String.valueOf(id), token, RedisClient.TOKEN_EXPIRES_SECOND);
return mode;
}
@Override
public boolean check(TokenModel model) {
boolean result = false;
if(model != null) {
String userId = model.getUserId().toString();
String token = model.getToken();
String authenticatedToken = redisClient.get(userId);
if(authenticatedToken != null && authenticatedToken.equals(token)) {
redisClient.expire(userId, RedisClient.TOKEN_EXPIRES_SECOND);
result = true;
}
}
return result;
}
@Override
public TokenModel get(String authStr) {
TokenModel model = null;
if(StringUtils.isNotEmpty(authStr)) {
String[] modelArr = authStr.split("_");
if(modelArr.length == 2) {
int userId = Integer.parseInt(modelArr[0]);
String token = modelArr[1];
model = new TokenModel(userId, token);
}
}
return model;
}
@Override
public boolean delete(Integer id) {
return redisClient.remove(id == null ? null : 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 {
@Autowired
private TokenHelper tokenHelper;
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println(11);
// 如果不是映射到方法直接通過
if (!(handler instanceof HandlerMethod)) {
return true;
}
//如果被@NoneAuth注解代表不需要登錄驗證软能,直接通過
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
if(method.getAnnotation(NoneAuth.class) != null) return true;
//token驗證
String authStr = request.getHeader(NormalConstant.AUTHORIZATION);
TokenModel model = tokenHelper.get(authStr);
//驗證通過
if(tokenHelper.check(model)) {
request.setAttribute(NormalConstant.CURRENT_USER_ID, model.getUserId());
return true;
}
//驗證未通過
response.setCharacterEncoding("UTF-8");
response.setContentType("application/json; charset=utf-8");
response.getWriter().write(JsonUtils.obj2String(JsonData.buildError(401, "權(quán)限未認證")));
return false;
}
}
【登錄邏輯】
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 {
@Autowired
private UserMapper userMapper;
@Autowired
private TokenHelper tokenHelper;
@NoneAuth
@GetMapping
public Object login(String username, String password) {
User user = userMapper.findByName(username);
if(user == null || !user.getPassword().equals(password)) {
return JsonData.buildError(HttpStatusEnum.NOT_FOUND.getCode(), MessageConstant.USERNAME_OR_PASSWORD_ERROR);
}
//用戶名密碼驗證通過后,生成token
TokenModel model = tokenHelper.create(user.getId());
return JsonData.buildSuccess(model);
}
@DeleteMapping
public Object logout(HttpServletRequest request) {
Integer userId = (Integer) request.getAttribute(NormalConstant.CURRENT_USER_ID);
if(userId != null) {
tokenHelper.delete(userId);
}
return 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>
測試環(huán)境中兩個頁面login.html和index.html均當做靜態(tài)資源處理
【未登錄狀態(tài)】
- 首先再未登錄狀態(tài)下直接訪問index頁面http://localhost:8080/tokenAuth/page/index.html
- 點擊get按鈕獲取數(shù)據(jù)举畸,由于沒有攜帶token導致認證失敗
【登錄狀態(tài)】
- 訪問登錄網(wǎng)站http://localhost:8080/tokenAuth/page/login.html查排,輸入username和password進行點擊Login按鈕登錄
-
登錄成功并跳轉(zhuǎn)到index頁面,并且生成cookie抄沮,這里沒有設(shè)置cookie有效期跋核,默認關(guān)閉瀏覽器失效
-
再次點擊get按鈕請求數(shù)據(jù),請求成功
-
點擊logout按鈕銷毀登錄狀態(tài)叛买,然后再次請求數(shù)據(jù)