談 Builder Pattern 之前,先看個場景。假設你要預訂一支 iPhone 6,64G、金色,用程式碼描述大概長這樣:
// PFX 是前綴,因為直接寫 iPhone6 不符合類名大寫慣例, // 寫成 IPhone6 就更怪了 ╮(╯▽╰)╭ PFXiPhone6 *iphone = [[PFXiPhone6 alloc] init]; iphone.storage = 64; iphone.color = [UIColor goldenColor];
也可以換一種寫法:
PFXiPhone6 *iPhone = [[PFXiPhone6 alloc] initWithStorage:64 color:[UIColor goldenColor]];
第一種擴充性較好,但無法強制要求必須設定某些屬性;第二種修好了這個問題,代價是擴充性變差。
假設又有新需求:讓使用者選擇發售地區,港行、國行、美版等等。對第一種寫法,加一個屬性就好,但使用者很可能壓根不知道多了這個屬性。對第二種,只能再開一個初始化方法,例如 -initWithStorage:color:place。那如果需求繼續長出來呢——要不要刻字、刻什麼字?外殼要哪種材質?這兩種寫法都應付不來。
Builder Pattern 就是為了解這個問題。它在多數語言裡都很好實作,以 JavaScript 為例:
new PFXiPhone6Builder()
.setStorage(64)
.setColor('golden')
.setPlace('HK')
.build();有新屬性就再加一個 setProperty;漏了哪個必填項,在 build 裡檢查即可。
Objective-C 裡這種鏈式寫法並不流行(Masonry 用得比較多),所以在 OC 中大概會寫成:
PFXiPhone6Builder *builder = [[PFXiPhone6Builder alloc] init]; builder.storage = 64; builder.color = [UIColor goldenColor]; builder.place = @"HK"; PFXiPhone6 *iphone = [builder build];
少了屬性就在 build 時檢查。既解決了擴充問題,新增屬性時也不會被漏掉。
不過還是不夠優雅。這個 builder 只是個用完就丟的臨時工具,那有沒有可能寫法符合 OC 傳統,又讓它「臨時出現」一下?看下面這段:
PFXiPhone6 *iPhone6 = [PFXiPhone6 createWithBuilder:^(PFXiPhone6Builder *builder) {
builder.storage = 64;
builder.color = [UIColor goldenColor];
builder.place = @"HK";
}];是不是順眼多了。builder 只在 block 作用域內有效,不會污染當前 context 的變量。+createWithBuilder: 的實作如下:
+ (instancetype)createWithBuilder:(BuilderBlock)block {
NSParameterAssert(block);
PFXiPhone6Builder *builder = [[PFXiPhone6Builder alloc] init];
block(builder);
return [builder build];
}其中 build 有兩種寫法。第一種:
// PFXiPhone6Builder
- (PFXiPhone6 *)build {
return [[PFXiPhone6 alloc] initWithBuilder:self];
}
// PFXiPhone6
- (instancetype)initWithBuilder:(PFXiPhone6Builder *)builder {
if (self = [super init]) {
_storage = builder.storage;
_color = builder.color;
_place = builder.place;
}
}第二種是把兩個步驟合併:
// PFXiPhone6Builder
- (PFXiPhone6 *)build {
// 可以在這裡對 property 做檢查
NSAssert(self.place, @"發行地區別忘了填哦");
PFXiPhone6 *iPhone6 = [[PFXiPhone6 alloc] init];
iPhone6.storage = self.storage;
iPhone6.color = self.color;
iPhone6.place = self.place;
return iPhone6;
}差別在於參數處理的位置:前者在目標類別中處理,後者在 Builder 中處理。
Facebook 的 pop 裡也有類似用法:
POPAnimatableProperty *animatableProperty =
[POPAnimatableProperty propertyWithName:@"property" initializer:^(POPMutableAnimatableProperty *prop) {
prop.writeBlock = ^(id obj, const CGFloat values[]) {
};
prop.readBlock = ^(id obj, CGFloat values[]) {
};
}];這裡的 initializer 其實就是 builder。
我在做蘑菇街的基礎框架時也用過幾處,覺得對呼叫方相當友善。比如這個可橫向或縱向滾動、包含可點擊 Items 的 collectionView:
self.collectionView = [MGJFlowCollectionView collectionViewWithBuilder:^(MGJFlowCollectionViewBuilder *builder) {
builder.scrollDirection = UICollectionViewScrollDirectionHorizontal;
builder.minimumInteritemSpacing = 10;
builder.minimumLineSpacing = 10;
builder.sectionInset = UIEdgeInsetsMake(10, 10, 10, 10);
CGSize itemSize = CGSizeMake(81, 100);
builder.itemSize = itemSize;
builder.dataSource = @[@1,@2,@3,@4,@5,@6, @7,@8, @9,@10];
builder.cellBuilder = ^UIView *(NSNumber *number){
UIView *view = [[UIView alloc] initWithFrame:CGRectMake(0, 0, itemSize.width, itemSize.height)];
view.backgroundColor = [UIColor mgj_random];
return view;
};
}];這樣就能靠一份簡潔的設定,生成水平或垂直的 collectionView。
Builder Pattern 還有個附帶好處:把零散的設定集中在一處。建立一個 CollectionView 通常得設 layout、設 layout 的一堆屬性、再綁 DataSource / Delegate,現在可以在同一個 block 裡一次搞定,可讀性自然更好。
所以,當你遇到需要多個參數、甚至某個參數本身還帶著一堆子參數的情況,不妨考慮 Builder Pattern。
參考:https://www.annema.me/the-builder-pattern-in-objective-c