.NET中如何使用 IFormattable 接口实现格式化输出

封面图 • 2025-05-16 • .NET

在 .NET 中，`IFormattable` 接口用于支持自定义的格式化操作。通过实现这个接口，你可以控制对象如何被格式化为字符串。`IFormattable` 接口包含一个方法 `Format`，它允许你指定格式说明符和区域性信息。

以下是实现和使用 `IFormattable` 接口的基本步骤：

### 1. 实现 `IFormattable` 接口

首先，你需要创建一个类并实现 `IFormattable` 接口。然后在该类中实现 `Format` 方法。

```csharp
using System;

public class CustomNumber : IFormattable
{
    private int value;

public CustomNumber(int value)
    {
        this.value = value;
    }

// 实现 IFormattable 接口的 Format 方法
    public string ToString(string format, IFormatProvider formatProvider)
    {
        if (string.IsNullOrEmpty(format))
        {
            format = "G"; // 默认格式
        }

switch (format.ToUpper())
        {
            case "D": // 自定义的 "D" 格式
                return $"Custom Number: {value:D}";
            case "C": // 自定义的 "C" 格式
                return $"Custom Currency: {value:C}";
            default:
                return $"Custom Default: {value}";
        }
    }
}
```

在这个例子中，我们创建了一个 `CustomNumber` 类，它实现了 `IFormattable` 接口，并在 `ToString` 方法中根据不同的格式说明符返回不同的字符串表示形式。

- 如果格式是 `"D"`，则返回带有前缀的数字。
- 如果格式是 `"C"`，则返回带有货币符号的数字。
- 如果没有提供格式或格式不匹配，则返回默认的字符串表示。

### 2. 使用 `IFormattable` 对象

现在我们可以使用这个 `CustomNumber` 类来格式化输出。

```csharp
class Program
{
    static void Main()
    {
        CustomNumber number = new CustomNumber(42);

// 使用默认格式
        Console.WriteLine(number);  // 输出: Custom Default: 42

// 使用 "D" 格式
        Console.WriteLine(number.ToString("D", null));  // 输出: Custom Number: 42

// 使用 "C" 格式
        Console.WriteLine(number.ToString("C", null));  // 输出: Custom Currency: $42.00

// 使用自定义格式
        Console.WriteLine(number.ToString("X", null));  // 输出: Custom Default: 42
    }
}
```

### 3. 关键点解析

- **`ToString(string format, IFormatProvider formatProvider)`**：这是 `IFormattable` 接口的核心方法，用于格式化对象。`format` 参数是用户提供的格式说明符，`formatProvider` 参数可以用来提供区域性信息（如货币符号、日期格式等）。
  
- **`null` 作为 `formatProvider`**：在上面的例子中，我们将 `formatProvider` 设置为 `null`，这意味着使用系统的默认区域性设置。如果你需要特定的区域性（例如法语或德语），可以传递相应的 `IFormatProvider` 实现。

- **灵活性**：通过实现 `IFormattable`，你可以为你的类提供灵活的格式化选项，使你的对象能够以多种方式输出。

### 4. 扩展性

你还可以扩展 `CustomNumber` 类，使其支持更多的格式化选项。例如，你可以添加对日期格式的支持，或者根据区域性调整输出内容。

### 总结

通过实现 `IFormattable` 接口，你可以为自定义类型提供强大的格式化能力。这在需要高度定制化的字符串表示时非常有用，比如处理货币、日期时间或其他复杂的数据类型。