《Effective Java 中文版 第二版》第二章 第2条:遇到多个构造器参数时要考虑用构建器(builder)

本章的主题是创建和销毁对象:何时以及如何创建对象,何时以及如何避免创建对象,如何确保它们能够适时地销毁,以及如何管理对象销毁之前必须进行的各种清理动作。


[toc]

静态工厂 和 构造器 有个共同的局限性:它们都不能很好地扩展到大量的可选参数。

书中例子为:编写一个类标识包装食品外面显示的营养成份标签。类似这个营养成分表:

营养成分表

方法一:程序员一向习惯采用重叠构造器(telescoping constructor)模式:

// Telescoping constructor pattern - does not scale well!
public class NutritionFacts { 
    private final int servingSize; // (mL) required 
    private final int servings; // (per container) required 
    private final int calories; // optional 
    private final int fat; // (g) optional
    private final int sodium; // (mg) optional 
    private final int carbohydrate; // (g) optional
    
    public NutritionFacts(int servingSize, int servings) {                 this(servingSize, servings, 0); 
    }   
    public NutritionFacts(int servingSize, int servings, int calories) {
    this(servingSize, servings, calories, 0); 
    }
    public NutritionFacts(int servingSize, int servings, int calories, int fat) { 
    this(servingSize, servings, calories, fat, 0); 
    }
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium) {
    this(servingSize, servings, calories, fat, sodium, 0); 
    }
    
    public NutritionFacts(int servingSize, int servings, int calories, int fat, int sodium, int carbohydrate) { 
    this.servingSize  = servingSize; 
    this.servings     = servings; 
    this.calories     = calories; 
    this.fat          = fat; 
    this.sodium       = sodium; 
    this.carbohydrate = carbohydrate; 
    }
}

调用方式如下:

NutritionFacts cocaCola = new NutritionFacts(240, 8, 100, 0, 35, 27);

重叠构造器模式可行,但是当有许多参数的时候,客户端代码会变得很难写,并且仍然较难以阅读。

方法二: JavaBeans 模式:调用一个无参构造器来创建对象,然后调用 setter 方法来设置每个必要的参数,以及每个相关的可选参数。

// JavaBeans Pattern - allows inconsistency, mandates mutability 
public class NutritionFacts {
// Parameters initialized to default values (if any) 
    private int servingSize = -1;  // Required; no default value
    private int servings     = -1;  //     "     "     "      " 
    private int calories     = 0; 
    private int fat          = 0; 
    private int sodium       = 0; 
    private int carbohydrate = 0;
    public NutritionFacts() { }

    // Setters 
    public void setServingSize(int val) { servingSize = val; } 
    public void setServings(int val) { servings = val; }
    public void setCalories(int val) { calories = val; } 
    public void setFat(int val) { fat = val; } 
    public void setSodium(int val) { sodium = val; } 
    public void setCarbohydrate(int val) { carbohydrate = val; }
}

调用方式如下:

NutritionFacts cocaCola = new NutritionFacts();
cocaCola.setServingSize(240); 
cocaCola.setServings(8); 
cocaCola.setCalories(100); 
cocaCola.setSodium(35);
cocaCola.setCarbohydrate(27);

这种模式弥补了重叠构造器模式的不足,可读性也好,但也存在严重的缺点:

  • 在构造过程中 JavaBean 可能处于不一致的状态
    因为构造过程被分到了几个调用中,有可能在构造完成之前使用它,导致当时使用的信息 与完成的信息不符,从而在使用时导致失败。

    可以通过手工冻结/解冻的方式弥补此不足,不允许对象构造完成前使用,但是显得十分笨拙,甚至导致运行时错误,因为编译器无法确保程序员会在使用之前先在对象上调用 freeze 方法。

    不一致状态

    这里值得注意的是,英文版中对于中文版 第10页最后一段的描述如下:

    英文版第二版 第13页

框起来的部分为本段标题:在构造过程中 JavaBean 可能处于 不一致的状态。

如果读者对于不一致的状态不理解,英文版中使用了 inconsistent 这个单词,将其翻译为"前后矛盾的状态"可能会更好理解。

inconsistent 百度翻译

  • 与第一点相关的另一点不足:JavaBeans 模式阻止了把类做成不可变的可能(见第15条)
    这需要程序员付出额外的努力来确保它的线程安全

方法三:Builder 模式

不直接生成想要的对象,而是让客户端利用所有必要的参数调用构造器(或者静态工厂),得到一个 builder 对象。然后客户端在 builder 对象上调用类似与 setter 的方法,来设置每个相关的可选数。最后,客户端调用无参的 build 方法来生成不可变的对象。这个 builder 是它构造的类的静态成员类(见第22条)。

