Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / C#

Oblikovanje po meri v .NET: ponudnik, oblikovalnik in tip

Loči tri pogodbe oblikovanja: iskanje storitve, obdelavo oblikovnega elementa in pretvorbo v besedilo, ki jo določa tip vrednosti.

Različica: C# 12 and .NET 8; later runtimes may add compatible features

Sintaksa

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 in .NET 8 so vsi trije vmesniki v imenskem prostoru System. Preobremenitev string.Format, ki sprejme ponudnika, pokliče IFormatProvider.GetFormat(Type?) z typeof(ICustomFormatter), ne s tipom vrednosti, ki jo oblikuje. Ponudnik vrne storitev zahtevanega tipa ali null. Če storitev implementira sam, lahko vrne this. Najdeni oblikovalnik se v tem klicu ponovno uporablja.

Pri {0:F2} prejme ICustomFormatter.Format niz "F2", argument na indeksu nič in ponudnika. V {0} oblikovne kode ni, zato metoda prejme null. Vsak vrnjeni niz, tudi "", zaključi obdelavo elementa. Če metoda vrne null, ta preobremenitev string.Format nadaljuje z običajnim oblikovanjem. Znak ! v null! le utiša opozorilo o vrednosti null: metoda še vedno vrne null, čeprav je njen povratni tip string.

Če oblikovalnik po meri ni na voljo ali elementa ne obdela, lahko string.Format v .NET 8 najprej poskusi uporabiti ISpanFormattable.TryFormat. Če ta korak preskoči ali TryFormat vrne false, se argument, ki ni null in implementira IFormattable, oblikuje prek IFormattable.ToString(format, provider). Za druge argumente, ki niso null, se uporabi ToString() brez parametrov, ki ne prejme oblikovne kode. Argument null, ki pride do običajnega oblikovanja, se obravnava kot prazen niz pred morebitnim dodajanjem presledkov za poravnavo. Za "G" in null implementiraj splošno obliko. Tip lahko ob nepodprti kodi sproži FormatException; string.Format lahko neodvisno sproži isto izjemo, na primer ob indeksu zunaj seznama argumentov.

Neposredni klic ToString z dvema argumentoma ne prikliče samodejno ICustomFormatter. Tip lahko vseeno uporabi ponudnika, na primer za pridobitev NumberFormatInfo ali DateTimeFormatInfo prek GetFormat. Znotraj Format ne kliči znova string.Format z istim ponudnikom, argumentom in kodo: tako lahko znova pokličeš isti oblikovalnik.

Primeri

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

Rezultat

[12.50 V] | 12.50 V | 12.5 V

Oblikovalnik za `Voltage` obdela `bracket` tako, da neposredno pokliče `ToString("F2", formatProvider)` in doda oglate oklepaje. Druga dva elementa obdela `Voltage.ToString`. Ponudnik preusmeri zahteve za podatke o kulturi na `CultureInfo.InvariantCulture`, zato je decimalno ločilo pika.

Povezane lekcije

  • C# · Lekcija 33 · Napredna · Različica: 3

Viri