在 .NET 中使用 Sqids 快速的为数字 ID 披上神秘短串,轻松隐藏敏感数字!

前言

在当今数字化时代,数据的安全性和隐私性至关重要。随着网络应用的不断发展,数字 ID 作为数据标识和访问控制的关键元素,其保护显得尤为重要。然而,传统的数字 ID 往往直接暴露了一些敏感信息,如顺序编号或数据库主键ID,这不仅增加了数据泄露的风险,还可能让不法分子有机可乘。

本文大姚将带领大家在 .NET 中使用 Sqids 快速的为数字 ID 披上神秘短串,从而轻松隐藏敏感数字,保护数据安全。

Sqids 介绍

Sqids 是一个基于 C# 编写、开源的轻量级工具库,它允许你从数字生成类似 YouTube 的 ID。它可以将数字(如 127)编码为字符串(如 yc3),然后你可以将这些字符串解码回原始数字。当你想要将数字(如顺序数值 ID)混淆为看似随机的字符串,以便在 URL 和其他地方使用时,Sqids 就非常派得上用场。

功能特点

  • Sqids 生成的 ID 是唯一的,并且始终可以解码回原始数字。
  • 可以将多个数字捆绑成一个 ID,然后可以将该 ID 解码回相同的数字集。
  • Sqids 生成的 ID 确保不包含常见的脏话,因此您可以在用户可以看到的地方安全地使用这些 ID(例如在 URL 中)。
  • .NET 7 及以上版本支持所有整数类型(如 int、long、byte、short 等),而旧版本仅支持 int。
  • 采用基于 span 的优化实现,最小化内存分配并最大化性能。

创建一个控制台应用

首先我们创建一个名为:SqidsExercise 的 .NET 9 控制台应用:

安装 Sqids NuGet 包

在 NuGet 包管理器中搜索 Sqids 安装:

简单使用示例

复制代码
    internal class Program
    {
        static void Main(string[] args)
        {
            // 使用默认选项创建 SqidsEncoder 实例
            var sqids = new SqidsEncoder<int>();

            // 编码单个数字
            var id = sqids.Encode(99);
            Console.WriteLine($"编码单个数字: {id}"); // 输出:Q8P

            // 解码单个 ID
            var number = sqids.Decode(id).Single();
            Console.WriteLine($"解码单个 ID '{id}': {number}"); // 输出:99

            // 编码多个数字
            var ids = sqids.Encode(7, 8, 9);
            Console.WriteLine($"编码多个数字 7, 8, 9: {ids}"); // 输出:ylrR3H

            // 解码多个 ID
            var numbers = sqids.Decode(ids);
            Console.WriteLine($"解码多个 ID '{ids}': {string.Join(", ", numbers)}"); // 输出:7, 8, 9

            // 使用自定义选项创建 SqidsEncoder 实例
            var customSqids = new SqidsEncoder<int>(new SqidsOptions
            {
                Alphabet = "mTHivO7hx3RAbr1f586SwjNnK2lgpcUVuG09BCtekZdJ4DYFPaWoMLQEsXIqyz",//自定义字母表(注意:字母表至少需要 3 个字符)
                MinLength = 5,//最小长度,默认情况下,Sqids 使用尽可能少的字符来编码给定的数字。但是,如果你想让你的所有 ID 至少达到一定的长度(例如,为了美观),你可以通过 MinLength 选项进行配置:
                BlockList = { "whatever", "else", "you", "want" } //自定义黑名单,Sqids 自带一个大的默认黑名单,这将确保常见的诅咒词等永远不会出现在您的 ID 中。您可以像这样向这个默认黑名单添加额外项:
            });

            // 使用自定义 SqidsEncoder 编码和解码
            var customId = customSqids.Encode(8899);
            Console.WriteLine($"使用自定义 SqidsEncoder 编码: {customId}"); // 输出:i1uYg

            var customNumber = customSqids.Decode(customId).Single();
            Console.WriteLine($"使用自定义 SqidsEncoder 解码: {customNumber}"); // 输出:8899
        }
    }

项目源码地址

更多项目实用功能和特性欢迎前往项目开源地址查看👀,别忘了给项目一个Star支持💖。

优秀项目和框架精选

该项目已收录到C#/.NET/.NET Core优秀项目和框架精选中,关注优秀项目和框架精选能让你及时了解C#、.NET和.NET Core领域的最新动态和最佳实践,提高开发工作效率和质量。坑已挖,欢迎大家踊跃提交PR推荐或自荐(让优秀的项目和框架不被埋没🤞)。

相关推荐
追逐时光者2 天前
C#/.NET/.NET Core优秀项目和框架2025年4月简报
【.net】·【c#】·【.net core】·【每月简报】
追逐时光者3 天前
C# 14 新增功能一览,你觉得实用吗?
【.net】·【c#】·【.net core】·【拾遗补漏】
追逐时光者5 天前
一个包含 80+ C#/.NET 编程技巧实战练习开源项目!
【.net】·【c#】·【开源项目】·【.net core】
追逐时光者8 天前
分享5款开源、美观的 WinForm UI 控件库
【.net】·【c#】·【开源项目】·【winform】
追逐时光者9 天前
一个基于 C# Unity 开发的金庸群侠传 3D 版,直呼牛逼!
【c#】·【开源游戏】
追逐时光者11 天前
EF Core 10 现已支持 LeftJoin 和 RightJoin 运算符查询了!
【.net】·【c#】·【.net core】·【拾遗补漏】·【ef core】
追逐时光者12 天前
一个开源、经典的 WPF 控件、组件和实用工具集合,值得参考学习!
【.net】·【开源项目】·【wpf】
追逐时光者14 天前
精选 14 款 .NET 开源、功能强大的快速开发框架,提高开发生产效率、避免工作996!
【.net】·【c#】·【开源项目】·【.net core】