Abp + gRpc 如何实现用户会话状态传递
0.背景
在实际项目当中,我们采用的是 Abp 框架,但是 Abp 框架官方并没有针对 Grpc 进行模块封装。基于此我结合 Abp 与 MagicOnion 封装了一个 Abp.Grpc 模块,它包括服务端和调用端两部分的包。通过这两个包,你可以很方便地在 Abp 框架当中集成 Grpc 实现服务内部通讯。
但是在实际使用当中会出现一个问题,当 A 服务调用 B 服务的时候,A 服务当前登录用户为 admin,调用 B 服务的 IAbpSession
的值仍然为空,这个时候当 B 服务内部实现使用了 IAbpSession
时会出现问题。
这是因为通过 Grpc 接口调用时,并没有传递诸如 Token 之类的东西,而在 B 服务内部的 IAbpSession
本身附加的数据是从 HttpContext
里面获取的,所以 B 服务当前是没有用户状态的。
1.解决
所幸 IAbpSession
提供了一个 Use
方法,通过这个方法我们可以临时地改变 IAbpSession
内部的值,当 。定义如下:
IDisposable Use(int? tenantId, long? userId);
使用方法如下:
public class TestAppService : ITransientDependency
{
private readonly IAbpSession _abpSession;
public TestAppService(IAbpSession abpSession)
{
_abpSession = abpSession;
}
public void TestMethod()
{
using(_abpSession.Use(10,20))
{
// 其他操作
}
// 出去 using 语句之后会自动释放之前的值
}
}
2.Grpc 接口改造
这里 Abp.Grpc 库使用的是 MagicOnion 库实现 Grpc 接口的,底层序列化使用的是 MessagePack,速度也不比 Protocol Buffer 差。
2.1 服务定义
服务定义接口时,必须附加一个 GrpcSession
参数,这个参数用于调用方传递其 IAbpSession
值所使用。例如我有一个接口方法如下,用于返回服务方接收到的用户 Id 值。
public interface ITestGrpcService : IService<ITestGrpcService>
{
// 普通的 Grpc 接口定义
UnaryResult<int> Sum(int x, int y);
// 带有 GrpcSession 的接口定义
UnaryResult<long?> TestGrpcSession(GrpcSession session);
}
2.2 服务提供方
服务提供方在实现 ITestGrpcService
的时候,需要在代码起始点就开始使用 using
语句包裹代码。
public class TestGrpcService : ServiceBase<ITestGrpcService>, ITestGrpcService
{
private readonly IAbpSession _abpSession;
public TestGrpcService()
{
_abpSession = IocManager.Instance.Resolve<IIocManager>().Resolve<IAbpSession>();
}
public UnaryResult<int> Sum(int x, int y)
{
return UnaryResult(x + y);
}
public UnaryResult<long?> TestGrpcSession(GrpcSession session)
{
// 赋值前 Session 的值
Console.WriteLine(_abpSession.UserId);
// 临时改变 Session 值
using (_abpSession.Use(session.TenantId, session.UserId))
{
Console.WriteLine(_abpSession.UserId);
}
// 离开 using 语句时 Session 的值
Console.WriteLine(_abpSession.UserId);
return new UnaryResult<long?>(1000);
}
}
2.3 服务调用方
服务调用方则直接在调用 Grpc 接口的时候,传递给接口当前服务的 Session 状态。
public class TestApplicationService : ApplicationService
{
private readonly IGrpcConnectionUtility _utility;
public TestApplicationService(IGrpcConnectionUtility utility)
{
_utility = utility;
}
public void TestAction()
{
// 获得指定的 Grpc 服务
var service = _utility.GetRemoteService<ITestGrpcService>("Grpc 服务名称");
// 调用测试方法,传递当前调用方的 Session 值
var userId = service.TestGrpcSession(AbpSession as AbpSessionBase).GetAwaiter().GetResult();
Console.WriteLine("TestGrpcSession 方法结果:" + userId);
}
}
2.4 最后的效果
当客户端调用 GRPC 接口时,会将自身的 Session 状态通过 GrpcSession 传递到服务端,这样服务端就能够共享客户端的绘画状态。
3.Abp.Grpc 项目地址
Abp.Grpc 库地址:https://github.com/GameBelial/Abp.Grpc