Паттерн строитель

Часть раздела Объектно-ориентированное программирование путешествия по Swift на Coddy. Урок 48 из 57.

Паттерн «строитель» собирает сложный объект пошагово. Каждый шаг устанавливает одну его часть и возвращает строитель, поэтому шаги можно объединять в цепочку, а финальный вызов build() создаёт готовый объект:

struct Request {
    let url: String
    let method: String
    let headers: [String: String]
}

struct RequestBuilder {
    private var url = ""
    private var method = "GET"
    private var headers: [String: String] = [:]

    func url(_ u: String) -> RequestBuilder { var b = self; b.url = u; return b }
    func method(_ m: String) -> RequestBuilder { var b = self; b.method = m; return b }
    func header(_ k: String, _ v: String) -> RequestBuilder { var b = self; b.headers[k] = v; return b }
    func build() -> Request { Request(url: url, method: method, headers: headers) }
}

let req = RequestBuilder().url("/users").method("POST").header("Auth", "token").build()
print("\(req.method) \(req.url) \(req.headers.count) header")

Результат:

POST /users 1 header

Сборщик может проверить всю конфигурацию перед созданием объекта, поэтому недопустимый объект никогда не создаётся. Здесь build() вызывает исключение, если обязательная часть отсутствует:

enum BuildError: Error { case missingURL }

struct Request { let url: String; let method: String }

struct RequestBuilder {
    private var url: String?
    private var method = "GET"
    func url(_ u: String) -> RequestBuilder { var b = self; b.url = u; return b }
    func method(_ m: String) -> RequestBuilder { var b = self; b.method = m; return b }
    func build() throws -> Request {
        guard let url else { throw BuildError.missingURL }
        return Request(url: url, method: method)
    }
}

do {
    _ = try RequestBuilder().method("PUT").build()
} catch {
    print("cannot build: \(error)")
}

Вывод:

cannot build: missingURL

Каждый шаг копирует структуру и изменяет копию, поэтому частично настроенный построитель можно повторно использовать как шаблон для нескольких объектов:

struct PizzaBuilder {
    private var size = "medium"
    private var toppings: [String] = []
    func size(_ s: String) -> PizzaBuilder { var b = self; b.size = s; return b }
    func add(_ t: String) -> PizzaBuilder { var b = self; b.toppings.append(t); return b }
    func build() -> String { "\(size) pizza with " + (toppings.isEmpty ? "nothing" : toppings.joined(separator: ", ")) }
}

let base = PizzaBuilder().size("large").add("cheese")
print(base.add("ham").build())
print(base.add("olives").build())

Вывод:

large pizza with cheese, ham
large pizza with cheese, olives

Значения параметров Swift по умолчанию уже подходят для простых случаев (Request(url: "/", method: "GET")). Строитель становится полезен, когда у объекта много необязательных частей, части зависят друг от друга или перед его созданием нужно проверить определённые правила.

// просто: аргументов по умолчанию достаточно
struct Point { var x = 0, y = 0 }
// сложно: много необязательных частей и валидация -> builder
let report = ReportBuilder().title("Q3").add(section: s1).add(section: s2).footer("draft").build()

Задание

Легко

Напишите построитель для сообщений электронной почты. EmailBuilder содержит цепочечные шаги to(_:) (его можно вызывать несколько раз, добавляя получателей), subject(_:), body(_:) и urgent(). build() возвращает Email или выбрасывает EmailError.noRecipients либо EmailError.noSubject. У срочного сообщения перед темой добавляется [URGENT] .

Предоставленный код считывает команды для каждого сообщения, разделённые строками --- (to ada@x.io, subject Hello, body text, urgent, затем send), и выводит To: ada@x.io, bo@x.io | [URGENT] Hello | text, error: no recipients или error: no subject.

Ваш код должен находиться в Email.swift, EmailError.swift и EmailBuilder.swift. В main.swift находится предоставленный код ввода/вывода, и его нельзя изменять.

Попробуйте сами

// Предоставленный код ввода/вывода: оставьте его как есть
var input: [String] = []
while let line = readLine() { input.append(line) }
var builder = EmailBuilder()
for line in input {
    let p = line.split(separator: " ", maxSplits: 1).map(String.init)
    switch p[0] {
    case "to": builder = builder.to(p[1])
    case "subject": builder = builder.subject(p[1])
    case "body": builder = builder.body(p[1])
    case "urgent": builder = builder.urgent()
    case "send":
        do {
            let e = try builder.build()
            print("To: \(e.recipients.joined(separator: ", ")) | \(e.subject) | \(e.body)")
        } catch EmailError.noRecipients {
            print("error: no recipients")
        } catch {
            print("error: no subject")
        }
    default: builder = EmailBuilder()
    }
}