lsm/sa-token
1
0
Fork 0
mirror of https://gitee.com/dromara/sa-token.git synced 2025-10-21 02:57:23 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

简化 redis 和 rpc 相关集成包的包名

Browse Source
This commit is contained in:
click33
2023-05-14 01:31:10 +08:00
parent 4d954f12f4
commit 387af986c6
79 changed files with 68 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
sa-token-plugin/sa-token-grpc/.gitignore vendored Normal file
View File

@@ -0,0 +1,12 @@
target/
node_modules/
bin/
.settings/
unpackage/
.classpath
.project
.factorypath
.idea/

34
sa-token-plugin/sa-token-grpc/pom.xml Normal file
View File

@@ -0,0 +1,34 @@
<?xml version='1.0' encoding='utf-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-plugin</artifactId>
<version>${revision}</version>
<relativePath>../pom.xml</relativePath>
</parent>
<packaging>jar</packaging>
<artifactId>sa-token-grpc</artifactId>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>net.devh</groupId>
<artifactId>grpc-spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>cn.dev33</groupId>
<artifactId>sa-token-core</artifactId>
</dependency>
</dependencies>
</project>

21
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/SaTokenSecondContextCreatorForGrpc.java Normal file
View File

@@ -0,0 +1,21 @@
package cn.dev33.satoken.context.grpc;
import cn.dev33.satoken.context.second.SaTokenSecondContext;
import cn.dev33.satoken.context.second.SaTokenSecondContextCreator;
import org.springframework.stereotype.Component;
/**
* Sa-Token 二级Context - 创建器 [Grpc版]
*
* @author lym
* @since <= 1.34.0
*/
@Component
public class SaTokenSecondContextCreatorForGrpc implements SaTokenSecondContextCreator {
@Override
public SaTokenSecondContext create() {
return new SaTokenSecondContextForGrpc();
}
}

46
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/SaTokenSecondContextForGrpc.java Normal file
View File

@@ -0,0 +1,46 @@
package cn.dev33.satoken.context.grpc;
import cn.dev33.satoken.context.grpc.context.SaTokenGrpcContext;
import cn.dev33.satoken.context.grpc.model.SaRequestForGrpc;
import cn.dev33.satoken.context.grpc.model.SaResponseForGrpc;
import cn.dev33.satoken.context.grpc.model.SaStorageForGrpc;
import cn.dev33.satoken.context.model.SaRequest;
import cn.dev33.satoken.context.model.SaResponse;
import cn.dev33.satoken.context.model.SaStorage;
import cn.dev33.satoken.context.second.SaTokenSecondContext;
import cn.dev33.satoken.exception.ApiDisabledException;
/**
* Sa-Token 上下文 [grpc版本]
*
* @author lym
* @since <= 1.34.0
*/
public class SaTokenSecondContextForGrpc implements SaTokenSecondContext {
@Override
public SaRequest getRequest() {
return new SaRequestForGrpc();
}
@Override
public SaResponse getResponse() {
return new SaResponseForGrpc();
}
@Override
public SaStorage getStorage() {
return new SaStorageForGrpc();
}
@Override
public boolean matchPath(String pattern, String path) {
throw new ApiDisabledException();
}
@Override
public boolean isValid() {
return SaTokenGrpcContext.isNotNull();
}
}

20
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/constants/GrpcContextConstants.java Normal file
View File

@@ -0,0 +1,20 @@
package cn.dev33.satoken.context.grpc.constants;
import cn.dev33.satoken.same.SaSameUtil;
import cn.dev33.satoken.util.SaTokenConsts;
import io.grpc.Metadata;
/**
* 常量
*
* @author lym
* @since 2022/8/26 14:27
*/
public class GrpcContextConstants {
public static final Metadata.Key<String> SA_SAME_TOKEN =
Metadata.Key.of(SaSameUtil.SAME_TOKEN, Metadata.ASCII_STRING_MARSHALLER);
public static final Metadata.Key<String> SA_JUST_CREATED_NOT_PREFIX =
Metadata.Key.of(SaTokenConsts.JUST_CREATED_NOT_PREFIX, Metadata.ASCII_STRING_MARSHALLER);
}

