Skip to main content

JwtUtil

Struct JwtUtil 

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

JWT 生成与解析工具

基于 HMAC-SHA256 签名的 JWT Token 管理。

§示例

use tdm_server_rust::utils::JwtUtil;

let util = JwtUtil::new("my_secret_key", 7_200_000); // 2h 过期
let token = util.generate(42).expect("生成应成功");

// 解析并验证
let claims = util.parse(&token).expect("解析应成功");
assert_eq!(claims.id, 42);

§Panics

不 panic。所有错误通过 jsonwebtoken::errors::Result 返回。

§安全性

  • 签名密钥从配置文件 jwt.sign_key 加载
  • 默认有效期由 jwt.expire_ms 控制
  • 解析时自动验证签名和过期时间

Implementations§

Source§

impl JwtUtil

Source

pub fn new(sign_key: impl Into<String>, expire_ms: i64) -> Self

构造 JWT 工具实例。

§参数
  • sign_key: HMAC-SHA256 签名密钥
  • expire_ms: Token 过期时间(毫秒)
§返回值

返回配置好的 JwtUtil

Source

pub fn generate(&self, member_id: i32) -> Result<String>

生成 JWT Token。

Claims 仅包含 idexp 字段,与 Java 端一致。

§参数
  • member_id: 组员 ID
§返回值

成功返回签名的 JWT 字符串。

§Errors

仅当 HMAC 签名算法不可用时失败(不应发生)。

Source

pub fn parse(&self, token: &str) -> Result<JwtClaims>

解析并验证 JWT Token。

自动验证签名和过期时间。

§参数
  • token: 待解析的 JWT 字符串
§返回值

成功返回反序列化的 JwtClaims

§Errors
错误说明
InvalidSignature签名不匹配(密钥错误或 token 被篡改)
ExpiredSignatureToken 已过期
InvalidTokenToken 格式不合法

在 auth 中间件中,ExpiredSignature 会被转为 AppError::login_expired("登录数据过期,请重新登录喵!")

Source

pub fn generate_from_map( &self, claims: HashMap<String, Value>, ) -> Result<String>

从 HashMap 生成(扩展用)

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.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

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

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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