Java中的@Builder注解問題詳解
一、前言
@Builder 注解的其中一個大坑會導致默認值失效!
@Builder 的問題還不止一個, @Builder 會讓人誤以為是遵循構建器模式,實則不然,后面會介紹。
總的來說,不推薦再使用 @Builder 注解,接下來講重點介紹其原因和替代方案。
二、場景復現(xiàn)
2.1 如果不使用 @Builder
類定義:
package io.gitrebase.demo; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor @AllArgsConstructor public class APIResponse<T> { private T payload; private Status status; }
使用示例:
package io.gitrebase.demo; import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.bind.annotation.RestControllerAdvice; @Slf4j @RestControllerAdvice(assignableTypes = io.gitrebase.demo.RestApplication.class) public class ApplicationExceptionHandler { @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) public APIResponse handleException(Exception exception) { log.error("Unhandled Exception", exception); Status status = new Status(); status.setResponseCode("RESPONSE_CODE_IDENTIFIER"); status.setDescription("Bla Bla Bla"); APIResponse response = new APIResponse(); response.setStatus(status); return response; } }
2.2 使用 @Builder
類定義:
package io.gitrebase.demo; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; import lombok.NoArgsConstructor; @Builder @Data @NoArgsConstructor @AllArgsConstructor public class APIResponse<T> { private T payload; private Status status; }
使用示例:
package io.gitrebase.demo; import lombok.extern.slf4j.Slf4j; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.bind.annotation.RestControllerAdvice; @Slf4j @RestControllerAdvice(basePackageClasses = io.gitrebase.demo.RestApplication.class) public class ApplicationExceptionHandler { @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) public APIResponse handleException(Exception exception) { log.error("Unhandled Exception", exception); return APIResponse.builder().status(Status.builder() .responseCode("RESPONSE_CODE_IDENTIFIER") .description("Bla Bla Bla") .build()) .build(); } }
三、為什么不推薦使用 @Builder ?
- @Builder 會生成一個不完美的構建器,它不能區(qū)分哪些參數(shù)是必須的,哪些是可選的。這可能會導致構建對象時出現(xiàn)錯誤或不一致的情況。
- 很多人習慣于將 @Builder 和 @Data 一起使用使用會生成一個可變的構建器,它有 setter 方法可以修改構建器的狀態(tài)。這違反了構建器模式的原則,即構建器應該是不可變的,一旦創(chuàng)建就不能修改。
- @Builder 會生成一個具體類型的構建器,它不能適應不同類型的參數(shù)。這限制了構建器模式的優(yōu)勢,即可以根據(jù)不同的抽象類型創(chuàng)建不同風格的對象。
- @Builder 的使用場景很有限,它只適合那些有很多參數(shù)且大部分是可選的對象。對于那些只想實現(xiàn)一個流式風格的對象創(chuàng)建,@Builder 并不是一個好的選擇。
四、替代方案
4.1 首推: @Accessor
類的定義:
package io.gitrebase.demo; import lombok.Data; import lombok.experimental.Accessors; @Data @Accessors(chain = true) public class APIResponse<T> { private T payload; private Status status; }
編譯后的類:
package io.gitrebase.demo; import lombok.experimental.Accessors; @Accessors(chain = true) public class APIResponse<T> { private T payload; private Status status; public T getPayload() { return this.payload; } public APIResponse<T> setPayload(T payload) { this.payload = payload; return this; } public Status getStatus() { return this.status; } public APIResponse<T> setStatus(Status status) { this.status = status; return this; } }
使用示例:
package io.gitrebase.demo; import lombok.extern.slf4j.Slf4j; import lombok.var; import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.ResponseStatus; import org.springframework.web.bind.annotation.RestControllerAdvice; @Slf4j @RestControllerAdvice(basePackageClasses = io.gitrebase.demo.RestApplication.class) public class ApplicationExceptionHandler { @ResponseStatus(code = HttpStatus.INTERNAL_SERVER_ERROR) public APIResponse handleException(Exception exception) { log.error("Unhandled Exception", exception); var status = new Status().setResponseCode("RESPONSE_CODE_IDENTIFIER").setDescription("Bla Bla Bla"); return new APIResponse().setStatus(status); } }
此外,該注解還支持一些高級方法:
/** * A container for settings for the generation of getters and setters. * <p> * Complete documentation is found at <a rel="external nofollow" >the project lombok features page for @Accessors</a>. * <p> * Using this annotation does nothing by itself; an annotation that makes lombok generate getters and setters, * such as {@link lombok.Setter} or {@link lombok.Data} is also required. */ @Target({ElementType.TYPE, ElementType.FIELD}) @Retention(RetentionPolicy.SOURCE) public @interface Accessors { /** * If true, accessors will be named after the field and not include a {@code get} or {@code set} * prefix. If true and {@code chain} is omitted, {@code chain} defaults to {@code true}. * <strong>default: false</strong> * * @return Whether or not to make fluent methods (named {@code fieldName()}, not for example {@code setFieldName}). */ boolean fluent() default false; /** * If true, setters return {@code this} instead of {@code void}. * <strong>default: false</strong>, unless {@code fluent=true}, then <strong>default: true</strong> * * @return Whether or not setters should return themselves (chaining) or {@code void} (no chaining). */ boolean chain() default false; /** * If present, only fields with any of the stated prefixes are given the getter/setter treatment. * Note that a prefix only counts if the next character is NOT a lowercase character or the last * letter of the prefix is not a letter (for instance an underscore). If multiple fields * all turn into the same name when the prefix is stripped, an error will be generated. * * @return If you are in the habit of prefixing your fields (for example, you name them {@code fFieldName}, specify such prefixes here). */ String[] prefix() default {}; }
另外如果一個類有些參數(shù)必傳,有些參數(shù)選傳,可以將必傳參數(shù)定義到構造方法上,非必傳參數(shù)采用 @Accessor 方式鏈式設置。
// 導入 lombok 注解 import lombok.Data; import lombok.experimental.Accessors; // 定義 Person 類 @Getter // 自動生成 getter 方法 @Accessors(chain = true) // 開啟鏈式調用 public class Person { // 定義必傳的屬性 private String name; // 姓名 private int id; // 編號 // 定義選填的屬性 private int age; // 年齡 private String address; // 地址 // 定義構造函數(shù),接收必傳的參數(shù) public Person(String name, int id) { this.name = name; this.id = id; } } // 使用示例 public class Main { public static void main(String[] args) { // 創(chuàng)建一個 Person 對象,傳入必要的參數(shù),通過鏈式調用,設置選填的屬性 Person person = new Person("張三", 1001).setAge(25).setAddress("北京市"); // 打印 Person 對象的信息 System.out.println(person); } }
4.2 手動模擬 @Accessor
由于 @Accessor 在 lombok.experimental包下,有極個非常謹慎的人會擔心未來不穩(wěn)定,未來可能被移除。 其實,在我看來這個擔心有些多余,目前這個注解比 @Builder 更適合使用,而且一個成熟的工具類庫不會輕易移除一個功能,而且及時移除了這個功能編譯期就可以感知到,替換起來也很容易。 如果真的擔心不穩(wěn)定或者不想依賴 lombok,那么自己在默認生成的 Setter 方法上改造一下即可。
五、啟發(fā)
大多數(shù)同學使用 lombok 注解都不會主動看源碼,了解有哪些高級配置。建議工作之余稍微花點時間去看一下源碼。 大家在使用 lombok 注解時,一定要在腦海中能夠準確“編譯” 出背后的代碼。如果你沒有這個能力,早晚會遇到坑。如果你沒有這個能力,那么多去看編譯后的類,熟能生巧。
并不是大家都在用的都是對的,使用某些功能時需要主動思考是否正確,哪怕是正確的是否是最佳的。@Builder 注解的確和構建器設計模式有些背離,很多時候我們需要的是@Accessor 的行為。
到此這篇關于Java中的@Builder注解問題詳解的文章就介紹到這了,更多相關Java的@Builder內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
SpringBoot框架aop切面的execution表達式解讀
這篇文章主要介紹了SpringBoot框架aop切面的execution表達式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05Spring處理@Async導致的循環(huán)依賴失敗問題的方案詳解
這篇文章主要為大家詳細介紹了SpringBoot中的@Async導致循環(huán)依賴失敗的原因及其解決方案,文中的示例代碼講解詳細,感興趣的可以學習一下2022-07-07