44
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/context/SaTokenGrpcContext.java Normal file
View File

@@ -0,0 +1,44 @@
package cn.dev33.satoken.context.grpc.context;
import io.grpc.*;
import java.util.HashMap;
import java.util.Map;
/**
* @author lym
* @since 2022/8/25 11:02
**/
public class SaTokenGrpcContext {
/**
* grpc请求上下文。请求完成后会由grpc自动清空
*
* @see Contexts#interceptCall(Context, ServerCall, Metadata, ServerCallHandler)
*/
private static final Context.Key<Map<String, Object>> SA_TOKEN_CONTEXT_KEY =
Context.key("sa-token-context");
public static Object get(String key) {
return SA_TOKEN_CONTEXT_KEY.get().get(key);
}
public static void set(String key, Object value) {
SA_TOKEN_CONTEXT_KEY.get().put(key, value);
}
public static void removeKey(String key) {
SA_TOKEN_CONTEXT_KEY.get().remove(key);
}
public static Map<String, Object> getContext() {
return SA_TOKEN_CONTEXT_KEY.get();
}
public static boolean isNotNull() {
return SA_TOKEN_CONTEXT_KEY.get() != null;
}
public static Context create() {
return Context.current().withValue(SaTokenGrpcContext.SA_TOKEN_CONTEXT_KEY, new HashMap<>());
}
}

29
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/interceptor/SaTokenContextGrpcServerInterceptor.java Normal file
View File

@@ -0,0 +1,29 @@
package cn.dev33.satoken.context.grpc.interceptor;
import cn.dev33.satoken.context.grpc.context.SaTokenGrpcContext;
import io.grpc.*;
import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor;
import org.springframework.core.Ordered;
/**
* 处理请求前，创建上下文
*
* @author lym
* @since 2022/8/24 10:09
*/
@GrpcGlobalServerInterceptor
public class SaTokenContextGrpcServerInterceptor implements ServerInterceptor, Ordered {
@Override
public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> call, Metadata headers, ServerCallHandler<ReqT, RespT> next) {
Context ctx = SaTokenGrpcContext.create();
return Contexts.interceptCall(ctx, call, headers, next);
}
/**
* 必须最先创建上下文，后面的拦截器才能获取到上下文
*/
@Override
public int getOrder() {
return HIGHEST_PRECEDENCE;
}
}

69
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/interceptor/SaTokenGrpcClientInterceptor.java Normal file
View File

@@ -0,0 +1,69 @@
package cn.dev33.satoken.context.grpc.interceptor;
import org.springframework.core.Ordered;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.context.SaTokenContextDefaultImpl;
import cn.dev33.satoken.context.grpc.constants.GrpcContextConstants;
import cn.dev33.satoken.same.SaSameUtil;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaFoxUtil;
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.ForwardingClientCall;
import io.grpc.ForwardingClientCallListener;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.Status;
import net.devh.boot.grpc.client.interceptor.GrpcGlobalClientInterceptor;
/**
* 客户端请求的时候，带上token
*
* @author lym
* @since 2022/8/24 15:45
*/
@GrpcGlobalClientInterceptor
public class SaTokenGrpcClientInterceptor implements ClientInterceptor, Ordered {
@Override
public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(MethodDescriptor<ReqT, RespT> method,
CallOptions callOptions, Channel next) {
return new ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT>(next.newCall(method, callOptions)) {
@Override
public void start(Listener<RespT> responseListener, Metadata headers) {
// 追加 Same-Token 参数
if (SaManager.getConfig().getCheckSameToken()) {
headers.put(GrpcContextConstants.SA_SAME_TOKEN, SaSameUtil.getToken());
}
// 调用前，传递会话Token
String tokenValue = StpUtil.getTokenValue();
if (SaFoxUtil.isNotEmpty(tokenValue)
&& SaManager.getSaTokenContextOrSecond() != SaTokenContextDefaultImpl.defaultContext) {
headers.put(GrpcContextConstants.SA_JUST_CREATED_NOT_PREFIX, tokenValue);
}
super.start(new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(responseListener) {
/**
* 服务端结束响应后，解析回传的Token值
*/
@Override
public void onClose(Status status, Metadata responseHeader) {
StpUtil.setTokenValue(responseHeader.get(GrpcContextConstants.SA_JUST_CREATED_NOT_PREFIX));
super.onClose(status, responseHeader);
}
}, headers);
}
};
}
@Override
public int getOrder() {
return HIGHEST_PRECEDENCE;
}
}

