nacos源码阅读建造者模式

电玩女神 2024-04-06 13:46 55阅读 0赞

读源码时不知从何下手，但初衷是为了学习写代码的技巧，所以就从**common**这个**module**读起了。

**common**中的**RestResult**使用了建造者模式，类的属性定义也比较有参考价值，所以就拿出来聊下。

package com.alibaba.nacos.common.model;
    
    import java.io.Serializable;
    
    /**
     * Rest result.
     *
     * @author <a href="mailto:liaochuntao@live.com">liaochuntao</a>
     */
    public class RestResult<T> implements Serializable {
        
        private static final long serialVersionUID = 6095433538316185017L;
        
        private int code;
        
        private String message;
        
        private T data;
        
        public RestResult() {
        }
        
        //省略了构造方法和set/get/toString方法
        
        public boolean ok() {
            return this.code == 0 || this.code == 200;
        }
        
        public static <T> ResResultBuilder<T> builder() {
            return new ResResultBuilder<>();
        }
        
        public static final class ResResultBuilder<T> {
            
            private int code;
            
            private String errMsg;
            
            private T data;
            
            private ResResultBuilder() {
            }
            
            //省去了部分方法
            /**
             * Build result.
             *
             * @return result
             */
            public RestResult<T> build() {
                RestResult<T> restResult = new RestResult<>();
                restResult.setCode(code);
                restResult.setMessage(errMsg);
                restResult.setData(data);
                return restResult;
            }
        }
    }

为了方便阅读，这里省略了部分方法，上面的代码中有注释。

从代码中我们可以看到，**RestResult** 使用了定义api常用的三个属性，**code 结果码、message 提示信息、一个泛型 data**。这种设计的适应性很强，对返回请求结果的约束小，很值得借鉴。

这里 **RestResult** 的 **builder**方法是一个公开的静态方法，这意味着我们可以直接通过类名来调用这个方法获取一个**ResResultBuilder对象**，并通过**builder对象**的**build()**方法最终获取一个**RestResult**对象。

注意到这里**ResResultBuilder 类的定义，**使用了 **staitc** 和 **final** 修饰。

使用**static**是因为 **RestResult**的**builder**方法是一个**静态方法**，**静态资源**之间可以互相调用。

使用**final**是为了防止类被继承。

同时我们注意到 **ResResultBuilder** 的**无参构造方法**被 **private** 修饰了，这也意味着在不定义其他构造方法的情况下，**ResResultBuilder** 对象只能有**RestResult**的**builder**方法获取。这样强力的绑定了两个类之间的关系，可以在一定程度上防止滥用。

欢迎小伙伴们分享自己的看法，互相学习。

后边我会继续分享nacos源码中的其他亮点，欢迎关注。