Struct SaTokenManager 

pub struct SaTokenManager {
    pub config: SaTokenConfig,
    /* private fields */
}

sa-token 管理器

Fields

config: SaTokenConfig

Implementations

impl SaTokenManager

pub fn new(storage: Arc<dyn SaStorage>, config: SaTokenConfig) -> SaTokenManager

创建新的管理器实例

pub fn with_online_manager(self, manager: Arc<OnlineManager>) -> SaTokenManager

pub fn with_distributed_manager( self, manager: Arc<DistributedSessionManager>, ) -> SaTokenManager

pub fn online_manager(&self) -> Option<&Arc<OnlineManager>>

pub fn distributed_manager(&self) -> Option<&Arc<DistributedSessionManager>>

pub fn event_bus(&self) -> &SaTokenEventBus

获取事件总线的引用

pub async fn login( &self, login_id: impl Into<String>, ) -> Result<TokenValue, SaTokenError>

登录：为指定账号创建 token

pub async fn login_with_options( &self, login_id: impl Into<String>, login_type: Option<String>, device: Option<String>, extra_data: Option<Value>, nonce: Option<String>, expire_time: Option<DateTime<Utc>>, ) -> Result<TokenValue, SaTokenError>

登录：为指定账号创建 token（支持自定义 TokenInfo 字段）

参数 | Parameters

• login_id - 登录用户 ID | Login user ID
• login_type - 登录类型（如 “user”, “admin”）| Login type (e.g., “user”, “admin”)
• device - 设备标识 | Device identifier
• extra_data - 额外数据 | Extra data
• nonce - 防重放攻击的一次性令牌 | One-time token for replay attack prevention
• expire_time - 自定义过期时间（如果为 None，则使用配置的过期时间）| Custom expiration time (if None, use configured timeout)

示例 | Example

let token = manager.login_with_options(
    "user_123",
    Some("admin".to_string()),
    Some("iPhone".to_string()),
    Some(json!({"ip": "192.168.1.1"})),
    Some("nonce_123".to_string()),
    None,
).await?;

pub async fn login_with_token_info( &self, token_info: TokenInfo, ) -> Result<TokenValue, SaTokenError>

登录：使用完整的 TokenInfo 对象创建 token

参数 | Parameters

• token_info - 完整的 TokenInfo 对象，包含所有 token 信息 | Complete TokenInfo object containing all token information

说明 | Notes

• TokenInfo 中的 token 字段将被使用（如果已设置），否则会自动生成
• TokenInfo 中的 login_id 字段必须设置
• 如果 expire_time 为 None，将使用配置的过期时间
• The token field in TokenInfo will be used (if set), otherwise will be auto-generated
• The login_id field in TokenInfo must be set
• If expire_time is None, will use configured timeout

示例 | Example

use sa_token_core::token::{TokenInfo, TokenValue};
use chrono::Utc;
 
let mut token_info = TokenInfo::new(
    TokenValue::new("custom_token_123"),
    "user_123"
);
token_info.login_type = "admin".to_string();
token_info.device = Some("iPhone".to_string());
token_info.extra_data = Some(json!({"ip": "192.168.1.1"}));
 
let token = manager.login_with_token_info(token_info).await?;

pub async fn logout(&self, token: &TokenValue) -> Result<(), SaTokenError>

登出：删除指定 token

pub async fn logout_by_login_id( &self, login_id: &str, ) -> Result<(), SaTokenError>

根据登录 ID 登出所有 token

pub async fn get_token_info( &self, token: &TokenValue, ) -> Result<TokenInfo, SaTokenError>

获取 token 信息

pub async fn is_valid(&self, token: &TokenValue) -> bool

检查 token 是否有效

pub async fn get_session( &self, login_id: &str, ) -> Result<SaSession, SaTokenError>

获取 session

pub async fn save_session( &self, session: &SaSession, ) -> Result<(), SaTokenError>

保存 session

pub async fn delete_session(&self, login_id: &str) -> Result<(), SaTokenError>

删除 session

pub async fn renew_timeout( &self, token: &TokenValue, timeout_seconds: i64, ) -> Result<(), SaTokenError>

续期 token（重置过期时间）

pub async fn kick_out(&self, login_id: &str) -> Result<(), SaTokenError>

踢人下线

Trait Implementations

impl Clone for SaTokenManager

fn clone(&self) -> SaTokenManager

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.