48
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/interceptor/SaTokenGrpcServerInterceptor.java Normal file
View File

@@ -0,0 +1,48 @@
package cn.dev33.satoken.context.grpc.interceptor;
import cn.dev33.satoken.SaManager;
import cn.dev33.satoken.context.grpc.constants.GrpcContextConstants;
import cn.dev33.satoken.same.SaSameUtil;
import cn.dev33.satoken.stp.StpUtil;
import cn.dev33.satoken.util.SaFoxUtil;
import io.grpc.ForwardingServerCall;
import io.grpc.Metadata;
import io.grpc.ServerCall;
import io.grpc.ServerCallHandler;
import io.grpc.ServerInterceptor;
import io.grpc.Status;
import net.devh.boot.grpc.server.interceptor.GrpcGlobalServerInterceptor;
/**
* 鉴权，设置token
*
* @author lym
* @since 2022/8/25 11:33
**/
@GrpcGlobalServerInterceptor
public class SaTokenGrpcServerInterceptor implements ServerInterceptor {
@Override
public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> call, Metadata headers, ServerCallHandler<ReqT, RespT> next) {
// RPC 调用鉴权
if (SaManager.getConfig().getCheckSameToken()) {
String sameToken = headers.get(GrpcContextConstants.SA_SAME_TOKEN);
SaSameUtil.checkToken(sameToken);
}
String tokenFromClient = headers.get(GrpcContextConstants.SA_JUST_CREATED_NOT_PREFIX);
StpUtil.setTokenValue(tokenFromClient);
return next.startCall(new ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT>(call) {
/**
* 结束响应时，若本服务生成了新token，将其传回客户端
*/
@Override
public void close(Status status, Metadata responseHeaders) {
String justCreateToken = StpUtil.getTokenValue();
if (!SaFoxUtil.equals(justCreateToken, tokenFromClient) && SaFoxUtil.isNotEmpty(justCreateToken)) {
responseHeaders.put(GrpcContextConstants.SA_JUST_CREATED_NOT_PREFIX, justCreateToken);
}
super.close(status, responseHeaders);
}
}, headers);
}
}

107
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/model/SaRequestForGrpc.java Normal file
View File

@@ -0,0 +1,107 @@
package cn.dev33.satoken.context.grpc.model;
import cn.dev33.satoken.context.grpc.context.SaTokenGrpcContext;
import cn.dev33.satoken.context.model.SaRequest;
import java.util.List;
import java.util.Map;
/**
* Request for grpc
*
* @author lym
* @since <= 1.34.0
*/
public class SaRequestForGrpc implements SaRequest {
/**
* 获取底层源对象
*/
@Override
public Object getSource() {
return SaTokenGrpcContext.getContext();
}
/**
* 在 [请求体] 里获取一个值
*/
@Override
public String getParam(String name) {
// 不传播 url 参数
return null;
}
/**
* 获取 [请求体] 里提交的所有参数名称
* @return 参数名称列表
*/
@Override
public List<String> getParamNames(){
return null;
}
/**
* 获取 [请求体] 里提交的所有参数
* @return 参数列表
*/
@Override
public Map<String, String> getParamMap(){
return null;
}
/**
* 在 [请求头] 里获取一个值
*/
@Override
public String getHeader(String name) {
// 不传播 header 参数
return null;
}
/**
* 在 [Cookie作用域] 里获取一个值
*/
@Override
public String getCookieValue(String name) {
// 不传播 cookie 参数
return null;
}
/**
* 返回当前请求path (不包括上下文名称)
*/
@Override
public String getRequestPath() {
// 不传播 requestPath
return null;
}
/**
* 返回当前请求的url，例：http://xxx.com/test
*
* @return see note
*/
public String getUrl() {
// 不传播 url
return null;
}
/**
* 返回当前请求的类型
*/
@Override
public String getMethod() {
// 不传播 method
return null;
}
/**
* 转发请求
*/
@Override
public Object forward(String path) {
// 不传播 forward 动作
return null;
}
}

