跳到主要内容

JEP 405:记录模式(预览)

概括

_使用记录模式_增强 Java 编程语言以解构记录值。记录模式和类型模式可以嵌套,以实现强大的、声明性的、可组合形式的数据导航和处理。这是预览语言功能

目标

  • 扩展模式匹配以表达更复杂、可组合的数据查询。

  • 不要更改类型模式的语法或语义。

动机

在 JDK 16 中,JEP 394扩展了该instanceof运算符以采用_类型模式_并执行_模式匹配_。这个适度的扩展允许简化熟悉的 instanceof-and-cast 习惯用法:

// Old code
if (o instanceof String) {
String s = (String)o;
... use s ...
}

// New code
if (o instanceof String s) {
... use s ...
}

在新代码中,如果在运行时 的值是 的实例,则o匹配类型模式。如果模式匹配,则表达式为,并且模式变量被初始化为强制转换为的值,然后可以在包含的块中使用该值。String s``o``String``instanceof``true``s``o``String

switch在 JDK 17 和 JDK 18 中,我们还通过JEP 406JEP 420将类型模式的使用扩展到大小写标签。

字体模式一次性消除了许多铸造的情况。然而,它们只是迈向更具声明性、以数据为中心的编程风格的第一步。由于 Java 支持新的、更具表现力的数据建模方式,模式匹配可以让开发人员表达其模型的语义意图,从而简化此类数据的使用。

模式匹配和记录类

记录类(JEP 395)是数据的透明载体。接收记录类实例的代码通常会提取数据,称为_组件_。例如,我们可以使用类型模式来测试某个值是否是记录类的实例Point,如果是,则从该值中提取x和组件:y

record Point(int x, int y) {}

static void printSum(Object o) {
if (o instanceof Point p) {
int x = p.x();
int y = p.y();
System.out.println(x+y);
}
}

此处的模式变量p仅用于调用访问器方法x()和,该方法返回组件和y()的值。 (在每个记录类中,其访问器方法与其组件之间都存在一一对应关系。)如果该模式不仅可以测试某个值是否是 的实例,而且还可以从 中提取和组件,那就更好了直接值,代表我们调用访问器方法。换句话说:x``y``Point``x``y

record Point(int x, int y) {}

void printSum(Object o) {
if (o instanceof Point(int x, int y)) {
System.out.println(x+y);
}
}

Point(int x, int y)是一个_记录模式_。它将提取组件的局部变量声明提升到模式本身中,并在值与模式匹配时通过调用访问器方法来初始化这些变量。实际上,记录模式将记录的实例分解为其组件。

模式匹配的真正力量在于它可以优雅地扩展以匹配更复杂的对象图。例如,考虑以下声明:

record Point(int x, int y) {}
enum Color { RED, GREEN, BLUE }
record ColoredPoint(Point p, Color c) {}
record Rectangle(ColoredPoint upperLeft, ColoredPoint lowerRight) {}

我们已经看到,我们可以使用记录模式提取对象的组成部分。如果我们想从左上角提取颜色,我们可以这样写:

static void printUpperLeftColoredPoint(Rectangle r) {
if (r instanceof Rectangle(ColoredPoint ul, ColoredPoint lr)) {
System.out.println(ul.c());
}
}

但我们ColoredPoint本身就是一个记录,我们可能想进一步分解它。因此,记录模式支持_嵌套_,这允许记录组件进一步匹配嵌套模式并由嵌套模式分解。我们可以在记录模式中嵌套另一个模式,并同时分解外部和内部记录:

static void printColorOfUpperLeftPoint(Rectangle r) {
if (r instanceof Rectangle(ColoredPoint(Point p, Color c),
ColoredPoint lr)) {
System.out.println(c);
}
}

嵌套模式进一步使我们能够使用与将其组合在一起的代码一样清晰简洁的代码来分解聚合。例如,如果我们要创建一个矩形,我们可能会将构造函数嵌套在单个表达式中:

Rectangle r = new Rectangle(new ColoredPoint(new Point(x1, y1), c1), 
new ColoredPoint(new Point(x2, y2), c2));

通过嵌套模式,我们可以使用与嵌套构造函数的结构相呼应的代码来解构这样的矩形:

static void printXCoordOfUpperLeftPointWithPatterns(Rectangle r) {
if (r instanceof Rectangle(ColoredPoint(Point(var x, var y), var c),
var lr)) {
System.out.println("Upper-left corner: " + x);
}
}

总之,嵌套模式消除了导航对象的意外复杂性,以便我们可以专注于这些对象所表达的数据。

描述

我们使用可嵌套记录模式扩展了 Java 编程语言。

模式的语法将变为:

Pattern:
TypePattern
ParenthesizedPattern
RecordPattern

