CKTIS / C#
Mise en forme personnalisée dans .NET : fournisseur, formateur et type
Distinguez trois contrats : trouver un service de mise en forme, traiter un élément de format et laisser le type de la valeur produire le texte.
Version : C# 12 and .NET 8; later runtimes may add compatible features
Syntaxe
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)En C# 12 et .NET 8, les trois interfaces appartiennent à System. La surcharge de string.Format qui accepte un fournisseur appelle IFormatProvider.GetFormat(Type?) avec typeof(ICustomFormatter), et non avec le type de la valeur à mettre en forme. Le fournisseur renvoie un service du type demandé ou null. Il peut renvoyer this s’il implémente lui-même le service. Le formateur trouvé est réutilisé pendant cet appel.
Pour {0:F2}, ICustomFormatter.Format reçoit "F2", l’argument d’indice zéro et le fournisseur. Dans {0}, le code de format est absent : la méthode reçoit donc null. Toute chaîne renvoyée, même "", suffit à traiter l’élément. Si la méthode renvoie null, cette surcharge de string.Format poursuit la mise en forme ordinaire. Le ! de null! ne fait que supprimer un avertissement de nullabilité : la méthode renvoie bien null malgré son type de retour string.
Si aucun formateur personnalisé n’est disponible ou s’il ne traite pas l’élément, string.Format peut d’abord tenter d’utiliser ISpanFormattable.TryFormat dans .NET 8. Si cette étape est ignorée ou si TryFormat renvoie false, un argument non nul qui implémente IFormattable est mis en forme par IFormattable.ToString(format, provider). Pour les autres arguments non nuls, ToString() sans paramètre est utilisé et ne reçoit pas le code de format. Un argument null qui atteint la mise en forme ordinaire est traité comme une chaîne vide avant tout ajout d’espaces pour l’alignement. Prévoyez le format général pour "G" et null. Un type peut lever FormatException pour un code non pris en charge ; string.Format peut lever la même exception indépendamment, par exemple pour un indice hors de la liste des arguments.
Un appel direct à ToString avec deux arguments n’invoque pas automatiquement ICustomFormatter. Le type peut néanmoins utiliser le fournisseur pour obtenir, par exemple, NumberFormatInfo ou DateTimeFormatInfo via GetFormat. Dans Format, évitez de rappeler string.Format avec le même fournisseur, le même argument et le même code : vous risquez de rappeler le même formateur.
Exemples
#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";
}Résultat
[12.50 V] | 12.50 V | 12.5 V
Le formateur traite `bracket` pour `Voltage` en appelant directement `ToString("F2", formatProvider)` et en ajoutant des crochets. Les deux autres éléments passent par `Voltage.ToString`. Le fournisseur délègue les demandes de données culturelles à `CultureInfo.InvariantCulture`, de sorte que le séparateur décimal est un point.
Leçons associées
- C# · Leçon 33 · Avancé · Version : 3