Skip to main content

TenantContext

Struct TenantContext 

Source
pub struct TenantContext;
Expand description

全局租户上下文 — 持有当前请求的 tenant_id

§线程安全

内部使用线程局部存储(thread_local!),每个线程持有独立的租户上下文。 在 axum 中间件(运行于请求线程)中设置后,同线程的业务代码通过 Self::current() 读取。 多线程并发场景下各线程互不干扰,适合测试并行执行。

Implementations§

Source§

impl TenantContext

Source

pub fn set_current(tenant_id: i64)

设置当前租户 ID

Source

pub fn clear()

清除当前租户 ID(请求结束后调用)

Source

pub fn current() -> Option<i64>

获取当前租户 ID

未设置时返回 None。业务代码应在此情况下拒绝数据操作。

Source

pub fn require_current() -> Result<i64, TenantError>

获取当前租户 ID,未设置时返回错误

Source

pub fn is_set() -> bool

判断是否已设置租户上下文

Source

pub fn guard() -> Result<TenantGuard, TenantError>

创建 TenantGuard — 在 await 前捕获当前租户 ID

§为什么需要 Guard

TenantContext 基于 thread_local! 存储。在 tokio 异步运行时中, .await 可能导致任务切换到不同线程,使 thread_local 值静默改变。

在业务代码需要跨 await 使用租户 ID 时,应先在 await 调用本方法 创建 TenantGuard,之后通过 guard.tenant_id() 访问(而非 TenantContext::current())。

§使用示例
async fn handle_request() -> Result<(), TenantError> {
    // 在第一个 await 之前捕获租户 ID
    let guard = TenantContext::guard()?;

    // 以下操作可能跨越 await,但 guard 持有正确的 tenant_id
    let data = fetch_from_db(guard.tenant_id()).await?;
    process(data, guard.tenant_id()).await?;

    Ok(())
}
§安全保证
  • guard.tenant_id() 返回创建时捕获的值,不受线程切换影响
  • guard.assert_current() 可验证当前 thread_local 是否与捕获值一致 (用于检测中间件是否正确设置了上下文)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more