TypePattern:
LocalVariableDeclaration

ParenthesizedPattern:
( Pattern )

RecordPattern:
ReferenceType RecordStructurePattern [ Identifier ]

RecordStructurePattern:
( [ RecordComponentPatternList ] )

RecordComponentPatternList :
Pattern { , Pattern }

记录模式

记录_模式_由类型、(可能为空)记录组件模式列表(用于匹配相应的记录组件)和可选标识符组成。带有标识符的记录模式称为_命名_记录模式,变量称为_记录模式变量_。

例如,给定声明

record Point(int i, int j) {}

如果值是记录类型的实例,则v它与记录模式匹配;如果是,则用调用该值对应的访问器方法的结果来初始化模式变量,并将模式变量初始化为调用该值对应的访问器方法的结果。 (模式变量的名称不需要与记录组件的名称相同;即,除了模式变量和被初始化之外,记录模式的行为相同。)记录模式变量被初始化为强制转换的值到。Point(int i, int j) p``Point``i``i``j``j``Point(int x, int y)``x``y``p``v``Point

null值与任何记录模式都不匹配。

记录模式可用于var匹配记录组件,而无需说明组件的类型。在这种情况下,编译器会推断模式引入的模式变量的类型var。例如,模式Point(var a, var b)是模式的简写Point(int a, int b)

由记录模式声明的模式变量集包括在记录组件模式列表中声明的所有模式变量,并且如果记录模式是命名记录模式,则还包括记录模式变量。

如果表达式可以转换为模式中的记录类型而不需要未经检查的转换,则该表达式与记录模式兼容。

如果记录类是通用的,则命名该记录类的任何记录模式都必须使用通用类型。例如,给定声明:

record Box<T>(T t) {}

以下方法是正确的:

static void test1(Box<Object> bo) {
if (bo instanceof Box<Object>(String s)) {
System.out.println("String " + s);
}
}
static void test2(Box<Object> bo) {
if (bo instanceof Box<String>(var s)) {
System.out.println("String " + s);
}
}

而以下两种情况都会导致编译时错误:

static void erroneousTest1(Box<Object> bo) {
if (bo instanceof Box(var s)) { // Error
System.out.println("I'm a box");
}
}
static void erroneousTest2(Box b) {
if (b instanceof Box(var t)) { // Error
System.out.println("I'm a box");
}
}

将来我们可能会扩展推理以推断通用记录模式的类型参数。

记录模式并详尽switch

JEP 420增强了switch表达式和switch语句以支持包含模式(包括记录模式)的标签。switch表达式和模式语句都switch必须是_详尽的:_ switch 块必须具有处理选择器表达式的所有可能值的子句。对于模式标签,这是通过分析模式类型来确定的;例如,case 标签case Bar b匹配 type 的值Bar以及 的所有可能的子类型Bar

对于涉及记录模式的模式标签,分析会更加复杂,因为我们必须考虑组件模式的类型并考虑到sealed层次结构。例如,考虑以下声明:

class A {}
class B extends A {}
sealed interface I permits C, D {}
final class C implements I {}
final class D implements I {}
record Pair<T>(T x, T y) {}

Pair<A> p1;
Pair<I> p2;

以下内容switch并不详尽,因为不存在包含两个类型均为 的值的对A

switch (p1) {                 // Error!
case Pair<A>(A a, B b) -> ...
case Pair<A>(B b, A a) -> ...
}

这两个开关是详尽的,因为接口Isealed类型都C涵盖D了所有可能的实例:

switch (p2) {
case Pair<I>(I i, C c) -> ...
case Pair<I>(I i, D d) -> ...
}

switch (p2) {
case Pair<I>(C c, I i) -> ...
case Pair<I>(D d, C c) -> ...
case Pair<I>(D d1, D d2) -> ...
}

相反,这switch并不详尽,因为包含两个类型均为 的值的对没有匹配项D

switch (p2) {                        // Error!
case Pair<I>(C fst, D snd) -> ...
case Pair<I>(D fst, C snd) -> ...
case Pair<I>(I fst, C snd) -> ...
}

未来的工作

这里描述的记录模式可以在许多方向上扩展:

  • 数组模式,其子模式与各个数组元素匹配;
  • Varargs 模式,当记录是 varargs 记录时;
  • 通用记录模式中类型参数的推断,可能使用菱形形式 ( <>);
  • 不关心模式,可以作为记录组件模式列表中的元素出现,但不声明模式变量;和
  • 基于任意类而不仅仅是记录类的模式。

我们可能会在未来的 JEP 中考虑其中的一些内容。

依赖关系

此 JEP 基于JEP 394(模式匹配instanceof)构建,在 JDK 16 中提供。