自动匹配模式

Pattern Matching for instanceof (Second Preview) instanceof

引入

在Java 14中作为预览语言功能引入的instanceof模式匹配，在JDK 15中处于第二次预览

模式匹配允许程序中的通用逻辑（主要是从对象中的条件提取组件）可以更简洁地表达。Haskell 和 C# 等语言已采用模式匹配来实现简洁和安全性。模式匹配能够使程序的通用逻辑更加简洁，代码更加简单，同时在做类型判断和类型转换的时候也更加安全，接下来我们来详细讲解一下。

设计初衷

几乎每个程序员都见过如下代码，在包含判断表达式是否具有某种类型的逻辑时，程序会对不同类型进行不同的处理。我么来看一下熟悉的instanceof-and-cast用法：

// 在方法的入口接收一个对象
public void beforeWay(Object obj) {
    // 通过instanceof判断obj对象的真实数据类型是否是String类型
    if (obj instanceof String) {
        // 如果进来了，说明obj的类型是String类型，直接进行强制类型转换。
        String str = (String) obj;
        // 输出字符串的长度
        System.out.println(str.length());
    }
}

这段程序做了3件事：

• 先判断obj的真实数据类型
• 判断成立后进行了强制类型转换（将对象obj强制类型转换为String）
• 声明一个新的本地变量str，指向上面的obj

这种模式的逻辑并不复杂，并且几乎所有Java程序员都可以理解。但是出于以下原因，上述做法并不是最理想的：

• 语法臃肿乏味
• 同时执行类型检测校验和类型转换。
• String类型在程序中出现了3次，但是最终要的可能只是一个字符串类型的对象变量而已。
• 重复的代码过多，冗余度较高。

JDK 14提供了新的解决方案：新的instanceof模式匹配 ，新的模式匹配的用法如下所示，在instanceof的类型之后添加了变量str。如果instanceof对obj的类型检查通过，obj会被转换成str表示的String类型。在新的用法中，String类型仅出现一次。

具体描述

示例代码：

public void patternMatching(Object obj) {
    if (obj instanceof String str) {
       // can use str here
        System.out.println(str.length());
    } else {
        // can't use str here
    }
}

由于instanceof的模式匹配是预览功能，需要通过选项--enable-preview --source 14来启用。下面的代码中用到了JDK 11引入的使用java运行Java源代码的功能。

需要带上--enable-preview允许预览机制进行编译。

javac --enable-preview -source 14 InstanceofDemo.java 

需要带上--enable-preview允许预览机制进行执行。

java --enable-preview InstanceofDemo

上述代码需要注意：

如果obj是String的实例，则将其强制转换为String并分配给绑定变量s。绑定变量在if语句的true块中，而不在if语句的false块中。

if (obj instanceof String s) {
    // 使用s
} else {
    // 不能使用s
}

与局部变量的范围不同，绑定变量的范围由包含的表达式和语句的语义确定。例如，在此代码中：

if (!(obj instanceof String s)) {
    .. s.contains(..) ..
} else {
    .. s.contains(..) ..
}

true块中的s表示封闭类中的字段，false块中的s表示由instanceof运算符引入的绑定变量。

当if语句的条件变得比单个instanceof更复杂时，绑定变量的范围也会相应地增长。 例如，在此代码中：

if (obj instanceof String s && s.length() > 5) {.. s.contains(..) ..}

绑定变量s在&&运算符右侧以及true块中。仅当instanceof成功并分配给s时，才评估右侧。

另一方面，在此代码中：

if (obj instanceof String s || s.length() > 5) {.. s.contains(..) ..}

绑定变量s不在||右侧的范围内运算符，也不在true块的范围内。s指的是封闭的一个字段。

接下来我们看一下模式匹配帮助我们简化案例的经典做法：

通常equals()方法的实现都会先检查目标对象的类型。instanceof的模式匹配可以简化equals()方法的实现逻辑。下面代码中的Student类展示了相关的用法。

public class Student {
  private  String name ;

  public Student(String name) {
    this.name = name;
  }

//    @Override
//    public boolean equals(Object o) {
//        if (this == o) return true;
//        if (o == null || getClass() != o.getClass()) return false;
//        Student student = (Student) o;
//        return Objects.equals(name, student.name);
//    }
    
  // 简化后做法！  
  @Override
  public boolean equals(Object obj) {
    return (obj instanceof Student s) && Objects.equals(this.name, s.name);
  }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }

}

小结

instanceof运算符“匹配”规则如下：

• 如果obj是String类型，则将obj类型转换为String，并将其赋值给变量str。绑定的变量作用域为if语句内部，并不在false语句块内。
• 到这儿，有一定Java基础的同学应该看出来的JDK 14后的instanceof的模式匹配极大的简化了类型检查和转型的问题。