// Builder Pattern 
public class NutritionFacts { 
    private final int servingSize; 
    private final int servings;
    private final int calories; 
    private final int fat; 
    private final int sodium; 
    private final int carbohydrate;
    public static class Builder {
        // Required parameters 
        private final int servingSize; 
        private final int servings;
        
        // Optional parameters - initialized to default values
        private int calories = 0;
        private int fat = 0; 
        private int carbohydrate = 0;
        private int sodium = 0;
    
        public Builder(int servingSize, int servings) { 
            this.servingSize = servingSize;
            this.servings    = servings; 
        }
        
        public Builder calories(int val) 
            {calories = val; return this; } 
        public Builder fat(int val) 
            { fat = val; return this; } 
        public Builder carbohydrate(int val) 
            { carbohydrate = val; return this; } 
        public Builder sodium(int val) 
            { sodium = val; return this; }
            
        public NutritionFacts build() {
        return new NutritionFacts(this); 
        }
    }
    private NutritionFacts(Builder builder) { 
        servingSize = builder.servingSize; 
        servings = builder.servings; 
        calories = builder.calories; 
        fat = builder.fat; 
        sodium = builder.sodium; 
        carbohydrate = builder.carbohydrate; 
    }
}

调用方式如下:

NutritionFacts cocaCola = new NutritionFacts.Builder(240, 8). calories(100).sodium(35).carbohydrate(27).build();

客户端代码很容易编写,更重要的是,易于阅读,builder 模式模拟了具名的可选参数,就像 Ada 和 Python 中的一样

具名的可选参数

英文原文为:


英文版第二版 第15页

named optional parameters 书中翻译为 具名的可选参数【google 为 : 命名可选参数】

因为本人没有学过 Ada 和 Python ,所以通过 google 找来了 Python 的例子,有感兴趣的可以看看Fun With Python Function Parameters

本人也用自己的理解简单的说一下【以下的图片内容通过 Chrome 的翻译所得】


普通 Python 位置函数
命名的 Python 功能参数

个人理解:你既可以只传入必须值,也可以更改默认的一些可选参数,获得所需内容(实例)。


总结

  • builder 像个构造器一样,可以对其参数强加约束条件。
    build 方法可以检测这些约束条件。将参数从 builder 拷贝到 对象 中之后,并在对象域而不是builder 域(见第39条)中对它们进行检验,这点很重要。如果违法了任何约束,build方法应该抛出异常(IllegalArgumentException),并显示详细信息(违反哪个约束)。

  • 对多个参数加强条件的另一种方法是,用多个 setter 方法 对某个条件必须持有的参数进行检查,如果约束条件没有满足就抛出 IllegalArgumentException 异常。此方法可以在传递了无效参数时立即报错,不用等到 build 方法调用。

与构造器相比,builder 的略微优势:

  • builder可以有多个可变(varargs)参数。构造器就像方法一样,只能有一个。
    请对比 重叠构造器模式 和 builder模式 观察其中的 可变参数(非 final)

  • Builder模式 十分灵活,可以利用单个builder构建多个对象;

  • Builder 参数也可以在创建对象期间进行调整,也可以随着不同的对象而改变;

  • Builder 也可以自动填充都写域,例如每次穿件对象时自动增加序号;

  • Class.newInstance 破坏了编译时的异常检查。而 Builder接口弥补了这些不足;

  • 设置了参数的 builder 生成了一个很好的抽象工厂【 builder 接口 为形参数类型】;

Builder模式 的不足:

  • 为了创建对象,必须先创建它的构造器。
    性能问题(十分重性能的情况下)
  • 比重叠构造器模式更加冗长,因此只有在很多参数时才使用。
    参数 >= 4

但是记住,未来你可能还需要添加参数,如果一开就使用构造器或者静态工厂,等到类需要多个参数时才添加构造器,就会无法控制,那些果实的构造器或者静态工厂显得十分不协调。因此,通常最好一开始就使用构造器

如果类的构造器或者静态工厂中具有多个参数,设计这种类时, Builder 模式就是种不错的选择,特别是当大多数参数都是可选的时候。与使用传统的重叠构造器模式相比,使用 Builder 模式的客户端代码将更易于阅读和编写,构造器也比 JavaBeans 更加安全。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,456评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,370评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,337评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,583评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,596评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,572评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,936评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,595评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,850评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,601评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,685评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,371评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,951评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,934评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,167评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,636评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,411评论 2 342

推荐阅读更多精彩内容