Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / C#

Vlastní formátování v .NET: poskytovatel, formátovač a typ

Rozliš tři smlouvy formátování: vyhledání služby, zpracování položky formátu a vytvoření textu samotným typem hodnoty.

Verze: 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)

V C# 12 a .NET 8 jsou všechna tři rozhraní v oboru názvů System. Přetížení string.Format s poskytovatelem volá IFormatProvider.GetFormat(Type?) s požadavkem typeof(ICustomFormatter), nikoli s typem formátované hodnoty. Poskytovatel vrací službu požadovaného typu nebo null. Pokud službu sám implementuje, může vrátit this. Nalezený formátovač se v rámci tohoto volání používá opakovaně.

Pro {0:F2} dostane ICustomFormatter.Format hodnotu "F2", argument na indexu nula a poskytovatele. V {0} kód formátu chybí, takže metoda dostane null. Vrácený řetězec, i "", uzavírá zpracování položky. Vrátí-li metoda null, toto přetížení string.Format pokračuje běžným formátováním. Znak ! v null! pouze potlačí upozornění na možnou hodnotu null: metoda stále vrací null, přestože návratový typ je string.

Pokud vlastní formátovač není k dispozici nebo položku nezpracuje, může string.Format v .NET 8 nejprve zkusit použít ISpanFormattable.TryFormat. Pokud se tento krok přeskočí nebo TryFormat vrátí false, argument různý od null, který implementuje IFormattable, se formátuje pomocí IFormattable.ToString(format, provider). U ostatních argumentů různých od null se použije bezparametrové ToString(), které nedostane kód formátu. Argument null, který se dostane k běžnému formátování, se před případným doplněním mezer pro zarovnání zpracuje jako prázdný řetězec. Pro "G" a null implementuj obecný formát. Typ může při nepodporovaném kódu vyvolat FormatException; string.Format může nezávisle vyvolat stejnou výjimku například při indexu mimo seznam argumentů.

Přímé volání ToString se dvěma argumenty nespouští automaticky ICustomFormatter. Typ ovšem může poskytovatele použít například k získání NumberFormatInfo nebo DateTimeFormatInfo přes GetFormat. Uvnitř Format znovu nevolej string.Format se stejným poskytovatelem, argumentem a kódem: mohl by se znovu zavolat tentýž formátovač.

Příklady

#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";
}

Výsledek

[12.50 V] | 12.50 V | 12.5 V

Formátovač zpracuje `bracket` pro `Voltage` přímým voláním `ToString("F2", formatProvider)` a přidáním hranatých závorek. Zbývající dvě položky zpracuje `Voltage.ToString`. Poskytovatel předává požadavky na údaje o kultuře objektu `CultureInfo.InvariantCulture`, takže desetinným oddělovačem je tečka.

Související lekce

  • C# · Lekce 33 · Pokročilá · Verze: 3

Zdroje