Java 7 to 17 Record

一、前言

返回目錄

在 Java 的發展歷程中，簡潔且具有表達力的程式碼一直是被追求的目標。「record」 的引入正是為了解決傳統 Java 類別在數據載體（Data Carrier）場景下過於繁瑣的問題。Java 7 到 17 的演進中，「record」 從預覽功能逐步成為正式語言特性，展現了 Java 團隊不斷優化語言，提升開發者效率的努力。本文將詳細梳理 Java 14 到 16 中「record」的演進過程，並探討其在實際開發中的應用。

目錄

• 一、前言
  • 目錄
• 二、「record」 的誕生背景與動機
• 三、Java 14：初試啼聲（預覽功能）
  • 3.1 語法與特性
  • 3.2 工具與使用
  • 3.3 範例
• 四、Java 15：二度預覽（收集回饋）
• 五、Java 16：正式發布（標準特性）
  • 5.1 關鍵變化
  • 5.2 進階用法
  • 5.3 範例
  • 六、 record 的實際應用場景
• 七、總結

二、「record」 的誕生背景與動機

返回目錄

在 Java 中，創建一個僅用於儲存數據的類別（例如 DTO、POJO 或 Value Object）通常需要編寫大量的樣板程式碼，包括：

• 宣告私有欄位（private fields）。
• 建構子（constructor）。
• getter 方法。
• equals() 、 hashCode() 和 toString() 方法。

這些程式碼雖然必要，但重複且乏味，不僅降低了開發效率，也使得程式碼閱讀性較差。 在實際開發中，這種情況非常常見，例如從資料庫查詢出的資料，或者從 API 接收到的 JSON 資料，都需要建立對應的 Java 物件來儲存，而這些物件往往只需要儲存資料，不需要複雜的業務邏輯。 「record」 的引入，旨在通過簡化的語法自動生成這些樣板程式碼，讓開發者更專注於業務邏輯，而不是在重複撰寫資料載體的程式碼。

三、Java 14：初試啼聲（預覽功能）

返回目錄

在 Java 14 中，「record」 作為預覽功能首次亮相。這代表開發者可以體驗 record 的語法和功能，主要目的在於讓開發者體驗新語法，並收集社群回饋。 本篇文章的範例將以 Java 17 為基礎進行示範。

3.1 語法與特性

返回目錄

record 的基本語法如下：

record Point(int x, int y) {}

這行程式碼宣告了一個名為 Point 的 record ，它具有兩個整數類型的元件 x 和 y 。編譯器會自動生成以下內容：

• 私有 final 欄位 x 和 y 。
• 接受 x 和 y 作為參數的 標準建構子 (Canonical Constructor) 。
• getter 方法 x() 和 y() ，方法名稱與欄位名稱一致。
• equals() 、 hashCode() 和 toString() 方法，基於所有欄位生成。

重點說明：

• record 的欄位預設為 private final ，這代表 record 一旦建立，其欄位值就不能被修改，是一種不可變 (immutable) 的資料載體。
• record 會自動生成一個標準建構子 (Canonical Constructor)，其參數順序和欄位宣告順序一致。
• 自動生成的 getter 方法名稱與欄位名稱相同，而非傳統的 getX() 或 getY() 。
• equals 和 hashCode 方法會基於所有欄位值進行比較，確保資料的正確性。

3.2 工具與使用

返回目錄

重要提醒： 由於本篇文章使用 Java 17 JDK 進行示範，因此無法使用 Java 14 的環境來驗證 --source 14 --enable-preview 的行為。 我們使用 Java 17 測試後得知 本身並不支援 --source 14 --enable-preview 選項 。

$ java --source 14 --enable-preview RecordExample.java error: invalid source release 14 with --enable-preview (preview language features are only supported for release 17) error: compilation failed

3.3 範例

返回目錄

// 使用 record 定義一個 Point 類別 record Point(int x, int y) {} public class RecordExample { public static void main(String[] args) { Point p = new Point(10, 20); System.out.println("Point x: " + p.x()); System.out.println("Point y: " + p.y()); System.out.println("Point: " + p); Point p2 = new Point(10, 20); System.out.println("p.equals(p2): " + p.equals(p2)); } }

執行結果：

