使用lombok編寫優雅的Bean對象

使用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的區別就在于使用getter和setter。