Java 命名約定

1. 概述

在本教程中，我們將探討幫助我們編寫清晰、可維護且一致的程式碼的基本 Java 命名約定。採用這些約定對於減少歧義和改善開發人員之間的協作至關重要。

我們將深入研究命名類別、介面、方法、變數、套件、枚舉和註釋的最佳實踐。

2. 類別命名約定

我們使用UpperCamelCase來命名我們的類，以表示該標識符代表一個類別。我們選擇描述性的名稱，並使用名詞或名詞短語來反映正在建模的角色或實體：

class CustomerAccount {

 }

在這段程式碼中，類別名稱CustomerAccount立即告訴我們該類別負責管理客戶帳戶資訊。我們避免使用縮寫或模糊的名稱，以便我們的程式碼保持清晰和不言自明。

3. 介面命名規範

我們使用 UpperCamelCase 來命名我們的接口，就像類別一樣。我們選擇的名稱可以清楚地表示實現類別所期望的行為或契約：

interface Printable {

 }

在這個例子中，介面Printable為列印功能定義了明確的契約。我們使用的名稱可以立即表明介面的用途並且沒有任何歧義。

4.變數命名約定

在命名變數時，我們專注於清晰度和一致性，以增強程式碼的可讀性和可維護性。我們選擇能夠反映變數用途的描述性名稱。對於可變字段，我們使用 lowerCamelCase。另一方面，對於常數，我們使用UPPER_SNAKE_CASE ：

public class CustomerAccount {

 private String accountNumber;

 private double balance;



 public static final double MAX_BALANCE = 1000000.00;

 }

在此範例中， accountNumber和balance是實例變數。常數MAX_BALANCE使用static final修飾語定義，其名稱採用 UPPER_SNAKE_CASE 格式。

5. 方法命名約定

我們使用 lowerCamelCase 作為方法名稱，確保它們以描述其執行操作的動詞開頭。這種做法使我們的程式碼直觀且不言自明。

例如，讓我們考慮CustomerAccount類別中的deposit()方法：

public void deposit(double amount) {

 if (balance + amount > MAX_BALANCE) {

 System.out.println("Deposit exceeds max balance limit.");

 } else {

 this.balance += amount;

 }

 }

這裡，方法名稱deposit()表示它將金額加到帳戶餘額中。

類似地，在我們的介面範例中， print()方法的命名反映了其行為：

public interface Printable {

 void print();

 }

方法名稱print()簡潔地描述了產生輸出的動作。

6. 包命名約定

我們將類別和介面組織到套件中，這有助於維護結構。我們遵循一致的命名模式，使用全部小寫字母並採用反向網域表示法：

package com.baeldung.namingconventions;

在此範例中，包聲明遵循標準約定。這種命名風格不僅可以合乎邏輯地組織程式碼，而且還最大限度地降低了與其他套件發生衝突的風險。

7. 枚舉命名約定

我們使用 UpperCamelCase 來命名枚舉類型，而其常數則以 UPPER_SNAKE_CASE 命名。這種差異有助於我們快速識別枚舉代表一組不可變的值：

enum DayOfWeek {

 SUNDAY,

 MONDAY,

 TUESDAY,

 WEDNESDAY,

 THURSDAY,

 FRIDAY,

 SATURDAY

 }

在此範例中，枚舉類型DayOfWeek採用 UpperCamelCase 格式書寫。每個常數（例如SUNDAY或MONDAY ）都採用大寫蛇形命名法，這立即表明這些值是固定的且不可改變的。

8.註釋命名約定

我們使用 UpperCamelCase 來命名註解類型以表明其作用和目的，就像我們對類別和介面所做的那樣：

@interface Auditable {

 String action();

 }

在此範例中，我們使用 UpperCamelCase 定義註解Auditable ，遵循標準命名約定。這種方法使程式碼清晰且易於識別，並且當應用註解時，它提供有關方法或類別相關的操作的特定元資料。

9. 結論

在本文中，我們研究了類別、介面、方法、變數、套件、枚舉和註解的基本 Java 命名約定。我們學習了清晰的指導方針和範例，幫助我們編寫易於閱讀和維護的程式碼。透過遵循這些約定，我們創建了一個一致的程式碼庫，以增強協作並簡化持續開發。

與往常一樣，原始碼可在 GitHub 上取得。