lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2026-02-27 16:50:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

抽离包装类，核心包脱离ServletAPI

Browse Source
This commit is contained in:
shengzhang
2021-04-05 22:54:25 +08:00
parent 9b44e05c28
commit 15eefbed33
30 changed files with 522 additions and 405 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
sa-token-core/pom.xml
View File

@@ -16,11 +16,7 @@
<description>A Java Web lightweight authority authentication framework, comprehensive function, easy to use</description>
<dependencies>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<!-- Zero dependence！ -->
</dependencies>

45
sa-token-core/src/main/java/cn/dev33/satoken/SaTokenManager.java
View File

@@ -7,12 +7,10 @@ import cn.dev33.satoken.action.SaTokenAction;
import cn.dev33.satoken.action.SaTokenActionDefaultImpl;
import cn.dev33.satoken.config.SaTokenConfig;
import cn.dev33.satoken.config.SaTokenConfigFactory;
import cn.dev33.satoken.cookie.SaTokenCookie;
import cn.dev33.satoken.cookie.SaTokenCookieDefaultImpl;
import cn.dev33.satoken.context.SaTokenContext;
import cn.dev33.satoken.context.SaTokenContextDefaultImpl;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.dao.SaTokenDaoDefaultImpl;
import cn.dev33.satoken.servlet.SaTokenServlet;
import cn.dev33.satoken.servlet.SaTokenServletDefaultImpl;
import cn.dev33.satoken.stp.StpInterface;
import cn.dev33.satoken.stp.StpInterfaceDefaultImpl;
import cn.dev33.satoken.stp.StpLogic;
@@ -108,47 +106,29 @@ public class SaTokenManager {
}
/**
* Cookie操作 Bean
* 容器操作 Bean
*/
private static SaTokenCookie saTokenCookie;
public static void setSaTokenCookie(SaTokenCookie saTokenCookie) {
SaTokenManager.saTokenCookie = saTokenCookie;
private static SaTokenContext saTokenContext;
public static void setSaTokenContext(SaTokenContext saTokenContext) {
SaTokenManager.saTokenContext = saTokenContext;
}
public static SaTokenCookie getSaTokenCookie() {
if (saTokenCookie == null) {
public static SaTokenContext getSaTokenContext() {
if (saTokenContext == null) {
// 如果对象为空，则使用框架默认方式初始化
synchronized (SaTokenManager.class) {
if (saTokenCookie == null) {
setSaTokenCookie(new SaTokenCookieDefaultImpl());
if (saTokenContext == null) {
setSaTokenContext(new SaTokenContextDefaultImpl());
}
}
}
return saTokenCookie;
}
/**
* Servlet操作 Bean
*/
private static SaTokenServlet saTokenServlet;
public static void setSaTokenServlet(SaTokenServlet saTokenServlet) {
SaTokenManager.saTokenServlet = saTokenServlet;
}
public static SaTokenServlet getSaTokenServlet() {
if (saTokenServlet == null) {
// 如果对象为空，则使用框架默认方式初始化
synchronized (SaTokenManager.class) {
if (saTokenServlet == null) {
setSaTokenServlet(new SaTokenServletDefaultImpl());
}
}
}
return saTokenServlet;
return saTokenContext;
}
/**
* StpLogic集合, 记录框架所有成功初始化的StpLogic
*/
public static Map<String, StpLogic> stpLogicMap = new HashMap<String, StpLogic>();
/**
* 向集合中 put 一个 StpLogic
* @param stpLogic StpLogic
@@ -156,6 +136,7 @@ public class SaTokenManager {
public static void putStpLogic(StpLogic stpLogic) {
stpLogicMap.put(stpLogic.getLoginKey(), stpLogic);
}
/**
* 根据 LoginKey 获取对应的StpLogic，如果不存在则返回null
* @param loginKey 对应的LoginKey

36
sa-token-core/src/main/java/cn/dev33/satoken/context/SaTokenContext.java Normal file
View File

@@ -0,0 +1,36 @@
package cn.dev33.satoken.context;
import cn.dev33.satoken.context.model.SaRequest;
import cn.dev33.satoken.context.model.SaResponse;
/**
* 与底层容器交互接口
* @author kong
*
*/
public interface SaTokenContext {
/**
* 获取当前请求的 Request 对象
*
* @return see note
*/
public SaRequest getRequest();
/**
* 获取当前请求的 Response 对象
*
* @return see note
*/
public SaResponse getResponse();
/**
* 校验指定路由匹配符是否可以匹配成功指定路径
*
* @param pattern 路由匹配符
* @param path 需要匹配的路径
* @return see note
*/
public boolean matchPath(String pattern, String path);
}

38
sa-token-core/src/main/java/cn/dev33/satoken/context/SaTokenContextDefaultImpl.java Normal file
View File

@@ -0,0 +1,38 @@
package cn.dev33.satoken.context;
import cn.dev33.satoken.context.model.SaRequest;
import cn.dev33.satoken.context.model.SaResponse;
import cn.dev33.satoken.exception.SaTokenException;
/**
* Sa-Token 与底层容器交互接口 [默认实现类]
* @author kong
*
*/
public class SaTokenContextDefaultImpl implements SaTokenContext {
/**
* 获取当前请求的Request对象
*/
@Override
public SaRequest getRequest() {
throw new SaTokenException("未初始化任何有效容器");
}
/**
* 获取当前请求的Response对象
*/
@Override
public SaResponse getResponse() {
throw new SaTokenException("未初始化任何有效容器");
}
/**
* 校验指定路由匹配符是否可以匹配成功指定路径
*/
@Override
public boolean matchPath(String pattern, String path) {
throw new SaTokenException("未初始化任何有效容器");
}
}

10
sa-token-core/src/main/java/cn/dev33/satoken/context/model/SaCookie.java Normal file
View File

@@ -0,0 +1,10 @@
package cn.dev33.satoken.context.model;
/**
* Cookie 包装类
* @author kong
*
*/
public class SaCookie {
}

63
sa-token-core/src/main/java/cn/dev33/satoken/context/model/SaRequest.java Normal file
View File

@@ -0,0 +1,63 @@
package cn.dev33.satoken.context.model;
/**
* Request包装类
* @author kong
*
*/
public interface SaRequest {
/**
* 获取底层源对象
* @return see note
*/
public Object getSource();
/**
* 在 [Request作用域] 里写入一个值
* @param name 键
* @param value 值
*/
public void setAttribute(String name, Object value);
/**
* 在 [Request作用域] 里获取一个值
* @param name 键
* @return 值
*/
public Object getAttribute(String name);
/**
* 在 [Request作用域] 里删除一个值
* @param name 键
*/
public void removeAttribute(String name);
/**
* 在 [请求体] 里获取一个值
* @param name 键
* @return 值
*/
public String getParameter(String name);
/**
* 在 [请求头] 里获取一个值
* @param name 键
* @return 值
*/
public String getHeader(String name);
/**
* 在 [Cookie作用域] 里获取一个值
* @param name 键
* @return 值
*/
public String getCookieValue(String name);
/**
* 返回当前请求的URL
* @return see note
*/
public String getRequestURI();
}

32
sa-token-core/src/main/java/cn/dev33/satoken/context/model/SaResponse.java Normal file
View File

@@ -0,0 +1,32 @@
package cn.dev33.satoken.context.model;
/**
* Response 包装类
* @author kong
*
*/
public interface SaResponse {
/**
* 获取底层源对象
* @return see note
*/
public Object getSource();
/**
* 删除指定Cookie
* @param name Cookie名称
*/
public void deleteCookie(String name);
/**
* 写入指定Cookie
* @param name Cookie名称
* @param value Cookie值
* @param path Cookie路径
* @param domain Cookie的作用域
* @param timeout 过期时间 （秒）
*/
public void addCookie(String name, String value, String path, String domain, int timeout);
}

4
sa-token-core/src/main/java/cn/dev33/satoken/context/package-info.java Normal file
View File

@@ -0,0 +1,4 @@
/**
* 因为不能确定最终运行的容器属于标准Servlet模型还是非Servlet模型，特封装此包下的包装类进行对接
*/
package cn.dev33.satoken.context;

55
sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookie.java
View File

@@ -1,55 +0,0 @@
package cn.dev33.satoken.cookie;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* sa-token 对cookie的相关操作 接口类
*
* @author kong
*
*/
public interface SaTokenCookie {
/**
* 在request对象中获取指定Cookie
*
* @param request request对象
* @param cookieName Cookie名称
* @return 查找到的Cookie对象
*/
public Cookie getCookie(HttpServletRequest request, String cookieName);
/**
* 添加Cookie
*
* @param response response对象
* @param name Cookie名称
* @param value Cookie值
* @param path Cookie路径
* @param domain Cookie的作用域
* @param timeout 过期时间 （秒）
*/
public void addCookie(HttpServletResponse response, String name, String value, String path, String domain, int timeout);
/**
* 删除Cookie
*
* @param request request对象
* @param response response对象
* @param name Cookie名称
*/
public void delCookie(HttpServletRequest request, HttpServletResponse response, String name);
/**
* 修改Cookie的value值
*
* @param request request对象
* @param response response对象
* @param name Cookie名称
* @param value Cookie值
*/
public void updateCookie(HttpServletRequest request, HttpServletResponse response, String name, String value);
}

47
sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieDefaultImpl.java
View File

@@ -1,47 +0,0 @@
package cn.dev33.satoken.cookie;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* sa-token 对cookie的相关操作 接口实现类
*
* @author kong
*
*/
public class SaTokenCookieDefaultImpl implements SaTokenCookie {
/**
* 获取指定cookie
*/
@Override
public Cookie getCookie(HttpServletRequest request, String cookieName) {
return SaTokenCookieUtil.getCookie(request, cookieName);
}
/**
* 添加cookie
*/
@Override
public void addCookie(HttpServletResponse response, String name, String value, String path, String domain, int timeout) {
SaTokenCookieUtil.addCookie(response, name, value, path, domain, timeout);
}
/**
* 删除cookie
*/
@Override
public void delCookie(HttpServletRequest request, HttpServletResponse response, String name) {
SaTokenCookieUtil.delCookie(request, response, name);
}
/**
* 修改cookie的value值
*/
@Override
public void updateCookie(HttpServletRequest request, HttpServletResponse response, String name, String value) {
SaTokenCookieUtil.updateCookie(request, response, name, value);
}
}

98
sa-token-core/src/main/java/cn/dev33/satoken/cookie/SaTokenCookieUtil.java
View File

@@ -1,98 +0,0 @@
package cn.dev33.satoken.cookie;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import cn.dev33.satoken.util.SaTokenInsideUtil;
/**
* Cookie操作工具类
*
* @author kong
*/
public class SaTokenCookieUtil {
/**
* 在request对象中获取指定Cookie
*
* @param request request对象
* @param cookieName Cookie名称
* @return 查找到的Cookie对象
*/
public static Cookie getCookie(HttpServletRequest request, String cookieName) {
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (Cookie cookie : cookies) {
if (cookie != null && cookieName.equals(cookie.getName())) {
return cookie;
}
}
}
return null;
}
/**
* 添加cookie
*
* @param response response
* @param name Cookie名称
* @param value Cookie值
* @param path Cookie写入路径
* @param domain Cookie的作用域
* @param timeout Cookie有效期 (秒)
*/
public static void addCookie(HttpServletResponse response, String name, String value, String path, String domain, int timeout) {
Cookie cookie = new Cookie(name, value);
if(SaTokenInsideUtil.isEmpty(path) == true) {
path = "/";
}
if(SaTokenInsideUtil.isEmpty(domain) == false) {
cookie.setDomain(domain);
}
cookie.setPath(path);
cookie.setMaxAge(timeout);
response.addCookie(cookie);
}
/**
* 删除Cookie
*
* @param request request对象
* @param response response对象
* @param name Cookie名称
*/
public static void delCookie(HttpServletRequest request, HttpServletResponse response, String name) {
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (Cookie cookie : cookies) {
if (cookie != null && (name).equals(cookie.getName())) {
addCookie(response, name, null, null, null, 0);
return;
}
}
}
}
/**
* 修改cookie的value值
*
* @param request request对象
* @param response response对象
* @param name Cookie名称
* @param value Cookie值
*/
public static void updateCookie(HttpServletRequest request, HttpServletResponse response, String name,
String value) {
Cookie[] cookies = request.getCookies();
if (cookies != null) {
for (Cookie cookie : cookies) {
if (cookie != null && (name).equals(cookie.getName())) {
addCookie(response, name, value, cookie.getPath(), cookie.getDomain(), cookie.getMaxAge());
return;
}
}
}
}
}

10
sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouteFunction.java
View File

@@ -1,7 +1,7 @@
package cn.dev33.satoken.router;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import cn.dev33.satoken.context.model.SaRequest;
import cn.dev33.satoken.context.model.SaResponse;
/**
* 执行验证方法的辅助类
@@ -14,10 +14,10 @@ public interface SaRouteFunction {
/**
* 执行验证的方法
*
* @param request request对象
* @param response response对象
* @param request Request包装对象
* @param response Response包装对象
* @param handler 处理对象
*/
public void run(HttpServletRequest request, HttpServletResponse response, Object handler);
public void run(SaRequest request, SaResponse response, Object handler);
}

8
sa-token-core/src/main/java/cn/dev33/satoken/router/SaRouterUtil.java
View File

@@ -23,7 +23,7 @@ public class SaRouterUtil {
* @return 是否匹配成功
*/
public static boolean isMatch(String pattern, String path) {
return SaTokenManager.getSaTokenServlet().matchPath(pattern, path);
return SaTokenManager.getSaTokenContext().matchPath(pattern, path);
}
/**
@@ -47,7 +47,7 @@ public class SaRouterUtil {
* @return 是否匹配成功
*/
public static boolean isMatchCurrURI(String pattern) {
return isMatch(pattern, SaTokenManager.getSaTokenServlet().getRequest().getRequestURI());
return isMatch(pattern, SaTokenManager.getSaTokenContext().getRequest().getRequestURI());
}
/**
@@ -56,7 +56,7 @@ public class SaRouterUtil {
* @return 是否匹配成功
*/
public static boolean isMatchCurrURI(List<String> patterns) {
return isMatch(patterns, SaTokenManager.getSaTokenServlet().getRequest().getRequestURI());
return isMatch(patterns, SaTokenManager.getSaTokenContext().getRequest().getRequestURI());
}
@@ -119,7 +119,7 @@ public class SaRouterUtil {
* @return 匹配结果包装对象
*/
public static IsRunFunction match(String... patterns) {
boolean matchResult = isMatch(Arrays.asList(patterns), SaTokenManager.getSaTokenServlet().getRequest().getRequestURI());
boolean matchResult = isMatch(Arrays.asList(patterns), SaTokenManager.getSaTokenContext().getRequest().getRequestURI());
return new IsRunFunction(matchResult);
}

36
sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServlet.java
View File

@@ -1,36 +0,0 @@
package cn.dev33.satoken.servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Servlet相关操作接口
*
* @author kong
*
*/
public interface SaTokenServlet {
/**
* 获取当前请求的 Request 对象
*
* @return 当前请求的Request对象
*/
public HttpServletRequest getRequest();
/**
* 获取当前请求的 Response 对象
*
* @return 当前请求的response对象
*/
public HttpServletResponse getResponse();
/**
* 校验指定路由匹配符是否可以匹配成功指定路径
* @param pattern 路由匹配符
* @param path 需要匹配的路径
* @return 是否匹配成功
*/
public boolean matchPath(String pattern, String path);
}

41
sa-token-core/src/main/java/cn/dev33/satoken/servlet/SaTokenServletDefaultImpl.java
View File

@@ -1,41 +0,0 @@
package cn.dev33.satoken.servlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import cn.dev33.satoken.exception.SaTokenException;
/**
* sa-token 对SaTokenServlet接口默认实现类
*
* @author kong
*
*/
public class SaTokenServletDefaultImpl implements SaTokenServlet {
/**
* 获取当前请求的Request对象
*/
@Override
public HttpServletRequest getRequest() {
throw new SaTokenException("SaTokenServlet接口未实现");
}
/**
* 获取当前请求的Response对象
*/
@Override
public HttpServletResponse getResponse() {
throw new SaTokenException("SaTokenServlet接口未实现");
}
/**
* 校验指定路由匹配符是否可以匹配成功指定路径
*/
@Override
public boolean matchPath(String pattern, String path) {
throw new SaTokenException("SaTokenServlet接口未实现");
}
}

38
sa-token-core/src/main/java/cn/dev33/satoken/stp/StpLogic.java
View File

@@ -6,16 +6,14 @@ import java.util.Arrays;
import java.util.List;
import java.util.Objects;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import cn.dev33.satoken.SaTokenManager;
import cn.dev33.satoken.annotation.SaCheckLogin;
import cn.dev33.satoken.annotation.SaCheckPermission;
import cn.dev33.satoken.annotation.SaCheckRole;
import cn.dev33.satoken.annotation.SaMode;
import cn.dev33.satoken.config.SaTokenConfig;
import cn.dev33.satoken.context.model.SaRequest;
import cn.dev33.satoken.context.model.SaResponse;
import cn.dev33.satoken.dao.SaTokenDao;
import cn.dev33.satoken.exception.DisableLoginException;
import cn.dev33.satoken.exception.NotLoginException;
@@ -95,8 +93,8 @@ public class StpLogic {
*/
public void setTokenValue(String tokenValue, int cookieTimeout){
SaTokenConfig config = getConfig();
// 将token保存到本次request里
HttpServletRequest request = SaTokenManager.getSaTokenServlet().getRequest();
// 将token保存到本次Request里
SaRequest request = SaTokenManager.getSaTokenContext().getRequest();
// 判断是否配置了token前缀
String tokenPrefix = config.getTokenPrefix();
if(SaTokenInsideUtil.isEmpty(tokenPrefix)) {
@@ -108,9 +106,8 @@ public class StpLogic {
// 注入Cookie
if(config.getIsReadCookie() == true){
HttpServletResponse response = SaTokenManager.getSaTokenServlet().getResponse();
SaTokenManager.getSaTokenCookie().addCookie(response, getTokenName(), tokenValue,
"/", config.getCookieDomain(), cookieTimeout);
SaResponse response = SaTokenManager.getSaTokenContext().getResponse();
response.addCookie(getTokenName(), tokenValue, "/", config.getCookieDomain(), cookieTimeout);
}
}
@@ -120,7 +117,7 @@ public class StpLogic {
*/
public String getTokenValue(){
// 0. 获取相应对象
HttpServletRequest request = SaTokenManager.getSaTokenServlet().getRequest();
SaRequest request = SaTokenManager.getSaTokenContext().getRequest();
SaTokenConfig config = getConfig();
String keyTokenName = getTokenName();
String tokenValue = null;
@@ -139,10 +136,7 @@ public class StpLogic {
}
// 4. 尝试从cookie里读取
if(tokenValue == null && config.getIsReadCookie()){
Cookie cookie = SaTokenManager.getSaTokenCookie().getCookie(request, keyTokenName);
if(cookie != null){
tokenValue = cookie.getValue();
}
tokenValue = request.getCookieValue(keyTokenName);
}
// 5. 如果打开了前缀模式
@@ -290,7 +284,7 @@ public class StpLogic {
}
// 如果打开了cookie模式，第一步，先把cookie清除掉
if(getConfig().getIsReadCookie() == true){
SaTokenManager.getSaTokenCookie().delCookie(SaTokenManager.getSaTokenServlet().getRequest(), SaTokenManager.getSaTokenServlet().getResponse(), getTokenName());
SaTokenManager.getSaTokenContext().getResponse().deleteCookie(getTokenName());
}
logoutByTokenValue(tokenValue);
}
@@ -379,7 +373,7 @@ public class StpLogic {
public boolean isDisable(Object loginId) {
return SaTokenManager.getSaTokenDao().get(splicingKeyDisable(loginId)) != null;
}
/**
* 获取指定账号剩余封禁时间，单位：秒（-1=永久封禁，-2=未被封禁）
* @param loginId 账号id
@@ -692,7 +686,7 @@ public class StpLogic {
// 删除[最后操作时间]
SaTokenManager.getSaTokenDao().delete(splicingKeyLastActivityTime(tokenValue));
// 清除标记
SaTokenManager.getSaTokenServlet().getRequest().removeAttribute(SaTokenConsts.TOKEN_ACTIVITY_TIMEOUT_CHECKED_KEY);
SaTokenManager.getSaTokenContext().getRequest().removeAttribute((SaTokenConsts.TOKEN_ACTIVITY_TIMEOUT_CHECKED_KEY));
}
/**
@@ -705,7 +699,7 @@ public class StpLogic {
return;
}
// 如果本次请求已经有了[检查标记], 则立即返回
HttpServletRequest request = SaTokenManager.getSaTokenServlet().getRequest();
SaRequest request = SaTokenManager.getSaTokenContext().getRequest();
if(request.getAttribute(SaTokenConsts.TOKEN_ACTIVITY_TIMEOUT_CHECKED_KEY) != null) {
return;
}
@@ -1255,14 +1249,14 @@ public class StpLogic {
* @param loginId 指定loginId
*/
public void switchTo(Object loginId) {
SaTokenManager.getSaTokenServlet().getRequest().setAttribute(splicingKeySwitch(), loginId);
SaTokenManager.getSaTokenContext().getRequest().setAttribute(splicingKeySwitch(), loginId);
}
/**
* 结束临时切换身份
*/
public void endSwitch() {
SaTokenManager.getSaTokenServlet().getRequest().removeAttribute(splicingKeySwitch());
SaTokenManager.getSaTokenContext().getRequest().removeAttribute(splicingKeySwitch());
}
/**
@@ -1270,7 +1264,7 @@ public class StpLogic {
* @return 是否正处于[身份临时切换]中
*/
public boolean isSwitch() {
return SaTokenManager.getSaTokenServlet().getRequest().getAttribute(splicingKeySwitch()) != null;
return SaTokenManager.getSaTokenContext().getRequest().getAttribute(splicingKeySwitch()) != null;
}
/**
@@ -1278,7 +1272,7 @@ public class StpLogic {
* @return 返回[身份临时切换]的loginId
*/
public Object getSwitchLoginId() {
return SaTokenManager.getSaTokenServlet().getRequest().getAttribute(splicingKeySwitch());
return SaTokenManager.getSaTokenContext().getRequest().getAttribute(splicingKeySwitch());
}
/**