sa_token_core/
manager.rs

1// Author: 金书记
2//
3//! Token 管理器 - sa-token 的核心入口
4
5use std::sync::Arc;
6use std::collections::HashMap;
7use chrono::{DateTime, Duration, Utc};
8use tokio::sync::RwLock;
9use sa_token_adapter::storage::SaStorage;
10use crate::config::SaTokenConfig;
11use crate::error::{SaTokenError, SaTokenResult};
12use crate::token::{TokenInfo, TokenValue, TokenGenerator};
13use crate::session::SaSession;
14use crate::event::{SaTokenEventBus, SaTokenEvent};
15use crate::online::OnlineManager;
16use crate::distributed::DistributedSessionManager;
17
18/// sa-token 管理器
19#[derive(Clone)]
20pub struct SaTokenManager {
21    pub(crate) storage: Arc<dyn SaStorage>,
22    pub config: SaTokenConfig,
23    /// 用户权限映射 user_id -> permissions
24    pub(crate) user_permissions: Arc<RwLock<HashMap<String, Vec<String>>>>,
25    /// 用户角色映射 user_id -> roles
26    pub(crate) user_roles: Arc<RwLock<HashMap<String, Vec<String>>>>,
27    /// 事件总线
28    pub(crate) event_bus: SaTokenEventBus,
29    /// 在线用户管理器
30    online_manager: Option<Arc<OnlineManager>>,
31    /// 分布式 Session 管理器
32    distributed_manager: Option<Arc<DistributedSessionManager>>,
33}
34
35impl SaTokenManager {
36    /// 创建新的管理器实例
37    pub fn new(storage: Arc<dyn SaStorage>, config: SaTokenConfig) -> Self {
38        Self { 
39            storage, 
40            config,
41            user_permissions: Arc::new(RwLock::new(HashMap::new())),
42            user_roles: Arc::new(RwLock::new(HashMap::new())),
43            event_bus: SaTokenEventBus::new(),
44            online_manager: None,
45            distributed_manager: None,
46        }
47    }
48    
49    pub fn with_online_manager(mut self, manager: Arc<OnlineManager>) -> Self {
50        self.online_manager = Some(manager);
51        self
52    }
53    
54    pub fn with_distributed_manager(mut self, manager: Arc<DistributedSessionManager>) -> Self {
55        self.distributed_manager = Some(manager);
56        self
57    }
58    
59    pub fn online_manager(&self) -> Option<&Arc<OnlineManager>> {
60        self.online_manager.as_ref()
61    }
62    
63    pub fn distributed_manager(&self) -> Option<&Arc<DistributedSessionManager>> {
64        self.distributed_manager.as_ref()
65    }
66    
67    /// 获取事件总线的引用
68    pub fn event_bus(&self) -> &SaTokenEventBus {
69        &self.event_bus
70    }
71    
72    /// 登录：为指定账号创建 token
73    pub async fn login(&self, login_id: impl Into<String>) -> SaTokenResult<TokenValue> {
74        self.login_with_options(login_id, None, None, None, None, None).await
75    }
76    
77    /// 登录：为指定账号创建 token（支持自定义 TokenInfo 字段）
78    /// 
79    /// # 参数 | Parameters
80    /// * `login_id` - 登录用户 ID | Login user ID
81    /// * `login_type` - 登录类型（如 "user", "admin"）| Login type (e.g., "user", "admin")
82    /// * `device` - 设备标识 | Device identifier
83    /// * `extra_data` - 额外数据 | Extra data
84    /// * `nonce` - 防重放攻击的一次性令牌 | One-time token for replay attack prevention
85    /// * `expire_time` - 自定义过期时间（如果为 None，则使用配置的过期时间）| Custom expiration time (if None, use configured timeout)
86    /// 
87    /// # 示例 | Example
88    /// ```rust,ignore
89    /// let token = manager.login_with_options(
90    ///     "user_123",
91    ///     Some("admin".to_string()),
92    ///     Some("iPhone".to_string()),
93    ///     Some(json!({"ip": "192.168.1.1"})),
94    ///     Some("nonce_123".to_string()),
95    ///     None,
96    /// ).await?;
97    /// ```
98    pub async fn login_with_options(
99        &self,
100        login_id: impl Into<String>,
101        login_type: Option<String>,
102        device: Option<String>,
103        extra_data: Option<serde_json::Value>,
104        nonce: Option<String>,
105        expire_time: Option<DateTime<Utc>>,
106    ) -> SaTokenResult<TokenValue> {
107        let login_id = login_id.into();
108        
109        // 生成 token（支持 JWT）
110        let token = TokenGenerator::generate_with_login_id(&self.config, &login_id);
111        
112        // 创建 token 信息
113        let mut token_info = TokenInfo::new(token.clone(), login_id.clone());
114        
115        // 设置登录类型
116        token_info.login_type = login_type.unwrap_or_else(|| "default".to_string());
117        
118        // 设置设备标识
119        if let Some(device_str) = device {
120            token_info.device = Some(device_str);
121        }
122        
123        // 设置额外数据
124        if let Some(extra) = extra_data {
125            token_info.extra_data = Some(extra);
126        }
127        
128        // 设置 nonce
129        if let Some(nonce_str) = nonce {
130            token_info.nonce = Some(nonce_str);
131        }
132        
133        // 设置过期时间
134        if let Some(custom_expire_time) = expire_time {
135            token_info.expire_time = Some(custom_expire_time);
136        }
137        // 注意：如果 expire_time 为 None，login_with_token_info 会自动使用配置的过期时间
138        
139        // 调用底层方法
140        self.login_with_token_info(token_info).await
141    }
142    
143    /// 登录：使用完整的 TokenInfo 对象创建 token
144    /// 
145    /// # 参数 | Parameters
146    /// * `token_info` - 完整的 TokenInfo 对象，包含所有 token 信息 | Complete TokenInfo object containing all token information
147    /// 
148    /// # 说明 | Notes
149    /// * TokenInfo 中的 `token` 字段将被使用（如果已设置），否则会自动生成
150    /// * TokenInfo 中的 `login_id` 字段必须设置
151    /// * 如果 `expire_time` 为 None，将使用配置的过期时间
152    /// * The `token` field in TokenInfo will be used (if set), otherwise will be auto-generated
153    /// * The `login_id` field in TokenInfo must be set
154    /// * If `expire_time` is None, will use configured timeout
155    /// 
156    /// # 示例 | Example
157    /// ```rust,ignore
158    /// use sa_token_core::token::{TokenInfo, TokenValue};
159    /// use chrono::Utc;
160    /// 
161    /// let mut token_info = TokenInfo::new(
162    ///     TokenValue::new("custom_token_123"),
163    ///     "user_123"
164    /// );
165    /// token_info.login_type = "admin".to_string();
166    /// token_info.device = Some("iPhone".to_string());
167    /// token_info.extra_data = Some(json!({"ip": "192.168.1.1"}));
168    /// 
169    /// let token = manager.login_with_token_info(token_info).await?;
170    /// ```
171    pub async fn login_with_token_info(&self, mut token_info: TokenInfo) -> SaTokenResult<TokenValue> {
172        let login_id = token_info.login_id.clone();
173        
174        // 如果 token_info 中没有 token，则生成一个
175        let token = if token_info.token.as_str().is_empty() {
176            TokenGenerator::generate_with_login_id(&self.config, &login_id)
177        } else {
178            token_info.token.clone()
179        };
180        
181        // 更新 token_info 中的 token
182        token_info.token = token.clone();
183        
184        // 更新最后活跃时间为当前时间
185        token_info.update_active_time();
186        
187        // 如果过期时间为 None，使用配置的过期时间
188        let now = Utc::now();
189        if token_info.expire_time.is_none() {
190            if let Some(timeout) = self.config.timeout_duration() {
191                token_info.expire_time = Some(now + Duration::from_std(timeout).unwrap());
192            }
193        }
194        
195        // 确保登录类型不为空
196        if token_info.login_type.is_empty() {
197            token_info.login_type = "default".to_string();
198        }
199        
200        // 存储 token 信息
201        let key = format!("sa:token:{}", token.as_str());
202        let value = serde_json::to_string(&token_info)
203            .map_err(|e| SaTokenError::SerializationError(e))?;
204        
205        self.storage.set(&key, &value, self.config.timeout_duration()).await
206            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
207        
208        // 保存 login_id 到 token 的映射（用于根据 login_id 查找 token）
209        // 如果 login_type 不为空，使用包含 login_type 的 key 格式避免冲突
210        // If login_type is not empty, use key format with login_type to avoid conflicts
211        let login_token_key = if !token_info.login_type.is_empty() && token_info.login_type != "default" {
212            format!("sa:login:token:{}:{}", login_id, token_info.login_type)
213        } else {
214            format!("sa:login:token:{}", login_id)
215        };
216        self.storage.set(&login_token_key, token.as_str(), self.config.timeout_duration()).await
217            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
218        
219        // 如果不允许并发登录，踢掉之前的 token
220        if !self.config.is_concurrent {
221            self.logout_by_login_id(&login_id).await?;
222        }
223        
224        // 触发登录事件
225        let event = SaTokenEvent::login(login_id.clone(), token.as_str())
226            .with_login_type(&token_info.login_type);
227        self.event_bus.publish(event).await;
228        
229        Ok(token)
230    }
231    
232    /// 登出：删除指定 token
233    pub async fn logout(&self, token: &TokenValue) -> SaTokenResult<()> {
234        // 先从存储获取 token 信息，用于触发事件（不调用 get_token_info 避免递归）
235        let key = format!("sa:token:{}", token.as_str());
236        let token_info_str = self.storage.get(&key).await
237            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
238        
239        let token_info = if let Some(value) = token_info_str {
240            serde_json::from_str::<TokenInfo>(&value).ok()
241        } else {
242            None
243        };
244        
245        // 删除 token
246        self.storage.delete(&key).await
247            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
248        
249        // 触发登出事件
250        if let Some(info) = token_info.clone() {
251            let event = SaTokenEvent::logout(&info.login_id, token.as_str())
252                .with_login_type(&info.login_type);
253            self.event_bus.publish(event).await;
254            
255            // 如果有在线用户管理，通知用户下线
256            if let Some(online_mgr) = &self.online_manager {
257                online_mgr.mark_offline(&info.login_id, token.as_str()).await;
258            }
259        }
260        
261        Ok(())
262    }
263    
264    /// 根据登录 ID 登出所有 token
265    pub async fn logout_by_login_id(&self, login_id: &str) -> SaTokenResult<()> {
266        // 获取所有 token 键的前缀
267        let token_prefix = "sa:token:";
268        
269        // 获取所有 token 键
270        if let Ok(keys) = self.storage.keys(&format!("{}*", token_prefix)).await {
271            // 遍历所有 token 键
272            for key in keys {
273                // 获取 token 值
274                if let Ok(Some(token_info_str)) = self.storage.get(&key).await {
275                    // 反序列化 token 信息
276                    if let Ok(token_info) = serde_json::from_str::<TokenInfo>(&token_info_str) {
277                        // 如果 login_id 匹配，则登出该 token
278                        if token_info.login_id == login_id {
279                            // 提取 token 字符串（从键中移除前缀）
280                            let token_str = key[token_prefix.len()..].to_string();
281                            let token = TokenValue::new(token_str);
282                            
283                            // 调用登出方法（logout 方法内部会处理删除映射和在线用户管理）
284                            let _ = self.logout(&token).await;
285                        }
286                    }
287                }
288            }
289        }
290        
291        Ok(())
292    }
293    
294    /// 获取 token 信息
295    pub async fn get_token_info(&self, token: &TokenValue) -> SaTokenResult<TokenInfo> {
296        let key = format!("sa:token:{}", token.as_str());
297        let value = self.storage.get(&key).await
298            .map_err(|e| SaTokenError::StorageError(e.to_string()))?
299            .ok_or(SaTokenError::TokenNotFound)?;
300        
301        let token_info: TokenInfo = serde_json::from_str(&value)
302            .map_err(|e| SaTokenError::SerializationError(e))?;
303        
304        // 检查是否过期
305        if token_info.is_expired() {
306            // 删除过期的 token
307            self.logout(token).await?;
308            return Err(SaTokenError::TokenExpired);
309        }
310        
311        // 如果开启了自动续签，则自动续签
312        // 注意：为了避免递归调用 get_token_info，这里直接更新过期时间
313        if self.config.auto_renew {
314            let renew_timeout = if self.config.active_timeout > 0 {
315                self.config.active_timeout
316            } else {
317                self.config.timeout
318            };
319            
320            // 直接续签（不递归调用 get_token_info）
321            let _ = self.renew_timeout_internal(token, renew_timeout, &token_info).await;
322        }
323        
324        Ok(token_info)
325    }
326    
327    /// 检查 token 是否有效
328    pub async fn is_valid(&self, token: &TokenValue) -> bool {
329        self.get_token_info(token).await.is_ok()
330    }
331    
332    /// 获取 session
333    pub async fn get_session(&self, login_id: &str) -> SaTokenResult<SaSession> {
334        let key = format!("sa:session:{}", login_id);
335        let value = self.storage.get(&key).await
336            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
337        
338        if let Some(value) = value {
339            let session: SaSession = serde_json::from_str(&value)
340                .map_err(|e| SaTokenError::SerializationError(e))?;
341            Ok(session)
342        } else {
343            Ok(SaSession::new(login_id))
344        }
345    }
346    
347    /// 保存 session
348    pub async fn save_session(&self, session: &SaSession) -> SaTokenResult<()> {
349        let key = format!("sa:session:{}", session.id);
350        let value = serde_json::to_string(session)
351            .map_err(|e| SaTokenError::SerializationError(e))?;
352        
353        self.storage.set(&key, &value, None).await
354            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
355        
356        Ok(())
357    }
358    
359    /// 删除 session
360    pub async fn delete_session(&self, login_id: &str) -> SaTokenResult<()> {
361        let key = format!("sa:session:{}", login_id);
362        self.storage.delete(&key).await
363            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
364        Ok(())
365    }
366    
367    /// 续期 token（重置过期时间）
368    pub async fn renew_timeout(
369        &self,
370        token: &TokenValue,
371        timeout_seconds: i64,
372    ) -> SaTokenResult<()> {
373        let token_info = self.get_token_info(token).await?;
374        self.renew_timeout_internal(token, timeout_seconds, &token_info).await
375    }
376    
377    /// 内部续期方法（避免递归调用 get_token_info）
378    async fn renew_timeout_internal(
379        &self,
380        token: &TokenValue,
381        timeout_seconds: i64,
382        token_info: &TokenInfo,
383    ) -> SaTokenResult<()> {
384        let mut new_token_info = token_info.clone();
385        
386        // 设置新的过期时间
387        use chrono::{Utc, Duration};
388        let new_expire_time = Utc::now() + Duration::seconds(timeout_seconds);
389        new_token_info.expire_time = Some(new_expire_time);
390        
391        // 保存更新后的 token 信息
392        let key = format!("sa:token:{}", token.as_str());
393        let value = serde_json::to_string(&new_token_info)
394            .map_err(|e| SaTokenError::SerializationError(e))?;
395        
396        let timeout = std::time::Duration::from_secs(timeout_seconds as u64);
397        self.storage.set(&key, &value, Some(timeout)).await
398            .map_err(|e| SaTokenError::StorageError(e.to_string()))?;
399        
400        Ok(())
401    }
402    
403    /// 踢人下线
404    pub async fn kick_out(&self, login_id: &str) -> SaTokenResult<()> {
405        let token_result = self.storage.get(&format!("sa:login:token:{}", login_id)).await;
406        
407        if let Some(online_mgr) = &self.online_manager {
408            let _ = online_mgr.kick_out_notify(login_id, "Account kicked out".to_string()).await;
409        }
410        
411        self.logout_by_login_id(login_id).await?;
412        self.delete_session(login_id).await?;
413        
414        if let Ok(Some(token_str)) = token_result {
415            let event = SaTokenEvent::kick_out(login_id, token_str);
416            self.event_bus.publish(event).await;
417        }
418        
419        Ok(())
420    }
421}
sa_token_core/manager.rs

sa_token_core/
manager.rs
