c# DiffPlex介绍

DiffPlex 是一个用于生成文本差异（diffs）和补丁（patches）的 .NET 库，主要用于比较两个字符串或文件之间的差异。它提供了对行和字符级别的差异检测，并可以生成各种形式的差异报告。下面是 DiffPlex 的详细用法介绍，包括如何在 C# 中使用它。

1. 安装 DiffPlex

首先，在你的项目中添加 DiffPlex 的 NuGet 包。你可以使用以下命令通过 NuGet 包管理器安装：

dotnet add package DiffPlex

2. 基本用法

2.1 文本比较

using DiffPlex;
using DiffPlex.DiffBuilder;
using DiffPlex.DiffBuilder.Model;

class Program
{
    static void Main()
    {
        string oldText = "Hello World\nThis is the old text.";
        string newText = "Hello Universe\nThis is the new text.";

        var differ = new Differ();
        var diff = differ.CreateLineDiffs(oldText, newText, true);

        foreach (var diffBlock in diff.DiffBlocks)
        {
            Console.WriteLine($"Block at {diffBlock.InsertStart} to {diffBlock.DeleteStart}:");
            for (int i = 0; i < diffBlock.DeleteCount; i++)
            {
                Console.WriteLine($"- {oldText.Split('\n')[diffBlock.DeleteStart + i]}");
            }
            for (int i = 0; i < diffBlock.InsertCount; i++)
            {
                Console.WriteLine($"+ {newText.Split('\n')[diffBlock.InsertStart + i]}");
            }
        }
    }
}

在这个示例中，CreateLineDiffs 方法用于比较两个字符串，并返回一个 DiffResult 对象。你可以通过 DiffResult 的 DiffBlocks 属性来查看差异的详细信息。

2.2 使用 InlineDiffBuilder 比较文本

InlineDiffBuilder 可以生成内联格式的差异报告，显示文本的更改行。

using DiffPlex.DiffBuilder;
using DiffPlex.DiffBuilder.Model;

class Program
{
    static void Main()
    {
        string oldText = "Hello World\nThis is the old text.";
        string newText = "Hello Universe\nThis is the new text.";

        var inlineDiffBuilder = new InlineDiffBuilder(new Differ());
        var diffModel = inlineDiffBuilder.BuildDiffModel(oldText, newText);

        foreach (var line in diffModel.Lines)
        {
            switch (line.Type)
            {
                case ChangeType.Inserted:
                    Console.WriteLine($"+ {line.Text}");
                    break;
                case ChangeType.Deleted:
                    Console.WriteLine($"- {line.Text}");
                    break;
                case ChangeType.Modified:
                    Console.WriteLine($"~ {line.Text}");
                    break;
                default:
                    Console.WriteLine($"  {line.Text}");
                    break;
            }
        }
    }
}

2.3 使用 SideBySideDiffBuilder 比较文本

SideBySideDiffBuilder 可以生成并排格式的差异报告。

using DiffPlex.DiffBuilder;
using DiffPlex.DiffBuilder.Model;

class Program
{
    static void Main()
    {
        string oldText = "Hello World\nThis is the old text.";
        string newText = "Hello Universe\nThis is the new text.";

        var sideBySideDiffBuilder = new SideBySideDiffBuilder(new Differ());
        var diffModel = sideBySideDiffBuilder.BuildDiffModel(oldText, newText);

        for (int i = 0; i < diffModel.OldText.Lines.Count; i++)
        {
            var oldLine = diffModel.OldText.Lines[i];
            var newLine = diffModel.NewText.Lines[i];

            Console.WriteLine($"Old: {oldLine.Text ?? ""} New: {newLine.Text ?? ""}");
        }
    }
}

3. 高级用法

3.1 字符级别的比较

除了行级别的比较，DiffPlex 还支持字符级别的比较。可以用 CreateCharacterDiffs 方法来实现。

var differ = new Differ();
var diff = differ.CreateCharacterDiffs("Hello World", "Hello Universe", true);

3.2 自定义比较器

DiffPlex 允许你定义自己的差异比较逻辑。你可以继承 IDiffer 接口，并实现自己的比较算法。

public class MyCustomDiffer : IDiffer
{
    public DiffResult CreateLineDiffs(string oldText, string newText, bool ignoreWhitespace)
    {
        // 自定义比较逻辑
    }

    public DiffResult CreateCharacterDiffs(string oldText, string newText, bool ignoreWhitespace)
    {
        // 自定义比较逻辑
    }
}

4. 实际应用场景

• 版本控制系统：对文件或文档的不同版本进行比较。
• 编辑器或IDE：提供差异比较功能，以查看文本修改前后的变化。
• 自动化测试：比较期望输出与实际输出之间的差异。