使用lombok編寫優雅的Bean物件

阿新 • • 發佈：2019-04-23

使用java編寫程式碼，十之八九都是在寫java類，從而構建java物件。lombok之前也說了不少，但使用了這麼多年，感覺還是有很多技巧可以使用的。

毫無疑問，使用lombok，編寫的java程式碼很優雅，而使用起來和普通的java編碼方式建立的類毫無二致。

不過，這樣就滿足了嗎？實際上lombok很多註解，讓這個java類在使用的時候，也可以更優雅。

本文就從ORM實體類、Builder模式工具類、Wither工具類以及Accessors工具類幾個層面對比一下。

首先說明，不同的方式本質上沒有優劣之分，不過在不同的應用場景就會變得很奇妙了。

ORM實體類

當一個java Bean類作為ORM實體類，或者xml、json的對映類時，需要這個類有這幾個特徵：

擁有無參構造器
擁有setter方法，用以反序列化；
擁有getter方法，用以序列化。

那麼最簡單的情況就是：

@Data
public class UserBean{
  private Integer id;
  private String userName;
}

複習一下，Data 註解相當於裝配了 @Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode

那麼，作為實體類、或者序列化的Bean類，足夠用了。

Builder

構造器模式，在很多工具類中頻繁的使用。

package com.pollyduan.builder;

import lombok.Builder;

@Builder
public class UserBean {
	  private Integer id;
	  private String userName;
}

它做了什麼事？

它建立了一個private 的全參構造器。也就意味著無參構造器沒有; 同時也意味著這個類不可以直接構造物件。
它為每一個屬性建立了一個同名的方法用於賦值，代替了setter，而該方法的返回值為物件本身。

使用一下：

UserBean u=UserBean.builder()
	.id(1001)
	.userName("polly")
	.build();
System.out.println(u);

還不錯，然並卵，由於這個Bean並沒有getter方法，裡邊的資料沒辦法直接使用。光說沒用，繼續執行你會發現輸出是這個東西：com.pollyduan.builder.UserBean@20322d26

,連看都看不出是什麼東東。因此，Builder提供了一個種可能性，實際使用還需要更多的東西。

那麼，我們為了測試方便需要新增 @ToString() 註解，就會輸出 UserBean(id=1001, userName=polly)

換一個思路，你可能想，我不新增ToString註解，我把他轉成json輸出：

UserBean u=UserBean.builder()
	.id(1001)
	.userName("polly")
	.build();
ObjectMapper mapper=new ObjectMapper();
System.out.println(mapper.writeValueAsString(u));

很不幸，你會收到下面的異常：

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: No serializer found for class com.pollyduan.builder.UserBean and no properties discovered to create BeanSerializer (to avoid exception, disable SerializationFeature.FAIL_ON_EMPTY_BEANS)

看到 no properties discovered 了吧，沒錯，工具類無法找到屬性，因為沒有 getter，那麼我們加上 @Getter 就可以了。

package com.pollyduan.builder;

import lombok.Builder;
import lombok.Getter;

@Builder
@Getter
public class UserBean {
	  private Integer id;
	  private String userName;
}

序列化為json可以了，那麼從一個json反序列化為物件呢？

@Builder
@Getter
@Setter
public class UserBean {
	  private Integer id;
	  private String userName;
}

還是不行，如無意外，會遇到 com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance ofcom.pollyduan.builder.UserBean(no Creators, like default construct, exist): cannot deserialize from Object value (no delegate- or property-based Creator)

前面已經交代了，光增加 @Setter 還不夠，他還需要一個無參構造器。那麼，下面可以嗎？

package com.pollyduan.builder;

import lombok.Builder;
import lombok.Data;

@Builder
@Data
public class UserBean {
	  private Integer id;
	  private String userName;
}

同樣不行，因為雖然 Data使用的時候可以直接使用無參構造器，但由於 Builder 引入了全參構造器，那麼按照java原生的規則，無參構造器就沒有了。那麼就再加一個無參構造器

@Builder
@Data
@NoArgsConstructor

很不幸，Builder又報錯了，它找不到全參構造器了。好吧，最終的效果如下：

@Builder
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor

注意全參構造器的訪問級別，不要破壞Builder的規則。

更進一步，看如下示例：

package com.pollyduan.builder;

import java.util.List;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Builder
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor
public class UserBean {
	  private Integer id;
	  private String userName;
	  private List<String> addresses;
}

思考一下，這個List 我們也需要在外面new 一個 ArrayList，然後build進去，使用起來並不舒服。lombok提供了另一個註解配合使用，那就是 @Singular，如下：

package com.pollyduan.builder;

import java.util.List;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

@Builder
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor
public class UserBean {
	  private Integer id;
	  private String userName;
	  @Singular
	  private List<String> favorites;
}

那麼就可以這樣操作這個列表了。

UserBean u = UserBean.builder()
	.id(1001)
	.userName("polly")
	.favorite("music")
	.favorite("movie")
	.build();

是不是很方便？同時還提供了一個 clearXXX方法，清空集合。

還有一個小坑，如果我們增加一個example屬性，然後給它一個預設值：

@Builder
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor
public class UserBean {
	  private Integer id;
	  private String userName;
	  private String example="123456";
}

測試一下看：

UserBean u = UserBean.builder()
	.id(1001)
	.userName("polly")
	.build();
System.out.println(u.toString());