61
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/model/SaResponseForGrpc.java Normal file
View File

@@ -0,0 +1,61 @@
package cn.dev33.satoken.context.grpc.model;
import cn.dev33.satoken.context.grpc.context.SaTokenGrpcContext;
import cn.dev33.satoken.context.model.SaResponse;
/**
* Response for grpc
*
* @author lym
* @since <= 1.34.0
*/
public class SaResponseForGrpc implements SaResponse {
/**
* 获取底层源对象
*/
@Override
public Object getSource() {
return SaTokenGrpcContext.getContext();
}
/**
* 设置响应状态码
*/
@Override
public SaResponse setStatus(int sc) {
// 不回传 status 状态
return this;
}
/**
* 在响应头里写入一个值
*/
@Override
public SaResponse setHeader(String name, String value) {
// 不回传 header响应头
return this;
}
/**
* 在响应头里添加一个值
*
* @param name 名字
* @param value 值
* @return 对象自身
*/
public SaResponse addHeader(String name, String value) {
// 不回传 header响应头
return this;
}
/**
* 重定向
*/
@Override
public Object redirect(String url) {
// 不回传 重定向 动作
return null;
}
}

48
sa-token-plugin/sa-token-grpc/src/main/java/cn/dev33/satoken/context/grpc/model/SaStorageForGrpc.java Normal file
View File

@@ -0,0 +1,48 @@
package cn.dev33.satoken.context.grpc.model;
import cn.dev33.satoken.context.grpc.context.SaTokenGrpcContext;
import cn.dev33.satoken.context.model.SaStorage;
/**
* Storage for grpc
*
* @author lym
* @since <= 1.34.0
*/
public class SaStorageForGrpc implements SaStorage {
/**
* 获取底层源对象
*/
@Override
public Object getSource() {
return SaTokenGrpcContext.getContext();
}
/**
* 在 [Request作用域] 里写入一个值
*/
@Override
public SaStorage set(String key, Object value) {
SaTokenGrpcContext.set(key, value);
return this;
}
/**
* 在 [Request作用域] 里获取一个值
*/
@Override
public Object get(String key) {
return SaTokenGrpcContext.get(key);
}
/**
* 在 [Request作用域] 里删除一个值
*/
@Override
public SaStorage delete(String key) {
SaTokenGrpcContext.removeKey(key);
return this;
}
}

5
sa-token-plugin/sa-token-grpc/src/main/resources/META-INF/spring.factories Normal file
View File

@@ -0,0 +1,5 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.dev33.satoken.context.grpc.interceptor.SaTokenGrpcClientInterceptor,\
cn.dev33.satoken.context.grpc.interceptor.SaTokenContextGrpcServerInterceptor,\
cn.dev33.satoken.context.grpc.interceptor.SaTokenGrpcServerInterceptor,\
cn.dev33.satoken.context.grpc.SaTokenSecondContextCreatorForGrpc

4
sa-token-plugin/sa-token-grpc/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports Normal file
View File

@@ -0,0 +1,4 @@
cn.dev33.satoken.context.grpc.interceptor.SaTokenGrpcClientInterceptor
cn.dev33.satoken.context.grpc.interceptor.SaTokenContextGrpcServerInterceptor
cn.dev33.satoken.context.grpc.interceptor.SaTokenGrpcServerInterceptor
cn.dev33.satoken.context.grpc.SaTokenSecondContextCreatorForGrpc