一个.NET的轻量级JWT库

.NET JWT

# 开源推荐 2022-12-26 10:30 DotNet宝藏库

一个.NET的轻量级JWT库LitJWT，LitJWT号称主要关注性能，能提升至少5倍的编码/解码速度，以及更少的配置！

LitJWT支持的平台为netstandard 2.1或net5.0更高。

LitJWT宣传的性能对比图：

使用方法：

1、安装依赖：

PM> Install-Package LitJWT

2、使用：

// Get recommended-size random key.
var key = HS256Algorithm.GenerateRandomRecommendedKey();

// Create encoder, JwtEncoder is thread-safe and recommend to store static/singleton.
var encoder = new JwtEncoder(new HS256Algorithm(key));

// Encode with payload, expire, and use specify payload serializer.
var token = encoder.Encode(new { foo = "pay", bar = "load" }, TimeSpan.FromMinutes(30));

// Create decoder, JwtDecoder is also thread-safe so recommend to store static/singleton.
var decoder = new JwtDecoder(encoder.SignAlgorithm);

// Decode and verify, you can check the result.
var result = decoder.TryDecode(token, out var payload);
if (result == DecodeResult.Success)
{
    Console.WriteLine((payload.foo, payload.bar));
}

自定义序列化：

在默认情况下。LitJWT 使用System.Text.Json.JsonSerializer进行序列号。如果你想使用自定义JsonSerializerOptions的话，JwtEncoder与JwtDecoder有JsonSerializerOptions serializerOptions构造函数的重载。

如果你想使用另一个序列化器，编码方法接收Action<T, JwtWriter> payloadWriter。您必须调用writer.Write(ReadOnlySpan<byte> payload)方法来序列化。ReadOnlySpan<byte>必须是 Utf8 。

这是使用 JSON.NET 的示例，这有编码开销。

var token = encoder.Encode(new PayloadSample { foo = "pay", bar = "load" }, TimeSpan.FromMinutes(30),
    (x, writer) => writer.Write(Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(x))));

解码方法接收delegate T PayloadParser<T>(ReadOnlySpan<byte> payload)。ReadOnlySpan<byte>是utf8 json。基于 utf8 的序列化是最好的，虽然也可以使用 JSON.NET（但有编码损失）。

var result = decoder.TryDecode(token, x => JsonConvert.DeserializeObject<PayloadSample>(Encoding.UTF8.GetString(x)), out var payload);

一个.NET的轻量级JWT库

随机推荐文章