Skip to main content

L2Cache

Struct L2Cache 

Source
pub struct L2Cache { /* private fields */ }
Expand description

L2 二级缓存 — 跨 Session 共享

线程安全:内部使用 RwLock,可在多线程环境下共享。

§示例

use sz_orm_core::l2_cache::{L2Cache, CacheKey};
use sz_orm_core::Value;
use std::time::Duration;

let cache = L2Cache::new();

// 缓存单行
let key = CacheKey::by_pk("users", 1);
cache.put(&key, Value::String("Alice".to_string()), None);

// 读取
assert!(cache.get(&key).is_some());

// 表级失效
cache.invalidate_table("users");
assert!(cache.get(&key).is_none());

Implementations§

Source§

impl L2Cache

Source

pub fn new() -> Self

创建 L2 缓存(默认容量 10000,无 TTL)

Source

pub fn with_default_ttl(self, ttl: Duration) -> Self

设置默认 TTL

Source

pub fn with_max_size(self, max_size: usize) -> Self

设置最大容量

Source

pub fn with_invalidation_bus(self, bus: Arc<dyn InvalidationBus>) -> Self

设置缓存失效总线(用于跨实例失效通知)

Source

pub fn put(&self, key: &CacheKey, value: Value, ttl: Option<Duration>)

存入缓存项

§TTL 语义
  • ttl = Some(d):使用 d 作为过期时间
  • ttl = None:使用 default_ttl(若未设置则永不过期)
  • 要显式表示“永不失效“,请传 Some(Duration::MAX)
Source

pub fn get(&self, key: &CacheKey) -> Option<Value>

读取缓存项(不存在或已过期返回 None)

命中时会更新 LRU 访问顺序(移到尾部)。

Source

pub fn invalidate(&self, key: &CacheKey)

失效单个缓存项

Source

pub fn invalidate_table(&self, table: &str)

失效整张表的所有缓存项

仅统计实际从缓存中删除的 key 数量,避免 evictions 偏大。 若设置了失效总线,会同时发布 InvalidateTable 消息通知其他实例。

Source

pub fn clear(&self)

清空所有缓存

Source

pub fn size(&self) -> usize

获取当前缓存项数量

Source

pub fn stats(&self) -> L2CacheStats

获取统计信息

Source

pub fn reset_stats(&self)

重置统计信息(含全局和按表分桶)

Source

pub fn table_stats(&self, table: &str) -> Option<PerTableStats>

获取指定表的命中率统计

Source

pub fn all_table_stats(&self) -> HashMap<String, PerTableStats>

获取所有表的命中率统计快照

Source

pub fn contains(&self, key: &CacheKey) -> bool

检查缓存项是否存在(不更新统计与 LRU 顺序)

Source

pub fn evict_expired(&self) -> usize

手动清理所有过期项

Source

pub fn update_ttl(&self, key: &CacheKey, ttl: Duration) -> bool

更新缓存项的 TTL(若 key 不存在返回 false)

用于 Cache trait 的 expire 方法实现。

Source

pub fn remaining_ttl(&self, key: &CacheKey) -> Option<Option<Duration>>

获取缓存项的剩余 TTL

返回值:

  • None:key 不存在或已过期
  • Some(None):key 存在但无 TTL(永不过期)
  • Some(Some(d)):key 存在且剩余 TTL 为 d

用于 Cache trait 的 ttl 方法实现。

Trait Implementations§

Source§

impl Cache for L2Cache

为 L2Cache 实现 Cache trait

通过 CacheKey::by_pk("__cache__", key) 将字符串 key 映射到 L2Cache 的 CacheKey 体系, 所有通过 Cache trait 写入的缓存项归入 __cache__ 表,与业务缓存项隔离。

值以 Value::Bytes(Vec<u8>) 存储;若通过 Cache::get 读取到的 Value 非 Bytes 类型 (如直接通过 L2Cache::put 写入的其他类型),则回退为 JSON 序列化。

Source§

fn get(&self, key: &str) -> Result<Option<Vec<u8>>, CacheError>

Source§

fn set( &self, key: &str, value: Vec<u8>, ttl: Option<Duration>, ) -> Result<(), CacheError>

Source§

fn delete(&self, key: &str) -> Result<(), CacheError>

Source§

fn clear(&self) -> Result<(), CacheError>

Source§

fn exists(&self, key: &str) -> Result<bool, CacheError>

Source§

fn expire(&self, key: &str, ttl: Duration) -> Result<(), CacheError>

Source§

fn ttl(&self, key: &str) -> Result<Option<Duration>, CacheError>

Source§

impl Default for L2Cache

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<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, 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<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