NaturalSort.Extension 项目使用教程

NaturalSort.Extension 项目使用教程

NaturalSort.Extension 🔀 Extension method for StringComparison that adds support for natural sorting (e.g. "abc1", "abc2", "abc10" instead of "abc1", "abc10", "abc2"). 项目地址: https://gitcode.com/gh_mirrors/na/NaturalSort.Extension

1. 项目介绍

NaturalSort.Extension 是一个用于自然排序的 C# 库，它扩展了 StringComparison 和 IComparer<string>，支持自然排序（例如 "abc1", "abc2", "abc10" 而不是 "abc1", "abc10", "abc2"）。该项目在 GitHub 上开源，使用 MIT 许可证，允许商业使用和分发。

主要功能

• 自然排序：支持字符串的自然排序，避免数字部分按字典序排序的问题。
• 扩展方法：提供扩展方法 WithNaturalSort()，方便在现有代码中集成。
• 多平台支持：支持 .NET Standard 1.3、.NET 6 和 .NET 8。

2. 项目快速启动

安装

通过 NuGet 安装 NaturalSort.Extension：

PM> Install-Package NaturalSort.Extension

使用示例

以下是一个简单的使用示例，展示如何使用 NaturalSort.Extension 进行自然排序：

using NaturalSort.Extension;
using System;
using System.Linq;

class Program
{
    static void Main()
    {
        var sequence = new[] { "img12.png", "img10.png", "img2.png", "img1.png" };
        var ordered = sequence.OrderBy(x => x, StringComparison.OrdinalIgnoreCase.WithNaturalSort());

        foreach (var item in ordered)
        {
            Console.WriteLine(item);
        }
    }
}

输出结果将是：

img1.png
img2.png
img10.png
img12.png

3. 应用案例和最佳实践

应用案例

文件名排序

在处理文件名时，自然排序非常有用。例如，在文件管理器中，文件名按自然顺序排序可以更直观地显示文件。

数据库排序

在数据库查询中，使用自然排序可以确保结果按预期顺序排列。例如，在 SQLite 中注册自定义排序规则：

private static readonly NaturalSortComparer NaturalComparer = new(StringComparison.InvariantCultureIgnoreCase);

using (var conn = new SqliteConnection("Data Source=:memory:"))
{
    conn.CreateCollation("NATURALSORT", (x, y) => NaturalComparer.Compare(x, y));
    conn.Open();

    var command = conn.CreateCommand();
    command.CommandText = "SELECT * FROM Customers ORDER BY Name COLLATE NATURALSORT";
    var reader = command.ExecuteReader();
}

最佳实践

• 使用 StringComparison 枚举：推荐使用 StringComparison 枚举来创建比较器，以获得最佳性能。
• 避免重复创建比较器：在性能敏感的场景中，避免重复创建 NaturalSortComparer 实例，可以提升性能。

4. 典型生态项目

相关项目

• C# 排序库：NaturalSort.Extension 是一个专注于字符串自然排序的库，适用于需要精确排序的场景。
• SQLite 扩展：该项目还支持在 SQLite 中注册自定义排序规则，适用于需要数据库内排序的场景。

集成项目

• .NET 生态：该项目可以与任何使用 .NET Standard 1.3、.NET 6 或 .NET 8 的项目集成，广泛应用于各种 .NET 应用程序中。

通过以上内容，您可以快速了解并开始使用 NaturalSort.Extension 项目。

NaturalSort.Extension 🔀 Extension method for StringComparison that adds support for natural sorting (e.g. "abc1", "abc2", "abc10" instead of "abc1", "abc10", "abc2"). 项目地址: https://gitcode.com/gh_mirrors/na/NaturalSort.Extension