Логирование в Swift приложениях: лучшие практики на практике

Логирование в Swift приложениях: лучшие практики на практике

Логирование — это не просто запись сообщений в консоль. В профессиональной разработке под iOS/macOS правильно настроенное логирование становится незаменимым инструментом для отладки, мониторинга и анализа поведения приложения в production. В этой статье мы разберем лучшие практики логирования в Swift, рассмотрим современные инструменты (os_log, SwiftyBeaver) и напишем реальные примеры кода, которые вы сможете внедрить в свой проект уже сегодня.

Почему print() — это плохо для production

Многие начинающие разработчики используют print() для отладки. Однако в production-приложениях это приводит к проблемам:

• Производительность: print() синхронно блокирует поток, замедляя UI.
• Безопасность: Чувствительные данные (токены, пароли) могут попасть в системные логи.
• Отсутствие фильтрации: Вы не можете отделить debug-сообщения от error.
• Нет структуры: Каждое сообщение — просто строка без метаданных (уровень, категория, файл, функция).

Вместо print() используйте системный фреймворк os_log (Unified Logging) или сторонние библиотеки, такие как SwiftyBeaver.

Лучшая практика #1: Использование os_log (Unified Logging System)

Начиная с iOS 10 / macOS 10.12, Apple рекомендует использовать os_log из фреймворка OSLog. Это встроенный механизм, который работает асинхронно, не влияет на производительность и автоматически собирает метаданные.

Базовая настройка os_log

import OSLog

// Создаем логгер для модуля "Network"
let networkLogger = Logger(subsystem: "com.yourapp.network", category: "HTTP")

// Логируем разные уровни
networkLogger.debug("Запрос отправлен: \(url)")
networkLogger.info("Ответ получен: \(statusCode)")
networkLogger.error("Ошибка соединения: \(error.localizedDescription)")
networkLogger.fault("Критическая ошибка: потеря данных")

Преимущества os_log:

• Асинхронность: Не блокирует main thread.
• Уровни: debug, info, error, fault — можно фильтровать в консоли Xcode.
• Безопасность: Чувствительные данные автоматически маскируются в release-сборках.
• Интеграция с Console.app: Все логи доступны на устройстве пользователя (с его разрешения).

Динамические уровни для отладки

Для удобства можно создать обертку, которая позволяет включать/выключать debug-логи в зависимости от схемы сборки:

import OSLog

struct AppLogger {
    private static let subsystem = "com.yourapp.main"
    
    static let general = Logger(subsystem: subsystem, category: "General")
    static let network = Logger(subsystem: subsystem, category: "Network")
    static let database = Logger(subsystem: subsystem, category: "Database")
    
    static func debug(_ message: String, file: String = #file, function: String = #function, line: Int = #line) {
        #if DEBUG
        let fileName = (file as NSString).lastPathComponent
        general.debug("[\(fileName):\(line)] \(function) - \(message)")
        #endif
    }
}

// Использование
AppLogger.debug("User tapped login button")
AppLogger.network.info("API call started")

Лучшая практика #2: SwiftyBeaver — гибкое логирование для сложных проектов

Если вам нужна расширенная функциональность (логирование в файл, отправка на сервер, цветной вывод в консоль), обратите внимание на SwiftyBeaver. Это одна из самых популярных библиотек для логирования в Swift.

Установка через Swift Package Manager

// В Package.swift или через Xcode -> File -> Add Packages
// URL: https://github.com/SwiftyBeaver/SwiftyBeaver.git

Пример настройки SwiftyBeaver

import SwiftyBeaver

let log = SwiftyBeaver.self

// Настраиваем консольный вывод (цветной, с эмодзи)
let console = ConsoleDestination()
console.format = "$DHH:mm:ss$d $L $N.$F:$l - $M"
console.levelColor.verbose = "💜 "
console.levelColor.debug = "💚 "
console.levelColor.info = "💙 "
console.levelColor.warning = "💛 "
console.levelColor.error = "❤️ "

// Добавляем файловое логирование
let file = FileDestination()
file.logFileURL = URL(fileURLWithPath: "/tmp/myapp.log")

// Добавляем отправку на сервер (например, для аналитики)
let cloud = SBPlatformDestination(appID: "YOUR_APP_ID", appSecret: "YOUR_SECRET", encryptionKey: "YOUR_KEY")

log.addDestination(console)
log.addDestination(file)
// log.addDestination(cloud) // Раскомментировать для production

// Использование
log.verbose("Запуск приложения")
log.debug("Загружено 3 объекта")
log.info("Пользователь авторизован")
log.warning("Срок действия токена истекает")
log.error("Не удалось сохранить данные")

Преимущества SwiftyBeaver:

• 5 уровней логирования: verbose, debug, info, warning, error.
• Цветной вывод в Xcode консоль.
• Автоматическое логирование в файл с ротацией.
• Возможность отправлять логи на облачный сервер SwiftyBeaver.
• Фильтрация по уровням и категориям.

Лучшая практика #3: Структурированное логирование с метаданными

Простая строка — это плохо. Добавляйте контекст: имя файла, номер строки, название функции, идентификатор пользователя. Это сэкономит часы при поиске багов.

Пример структурированного лога с os_log

import OSLog

struct LogEvent {
    let level: OSLogType
    let message: String
    let file: String
    let function: String
    let line: Int
    let timestamp: Date
    let userID: String?
    
    var formatted: String {
        let fileName = (file as NSString).lastPathComponent
        let time = ISO8601DateFormatter().string(from: timestamp)
        let user = userID ?? "anonymous"
        return "[\(time)] [\(level)] [\(user)] \(fileName):\(line) \(function) - \(message)"
    }
}

class StructuredLogger {
    private let logger: Logger
    private var currentUserID: String?
    
    init(subsystem: String, category: String) {
        self.logger = Logger