輸出結果：UserBean(id=1001, userName=polly, example=null)

咦，不對呀？預設值呢？？這要從Builder的原理來解釋，他實際上是分別設定了一套屬性列表的值，然後使用全參構造器建立物件。那麼，預設值在Bean上，不在Builder上，那麼Builder沒賦值，它的值就是null，最後把所有屬性都複製給UserBean，從而null覆蓋了預設值。

如何讓Builder實體來有預設值呢？只需要給該欄位增加 @Default 註解級可。

package com.pollyduan.builder;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Builder.Default;
import lombok.Data;
import lombok.NoArgsConstructor;

@Builder
@Data
@AllArgsConstructor(access = AccessLevel.PRIVATE)
@NoArgsConstructor
public class UserBean {
	  private Integer id;
	  private String userName;
	  @Default
	  private String example="123456";
}

重新執行測試用例，輸出：UserBean(id=1001, userName=polly, example=123456)，OK，沒毛病了。

Wither

用wither方式構建物件，這在Objective-C 中比較多見。

適用的場景是，使用幾個必要的引數構建物件，其他引數，動態的拼裝。舉個例子，我們構建一個ApiClient，它的使用者名稱和密碼是必須的，他的ApiService的地址有一個預設值，然後我們可以自己定製這個地址。

package com.pollyduan.wither;

import lombok.AllArgsConstructor;
import lombok.experimental.Wither;

@Wither
@AllArgsConstructor //WITHER NEED IT.
public class ApiClient {
	private String appId;
	private String appKey;
	private String endpoint="http://api.pollyduan.com/myservice";
}

如何使用呢？

@Test
public void test1() {
	ApiClient client1=new ApiClient(null, null,null);
	System.out.println(client1);

	Object client2 = client1.withAppId("10001")
		.withAppKey("abcdefg")
		.withEndpoint("http://127.0.0.1/");
	System.out.println(client2);
}

預設的使用null去初始化一個物件還是很奇怪的。和 Builder一樣，Wither也是提供了可能性，實際使用還需要調整一下。

我們可以設定一個必選引數的構造器，如下：

package com.pollyduan.wither;

import lombok.AllArgsConstructor;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.experimental.Wither;

@RequiredArgsConstructor
@Wither
@AllArgsConstructor
public class ApiClient {
	@NonNull
	private String appId;
	@NonNull
	private String appKey;
	private String endpoint="http://api.pollyduan.com/myservice";
}

這樣使用時就可以這樣：

	@Test
	public void test1() {
		ApiClient client1=new ApiClient("10001", "abcdefgh");
		System.out.println(client1);
		
		Object client2 = client1.withEndpoint("http://127.0.0.1/");
		System.out.println(client2);
	}

是不是優雅了很多？而且實際上使用時也使用鏈式語法：

ApiClient client1=new ApiClient("10001", "abcdefgh")
	withEndpoint("http://127.0.0.1/");

另外還有一個小細節，前面的示例輸出如下：

com.pollyduan.wither.ApiClient@782830e
com.pollyduan.wither.ApiClient@470e2030

這個日誌表明，with() 返回的物件並不是原來的物件，而是一個新物件，這很重要。

Accessors

訪問器模式，是給一個普通的Bean增加一個便捷的訪問器，包括讀和寫。

它有兩種工作模式，fluent和chain，舉例說明：

package com.pollyduan.accessors;

import lombok.Data;
import lombok.experimental.Accessors;

@Accessors(fluent = true)
@Data
public class UserBean {
	private Integer id;
	private String userName;
	private String password;
	
}

使用程式碼：

UserBean u=new UserBean()
	.id(10001)
	.userName("polly")
	.password("123456");

u.userName("Tom");
System.out.println(u.userName());

這和 Builder 類似，但更小巧，而且不影響屬性的讀寫，只不過使用屬性同名字串代替了getter和setter。

另一個模式是 chain：

UserBean u=new UserBean()
	.setId(10001)
	.setUserName("polly")
	.setPassword("123456");

u.setUserName("Tom");
System.out.println(u.getUserName());

可以看得出來，這fluent的區別就在於使

使用lombok編寫優雅的Bean物件

ORM實體類

Builder

Wither

Accessors

使用lombok編寫優雅的Bean物件

利用Lombok編寫優雅的spring依賴注入程式碼,去掉繁人的@Autowired

【原創】如何優雅的轉換Bean物件

運用反射從bean物件中取出屬性頁面顯示list優化

Spring IOC -bean物件的生命週期詳解(補充,含程式碼)

Spring IOC的Bean物件

Spring Boot 普通類呼叫Bean物件的一種方式

spring容器建立bean物件的方式

springboot整合filter之在filter中如何獲取spring容器中的bean物件

spring 根據beanName獲取bean物件，呼叫其方法

Bean物件的細節

自定義bean物件實現序列化介面(Writable)以及實現案例

JsonObject轉換Bean物件和Bean物件轉換JsonObject工具類（填坑後）

java bean物件轉換json物件時過濾空值

json轉換成bean物件

如何用 PEP 8 編寫優雅的 Python 程式碼！

hibernate執行SQL返回自定義Bean物件

關於springmvc中註解@ModelAttribute的bean(物件引數)問題

spring靜態方法中使用bean物件

Java bean物件返回資料Json格式化

使用lombok編寫優雅的Bean物件

ORM實體類

Builder

Wither

Accessors

相關推薦