$ javac RecordExample.java && java RecordExample Point x: 10 Point y: 20 Point: Point[x=10, y=20] p.equals(p2): true

說明：

• 此範例展示了如何使用 record 定義一個 Point 類別，並驗證其自動生成的特性，例如 getter 方法、 toString() 方法和 equals() 方法。
• 請注意： 雖然這個範例程式碼看起來簡單，但實際上它是使用 Java 17 的編譯器編譯並執行，才能正常運行。

四、Java 15：二度預覽（收集回饋）

返回目錄

Java 15 將「record」 作為第二個預覽版本，沒有新增主要特性，主要目標是收集更多社群回饋，以確認其設計是否滿足實際需求，為最終版本做準備。

在這個版本中，使用方式與 Java 14 相同，仍然需要透過編譯器與執行時選項來啟用預覽功能。

五、Java 16：正式發布（標準特性）

返回目錄

Java 16 正式將 「record」 納入標準語言特性，不再是預覽功能。這意味著開發者可以直接使用「record」 而無需額外設定，標誌著 「record」 已成為 Java 語言的重要組成部分。

5.1 關鍵變化

返回目錄

• 不再需要 -enable-preview 選項。
• 「record」 的語法和行為已定型，不會再有重大變更。

5.2 進階用法

返回目錄

除了基本的資料載體功能，「record」 還具有以下特性：

• 靜態成員（Static Members）： 可以包含靜態成員（方法、欄位等）。
• 實例方法： 可以包含實例方法，用於添加額外的行為。
• 實作介面： 可以實作介面，提供額外的行為規範。
• 泛型： 可以使用泛型，使 record 能夠適用於不同類型的資料。
• 註解： 可以使用註解，提供額外的程式碼資訊或行為控制。

5.3 範例

返回目錄

// 定義一個泛型介面 Person，包含 getName 和 getData 方法 interface Person<T> { String getName(); T getData(); } // 定義一個泛型 record Employee，使用泛型 T 繼承自 Number，並實作 Person 介面 record Employee<T extends Number>(String name, int id, T data) implements Person<T> { // 定義一個靜態成員，用於自動產生員工 ID static int nextId = 1; // 定義一個建構子重載，只接受員工姓名和資料，ID 自動產生 public Employee(String name, T data) { this(name, nextId++, data); } // 定義一個實例方法，用於取得員工詳細資訊 public String getDetails() { return "Employee: " + name + ", ID: " + id + ", Data: " + data; } // 使用 @Override 註解，表明此方法是實作 Person 介面的方法，回傳員工姓名 @Override public String getName() { return this.name; } // 使用 @Override 註解，表明此方法是實作 Person 介面的方法，回傳員工資料 @Override public T getData() { return this.data; } } public class RecordExample2 { public static void main(String[] args) { // 建立一個 Employee<Integer> 物件 Employee<Integer> emp = new Employee<>("John Doe", 100); System.out.println(emp.getDetails()); // 呼叫 getDetails 方法，輸出員工詳細資訊 // 建立一個 Employee<Double> 物件 Employee<Double> emp2 = new Employee<>("Jane Doe", 10, 99.9); System.out.println(emp2); // 直接輸出 Employee 物件，呼叫 toString() 方法 // 建立一個 Employee<Integer> 物件 Employee<Integer> emp3 = new Employee<>("Mike", 200); System.out.println(emp3.getDetails()); // 呼叫 getDetails 方法，輸出員工詳細資訊 System.out.println("Employee name: " + emp.getName()); //呼叫 getName 方法 System.out.println("Employee data: " + emp.getData()); //呼叫 getData 方法 System.out.println("Employee 2 data: " + emp2.getData()); //呼叫 getData 方法 } }

執行結果：

$ javac -encoding utf-8 RecordExample2.java && java -Dfile.encoding=utf-8 RecordExample2 Note: RecordExample2.java uses or overrides a deprecated API. Note: Recompile with -Xlint:deprecation for details. Employee: John Doe, ID: 1, Data: 100 Employee[name=Jane Doe, id=10, data=99.9] Employee: Mike, ID: 2, Data: 200 Employee name: John Doe Employee data: 100 Employee 2 data: 99.9

這個範例演示了如何在 record 中加入靜態成員、實例方法和建構子重載，展現了 「record」 的靈活性。

