使用Java 17中的 record 替代 Lombok 的部分功能
在DD長期更新的Java新特性專欄中,已經介紹過Java 16中開始支持的新特性:record的使用:2分鐘學會Java中record關鍵字的用法
之前只是做了介紹,但沒有結合之前的編碼習慣或規范來聊聊未來的應用變化。最近正好因為互相review一些合作伙伴的代碼,產生了一些討論話題,主要正針對于有了record之后,其實之前有些用Lombok的場景,是可以替換掉的。
今天我們就來小小的總結下,我們可以在哪些地方,利用record來替換Lombok。
Lombok的威力
Lombok是我一直都喜歡使用的工具,因為它可以讓我們的代碼變的更加整潔。比如:當我們要寫一個User對象的時候,如果不使用Lombok,往往需要寫這么多內容:
public class User {
private String username;
private String email;
private int userId;
public User(String username, String email, int userId) {
this.username = username;
this.email = email;
this.userId = userId;
}
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getEmail() {
return email;
}
public void setEmail(String email) {
this.email = email;
}
public int getUserId() {
return userId;
}
public void setUserId(int userId) {
this.userId = userId;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
User user = (User) o;
if (userId != user.userId) return false;
if (username != null ? !username.equals(user.username) : user.username != null) return false;
return email != null ? email.equals(user.email) : user.email == null;
}
@Override
public int hashCode() {
int result = username != null ? username.hashCode() : 0;
result = 31 * result + (email != null ? email.hashCode() : 0);
result = 31 * result + userId;
return result;
}
@Override
public String toString() {
return "User{" +
"username='" + username + '\'' +
", email='" + email + '\'' +
", userId=" + userId +
'}';
}
}
在有了Lombok之后呢,通過使用@Data注解,可以將以上內容縮減到只需要下面這幾行即可:
@Data
public class User {
private String username;
private String email;
private int userId;
}
@Data注解涵蓋了@Getter、@Setter、@EqualsAndHashCode 和 @toString,所以一個注解就可以實現成員變量的Getter和Setter,equals和hashcode方法的重寫,以及toString的重寫。大大降低了代碼量,讓代碼看上去更加整潔。
Lombok的問題
雖然Lombok可以幫助我們少些很多代碼,但它依然有一些缺點,比如:
- Lombok并非Java官方提供,而是第三方依賴,依靠社區維護。對于較新的Java版本通常都會存在兼容性問題,容易產生一些不可預知的奇怪錯誤。
- IDE的兼容限制,并不是所有的IDE都可以完美兼容Lombok,所以可能也會因此產生一些奇怪的錯誤。
使用record來替代
在之前的Java 新特性:record一文中,已經提到過record類可以根據類的字段自動生成:構造函數、equals()、hashCode() 和 toString()。這個功能就跟上面我們演示的Lombok中的@Data非常類似。
寫法的話也非常簡單,只需要這樣一行即可搞定:
public record UserRecord(String username, String email, int userId) {}
可以看到該代碼的整潔度比Lombok的實現更加干凈。同時,最關鍵的一點,這是Java原生支持的,不需要引入任何第三方依賴!
record類定義完成了,具體使用的話就跟平時使用其他類一樣,去創建實例和調用方法即可,比如下面這樣:
UserRecord userRecord = new UserRecord("didi", "didi@didispace.com", 35);
System.out.println(userRecord.email());
System.out.println(userRecord.toString());
只是,我們在使用的時候需要了解record自動生成的代碼與Lombok的區別,就能馬上上手。
比如,從上面的例子中我們可以看到一個區別:獲取成員變量email的時候,這里并不想傳統getter那樣以getEmail()的形式生成。
哪些情況替代不了?
record類已經很強大,但目前并不能完全替代Lombok。主要原因如下:
- record中定義的成員變量是final類型的,初始化后就不能修改了
- record類不能被繼承,所以也無法進一步擴展
因此,在用record替代Lombok的時候,更多用來定義靜態變量,而不是可能會變化的實例變量。但是,由于record中也可以定義函數,所以對于一些對成員計算獲得的內容,也可以實現和使用。
總結
Lombok和record都可以幫助我們編寫更加整潔的代碼。前者是第三方庫,可能存在一些不可預知的問題和IDE兼容問題,但功能更加全面和強大;后者屬于Java原生的能力,功能雖弱一些,但用好它也能幫助我們減少很多代碼的編寫,且IDE兼容性更好。