Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / C#

Vlastné formátovanie v .NET: poskytovateľ, formátovač a typ

Rozlišuj tri kontrakty formátovania: vyhľadanie služby, spracovanie položky formátu a vytvorenie textu samotným typom hodnoty.

Verzia: C# 12 and .NET 8; later runtimes may add compatible features

Syntax

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 sú všetky tri rozhrania v priestore názvov System. Preťaženie string.Format s poskytovateľom volá IFormatProvider.GetFormat(Type?) s požiadavkou typeof(ICustomFormatter), nie s typom formátovanej hodnoty. Poskytovateľ vráti službu požadovaného typu alebo null. Ak službu sám implementuje, môže vrátiť this. Nájdený formátovač sa v rámci tohto volania používa opakovane.

Pri {0:F2} dostane ICustomFormatter.Format hodnotu "F2", argument s indexom nula a poskytovateľa. V {0} kód formátu chýba, preto metóda dostane null. Vrátený reťazec, aj "", ukončí spracovanie položky. Ak metóda vráti null, toto preťaženie string.Format pokračuje bežným formátovaním. Znak ! v null! len potlačí upozornenie na možnú hodnotu null: metóda stále vracia null, hoci návratový typ je string.

Ak vlastný formátovač nie je dostupný alebo položku nespracuje, string.Format môže v .NET 8 najprv skúsiť použiť ISpanFormattable.TryFormat. Ak sa tento krok vynechá alebo TryFormat vráti false, argument odlišný od null, ktorý implementuje IFormattable, sa formátuje cez IFormattable.ToString(format, provider). Pre ostatné argumenty odlišné od null sa použije bezparametrové ToString(), ktoré nedostane kód formátu. Ak sa argument null dostane k bežnému formátovaniu, spracuje sa ako prázdny reťazec pred prípadným doplnením medzier na zarovnanie. Pre "G" a null implementuj všeobecný formát. Typ môže pri nepodporovanom kóde vyvolať FormatException; string.Format môže nezávisle vyvolať rovnakú výnimku napríklad pri indexe mimo zoznamu argumentov.

Priame volanie ToString s dvoma argumentmi automaticky nevolá ICustomFormatter. Typ však môže využiť poskytovateľa, napríklad na získanie NumberFormatInfo alebo DateTimeFormatInfo cez GetFormat. V tele Format znova nevolaj string.Format s rovnakým poskytovateľom, argumentom a kódom: môžeš tým znova vyvolať ten istý formátovač.

Prí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ýsledok

[12.50 V] | 12.50 V | 12.5 V

Formátovač spracuje `bracket` pre `Voltage` tak, že priamo zavolá `ToString("F2", formatProvider)` a pridá hranaté zátvorky. Ďalšie dve položky spracuje `Voltage.ToString`. Poskytovateľ deleguje požiadavky na údaje o kultúre na `CultureInfo.InvariantCulture`, takže desatinným oddeľovačom je bodka.

Súvisiace lekcie

  • C# · Lekcia 33 · Pokročilá · Verzia: 3

Zdroje