A Philosophy of Software Design 정독

final class ImageLoader {
    func load(_ url: URL) -> UIImage?
    // 문서에만 있는 규칙들 = 전부 인터페이스다
    //  · configure(cacheSize:)를 먼저 불러야 한다
    //  · 메인 스레드에서만 호출할 것
    //  · nil은 "실패"일 수도 "아직 로딩 중"일 수도 있다
    //  · 반환된 UIImage를 강한 참조로 들고 있으면 캐시가 안 비워진다
}

enum ImageLoader {
    /// 이미지를 가져온다. 캐시·스레드·취소는 안에서 처리한다.
    /// 실패는 throw로 구분되고, 반환값 보관 여부는 캐시에 영향을 주지 않는다.
    static func image(at url: URL) async throws -> UIImage
}

FileInputStream fileStream =
        new FileInputStream(fileName);
BufferedInputStream bufferedStream =
        new BufferedInputStream(fileStream);
ObjectInputStream objectStream =
        new ObjectInputStream(bufferedStream);

final class DocumentReader {   // 앱 시작할 때 동작
    func read(_ url: URL) throws -> Document {
        // 헤더 16바이트 · 버전은 4~8바이트 · 본문은 리틀엔디안
    }
}

final class DocumentWriter {   // 앱 종료할 때 동작
    func write(_ doc: Document, to url: URL) throws {
        // 헤더 16바이트 · 버전은 4~8바이트 · 본문은 리틀엔디안
        // ↑ 같은 지식이 여기 또 있다. 포맷이 바뀌면 두 군데를 고쳐야 한다.
    }
}

enum DocumentFormat {          // "이 포맷을 안다"는 책임 하나
    static func decode(_ data: Data) throws -> Document
    static func encode(_ doc: Document) -> Data
    // 헤더 오프셋 · 엔디안 규칙은 이 안에만 있다
}

// ❌ 특수 목적 — 삭제 메서드가 세 개
protocol TextSpecial {
    func backspace()          // 커서 앞 한 글자
    func delete()             // 커서 뒤 한 글자
    func deleteSelection()    // 선택 영역
}

// ✅ 약간 범용 — 하나로 세 용도를 다 덮는다
protocol TextGeneral {
    func delete(from: Position, to: Position)
}

// ⚠️ 너무 범용 — 단순하고 범용적이지만 쓰기 나쁘다
protocol TextTooGeneral {
    func insert(_ ch: Character, at: Position)   // 한 글자씩만
    func delete(at: Position)                    // 상위 코드가 루프를 돌아야 하고 느리다
}

public class TextDocument ... {
    private TextArea textArea;

    public Character getLastTypedCharacter() {
        return textArea.getLastTypedCharacter();
    }
    public int getCursorOffset() {
        return textArea.getCursorOffset();
    }
    public void insertString(String textToInsert, int offset) {
        textArea.insertString(textToInsert, offset);
    }
}

// ❌ 복잡도를 위로 민다 — "몇 초가 맞는지는 네가 정해"
struct Transport {
    let retryInterval: TimeInterval    // 사용자가 이걸 어떻게 알지?
}

// ✅ 복잡도를 아래로 내린다 — 성공한 요청의 응답 시간을 재서 스스로 정한다
struct Transport {
    private var rtt = MovingAverage()
    private var retryInterval: TimeInterval { rtt.value * 2 }
    // 덤: 운영 조건이 바뀌면 자동으로 따라간다.
    //     고정 파라미터는 금방 낡는다("can easily become out of date").
}

extension String {
    func substring(from: Int, to: Int) throws -> String {
        guard from >= 0, to <= count, from <= to else { throw StringError.outOfRange }
        ...
    }
}

// 호출부 — 매번 이런다
let preview: String
if text.count > 100 {
    preview = try text.substring(from: 0, to: 100)
} else {
    preview = text
}

extension String {
    /// 인덱스가 beginIndex 이상 endIndex 미만인 문자들을 (있다면) 돌려준다.
    /// 음수든, begin > end 든 동작이 정의되어 있다. 실패하지 않는다.
    func substring(from: Int, to: Int) -> String {
        let lo = max(0, min(from, count))
        let hi = max(lo, min(to, count))
        ...
    }
}

let preview = text.substring(from: 0, to: 100)   // 짧아도 그냥 된다

// count를 1 증가시킨다
count += 1

/// 사용자를 가져온다
func fetchUser(id: String) async throws -> User

/// 사용자를 가져온다.
///
/// 네트워크 실패 시 최대 3회까지 지수 백오프로 재시도한다 — 호출자는 재시도를 신경 쓰지 않아도 된다.
/// 5분 이내에 같은 id로 호출하면 캐시된 값을 돌려준다. 강제로 새로 받으려면 `refreshUser(id:)`.
/// 취소되면 `CancellationError`를 던진다. 그 외 에러는 전부 `APIError`로 변환된다.
func fetchUser(id: String) async throws -> User

// ❌ 6개월
var block: Int = logicalBlock(of: file, at: offset)
writeToDisk(block)                     // 아무도 이상하다고 못 느낀다

// ✅ 컴파일러 없이도 눈에 보인다
var fileBlock: Int = logicalBlock(of: file, at: offset)
writeToDisk(fileBlock)                 // "fileBlock을 디스크에 쓴다고?" — 읽는 순간 걸린다
// 이름을 fileBlock / diskBlock 으로 나눴다면
// "프로그래머는 fileBlock을 그 자리에 쓸 수 없다는 걸 알았을 것이다"