YeaHub Tech on Telegram: “#IOS 🔖 6 принципов качественных iOS-модулей Соз…”

#IOS

🔖 6 принципов качественных iOS-модулей

Создание библиотек и модулей для iOS — это искусство баланса между функциональностью и простотой. Хорошо спроектированный модуль может сэкономить коллегам недели работы, а плохой — стать источником головной боли на годы.

Вот шесть ключевых принципов, которые помогут вам создавать модули, за которые коллеги будут благодарить, а не проклинать.

1️⃣Ограничьте поверхность API

Принцип: Делайте публичный интерфейс как можно меньше.

Каждый публичный метод, свойство или тип — это обещание, которое вы даете пользователям. Чем больше обещаний, тем сложнее их выполнять и изменять в будущем.

Почему это важно:
- Удалить функцию = breaking change
- Добавить функцию = безопасное изменение
- Меньше кода = меньше багов = меньше поддержки

Следствие: Предоставьте только один способ выполнения операции. Никаких дублирующих методов "для удобства".

2️⃣Отдавайте должное семантическому версионированию

Принцип: Используйте формат Major.Minor.Patch осмысленно.

- Patch (1.0.1): Исправления багов, внутренние изменения
- Minor (1.1.0): Новые функции без breaking changes
- Major (2.0.0): Breaking changes, изменения API

Золотое правило: Пользователи должны обновляться на patch и minor версии без изменений в своем коде.

Не забывайте про changelog и migration guides для major версий!

3️⃣Предоставляйте информативные сообщения об ошибках

Принцип: Никогда не возвращайте nil без объяснения причины.

// ❌ ПЛОХО
init?(value: Int) {
    guard isPrime(value) else { return nil }
    self.value = value
}

// ✅ ХОРОШО  
init(value: Int) throws {
    guard isPrime(value) else { 
        throw Error.notPrime 
    }
    self.value = value
}

Следствие: Никаких fatalError и принудительных крашей. Ваша библиотека не должна "ронять" чужое приложение.

4️⃣Всегда уважайте клиентское приложение

Принцип: Не переопределяйте делегаты и настройки приложения.

Если вашему модулю нужен доступ к NavigationController или другим компонентам приложения, создавайте wrapper-делегаты:

class SDKNavigationDelegate: UINavigationControllerDelegate {
    private weak var appDelegate: UINavigationControllerDelegate?
    
    init(navigationController: UINavigationController) {
        self.appDelegate = navigationController.delegate // Сохраняем оригинал
        navigationController.delegate = self
    }
    
    func unload() {
        navigationController?.delegate = appDelegate // Возвращаем обратно
    }
}

5️⃣Всегда проверяйте входные данные

Принцип: Создавайте строго типизированные входные параметры вместо примитивов.

// ❌ Вместо String
func processPayment(cardNumber: String) 

// ✅ Используйте типизированные обертки
struct CreditCardNumber {
    let number: String
    
    init(number: String) throws {
        guard !number.isEmpty else { throw Error.empty }
        guard number.count == 16 else { throw Error.wrongLength }
        guard number.allSatisfy(\.isNumber) else { throw Error.invalidCharacters }
        self.number = number
    }
}

Преимущества:
- Валидация выполняется один раз в начале
- Невозможно перепутать параметры местами
- Компилятор помогает отловить ошибки

6️⃣Пишите четкую и краткую документацию

Принцип: Документируйте не только "что", но и "почему", "когда" и "как".

Хорошая документация включает:
- Назначение метода
- Описание параметров
- Возвращаемые значения
- Возможные ошибки и их причины
- Сложность алгоритма (если важна)
- Примеры использования

📎 Статья

🎙 Новости

📝 База вопросов