用Java中的Record（记录类）简化代码

简介

Record是从Java 14开始引入的新特性，Record提供了一种简洁高效的方式来创建不可变类。

引入

使用Java进行开发的时候，程序员经常会创建一些不可变类专门用于承载数据（也就是MVC模型中的model），这些类可能涉及大量的样板代码，包括：

大量的private、final、public关键字
每个字段的getter
重写equals()、hashCode()、toString()方法

例如以下代码

package example;

import java.util.Objects;

public final class Person {

    private final Long id;
    private final String name;
    private final Integer age;

    // 构造函数
    public Person(Long id, String name, Integer age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }

    // Getter
    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public Integer getAge() {
        return age;
    }

    // equals 方法
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Person user = (Person) o;
        return Objects.equals(id, user.id) &&
                Objects.equals(name, user.name) &&
                Objects.equals(age, user.age);
    }

    // hashCode 方法
    @Override
    public int hashCode() {
        return Objects.hash(id, name, age);
    }

    // toString 方法
    @Override
    public String toString() {
        return "Person[" +
                "id=" + id +
                ", name=" + name + '\'' +
                ", age='" + age + '\'' +
                ']';
    }
}

使用record类就可以简化为

package example;

public record Person (

    Long id,
    String name,
    Integer age
) {}

record类的特性

自动生成带有所有参数的构造方法
自动生成每一个字段的getter方法，使用同名的public方法。
没有setter方法，这是因为记录类是不可变的
自动重写toString()方法，具体逻辑参考第一种Person类代码
自动重写hashCode()方法
自动重写equals()方法，判定两个对象相等当且仅当二者类型相同，且每个字段都相等
每一个属性都是final，不可修改
final类，不可被继承

定义

package example;

//访问修饰符 record 类名(字段列表)
public record Student(
        Long id,
        String name,
        Double englishScore,
        Double mathScore
    )
{
    //可以增加static字段
    public static int count = 0;

    //不可以增加实例变量（非静态属性）
    //private boolean thisIsNotAllowed = true;

    //可以自己写构造函数，如果没有写，record类默认会从参数赋值所有字段
    public Student {
        // 不用写这些代码，他们是自动的
        // this.id = id;
        // this.name = name;
        // this.englishScore = englishScore;
        // this.mathScore = mathScore;
        count++;
    }

    //可以额外增加成员方法
    public Double score() {
        return englishScore * 0.4 + mathScore * 0.6;
    }

}

解释一下上面的构造函数，实际上这段代码

1
2
3

public Student {
    count++;
}

和以下代码是等价的

public Student(Long id, String name, Double englishScore, Double mathScore) {
    this.id = id;
    this.name = name;
    this.englishScore = englishScore;
    this.mathScore = mathScore;
    count++;
}

是不是很方便！

使用

运行以下代码

package example;

public class Main {
    public static void main(String[] args) {
        Student student = new Student(1L, "cyrus28214", 60.0, 70.0);
        Student student2 = new Student(1L, "cyrus28214", 60.0, 70.0);
        System.out.println(Student.count);
        System.out.println(student.equals(student2));
        System.out.println(student.hashCode());
        System.out.println(student.toString());
        System.out.println(student.name());
        System.out.println(student.score());
    } 
}

将输出

2
true
1360019156
Student[id=1, name=cyrus28214, englishScore=60.0, mathScore=70.0]
cyrus28214
66.0

作用

record可以极大简化不可变类的代码，而不可变类在JPA中非常常见，所以可以利用record来写JPA：

import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.GenerationType;
import jakarta.persistence.Id;
import jakarta.persistence.Table;

@Entity
@Table(name = "users")
public record User (

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    Long id,
    String username,
    String passwordHash
) {}