Interpolace řetězců v jazyce C#

  • Článek

V tomto kurzu se dozvíte, jak pomocí interpolace řetězců formátovat a zahrnout výsledky výrazu do výsledného řetězce. V příkladech se předpokládá, že znáte základní koncepty jazyka C# a formátování typů .NET. Pokud s interpolací řetězců nebo formátováním typů .NET teprve začínáte, podívejte se nejprve na kurz interpolace interaktivních řetězců. Další informace o formátových typech v .NET naleznete v tématu Typy formátování v .NET.

Úvod

Pokud chcete identifikovat řetězcový literál jako interpolovaný řetězec, před něj před něj $ zadejte symbol. Můžete vložit libovolný platný výraz jazyka C#, který vrátí hodnotu do interpolovaného řetězce. Jakmile se výraz vyhodnotí, v následujícím příkladu se jeho výsledek převede na řetězec a zahrne se do výsledného řetězce:

double a = 3;
double b = 4;
Console.WriteLine($"Area of the right triangle with legs of {a} and {b} is {0.5 * a * b}");
Console.WriteLine($"Length of the hypotenuse of the right triangle with legs of {a} and {b} is {CalculateHypotenuse(a, b)}");
double CalculateHypotenuse(double leg1, double leg2) => Math.Sqrt(leg1 * leg1 + leg2 * leg2);
// Output:
// Area of the right triangle with legs of 3 and 4 is 6
// Length of the hypotenuse of the right triangle with legs of 3 and 4 is 5

Jak ukazuje příklad, zahrnete výraz do interpolovaného řetězce tak, že ho uzavřete do složených závorek:

{<interpolationExpression>}

Interpolované řetězce podporují všechny možnosti funkce složeného formátování řetězců. Díky tomu jsou čitelnější alternativou k použití String.Format metody.

Jak zadat formátovací řetězec pro interpolační výraz

Pokud chcete zadat formátovací řetězec podporovaný typem výsledku výrazu, postupujte podle interpolačního výrazu s dvojtečku (":") a formátovacím řetězcem:

{<interpolationExpression>:<formatString>}

Následující příklad ukazuje, jak zadat standardní a vlastní formátovací řetězce pro výrazy, které vytvářejí datum a čas nebo číselné výsledky:

var date = new DateTime(1731, 11, 25);
Console.WriteLine($"On {date:dddd, MMMM dd, yyyy} L. Euler introduced the letter e to denote {Math.E:F5}.");
// Output:
// On Sunday, November 25, 1731 L. Euler introduced the letter e to denote 2.71828.

Další informace naleznete v části Formát řetězce součásti složené formátování článku.

Jak řídit šířku pole a zarovnání formátovaného interpolačního výrazu

Pokud chcete zadat minimální šířku pole a zarovnání výsledku formátovaného výrazu, postupujte podle interpolačního výrazu čárkou (",") a konstantním výrazem:

{<interpolationExpression>,<alignment>}

Pokud je hodnota zarovnání kladná, výsledek formátovaného výrazu je zarovnaný doprava. Pokud je záporná, zarovná se doleva.

Pokud potřebujete zadat zarovnání i formátovací řetězec, začněte komponentou zarovnání:

{<interpolationExpression>,<alignment>:<formatString>}

Následující příklad ukazuje, jak zadat zarovnání a používat znaky svislé znaky (|) k oddělovači textových polí:

const int NameAlignment = -9;
const int ValueAlignment = 7;
double a = 3;
double b = 4;
Console.WriteLine($"Three classical Pythagorean means of {a} and {b}:");
Console.WriteLine($"|{"Arithmetic",NameAlignment}|{0.5 * (a + b),ValueAlignment:F3}|");
Console.WriteLine($"|{"Geometric",NameAlignment}|{Math.Sqrt(a * b),ValueAlignment:F3}|");
Console.WriteLine($"|{"Harmonic",NameAlignment}|{2 / (1 / a + 1 / b),ValueAlignment:F3}|");
// Output:
// Three classical Pythagorean means of 3 and 4:
// |Arithmetic|  3.500|
// |Geometric|  3.464|
// |Harmonic |  3.429|

Jak ukazuje příklad výstupu, pokud délka výsledku formátovaného výrazu překročí zadanou šířku pole, hodnota zarovnání se ignoruje.

Další informace najdete v části Komponenta Zarovnání v článku složené formátování .

Použití řídicích sekvencí v interpolovaném řetězci

Interpolované řetězce podporují všechny řídicí sekvence, které lze použít v běžných řetězcových literálech. Další informace naleznete v tématu Řídicí sekvence řetězců.

Pokud chcete řídicí sekvence interpretovat doslova, použijte doslovný řetězcový literál. Interpolovaný doslovný řetězec začíná oběma $ i @ znaky. Můžete použít $ a @ v libovolném pořadí: a $@"..."@$"..." jsou platné interpolované doslovné řetězce.

Chcete-li do výsledného řetězce zahrnout složenou závorku {nebo "}", použijte dvě složené závorky{ nebo }}. Další informace najdete v části Escaping závorky v článku složené formátování .

Následující příklad ukazuje, jak zahrnout složené závorky do výsledného řetězce a vytvořit doslovný interpolovaný řetězec:

