Crate sa_token_plugin_rocket 

sa-token-plugin-rocket

Rocket框架集成插件 - 一站式认证授权解决方案

快速开始

只需要导入这一个包，即可使用所有功能：

[dependencies]
sa-token-plugin-rocket = "0.1.3"  # 默认使用内存存储
# 或者使用 Redis 存储
sa-token-plugin-rocket = { version = "0.1.3", features = ["redis"] }

使用示例

use rocket::{State, get};
use sa_token_plugin_rocket::*;  // 一次性导入所有功能
 
#[get("/user/info")]
async fn user_info(token: SaTokenGuard) -> String {
    format!("User ID: {}", token.login_id())
}
 
#[rocket::main]
async fn main() {
    // 1. 初始化（使用内存存储，已重新导出）
    let state = SaTokenState::builder()
        .storage(Arc::new(MemoryStorage::new()))
        .timeout(7200)
        .build();
     
    // 2. 创建 Rocket 实例
    rocket::build()
        .attach(SaTokenFairing::new(state.manager.clone()))
        .manage(state)
        .mount("/", routes![user_info])
        .launch()
        .await
        .unwrap();
}

Re-exports

pub use middleware::SaTokenFairing;

pub use extractor::SaTokenGuard;

pub use extractor::OptionalSaTokenGuard;

pub use extractor::LoginIdGuard;

pub use adapter::RocketRequestAdapter;

pub use adapter::RocketResponseAdapter;

Modules

adapter

Rocket 请求/响应适配器

extractor

Rocket Request Guards (提取器)

middleware

Rocket Fairing (中间件)

Structs

AccessToken

Access Token Response | 访问令牌响应

AuthorizationCode

Authorization Code | 授权码

DefaultWsTokenExtractor

Default token extractor implementation 默认的 Token 提取器实现

DistributedSession

Distributed session data structure 分布式 Session 数据结构

DistributedSessionManager

Distributed session manager 分布式 Session 管理器

InMemoryDistributedStorage

In-memory distributed session storage implementation 内存分布式 Session 存储实现

InMemoryPusher

In-memory message pusher implementation 内存消息推送器实现

JwtClaims

JWT Claims | JWT 声明

JwtManager

JWT Manager | JWT 管理器

LoggingListener

简单的日志监听器示例

MemoryStorage

内存存储（默认启用） 内存存储实现

NonceManager

Nonce Manager | Nonce 管理器

OAuth2Client

OAuth2 Client Information | OAuth2 客户端信息

OAuth2Manager

OAuth2 Manager | OAuth2 管理器

OAuth2TokenInfo

OAuth2 Token Information (for storage) | OAuth2 令牌信息（用于存储）

OnlineManager

Online user manager 在线用户管理器

OnlineUser

Online user information 在线用户信息

PushMessage

Push message structure 推送消息结构

RefreshTokenManager

Refresh Token Manager | Refresh Token 管理器

SaSession

Session 对象 | Session Object

SaTokenConfig

sa-token 配置

SaTokenEvent

事件数据

SaTokenEventBus

事件总线 - 管理所有监听器并分发事件

SaTokenManager

sa-token 管理器

SaTokenState

Rocket 应用状态

SaTokenStateBuilder

状态构建器

ServiceCredential

Service credential for inter-service authentication 服务间认证的服务凭证

StpUtil

StpUtil - 权限认证工具类

TokenInfo

Token 信息 | Token Information

TokenValue

Token 值

WsAuthInfo

WebSocket authentication information WebSocket 认证信息

WsAuthManager

WebSocket authentication manager WebSocket 认证管理器

Enums

JwtAlgorithm

JWT Algorithm | JWT 算法

MessageType

Message type enumeration 消息类型枚举

SaTokenError

TokenStyle

Token 风格 | Token Style

Traits

DistributedSessionStorage

Distributed session storage trait 分布式 Session 存储 trait

FrameworkAdapter

框架适配器trait

MessagePusher

Message pusher trait 消息推送器 trait

PermissionChecker

权限检查器 | Permission Checker

SaStorage

存储适配器trait

SaTokenListener

事件监听器 trait | Event Listener Trait

WsTokenExtractor

Token extractor trait for WebSocket connections WebSocket 连接的 Token 提取器 trait

Attribute Macros

sa_check_login

检查登录状态的宏

sa_check_permission

检查权限的宏

sa_check_permissions_and

同时检查多个权限（AND逻辑）

sa_check_permissions_or

同时检查多个权限（OR逻辑）

sa_check_role

检查角色的宏

sa_check_roles_and

同时检查多个角色（AND逻辑）

sa_check_roles_or

同时检查多个角色（OR逻辑）

sa_ignore

忽略认证检查的宏