CKTIS / C#
Потребителско форматиране в .NET: доставчик, форматиращ обект и тип
Разграничи три договора за форматиране: намиране на услуга, обработка на елемент от формата и създаване на текст от самия тип на стойността.
Версия: C# 12 and .NET 8; later runtimes may add compatible features
Синтаксис
C# 12 / .NET 8, namespace System
IFormatProvider: object? GetFormat(Type? formatType);
ICustomFormatter: string Format(string? format, object? arg, IFormatProvider? formatProvider);
IFormattable: string ToString(string? format, IFormatProvider? formatProvider);
Composite formatting: string.Format(provider, "{0:code}", value)
Direct call: ((IFormattable)value).ToString("G", provider)В C# 12 и .NET 8 и трите интерфейса са в пространството от имена System. Версията на string.Format, която приема доставчик, извиква IFormatProvider.GetFormat(Type?) с typeof(ICustomFormatter), а не с типа на форматираната стойност. Доставчикът връща услуга от поискания тип или null. Ако сам реализира услугата, може да върне this. Намереният форматиращ обект се използва повторно в рамките на същото извикване.
За {0:F2} методът ICustomFormatter.Format получава "F2", аргумента с индекс нула и доставчика. В {0} няма код на формата, затова методът получава null. Всеки върнат низ, дори "", приключва обработката на елемента. Ако методът върне null, тази версия на string.Format продължава с обичайното форматиране. Знакът ! в null! само потиска предупреждение за възможна стойност null: методът връща null, въпреки че типът на резултата е string.
Ако няма потребителски форматиращ обект или той не обработи елемента, в .NET 8 string.Format може първо да опита да форматира аргумента чрез ISpanFormattable.TryFormat. Ако тази стъпка бъде пропусната или TryFormat върне false, аргумент, различен от null, който реализира IFormattable, се форматира чрез IFormattable.ToString(format, provider). За останалите аргументи, различни от null, се използва ToString() без параметри, който не получава кода на формата. Аргумент със стойност null, който стигне до обичайното форматиране, се третира като празен низ, преди да се добавят евентуални интервали за подравняване. Реализирай "G" и null като общ формат. Типът може да хвърли FormatException за неподдържан код; string.Format може независимо да хвърли същото изключение например при индекс извън списъка с аргументи.
Прякото извикване на ToString с два аргумента не извиква автоматично ICustomFormatter. Типът все пак може да използва доставчика, например за да получи NumberFormatInfo или DateTimeFormatInfo чрез GetFormat. Не извиквай отново string.Format в Format със същия доставчик, аргумент и код: така можеш да задействаш повторно същия форматиращ обект.
Примери
#nullable enable
using System;
using System.Globalization;
var provider = new ReadingFormatProvider();
var reading = new Voltage(12.5m);
Console.WriteLine(string.Format(provider, "{0:bracket} | {0:F2} | {0}", reading));
sealed class ReadingFormatProvider : IFormatProvider, ICustomFormatter
{
public object? GetFormat(Type? formatType) =>
formatType == typeof(ICustomFormatter)
? this
: CultureInfo.InvariantCulture.GetFormat(formatType);
public string Format(string? format, object? arg, IFormatProvider? formatProvider)
{
if (format == "bracket" && arg is Voltage voltage)
return "[" + voltage.ToString("F2", formatProvider) + "]";
return null!; // string.Format continues with ordinary formatting.
}
}
sealed class Voltage(decimal volts) : IFormattable
{
public override string ToString() => ToString("G", null);
public string ToString(string? format, IFormatProvider? formatProvider) =>
(format switch
{
null or "G" => volts.ToString("G", formatProvider),
"F2" => volts.ToString("F2", formatProvider),
_ => throw new FormatException($"Unsupported voltage format: {format}")
}) + " V";
}Резултат
[12.50 V] | 12.50 V | 12.5 V
Форматиращият обект обработва `bracket` за `Voltage`, като извиква пряко `ToString("F2", formatProvider)` и добавя квадратни скоби. Останалите два елемента се обработват от `Voltage.ToString`. Доставчикът препраща заявките за регионални настройки към `CultureInfo.InvariantCulture`, затова десетичният разделител е точка.
Свързани уроци
- C# · Урок 33 · Напреднало · Версия: 3