目錄
提示：以下是本篇文章正文內容，下面案例可供參考
此文章參考Sa-Token官方文檔
本案例分為3個服務
1.GateWay網關 提供鑒權請求攔截
2.Login-Serivce 提供登錄及存儲登錄用戶個人信息
3.Api-Service 獲取登錄的用戶信息
一、GateWay服務
1.引入依賴
<!-- Sa-Token 權限認證（Reactor響應式集成）, 在線文檔：http://sa-token.dev33.cn/ -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-reactor-spring-boot-starter</artifactId>
<version>1.29.0</version>
</dependency>
<!-- Sa-Token 整合 Redis （使用jackson序列化方式） -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId>
</dependency>
<!-- 提供Redis連接池 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
-對於網關服務，大體來講分為兩種：
- 一種是基於Servlet模型的，如：Zuul，我們需要引入的是：sa-token-spring-boot-starter，詳細戳：在SpingBoot環境繼承
- 一種是基於Reactor模型的，如：SpringCloud Gateway、ShenYu、Fizz Gateway 等等，我們需要引入的是：sa-token-reactor-spring-boot-starter，並且注冊全局過濾器！，詳細戳：在WebFlux環境集成
2.配置文件
sping:
redis:
# Redis數據庫索引（默認為0）
database: 1
# Redis服務器地址
host: 127.0.0.1
# Redis服務器連接端口
port: 6379
# Redis服務器連接密碼（默認為空）
password: 123456
# 連接超時時間
timeout: 10s
lettuce:
pool:
# 連接池最大連接數
max-active: 200
# 連接池最大阻塞等待時間（使用負值表示沒有限制）
max-wait: -1ms
# 連接池中的最大空閑連接
max-idle: 10
# 連接池中的最小空閑連接
min-idle: 0
3.配置類
Sa-Token可以無配置啟動，也可以通過yml/properties文件配置或使用配置類
我在配置文件中配置無效（未找到原因），此處使用配置類
package com.hangludian.config;
import cn.dev33.satoken.config.SaTokenConfig;
import cn.dev33.satoken.reactor.filter.SaReactorFilter;
import cn.dev33.satoken.router.SaRouter;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaResult;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
@Configuration
public class SaTokenConfigures {
@Bean
public SaReactorFilter getSaServletFilter() {
return new SaReactorFilter()
// 攔截地址
.addInclude("/**")
// 開放地址
.addExclude("/favicon.ico")
// 鑒權方法：每次訪問進入
.setAuth(obj -> {
// 登錄校驗 -- 攔截所有路由，並排除/user/doLogin 用於開放登錄
// SaRouter.match("/**", "/account-service/account/userLogin", r -> StpUtil.checkLogin());
SaRouter.match("/**").notMatch( "/account-service/account/userLogin","/tmcapi-service/account/userLogin",
"/**/swagger-resources/**", "/**/webjars/**", "/**/v2/**", "/**/swagger-ui.html/**" ,
"/**/doc.html/**", "/**/error","/**/favicon.ico")
.check( r -> StpUtil.checkLogin());
// 權限認證 -- 不同模塊, 校驗不同權限
SaRouter.match("/user/**", r -> StpUtil.checkPermission("user"));
SaRouter.match("/admin/**", r -> StpUtil.checkPermission("admin"));
SaRouter.match("/goods/**", r -> StpUtil.checkPermission("goods"));
SaRouter.match("/orders/**", r -> StpUtil.checkPermission("orders"));
// ...
})
// 異常處理方法：每次setAuth函數出現異常時進入
.setError(e -> SaResult.error(e.getMessage()))
.setBeforeAuth(obj -> {
// ---------- 設置跨域響應頭 ----------
SaHolder.getResponse()
// 允許指定域訪問跨域資源
.setHeader("Access-Control-Allow-Origin", "*")
// 允許所有請求方式
.setHeader("Access-Control-Allow-Methods", "POST, GET, OPTIONS, DELETE")
// 有效時間
.setHeader("Access-Control-Max-Age", "3600")
// 允許的header參數
.setHeader("Access-Control-Allow-Headers", "*");
// 如果是預檢請求，則立即返回到前端
SaRouter.match(SaHttpMethod.OPTIONS)
.free(r -> System.out.println("--------OPTIONS預檢請求，不做處理"))
.back();
});
}
@Bean
@Primary
public SaTokenConfig getSaTokenConfigPrimary() {
SaTokenConfig config = new SaTokenConfig();
config.setTokenName("token"); // token名稱 (同時也是cookie名稱)
config.setTimeout(30 * 24 * 60 * 60); // token有效期，單位s 默認30天
config.setActivityTimeout(-1); // token臨時有效期 (指定時間內無操作就視為token過期) 單位: 秒
config.setIsConcurrent(true); // 是否允許同一賬號並發登錄 (為true時允許一起登錄, 為false時新登錄擠掉舊登錄)
config.setIsShare(true); // 在多人登錄同一賬號時，是否共用一個token (為true時所有登錄共用一個token, 為false時每次登錄新建一個token)
config.setTokenStyle("uuid"); // token風格
config.setIsLog(false); // 是否輸出操作日志
return config;
}
}
4.全局異常類
代碼如下（示例）：
@ControllerAdvice
public class GlobalException {
// 全局異常攔截（攔截項目中的所有異常）
@ResponseBody
@ExceptionHandler
public AjaxJson handlerException(Exception e) {
// 打印堆棧，以供調試
// System.out.println("全局異常---------------");
e.printStackTrace();
// 不同異常返回不同狀態碼
AjaxJson aj = null;
if (e instanceof NotLoginException) { // 如果是未登錄異常
NotLoginException ee = (NotLoginException) e;
aj = AjaxJson.getNotLogin().setMsg(ee.getMessage());
}
else if(e instanceof NotRoleException) { // 如果是角色異常
NotRoleException ee = (NotRoleException) e;
aj = AjaxJson.getNotJur("無此角色：" + ee.getRole());
}
else if(e instanceof NotPermissionException) { // 如果是權限異常
NotPermissionException ee = (NotPermissionException) e;
aj = AjaxJson.getNotJur("無此權限：" + ee.getCode());
}
else if(e instanceof DisableLoginException) { // 如果是被封禁異常
DisableLoginException ee = (DisableLoginException) e;
aj = AjaxJson.getNotJur("賬號被封禁：" + ee.getDisableTime() + "秒后解封");
}
else { // 普通異常, 輸出：500 + 異常信息
aj = AjaxJson.getError(e.getMessage());
}
// 返回給前端
return aj;
}
}
5.返回對象
代碼如下（示例）：
/**
* ajax請求返回Json格式數據的封裝
*/
public class AjaxJson implements Serializable{
private static final long serialVersionUID = 1L; // 序列化版本號
public static final int CODE_SUCCESS = 200; // 成功狀態碼
public static final int CODE_ERROR = 500; // 錯誤狀態碼
public static final int CODE_WARNING = 501; // 警告狀態碼
public static final int CODE_NOT_JUR = 403; // 無權限狀態碼
public static final int CODE_NOT_LOGIN = 401; // 未登錄狀態碼
public static final int CODE_INVALID_REQUEST = 400; // 無效請求狀態碼
public int code; // 狀態碼
public String msg; // 描述信息
public Object data; // 攜帶對象
public Long dataCount; // 數據總數，用於分頁
/**
* 返回code
* @return
*/
public int getCode() {
return this.code;
}
/**
* 給msg賦值，連綴風格
*/
public AjaxJson setMsg(String msg) {
this.msg = msg;
return this;
}
public String getMsg() {
return this.msg;
}
/**
* 給data賦值，連綴風格
*/
public AjaxJson setData(Object data) {
this.data = data;
return this;
}
/**
* 將data還原為指定類型並返回
*/
@SuppressWarnings("unchecked")
public <T> T getData(Class<T> cs) {
return (T) data;
}
// ============================ 構建 ==================================
public AjaxJson(int code, String msg, Object data, Long dataCount) {
this.code = code;
this.msg = msg;
this.data = data;
this.dataCount = dataCount;
}
// 返回成功
public static AjaxJson getSuccess() {
return new AjaxJson(CODE_SUCCESS, "ok", null, null);
}
public static AjaxJson getSuccess(String msg) {
return new AjaxJson(CODE_SUCCESS, msg, null, null);
}
public static AjaxJson getSuccess(String msg, Object data) {
return new AjaxJson(CODE_SUCCESS, msg, data, null);
}
public static AjaxJson getSuccessData(Object data) {
return new AjaxJson(CODE_SUCCESS, "ok", data, null);
}
public static AjaxJson getSuccessArray(Object... data) {
return new AjaxJson(CODE_SUCCESS, "ok", data, null);
}
// 返回失敗
public static AjaxJson getError() {
return new AjaxJson(CODE_ERROR, "error", null, null);
}
public static AjaxJson getError(String msg) {
return new AjaxJson(CODE_ERROR, msg, null, null);
}
// 返回警告
public static AjaxJson getWarning() {
return new AjaxJson(CODE_ERROR, "warning", null, null);
}
public static AjaxJson getWarning(String msg) {
return new AjaxJson(CODE_WARNING, msg, null, null);
}
// 返回未登錄
public static AjaxJson getNotLogin() {
return new AjaxJson(CODE_NOT_LOGIN, "未登錄，請登錄后再次訪問", null, null);
}
// 返回沒有權限的
public static AjaxJson getNotJur(String msg) {
return new AjaxJson(CODE_NOT_JUR, msg, null, null);
}
// 返回一個自定義狀態碼的
public static AjaxJson get(int code, String msg){
return new AjaxJson(code, msg, null, null);
}
// 返回分頁和數據的
public static AjaxJson getPageData(Long dataCount, Object data){
return new AjaxJson(CODE_SUCCESS, "ok", data, dataCount);
}
// 返回，根據受影響行數的(大於0=ok，小於0=error)
public static AjaxJson getByLine(int line){
if(line > 0){
return getSuccess("ok", line);
}
return getError("error").setData(line);
}
// 返回，根據布爾值來確定最終結果的 (true=ok，false=error)
public static AjaxJson getByBoolean(boolean b){
return b ? getSuccess("ok") : getError("error");
}
/* (non-Javadoc)
* @see java.lang.Object#toString()
*/
@SuppressWarnings("rawtypes")
@Override
public String toString() {
String data_string = null;
if(data == null){
} else if(data instanceof List){
data_string = "List(length=" + ((List)data).size() + ")";
} else {
data_string = data.toString();
}
return "{"
+ "\"code\": " + this.getCode()
+ ", \"msg\": \"" + this.getMsg() + "\""
+ ", \"data\": " + data_string
+ ", \"dataCount\": " + dataCount
+ "}";
}
}
二、Login-Service
1.引入依賴
<!-- sa-token -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-spring-boot-starter</artifactId>
</dependency>
<!-- Sa-Token 整合 Redis （使用jackson序列化方式） -->
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-dao-redis-jackson</artifactId>
</dependency>
<!-- 提供Redis連接池 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-pool2</artifactId>
</dependency>
2.配置類
@Configuration
public class SaTokenConfig {
@Bean
@Primary
public cn.dev33.satoken.config.SaTokenConfig getSaTokenConfigPrimary() {
cn.dev33.satoken.config.SaTokenConfig config = new cn.dev33.satoken.config.SaTokenConfig();
config.setTokenName("token"); // token名稱 (同時也是cookie名稱)
config.setTimeout(30 * 24 * 60 * 60); // token有效期，單位s 默認30天
config.setActivityTimeout(-1); // token臨時有效期 (指定時間內無操作就視為token過期) 單位: 秒
config.setIsConcurrent(true); // 是否允許同一賬號並發登錄 (為true時允許一起登錄, 為false時新登錄擠掉舊登錄)
config.setIsShare(true); // 在多人登錄同一賬號時，是否共用一個token (為true時所有登錄共用一個token, 為false時每次登錄新建一個token)
config.setTokenStyle("uuid"); // token風格
config.setIsLog(false); // 是否輸出操作日志
return config;
}
}
配置文件同gateway
4.業務代碼
寫在登錄成功后
UserInfoVo userInfoVo = new UserInfoVo();
userInfoVo.setUserId(userModel.getUserId());
userInfoVo.setName(userModel.getName());
StpUtil.login(userModel.getUserId());
StpUtil.getSession().set("userInfo",userInfoVo);
三、Api-Service
引入依賴、配置類和配置文件同Login-Service 此處略
1.獲取登錄用戶信息
long userId = (UserInfoVo) StpUtil.getSession().get("userInfo").getUserId();
三、openfeign調用攜帶token
@Configuration
public class FeignRequestInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate template) {
try {
template.header("token", StpUtil.getTokenValue());
}catch (NotLoginException e){
}
}
}
四、請求手動返回token
@ApiOperation("用戶登錄")
@PostMapping("/userLogin")
public DataResult<UserResponse> userLogin(@RequestBody UserLoginRequest request, HttpServletResponse response) {
DataResult<UserResponse> userResponseDataResult = userService.userLogin(request);
String token = userResponseDataResult.getData().getToken();
Cookie cookie = new Cookie("token",token);
response.addCookie(cookie);
return userResponseDataResult;
}
或者
@Configuration
public class FeignRequestInterceptor implements RequestInterceptor {
@Override
public void apply(RequestTemplate template) {
try {
HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
if(request != null){
Enumeration<String> headerNames = request.getHeaderNames();
if(headerNames != null){
while (headerNames.hasMoreElements()){
String name = headerNames.nextElement();
String value = request.getHeader(name);
if (name.equals("content-length")){
continue;
}
template.header(name, value);
}
}
}
}catch (NotLoginException e){
}
}
}