Lombok.Data：用於簡化 Java 類的開發

一、簡介

Lombok 是一個開源的 Java 庫，可以自動化生成 Java 類的 getter、setter、equals、hashCode 等常用方法，減少了編寫樣板式代碼的工作量，提高開發效率。Lombok.Data 是 Lombok 中的一個註解，可以自動在類上生成 getter、setter、equals、hashCode 和 toString 方法。

二、@Data 註解的使用

要使用 Lombok.Data 需要在 pom.xml 文件中添加以下依賴：

{@code

    org.projectlombok
    lombok
    1.18.16
    provided

}

在 Java 類上添加 @Data 註解即可自動生成 getter、setter、equals、hashCode 和 toString 方法。

{@code
import lombok.Data;

@Data
public class User {
    private int id;
    private String name;
}
}

以上代碼會自動生成以下方法：

{@code
public int getId() {
    return id;
}

public void setId(int id) {
    this.id = id;
}

public String getName() {
    return name;
}

public void setName(String name) {
    this.name = name;
}

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

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

@Override
public String toString() {
    return "User{" +
            "id=" + id +
            ", name='" + name + '\'' +
            '}';
}
}

三、@Data 註解的特點

1. 鏈式調用

通過在屬性上使用 @Setter 和 @Accessors 註解，可以實現鏈式調用。使用 @Setter(chain = true) 開啟鏈式調用，@Accessors(chain = true) 控制鏈式調用的相關行為。

{@code
import lombok.Data;
import lombok.experimental.Accessors;

@Data
@Accessors(chain = true)
public class User {
    private int id;
    private String name;
}

// 使用
User user = new User().setId(1).setName("Tom");
}

2. 默認構造函數

在類上添加 @Data 註解，就會默認生成一個無參構造函數。

{@code
@Data
public class User {
    private int id;
    private String name;

    public User(){}
}
}

3. 全參構造函數

在類上添加 @AllArgsConstructor 註解，就會自動生成一個包含所有參數的構造函數。

{@code
@Data
@AllArgsConstructor
public class User {
    private int id;
    private String name;
}
}

4. 靜態方法

在類上添加 @Data(staticConstructor = “of”) 註解，就會自動生成一個以參數為輸入的靜態工廠方法。此方法的名稱可以在註解中指定。

{@code
@Data(staticConstructor = "of")
public class User {
    private int id;
    private String name;
}

// 使用
User user = User.of(1, "Tom");
}

四、@Data 註解的局限性

雖然 @Data 註解可以大大減少樣板代碼，但是也有它的局限性。下面是幾個 @Data 註解的局限性：

1. 不能控制生成方法的可見性

@Data 註解會將所有屬性的訪問級別設置為 public，不能控制生成方法的可見性。

{@code
@Data
public class User {
    private int id;
    private String name;
}

// 生成結果如下（getter 和 setter 方法都是 public 的）：
public int getId() {...}
public void setId(int id) {...}
public String getName() {...}
public void setName(String name) {...}
}

2. 相同名稱的屬性會出現名稱衝突問題

如果有兩個屬性的名稱相同，@Data 註解會將它們的 getter 和 setter 方法的名稱都設置為相同的名稱，會出現名稱衝突問題。

{@code
@Data
public class User {
    private int id;
    private String name;
    private String email;
}

// 生成結果如下（name 的 getter 和 setter 方法和 email 的 getter 和 setter 方法名字是相同的）：
public String getName() {...}
public void setName(String name) {...}
public String getEmail() {...}
public void setEmail(String email) {...}
}

3. 不能自定義 equals 和 hashCode 方法的具體實現

@Data 註解生成的 equals 和 hashCode 方法是基於所有屬性的默認實現，不能自定義它們的具體實現。

五、總結

Lombok.Data 可以大大減少樣板代碼的編寫，提高開發效率。但是它也有它的局限性，需要根據具體情況進行選擇。在實際開發中，可以根據具體需要使用 Lombok 的其他註解來解決上述問題。例如 @Getter、@Setter、@ToString、@EqualsAndHashCode 等。