Hashids.NET 技术文档

1. 安装指南

要安装 Hashids.NET，请使用 NuGet 包管理器。在您的项目中选择“管理 NuGet 包”，然后搜索 hashids.net。点击安装，即可将包添加到您的项目中。

安装命令如下：

Install-Package hashids.net

2. 项目使用说明

Hashids.NET 是一个小巧的 .NET 库，用于生成类似 YouTube 的 ID。它可以将数字（如 347）转换为字符串（如 yr8），或将数字数组（如 [27, 986]）转换为 3kTMd。您还可以将这些 ID 解码回原始数字。这对于将多个参数捆绑在一起、隐藏实际 ID 或仅作为短字符串 ID 使用非常有用。

使用步骤

1. 引入命名空间：

   using HashidsNet;
   

2. 编码一个数字：

   var hashids = new Hashids("this is my salt");
   var hash = hashids.Encode(12345);
   

   hash 将是：

   NkK9
   

   如果您的 ID 存储为 Int64，则需要使用 EncodeLong 方法。

3. 解码：

   var hashids = new Hashids("this is my salt");
   var numbers = hashids.Decode("NkK9");
   

   numbers 将是：

   [ 12345 ]
   

注意事项

• 不是真正的加密哈希，因为它是可逆的。
• 只支持零和正整数。负数将不会被编码。
• 只能指定最小哈希长度。无法将任意数字拟合在最大哈希长度内。
• 字母表区分大小写，且至少包含 16 个唯一字符。
• 分隔符用于在哈希中编码多个数字，也必须在字母表中。
• 盐必须小于可用的字母表，并且长度限于 字母表长度 - 分隔符长度 - 1。

3. 项目 API 使用文档

以下是一些 Hashids.NET 的主要 API 方法：

• Encode(int number): 编码一个整数。
• EncodeLong(long number): 编码一个长整数。
• Decode(string hash): 解码一个哈希字符串，返回一个整数数组。
• DecodeLong(string hash): 解码一个哈希字符串，返回一个长整数数组。
• DecodeSingle(string hash): 解码一个哈希字符串，返回单个整数。
• DecodeSingleLong(string hash): 解码一个哈希字符串，返回单个长整数。

更多方法和详细信息，请参考项目文档和源代码。

4. 项目安装方式

如前所述，您可以通过 NuGet 包管理器安装 Hashids.NET。在 Visual Studio 中，选择“管理 NuGet 包”，搜索 hashids.net，然后点击安装。也可以使用NuGet命令行工具，运行以下命令：

Install-Package hashids.net

以上就是 Hashids.NET 的技术文档。希望这对您使用该库有所帮助。