Pattern matching trong C#: is, switch, property pattern, list pattern

Pattern matching kiểm tra một giá trị có khớp với một hình dạng hay không: "nó có phải Circle không?", "nó có null không?", "Status của nó có phải "paid" và Total có trên 100 không?". Khi phép kiểm tra thành công, mẫu (pattern) còn có thể tách các phần của giá trị ra thành biến mới. Tính năng này bắt đầu khá nhỏ ở C# 7 với toán tử is và được mở rộng qua từng phiên bản kể từ đó, nên trang này ghi chú phiên bản cho từng dạng.

Mẫu kiểu với is (C# 7)

Trước C# 7, kiểm tra kiểu rồi dùng nó cần hai bước: as cộng một phép kiểm tra null, hoặc is cộng một phép ép kiểu. Mẫu kiểu (type pattern) làm cả hai cùng lúc và cho bạn một biến đúng kiểu:

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));
    }
}

Đầu ra:

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

p is CardPayment card chỉ đúng khi p là một CardPayment khác null (hoặc một lớp kế thừa từ nó), và khi đó card giữ giá trị đó với đúng kiểu tĩnh. Giá trị null không bao giờ khớp với mẫu kiểu, vì thế khoản thanh toán null rơi xuống tới phép kiểm tra null.

Phạm vi và gán chắc chắn

Biến của mẫu tồn tại trong khối lệnh bao quanh, nhưng trình biên dịch chỉ cho bạn đọc nó ở những chỗ chắc chắn phép khớp đã thành công. Nhờ vậy dạng "mệnh đề bảo vệ" (guard clause) hoạt động được: bạn thoát sớm và dùng biến ở phía sau:

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);
        }
    }
}

Đầu ra:

19.99
42 is over 40
price must be text

boxed is int n && n > 40 cho thấy một dạng phổ biến khác: biến dùng được ở bên phải &&, vì vế đó chỉ chạy khi phép khớp đã thành công. Ở bên phải || thì biến chưa được gán, và trình biên dịch sẽ báo như vậy (CS0165).

Mẫu cũng mở hộp (unbox) giá trị: boxed is int n thành công với một int đã đóng hộp và cho bạn giá trị mà không cần một phép ép kiểu có thể ném ngoại lệ. Với kiểu giá trị nullable, maybe is int n thành công đúng khi maybe có giá trị.

Mẫu hằng và mẫu null

Một hằng số cũng là một mẫu. x is null là mẫu được dùng nhiều nhất, và C# 7 còn cho phép x is 0, status is "paid" hay một thành viên 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();

Nhiều nhóm ưu tiên is null hơn == null vì nó không thể bị chuyển hướng bởi một toán tử nạp chồng trên kiểu. C# 9 bổ sung dạng phủ định, is not null.

Mẫu trong câu lệnh switch (C# 7)

Các mẫu kiểu đó cũng có thể làm nhãn cho case, và mệnh đề when thêm một điều kiện. Các case được thử từ trên xuống dưới, nên hãy sắp xếp từ cụ thể đến tổng quát:

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

Trình biên dịch kiểm tra thứ tự: một case không bao giờ khớp được vì một case phía trước đã bao trùm nó là lỗi CS8120. default luôn được xét cuối cùng, dù nó nằm ở đâu. Cùng logic đó viết bằng chuỗi if/is, như ví dụ thanh toán ở trên, chạy được ở mọi phiên bản C# từ 7 trở đi.

Biểu thức switch (C# 8)

Biểu thức switch là dạng gọn cho việc "tính một giá trị từ nhiều trường hợp". Giá trị đứng trước, rồi đến switch, rồi các nhánh mẫu => kết quả cách nhau bởi dấu phẩy, với _ để bắt mọi trường hợp còn lại:

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

Nếu lúc chạy không có nhánh nào khớp, biểu thức sẽ ném SwitchExpressionException, và trình biên dịch cảnh báo (CS8509) khi nó thấy có đầu vào chưa được xử lý. Trang về biểu thức switch trình bày riêng phần cú pháp; phần còn lại của trang này nói về các mẫu bạn có thể đặt trong các nhánh.

Mẫu thuộc tính (C# 8, mở rộng ở C# 10)

Mẫu thuộc tính (property pattern) so khớp các thuộc tính của một đối tượng với những mẫu lồng nhau, đặt trong cặp ngoặc nhọn. Đối tượng cũng phải khác null, nên chỉ riêng { } có nghĩa là "khác 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

Ở C# 8 và 9 bắt buộc phải dùng dạng lồng nhau: { ShipTo: { Country: "PT" } }. C# 10 cho phép cách viết tắt có dấu chấm như ở trên. Mẫu thuộc tính cũng dùng được với is, giúp các phép kiểm tra nhiều điều kiện đọc như một đoạn mô tả: if (order is { Status: "paid", Items: > 0 }).

Mẫu quan hệ và mẫu logic (C# 9)

C# 9 bổ sung các phép so sánh (<, <=, >, >=) và các phép kết hợp and, or và not, biến các khoảng giá trị thành mẫu:

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

Cách tương đương trong C# 7 là một chuỗi if/else if hoặc một switch với các mệnh đề when (case int s when s >= 90:).

Mẫu tuple và mẫu vị trí (C# 8)

Để switch trên nhiều giá trị cùng lúc, bạn switch trên một 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

Mẫu vị trí (positional pattern) làm điều tương tự với mọi kiểu có phương thức Deconstruct, bao gồm cả record: case Point(0, 0): hoặc p is Rectangle(var w, var h) && w == h.

Mẫu danh sách (C# 11)

Mẫu danh sách (list pattern) so khớp mảng và danh sách theo các phần tử. .. khớp với số phần tử bất kỳ (một "slice"), và mỗi vị trí phần tử có thể chứa bất kỳ mẫu nào khác:

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

Phiên bản nào bổ sung mẫu nào

Lỗi thường gặp

• Sắp xếp case từ tổng quát đến cụ thể. case Payment p: đứng trước case CardPayment c: khiến case thứ hai không bao giờ chạm tới được (CS8120). Đặt case cụ thể lên trước.
• Tưởng mẫu kiểu khớp với null. null is string s là false. Hãy xử lý null bằng một case riêng hoặc is null.
• Đọc biến của mẫu ở chỗ phép khớp có thể đã thất bại. Sau a is int n || ..., n chưa được gán (CS0165).
• Dùng switch theo kiểu dài dòng thay cho phương thức ảo. Nếu mỗi lớp con mới đều buộc bạn sửa cùng một câu switch ở năm chỗ, hành vi đó nên nằm trong cây kế thừa. Mẫu phát huy sức mạnh với dữ liệu đến từ bên ngoài (cấu trúc JSON, thông điệp, tuple đầu vào) và với các tập kiểu khép kín do bạn kiểm soát.
• Quên nhánh bắt mọi trường hợp trong biểu thức switch. Một đầu vào không khớp sẽ ném ngoại lệ lúc chạy; hãy đọc cảnh báo CS8509.