Pattern Matching di C#: is, Pola switch, Pola Property dan List

Pattern matching menguji sebuah nilai terhadap suatu bentuk: "apakah ini Circle?", "apakah ini null?", "apakah Status-nya "paid" dan Total-nya di atas 100?". Jika tesnya berhasil, pola juga bisa mengambil bagian dari nilai itu ke dalam variabel baru. Fitur ini dimulai kecil di C# 7 dengan operator is dan terus berkembang di setiap versi sejak itu, jadi halaman ini mencatat versi untuk setiap bentuknya.

Pola tipe dengan is (C# 7)

Sebelum C# 7, memeriksa tipe lalu memakainya butuh dua langkah: as plus cek null, atau is plus cast. Pola tipe melakukan keduanya sekaligus dan memberimu variabel yang sudah bertipe:

using System;
using System.Collections.Generic;

class Payment { public decimal Amount; }
class CardPayment : Payment { public string Last4; }
class BankTransfer : Payment { public string Iban; }

class Program
{
    static string Describe(Payment p)
    {
        if (p is CardPayment card)
            return $"card ending {card.Last4}: {card.Amount}";
        if (p is BankTransfer bank)
            return $"transfer from {bank.Iban.Substring(0, 4)}...: {bank.Amount}";
        if (p == null)
            return "no payment";
        return $"other payment: {p.Amount}";
    }

    static void Main()
    {
        var payments = new List<Payment>
        {
            new CardPayment { Amount = 49.90m, Last4 = "4242" },
            new BankTransfer { Amount = 1200m, Iban = "PT50000201231234567890154" },
            null,
            new Payment { Amount = 5m },
        };

        foreach (var p in payments)
            Console.WriteLine(Describe(p));
    }
}

Output:

card ending 4242: 49.90
transfer from PT50...: 1200
no payment
other payment: 5

p is CardPayment card bernilai true hanya jika p adalah CardPayment yang tidak null (atau class turunannya), dan saat itu card menyimpannya dengan tipe statis yang tepat. Nilai null tidak pernah cocok dengan pola tipe, itulah sebabnya pembayaran null lolos sampai ke cek null.

Cakupan dan penetapan pasti

Variabel pola ada di blok yang melingkupinya, tetapi compiler hanya mengizinkanmu membacanya di tempat yang pencocokannya pasti berhasil. Ini membuat bentuk "guard clause" bisa dipakai: kamu keluar lebih awal, lalu memakai variabelnya sesudahnya:

using System;

class Program
{
    static decimal ParsePrice(object input)
    {
        if (!(input is string text))
            throw new ArgumentException("price must be text");

        // text is definitely assigned here: the only way past the if is a match.
        return decimal.Parse(text.Trim().TrimStart('$'), System.Globalization.CultureInfo.InvariantCulture);
    }

    static void Main()
    {
        Console.WriteLine(ParsePrice(" $19.99 "));

        object boxed = 42;
        if (boxed is int n && n > 40)
            Console.WriteLine($"{n} is over 40");

        try
        {
            ParsePrice(19.99m);
        }
        catch (ArgumentException e)
        {
            Console.WriteLine(e.Message);
        }
    }
}

Output:

19.99
42 is over 40
price must be text

boxed is int n && n > 40 menunjukkan bentuk umum lainnya: variabel bisa dipakai di sisi kanan &&, karena sisi itu hanya berjalan jika pencocokannya berhasil. Di sisi kanan || variabel itu belum diberi nilai, dan compiler akan memberitahumu (CS0165).

Pola juga melakukan unboxing: boxed is int n berhasil untuk int yang sudah dibungkus (boxed) dan memberimu nilainya tanpa cast yang bisa melempar exception. Untuk nullable value type, maybe is int n berhasil tepat saat maybe punya nilai.

Pola konstanta dan pola null

Konstanta juga merupakan pola. x is null adalah yang paling sering dipakai, dan C# 7 juga mengizinkan x is 0, status is "paid", atau anggota enum:

if (customer is null) return;          // null check that ignores any == overload
if (count is 0) Console.WriteLine("empty");
if (level is LogLevel.Error) Alert();

Banyak tim lebih memilih is null daripada == null karena hasilnya tidak bisa dialihkan oleh overload operator pada tipenya. C# 9 menambahkan bentuk negasinya, is not null.

Pola di pernyataan switch (C# 7)

Pola tipe yang sama bisa menjadi label case, dan klausa when menambahkan kondisi. Case dicoba dari atas ke bawah, jadi urutkan dari yang spesifik ke yang umum:

static string Describe(object o)
{
    switch (o)
    {
        case null:                           return "nothing";
        case int n when n < 0:               return "negative number";
        case int n:                          return $"number {n}";
        case string s when s.Length == 0:    return "empty text";
        case string s:                       return $"text of {s.Length} chars";
        case IEnumerable<int> list:          return "a sequence of numbers";
        default:                             return o.GetType().Name;
    }
}

Describe(-4);                 // negative number
Describe("");                 // empty text
Describe(new List<int>());    // a sequence of numbers
Describe(2.5);                // Double

Compiler memeriksa urutannya: case yang tidak akan pernah cocok karena sudah dicakup case sebelumnya adalah error CS8120. default selalu dievaluasi terakhir, di mana pun letaknya. Logika yang sama yang ditulis dengan rangkaian if/is, seperti contoh pembayaran di atas, berjalan di semua versi C# mulai dari 7.

Ekspresi switch (C# 8)

Ekspresi switch adalah bentuk ringkas untuk "hitung satu nilai dari beberapa case". Nilainya ditulis lebih dulu, lalu switch, lalu cabang-cabang pattern => result yang dipisahkan koma, dengan _ sebagai penangkap semua:

public abstract record Shape;
public record Circle(double Radius) : Shape;
public record Rectangle(double Width, double Height) : Shape;

static double Area(Shape shape) => shape switch
{
    Circle c => Math.PI * c.Radius * c.Radius,
    Rectangle { Width: var w, Height: var h } => w * h,
    _ => throw new ArgumentException("Unknown shape", nameof(shape)),
};

Area(new Rectangle(3, 4));   // 12

Jika tidak ada cabang yang cocok saat program berjalan, ekspresi ini melempar SwitchExpressionException, dan compiler memberi peringatan (CS8509) jika ia bisa melihat ada input yang tidak ditangani. Halaman ekspresi switch membahas sintaksnya secara khusus; sisa halaman ini membahas pola yang bisa kamu taruh di cabang-cabangnya.

Pola property (C# 8, diperluas di C# 10)

Pola property mencocokkan property sebuah object dengan pola bersarang, di dalam kurung kurawal. Object itu juga harus tidak null, jadi { } saja berarti "tidak null":

public record Address(string City, string Country);
public record Order(decimal Total, string Status, Address ShipTo, int Items);

static string Shipping(Order order) => order switch
{
    { Status: "cancelled" }                   => "no shipment",
    { ShipTo.Country: "PT", Total: >= 50m }   => "free, domestic",     // C# 10 dotted form
    { ShipTo.Country: "PT" }                  => "4.90, domestic",
    { Total: > 200m }                         => "free, international",
    _                                         => "12.00, international",
};

Shipping(new Order(60m, "paid", new Address("Porto", "PT"), 2));    // free, domestic
Shipping(new Order(260m, "paid", new Address("Lyon", "FR"), 2));    // free, international

Di C# 8 dan 9, bentuk bersarang wajib dipakai: { ShipTo: { Country: "PT" } }. C# 10 mengizinkan singkatan bertitik seperti di atas. Pola property juga bisa dipakai dengan is, sehingga pengecekan dengan banyak kondisi terbaca seperti sebuah deskripsi: if (order is { Status: "paid", Items: > 0 }).

Pola relasional dan logika (C# 9)

C# 9 menambahkan perbandingan (<, <=, >, >=) dan penggabung and, or, dan not, yang mengubah rentang nilai menjadi pola:

static string Grade(int score) => score switch
{
    < 0 or > 100      => "invalid",
    >= 90             => "A",
    >= 75 and < 90    => "B",
    >= 50             => "C",
    _                 => "F",
};

Grade(82);    // B
Grade(101);   // invalid

if (input is not null and not "") { ... }
if (c is >= 'a' and <= 'z' or >= 'A' and <= 'Z') { ... }   // and binds tighter than or

Padanannya di C# 7 adalah rangkaian if/else if atau switch dengan klausa when (case int s when s >= 90:).

Pola tuple dan posisional (C# 8)

Switch pada beberapa nilai sekaligus dilakukan dengan switch pada sebuah tuple:

static string Quadrant(int x, int y) => (x, y) switch
{
    (0, 0)       => "origin",
    (> 0, > 0)   => "I",
    (< 0, > 0)   => "II",
    (< 0, < 0)   => "III",
    (> 0, < 0)   => "IV",
    _            => "on an axis",
};

Quadrant(-2, 5);   // II

Pola posisional melakukan hal yang sama untuk tipe apa pun yang punya method Deconstruct, termasuk record: case Point(0, 0): atau p is Rectangle(var w, var h) && w == h.

Pola list (C# 11)

Pola list mencocokkan array dan list berdasarkan elemennya. .. cocok dengan elemen berapa pun jumlahnya (sebuah "slice"), dan setiap posisi elemen bisa berisi pola lain apa pun:

static string Route(string[] args) => args switch
{
    []                         => "help",
    ["add", var item]          => $"add {item}",
    ["remove", var item, ..]   => $"remove {item}",
    [var cmd, ..]              => $"unknown command {cmd}",
};

Route(new[] { "add", "milk" });             // add milk
Route(new[] { "remove", "milk", "now" });   // remove milk

int[] nums = { 1, 2, 3, 4 };
if (nums is [1, .., var last]) Console.WriteLine(last);   // 4

Versi yang menambahkan apa

Kesalahan umum

• Mengurutkan case dari yang umum ke yang spesifik. case Payment p: sebelum case CardPayment c: membuat case kedua tidak bisa tercapai (CS8120). Yang spesifik dulu.
• Mengira pola tipe cocok dengan null. null is string s bernilai false. Tangani null dengan case tersendiri atau dengan is null.
• Membaca variabel pola di tempat pencocokannya mungkin gagal. Setelah a is int n || ..., n belum diberi nilai (CS0165).
• Switch tipe yang panjang alih-alih virtual method. Jika setiap subclass baru berarti mengedit switch yang sama di lima tempat, perilaku itu seharusnya ada di hierarki class. Pola paling berguna untuk data dari luar (bentuk JSON, pesan, tuple input) dan untuk kumpulan tipe tertutup yang kamu kendalikan.
• Lupa cabang penangkap semua di ekspresi switch. Input yang tidak cocok akan melempar exception saat program berjalan; perhatikan peringatan CS8509.