详解 Java 19 中的记录类型的模式匹配

Java 19 将于2022年9月20日发布，目前已经有发布候选（Release Candidate，RC）版本可供下载。本文对 Java 19 中的记录类型的模式匹配（Record Patterns）进行介绍。在阅读本文之前，你可以参考另外三篇相关的文章：

• 详解 Java 17 中的记录类型（Record）
• 详解 Java 17 中的模式匹配（Pattern Matching）
• 详解 Java 19 中 switch 的模式匹配

记录类型的模式是 Java 19 中可以使用的一种新的匹配模式。记录类型的模式不能单独使用，而是要与 instanceof 或 switch 模式匹配一同使用。记录类型的模式主要用于简化下面的一类使用场景。

记录类型的模式是预览功能，需要通过 javac 和 java 命令的参数 --enable-preview 来启用。

以记录类型 GeoLocation 为例来进行说明，要执行的操作仍然是进行格式化。

public record GeoLocation(double lng, double lat) {
}

期望的 GeoLocation 的格式化输出结果是类似 “[lng, lat]”。传统的写法如下面的代码所示，先进行类型判断，然后再强制类型转换，最后使用 GeoLocation 提供的访问方法（lng() 和 lat()）来获取值。

if (obj instanceof GeoLocation) {
    GeoLocation geoLocation = (GeoLocation) obj;
    return String.format("[%.6f, %.6f]", geoLocation.lng(), geoLocation.lat());
}

这种做法无疑是很繁琐的。记录类型的模式可以简化这种类型的操作，允许直接提取记录类型中的组件的值。

结合在 详解 Java 17 中的模式匹配（Pattern Matching）一文中提到的模式的组成部分，记录类型的模式由下面两个部分组成：

• 记录类型的模式的 predicate 与 instanceof 模式是一样的，都是进行类型匹配。
• 记录类型的模式的模式变量的集合，包含了要提取的记录类型的组件，以及记录对象本身。

下面的代码展示了记录类型的模式在 switch 语句中的用法。GeoLocation(double lng, double lat) 表示的是记录类型的模式，其中 GeoLocation 是需要匹配的类型，lng 和 lat 是两个模式变量，表示从记录类型中提取的值。这两个模式变量可以直接使用。

public class ObjectFormatter {
    public String format(Object obj) {
        return switch (obj) {
            case null -> "";
            case GeoLocation(double lng, double lat) -> String.format("[%.6f, %.6f]", lng, lat);
            case default -> obj.toString();
        };
    }
}

这里有几点需要注意：

• 在声明模式变量时，并不需要显式地指定类型，用 var 也是可以的，如 GeoLocation(var lng, var lat)。具体的类型由编译器自动推断。
• 模式变量的名称不需要与记录类型的组件名称保持一致，如 GeoLocation(var x, var y) 也是可以的。这些变量是按照记录类型的组件列表中的位置来匹配的。

由于记录类型是可以嵌套的，在匹配时也同样可以进行嵌套，从而很方便地从复杂的对象层次结构中提取数据。

下面的代码使用了 详解 Java 17 中的记录类型（Record）一文中介绍的 Order 记录类型。记录类型的模式匹配时，直接访问了嵌套的 Address 记录的 addressLine 组件。

public static void display(Order order) {
    if (order instanceof Order(String orderId, String userId, LocalDateTime createdAt,
        List<Order.LineItem> lineItems,
        Order.Address(String addressLine, String cityId, String provinceId,
            String zipCode))) {
        System.out.println(addressLine);
    }
}

除了记录类型中的组件之外，记录对象本身也可以作为模式变量。在下面的代码中，GeoLocation(double lng, double lat) 之后的 g 同样是模式变量，表示当前的 GeoLocation 对象。

if (geoLocation instanceof GeoLocation(double lng, double lat) g) {
    System.out.println(g);
    System.out.println(lng + "," + lat);
}

使用泛型的记录类型也是可以的。在进行匹配时，必须使用带实际类型的泛型形式。比如，下面代码中的记录类型 Box。

record Box<T> (T t) {}

在下面的代码中，匹配的模式必须是类似 Box<Object> 这样的。

static void test(Box<Object> box) {
    if (box instanceof Box<Object>(String s)) {
        System.out.println("字符串： " + s);
    }
}