六、 record 的實際應用場景

返回目錄

record 是一個非常有用的 Java 特性，它可以應用於許多不同的場景，以下是一些實際的例子：

1. 資料傳輸物件 (DTO)：

   • 場景： 在 Web 應用程式或微服務架構中，經常需要將資料從一個層傳輸到另一個層，例如從資料庫讀取資料後，需要將資料傳輸到服務層或 API 層。
   • record 的應用： 可以使用 record 來定義 DTO，例如 CustomerDTO 、 OrderDTO 、 ProductDTO 等。
   • 優點： record 可以簡化 DTO 的程式碼，自動產生 getter 、 equals() 、 hashCode() 和 toString() 方法，減少程式碼量。同時， record 的不可變性也能確保資料在傳輸過程中的一致性。
   • 具體例子：
     // 使用 record 定義 Customer DTO record CustomerDTO(int id, String name, String email) {} // 從資料庫讀取資料，並建立 CustomerDTO 物件 CustomerDTO customer = new CustomerDTO(1, "John Doe", "john.doe@example.com"); // 在服務層將 CustomerDTO 轉換為 Customer 物件 (如果需要的話) // Customer customerEntity = convertToCustomer(customer);
   • 補充說明: DTO 常被用於表示從資料庫或 API 接收到的資料，並將這些資料傳遞給應用程式的其他層級。 record 在此情境可以大幅減少建立 DTO 的程式碼。

2. 值物件 (Value Object)：

   • 場景： 在領域驅動設計 (DDD) 中，值物件通常用於表示一個概念上的值，例如貨幣、日期、地址、地理座標等。
   • record 的應用： 可以使用 record 來定義值物件，例如 Money 、 Address 、 DateRange 、 GeoLocation 等。
   • 優點： record 可以確保值物件的不可變性，避免被不小心修改，並自動產生 equals() 和 hashCode() 方法，方便比較和使用。 record 內建的不可變性，能夠降低程式碼複雜度，避免在多執行緒環境中的資料同步問題。
   • 具體例子：
     // 使用 record 定義 Money 值物件 record Money(String currency, BigDecimal amount) {} // 使用 Money 值物件 Money price = new Money("USD", new BigDecimal("19.99")); // 在計算總價時，可以確保 Money 物件的值不會被修改 Money totalPrice = new Money("USD", price.amount().multiply(new BigDecimal("10")));
     • 補充說明: 值物件通常表示一個不可變的量，例如經緯度座標，顏色，或是貨幣， record 天然就符合這種特性。

3. API 的請求和回應物件：

   • 場景： 在 REST API 或 gRPC 服務中，經常需要定義請求和回應的資料結構。
   • record 的應用： 可以使用 record 來定義 API 的請求和回應物件，例如 CreateUserRequest 、 GetUserResponse 、 UpdateProductRequest 、 SearchProductResponse 等。
   • 優點： record 可以簡化 API 物件的定義，並且搭配 JSON 序列化函式庫 (例如 Jackson 或 Gson)，可以方便地將 record 物件轉換為 JSON 字串，並傳輸到用戶端。 record 也能夠確保請求/回應物件在傳輸過程中不會被修改。
   • 具體例子：
     // 使用 record 定義 CreateUserRequest 物件 record CreateUserRequest(String username, String password, String email) {} // 使用 record 定義 GetProductResponse 物件 record GetProductResponse(int id, String name, BigDecimal price) {} // 接收 API 的請求，並建立 CreateUserRequest 物件 CreateUserRequest request = new CreateUserRequest("newuser", "password123", "newuser@example.com"); // 建立 GetProductResponse 物件並回傳 GetProductResponse response = new GetProductResponse(1, "Laptop", new BigDecimal("1200.00"));
     • 補充說明: API 物件通常需要轉換成 JSON 或 XML 格式進行傳輸， record 搭配 JSON 函式庫可以簡化此過程。