var xs = new int[] { 1, 2, 7, 9 };
var ys = new int[] { 7, 9, 12 };
Console.WriteLine($"Find the intersection of the {{{string.Join(", ",xs)}}} and {{{string.Join(", ",ys)}}} sets.");
// Output:
// Find the intersection of the {1, 2, 7, 9} and {7, 9, 12} sets.

var userName = "Jane";
var stringWithEscapes = $"C:\\Users\\{userName}\\Documents";
var verbatimInterpolated = $@"C:\Users\{userName}\Documents";
Console.WriteLine(stringWithEscapes);
Console.WriteLine(verbatimInterpolated);
// Output:
// C:\Users\Jane\Documents
// C:\Users\Jane\Documents

Počínaje jazykem C# 11 můžete použít interpolované řetězcové literály.

Použití ternárního podmíněného operátoru ?: ve výrazu interpolace

Protože dvojtečka (":") má speciální význam v položce s interpolačním výrazem, aby bylo možné použít podmíněný operátor ve výrazu, uzavřete ho do závorek, jak ukazuje následující příklad:

var rand = new Random();
for (int i = 0; i < 7; i++)
{
    Console.WriteLine($"Coin flip: {(rand.NextDouble() < 0.5 ? "heads" : "tails")}");
}

Vytvoření výsledného řetězce specifického pro jazykovou verzi s interpolací řetězců

Interpolovaný řetězec ve výchozím nastavení používá aktuální jazykovou verzi definovanou CultureInfo.CurrentCulture vlastností pro všechny operace formátování.

Počínaje rozhraním .NET 6 můžete metodu String.Create(IFormatProvider, DefaultInterpolatedStringHandler) použít k překladu interpolovaného řetězce na výsledný řetězec specifický pro jazykovou verzi, jak ukazuje následující příklad:

var cultures = new System.Globalization.CultureInfo[]
{
    System.Globalization.CultureInfo.GetCultureInfo("en-US"),
    System.Globalization.CultureInfo.GetCultureInfo("en-GB"),
    System.Globalization.CultureInfo.GetCultureInfo("nl-NL"),
    System.Globalization.CultureInfo.InvariantCulture
};
var date = DateTime.Now;
var number = 31_415_926.536;
foreach (var culture in cultures)
{
    var cultureSpecificMessage = string.Create(culture, $"{date,23}{number,20:N3}");
    Console.WriteLine($"{culture.Name,-10}{cultureSpecificMessage}");
}
// Output is similar to:
// en-US       8/27/2023 12:35:31 PM      31,415,926.536
// en-GB         27/08/2023 12:35:31      31,415,926.536
// nl-NL         27-08-2023 12:35:31      31.415.926,536
//               08/27/2023 12:35:31      31,415,926.536

V dřívějších verzích rozhraní .NET použijte implicitní převod interpolovaného řetězce na System.FormattableString instanci a zavolejte jeho ToString(IFormatProvider) metodu k vytvoření výsledného řetězce specifického pro jazykovou verzi. Následující příklad ukazuje, jak to udělat:

var cultures = new System.Globalization.CultureInfo[]
{
    System.Globalization.CultureInfo.GetCultureInfo("en-US"),
    System.Globalization.CultureInfo.GetCultureInfo("en-GB"),
    System.Globalization.CultureInfo.GetCultureInfo("nl-NL"),
    System.Globalization.CultureInfo.InvariantCulture
};
var date = DateTime.Now;
var number = 31_415_926.536;
FormattableString message = $"{date,23}{number,20:N3}";
foreach (var culture in cultures)
{
    var cultureSpecificMessage = message.ToString(culture);
    Console.WriteLine($"{culture.Name,-10}{cultureSpecificMessage}");
}
// Output is similar to:
// en-US       8/27/2023 12:35:31 PM      31,415,926.536
// en-GB         27/08/2023 12:35:31      31,415,926.536
// nl-NL         27-08-2023 12:35:31      31.415.926,536
//               08/27/2023 12:35:31      31,415,926.536

Jak ukazuje příklad, můžete použít jednu FormattableString instanci k vygenerování více výsledných řetězců pro různé jazykové verze.

Vytvoření výsledného řetězce pomocí invariantní jazykové verze

Počínaje rozhraním .NET 6 použijte metodu k překladu String.Create(IFormatProvider, DefaultInterpolatedStringHandler) interpolovaného řetězce na výsledný řetězec pro následující InvariantCulturepříklad:

string message = string.Create(CultureInfo.InvariantCulture, $"Date and time in invariant culture: {DateTime.Now}");
Console.WriteLine(message);
// Output is similar to:
// Date and time in invariant culture: 05/17/2018 15:46:24

V dřívějších verzích rozhraní .NET spolu s metodou FormattableString.ToString(IFormatProvider) můžete použít statickou FormattableString.Invariant metodu, jak ukazuje následující příklad:

string message = FormattableString.Invariant($"Date and time in invariant culture: {DateTime.Now}");
Console.WriteLine(message);
// Output is similar to:
// Date and time in invariant culture: 05/17/2018 15:46:24

Závěr

Tento kurz popisuje běžné scénáře použití interpolace řetězců. Další informace o interpolaci řetězců naleznete v tématu Interpolace řetězců. Další informace o typech formátování v .NET naleznete v článcích o formátování v .NET a složeného formátování .

Viz také