CKTIS / C#
Formattazione personalizzata in .NET: provider, formattatore e tipo
Distingui tre contratti di formattazione: trovare un servizio, intercettare un elemento e lasciare che il tipo del valore produca il testo.
Versione: C# 12 and .NET 8; later runtimes may add compatible features
Sintassi
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)In C# 12 e .NET 8, tutte e tre le interfacce appartengono a System. L’overload di string.Format che accetta un provider chiama IFormatProvider.GetFormat(Type?) con typeof(ICustomFormatter), non con il tipo del valore da formattare. Il provider restituisce un servizio del tipo richiesto oppure null. Può restituire this se implementa il servizio. Il formattatore trovato viene riutilizzato durante la chiamata.
Per {0:F2}, ICustomFormatter.Format riceve "F2", l’argomento di indice zero e il provider. In {0} manca il codice di formato, quindi il metodo riceve null. Qualsiasi stringa restituita, anche "", completa la formattazione dell’elemento. Se restituisce null, questo overload di string.Format prosegue con la formattazione ordinaria. Il ! in null! sopprime solo un avviso di nullabilità: il metodo restituisce comunque null, anche se il tipo restituito è string.
Se il formattatore personalizzato non è disponibile o non gestisce l’elemento, in .NET 8 string.Format può prima tentare di usare ISpanFormattable.TryFormat. Se questo passaggio viene saltato o TryFormat restituisce false, un argomento non nullo che implementa IFormattable viene formattato tramite IFormattable.ToString(format, provider). Per gli altri argomenti non nulli si usa ToString() senza parametri, che non riceve il codice di formato. Un argomento null che arriva alla formattazione ordinaria è trattato come una stringa vuota prima di aggiungere eventuali spazi per l’allineamento. Implementa "G" e null come formato generale. Un tipo può generare FormatException per un codice non supportato; string.Format può generare la stessa eccezione indipendentemente, per esempio per un indice fuori dall’elenco degli argomenti.
Chiamare direttamente ToString con due argomenti non richiama automaticamente ICustomFormatter. Il tipo può comunque usare il provider, ad esempio per ottenere NumberFormatInfo o DateTimeFormatInfo tramite GetFormat. Evita di richiamare string.Format dentro Format con lo stesso provider, argomento e codice: potresti rientrare nello stesso formattatore.
Esempi
#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";
}Risultato
[12.50 V] | 12.50 V | 12.5 V
Il formattatore gestisce `bracket` per `Voltage` chiamando direttamente `ToString("F2", formatProvider)` e aggiungendo parentesi quadre. Gli altri due elementi vengono formattati da `Voltage.ToString`. Il provider delega le richieste di dati delle impostazioni locali a `CultureInfo.InvariantCulture`, quindi il separatore decimale è un punto.
Lezioni correlate
- C# · Lezione 33 · Avanzato · Versione: 3