4. 資料庫查詢結果：

   • 場景： 在使用 JDBC 或 ORM 框架 (例如 Hibernate 或 JPA) 時，經常需要將資料庫查詢結果映射到 Java 物件。
   • record 的應用： 可以使用 record 來定義資料庫查詢結果的對應物件，例如 UserRecord 、 OrderRecord 、 ProductRecord 、 SalesReportRecord 等。
   • 優點： record 可以簡化查詢結果物件的定義，並減少樣板程式碼。 record 的簡潔性能夠方便資料查詢結果的處理和使用。
   • 具體例子：
     // 使用 record 定義 ProductRecord 物件 record ProductRecord(int id, String name, BigDecimal price) {} //資料庫查詢結果 ProductRecord product = new ProductRecord(1, "Laptop", new BigDecimal("1200.00")); //使用 ProductRecord 物件處理查詢結果 System.out.println("Product Name: " + product.name() + ", Price: " + product.price());
     • 補充說明: 資料庫查詢結果通常是簡單的資料集合， record 可以很方便地建立對應的物件。

5. 簡化測試程式碼：

   • 場景： 在撰寫單元測試或整合測試時，經常需要建立一些測試資料。
   • record 的應用： 可以使用 record 來建立測試資料物件，例如 TestUser 、 TestOrder 、 TestProduct 、 MockData 等。
   • 優點： record 可以簡化測試資料物件的定義，減少程式碼量，並提高測試程式碼的可讀性。
   • 具體例子：
     // 使用 record 定義測試用的 User 物件 record TestUser(int id, String name, String email) {} // 在測試程式碼中使用 TestUser 物件 TestUser user = new TestUser(1, "testuser", "testuser@example.com"); // 斷言測試結果 // assertEquals("testuser", user.name());
     • 補充說明: 測試程式碼經常需要建立簡單的測試資料， record 在這方面可以大幅減少程式碼。

6. 函式式編程 (Functional Programming)：

   • 場景： 在使用 Java 的函式式編程特性 (例如 Stream API) 時，經常需要建立簡單的數據結構來傳遞資料。
   • record 的應用： 可以使用 record 來定義簡單的數據結構，例如 Pair 、 Triple 、 Result 、 Entry 等。
   • 優點： record 可以簡化資料結構的定義，並確保資料的不可變性，方便在函式式編程中使用。 record 的簡潔性能夠與 Java Stream API 等函式式工具很好地整合。
   • 具體例子：
     // 使用 record 定義 Pair 資料結構 record Pair<T, U>(T first, U second) {} // 在函式式編程中使用 Pair 物件 Pair<String, Integer> pair = new Pair<>("key", 100); // 使用 stream 處理資料，使用 record 傳遞資料 List<Pair<String,Integer>> pairs = dataList.stream() .map(item -> new Pair<>(item.getKey(), item.getValue())) .collect(Collectors.toList());
     • 補充說明: 在函式式編程中，經常需要傳遞不可變的資料， record 可以很好的符合這個需求。

7. 事件 (Event) 物件：

   • 場景： 在事件驅動架構中，需要定義事件物件來傳遞事件相關的資料。
   • record 的應用： 可以使用 record 來定義事件物件，例如 UserCreatedEvent 、 OrderPlacedEvent 、 ProductUpdatedEvent 等。
   • 優點: record 可以簡化事件物件的定義，使其更簡潔易懂。 * 具體例子:
     // 使用 record 定義 UserCreatedEvent 物件 record UserCreatedEvent(int userId, String userName, String email){} // 當使用者建立時，發送 UserCreatedEvent UserCreatedEvent event = new UserCreatedEvent(1, "John Doe", "john.doe@example.com"); //eventBus.publish(event);
     • 補充說明: 事件物件通常只會儲存資料， record 天然符合這種需求。

8. 配置 (Configuration) 物件:

   • 場景: 在應用程式啟動時，需要讀取一些配置資訊，並將其存儲在物件中。
   • record 的應用: 可以使用 record 來表示配置物件，例如 DatabaseConfig 、 ServerConfig 、 AuthConfig 等。
   • 優點: record 的不可變性可以確保配置資訊在應用程式運行過程中不會被意外修改。
     • 具體例子:
       // 使用 record 定義資料庫設定 record DatabaseConfig(String url, String username, String password){} //讀取設定檔 DatabaseConfig config = new DatabaseConfig("jdbc:h2:mem:test", "sa", "password");
       • 補充說明: 配置資訊通常只需要讀取，而不需要修改， record 可以很好的保證此特性。

