快捷導(dǎo)航

Java設(shè)計模式中的建造者(Builder)模式解讀

更新時間：2023年10月09日 09:58:47 作者：蠟筆小久

這篇文章主要介紹了Java設(shè)計模式中的建造者(Builder)模式解讀, 建造者模式是一種創(chuàng)建對象的設(shè)計模式,它通過將對象的構(gòu)建過程分解為多個步驟,并使用一個建造者類來封裝這些步驟,從而使得對象的構(gòu)建過程更加靈活和可擴展,需要的朋友可以參考下

為什么需要建造者模式

在我們?nèi)粘５拈_發(fā)中，一般使用new 關(guān)鍵字通過構(gòu)造器就可以實現(xiàn)對象的創(chuàng)建，然后通過set來實現(xiàn)成員變量的修改, 為什么在Java中還需要建造者模式來創(chuàng)建對象？

假如我們系統(tǒng)中，需要有一個統(tǒng)一的日志模塊，包含了日志內(nèi)容(content)、日志所屬組織(orgId)、日志來源(logSource: 如app, 平臺操作)、用戶名(username)。

通常情況下我們可以直接通過定義一個日志類, 然后通過構(gòu)造器的方式, 進行參數(shù)設(shè)置。

public class LogEntity {
    @Getter
    private Long id;
    /**
     * 操作時間
     */
    @Getter
    private String eventDate;
    /**
     * 操作日志模塊: default other
     */
    @Getter
    private String module;
    /**
     * 操作內(nèi)容
     */
    @Getter
    private String message;
    /**
     * IP
     */
    @Getter
    private String ipAddress;
    /**
     * 操作用戶
     */
    @Getter
    private String username;
    /**
     * 日志所屬組織
     */
    @Getter
    private Long organizationId;
    /**
     * 日志來源('日志來源：1：終端上報，2：平臺下發(fā)，3：平臺操作，4：APP操作')
     */
    @Getter
    private Integer logSource;
    public PlatformLoggerEntity(Long id, String module, String message, Long organizationId, Integer logSource) {
        this.id = id;
        this.module = module;
        this.message = message;
        this.organizationId = organizationId;
        this.logSource = logSource;
    }
}

現(xiàn)在日志類，只有5個參數(shù)，參數(shù)的個數(shù)還在可接受范圍內(nèi)，假如后續(xù)LogEntity類要進行擴展, 存儲的參數(shù)變成10個或則更多，構(gòu)造器就會變得很長，并且可讀性和易用性都很變得很差。在使用構(gòu)造器時，還需要記得每個位置傳遞的是什么字段，如果字段類型相同，還有可能出現(xiàn)傳遞錯誤的情況。

你可能會說，我們可以通過set方法來設(shè)置值，確實，通過set方法來設(shè)置值可以避免必填字段和非必填字段問題。代碼的可用性也提高了。

出現(xiàn)的問題

1.id作為必填字段，需要寫在構(gòu)造器中，如果必填字段過多，又會出現(xiàn)構(gòu)造器參數(shù)列表過長的問題

2. 字段間存在關(guān)聯(lián)關(guān)系，比如logSource是平臺，則需要設(shè)置用戶的所屬企業(yè)id和用戶名, 如果我們通過set來設(shè)置值，那我們校驗的邏輯就沒有地方放了

3. 如果我們想把LogEntity設(shè)置為不可變對象，對象初始化后就不允許改變，那么我們再暴露set方法，就達到到該效果

因此我們可以通過建造者模式重寫方面的類, 重寫好的類如下:

public class PlatformLoggerEntity {
    /**
     * 使用雪花算法生成ID
     */
    @Getter
    private Long id;
    /**
     * 操作時間
     */
    @Getter
    private String eventDate;
    /**
     * 操作日志模塊: default other
     */
    @Getter
    private String module;
    /**
     * 操作內(nèi)容
     */
    @Getter
    private String message;
    /**
     * IP
     */
    @Getter
    private String ipAddress;
    /**
     * 操作用戶
     */
    @Getter
    private String username;
    /**
     * 日志所屬組織
     */
    @Getter
    private Long organizationId;
    /**
     * 日志來源('日志來源：1：終端上報，2：平臺下發(fā)，3：平臺操作，4：APP操作')
     */
    @Getter
    private Integer logSource;
    /**
     * 顯示類型 0：正常顯示  1：超鏈顯示
     */
    @Getter
    private Integer showType;
    private PlatformLoggerEntity(Builder builder) {
        this.id = IdUtil.next();
        this.username = SystemHelper.getCurrentUserName();
        this.ipAddress = SystemHelper.getIpAddress();
        this.organizationId = builder.organizationId;
        this.module = builder.module.getModule();
        this.message = builder.message;
        this.monitoringOperation = builder.monitoringOperation;
        this.monitorName = builder.monitorName;
        this.plateColor = builder.plateColor;
        this.showType = builder.showType;
        this.eventDate = LocalDateUtils.dateTimeFormat(new Date());
        this.logSource = builder.logSource.getLoggerSource();
    }
    /**
     * @return 創(chuàng)建builder類的實例對象
     */
    public static Builder newBuilder() {
        return new Builder();
    }
    /**
     * 日誌Builder類
     */
    public static class Builder {
        /**
         * 操作日志模塊: default other
         */
        private LoggerModule module;
        /**
         * 操作內(nèi)容
         */
        private String message;
        /**
         * 日志所屬組織
         */
        private Long organizationId;
        /**
         * 日志來源('日志來源：1：終端上報，2：平臺下發(fā)，3：平臺操作，4：APP操作')
         */
        private LoggerSource logSource;
        /**
         * 顯示類型 0：正常顯示  1：超鏈顯示
         */
        private Integer showType;
        publick LogEntity build() {
            // 默認(rèn)為平臺操作
            if (Objects.isNull(logSource)) {
                this.logSource = LoggerSource.PLATFORM_OPERATION;
            }
            if (Objects.isNull(organizationId)) {
                this.organizationId = SystemHelper.getCurrentUserOrgId();
            }
            // 用于前端展示
            if (Objects.isNull(module)) {
                this.module = LoggerModule.DEFAULT;
                this.showType = LoggerConstant.SHOW_TYPE_NORMAL;
            } else if (module.equals(LoggerModule.DEFAULT)) {
                this.showType = LoggerConstant.SHOW_TYPE_NORMAL;
            } else {
                this.showType = LoggerConstant.SHOW_TYPE_HYPERLINK;
            }
            return new PlatformLoggerEntity(this);
        }
        public Builder module(LoggerModule module) {
            this.module = module;
            return this;
        }
        public Builder message(String message) {
            this.message = message;
            return this;
        }
        public Builder organizationId(Long organizationId) {
            this.organizationId = organizationId;
            return this;
        }
        public Builder logSource(LoggerSource logSource) {
            this.logSource = logSource;
            return this;
        }
    }
}

我們重寫LogEntity類后，我們可以通過newBuilder來獲取內(nèi)部的Builder對象，并且通過build函數(shù)來創(chuàng)建LogEntity對象。

1.從上面代碼可以看出LogEntitty所有的成員屬性都只有g(shù)et方法，避免出現(xiàn)隨意修改的情況

2.通過LogEntity內(nèi)部的Builder類中的build() 來增加了相關(guān)聯(lián)屬性的驗證，避免調(diào)用則漏傳或則錯傳參數(shù)