9. 圖形使用者介面 (GUI) 資料：

   • 場景： 在開發 GUI 應用程式時，需要儲存和傳輸 UI 元件的資料。
   • record 的應用： 可以使用 record 來定義 UI 資料物件，例如 TextBoxData 、 ButtonData 、 TableData 等。
   • 優點： record 可以簡化 UI 資料物件的定義，並方便 UI 元件的資料綁定。
     • 具體例子:
     //使用 record 定義表格資料 record TableData(List<String> headers, List<List<String>> rows) {} //建立表格資料物件 List<String> headers = List.of("Name", "Age"); List<List<String>> rows = List.of(List.of("John", "30"), List.of("Jane", "25")); TableData data = new TableData(headers, rows);
     • 補充說明: record 天然可以用於表示 UI 元件的資料結構。

10. 狀態機 (State Machine) 的狀態:

    • 場景: 在開發需要狀態機的應用程式時，需要定義不同狀態的資料結構。
    • record 的應用: 可以使用 record 來定義狀態機的狀態資料，例如 OrderStatus 、 PaymentStatus 、 UserState 等。
    • 優點: record 的不可變性可以確保狀態的資料一致性。
      • 具體例子:
        // 使用 record 定義訂單狀態 record OrderStatus(String status, LocalDateTime timestamp) {} //設定訂單狀態 OrderStatus orderStatus = new OrderStatus("Processing", LocalDateTime.now());
        • 補充說明: 在狀態機的設計中，狀態通常是不可變的， record 很適合用於表示此類資料結構。

七、總結

返回目錄

「record」 的引入極大地簡化了 Java 中資料載體的程式碼編寫，提高了開發效率和程式碼的可讀性。從 Java 14 的預覽功能，到 Java 16 的正式發布，「record」 的演進體現了 Java 語言不斷進化的過程。**本篇文章基於 Java 17 環境，詳細介紹了 record 的語法、特性、實際應用場景，以及從預覽到正式特性的演進歷程。**開發者可以充分利用 「record」 的簡潔性和表達力，撰寫更優雅、更易維護的 Java 程式碼。

record 的優點：

• 簡化程式碼： record 可以自動生成 getter 、 equals() 、 hashCode() 和 toString() 方法，大幅減少程式碼量，讓開發者可以更專注於業務邏輯。
• 提高程式碼可讀性： record 的語法簡潔明瞭，可以清楚地表達資料的結構，更容易閱讀和理解。
• 確保資料不可變性： record 的欄位預設為 final ，可以確保資料的不可變性，避免在多執行緒環境中產生資料同步問題，並提高程式碼的安全性。
• 提高開發效率： 可以快速建立資料載體，減少樣板程式碼的撰寫時間，讓開發者可以更快速地完成開發任務。
• 與其他 Java 特性整合良好： record 可以與 Java 的其他特性 (例如泛型、介面、註解和 Stream API) 很好地整合，可以應用於更多的情境。

record 的適用時機：

• 當你需要建立一個只用於儲存資料的類別時，應該優先考慮使用 record 。
• 當你需要傳輸資料 (例如 DTO 或 API 物件) 時， record 是個很好的選擇。
• 當你需要表示一個概念上的值 (例如 Value Object) 時， record 的不可變性可以確保資料的正確性。
• 當你在函數式程式設計中需要傳遞資料時， record 的不可變性可以讓程式碼更容易撰寫和測試。
• 當你需要從資料庫讀取資料並將其映射到 Java 物件時， record 可以簡化程式碼。
• 當你需要撰寫測試程式碼並建立測試資料時， record 可以減少程式碼量。

record 的注意事項：

• record 預設是不可變的，如果你需要修改資料，可以使用傳統的類別。
• record 的欄位必須在宣告時明確定義，無法在之後動態新增欄位。
• record 本身沒有狀態，所以不適合用於需要儲存狀態的類別。
• 雖然 record 可以加入靜態方法或實作介面，但主要設計目的還是用來簡化資料載體，不應該放入過多的業務邏輯。

未來展望：

隨著 Java 語言的發展， record 有望在未來的版本中加入更多特性和改進，使其在不同的情境中可以發揮更大的價值。我們期待 record 在未來可以讓 Java 程式碼更加簡潔、優雅，也更加容易維護。

返回目錄