Чи правда, що не слід використовувати NSLog () у виробничому коді?

Мені про це говорили кілька разів на цьому самому сайті, але я хотів переконатися, що це дійсно так.

Я очікував, що зможу розпорошувати виклики функцій NSLog у всьому моєму коді, і що Xcode / gcc автоматично зніме ці виклики під час створення моїх версій / дистрибутивів.

Чи слід уникати використання цього? Якщо так, то які альтернативи є найбільш поширеними між досвідченими програмістами Objective-C?

Препроцесорні макроси справді чудові для налагодження. З NSLog () немає нічого поганого, але просто визначити власну функцію журналу з кращою функціональністю. Ось який я використовую, він включає ім'я файлу та номер рядка для полегшення відстеження виписок журналу.

#define DEBUG_MODE

#ifdef DEBUG_MODE
    #define DebugLog( s, ... ) NSLog( @"<%p %@:(%d)> %@", self, [[NSString stringWithUTF8String:__FILE__] lastPathComponent], __LINE__, [NSString stringWithFormat:(s), ##__VA_ARGS__] )
#else
    #define DebugLog( s, ... ) 
#endif

Мені було легше помістити весь цей вислів у заголовок префікса, а не у його власний файл. Ви можете, якщо хочете, створити більш складну систему ведення журналів, встановивши DebugLog взаємодію із звичайними об'єктами Objective-C. Наприклад, у вас може бути клас реєстрації, який записує у свій власний файл журналу (або базу даних) і включає аргумент "пріоритет", який ви могли встановити під час виконання, тому повідомлення про налагодження не відображаються у версії випуску, але повідомлення про помилки ( якщо ви це зробили, ви можете зробити DebugLog (), WarningLog () тощо).

О, і майте на увазі, що #define DEBUG_MODEїх можна повторно використовувати в різних місцях вашої програми. Наприклад, у своїй програмі я використовую його для відключення перевірок ліцензійних ключів і дозволяю запускати програму лише у тому випадку, коли вона закінчується до певної дати. Це дозволяє мені поширювати обмежену часом повністю функціональну бета-копію з мінімальними зусиллями з мого боку.

Покладіть ці 3 рядки в кінець файлу -prefix.pch:

#ifndef DEBUG
  #define NSLog(...) /* suppress NSLog when in release mode */
#endif

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

Виклики NSLog можна залишити у виробничому коді, але вони повинні бути там лише для справді виняткових випадків або інформації, яка бажається, що буде внесена до системного журналу.

Програми, які засмічують системний журнал, дратують і трапляються як непрофесійні.

Я не можу коментувати відповідь Марка Чарбоно , тому опублікую це як відповідь.

Крім додавання макросу до заздалегідь складеного заголовка, ви можете використовувати конфігурації збірки Target для управління визначаючим (або відсутністю визначення) DEBUG_MODE.

Якщо ви виберете " Налагодити " активну конфігурацію, DEBUG_MODEбуде визначено, і макрос розшириться до повного NSLogвизначення.

Вибір активної конфігурації " Випустити " не визначатиметься, DEBUG_MODEа ваш NSLogging буде випущено з версії версії

Кроки:

• Ціль> Отримати інформацію
• Вкладка "Збірка"
• Шукати "Макроси препроцесора" (або GCC_PREPROCESSOR_DEFINITIONS)
• Виберіть Конфігурація: Налагодження
• Змініть визначення на цьому рівні
• Додайте DEBUG_MODE=1
• Виберіть Конфігурація: Відпустіть
• підтвердження DEBUG_MODEне встановленоGCC_PREPROCESSOR_DEFINITIONS

якщо опустити символ '=' у визначенні, ви отримаєте помилку від препроцесора

Також вставте цей коментар (показаний нижче) над визначенням макросу, щоб нагадати, звідки DEBUG_MACROпоходить визначення;)

// Target > Get Info > Build > GCC_PREPROCESSOR_DEFINITIONS
// Configuration = Release: <empty>
//               = Debug:   DEBUG_MODE=1

EDIT: метод відправлений Марком Шарбонно , і звернув мою увагу на шо , набагато краще , ніж цей.

Я видалив частину своєї відповіді, яка запропонувала використовувати порожню функцію для відключення журналу, коли режим налагодження вимкнено. Частина, що стосується встановлення автоматичного макроса препроцесора, залишається актуальною, тому вона залишається. Я також відредагував ім'я макроса препроцесора, щоб воно краще відповідало відповіді Марка Чарбоно.

Для досягнення автоматичної (і очікуваної) поведінки в Xcode:

У налаштуваннях проекту перейдіть на вкладку «Збірка» та виберіть конфігурацію «Налагодження». Знайдіть розділ «Макроси препроцесора» та додайте макрос з назвою DEBUG_MODE.

...

РЕДАКТУВАННЯ: Дивіться відповідь Марка Шарбонно про правильний спосіб увімкнення та вимкнення журналу за допомогою DEBUG_MODEмакроса.

Я погоджуюся з Метью. Нічого поганого в NSLog у виробничому коді. Насправді це може бути корисно користувачеві. Це означає, що якщо ви використовуєте NSLog єдиною причиною, щоб допомогти налагоджувати, то, так, це слід видалити перед випуском.

Крім того, оскільки ви позначили це як питання iPhone, NSLog забирає ресурси, а це iPhone, що мало дорогоцінно. Якщо ви займаєтесь NSLogging що- небудь на iPhone, це забирає час роботи процесора у вашої програми. Використовуйте його розумно.

Проста правда полягає в тому, що NSLog просто повільний.

Але чому? Щоб відповісти на це питання, давайте дізнаємося, що робить NSLog, а потім як це робити.

Що саме робить NSLog?

NSLog робить 2 речі:

Він записує журнали повідомлень у систему Apple System Logging (asl). Це дозволяє відображати повідомлення журналу в Console.app. Він також перевіряє, чи надходить stderr потік програми до терміналу (наприклад, коли програма запущена через Xcode). Якщо так, він записує повідомлення журналу в stderr (щоб воно відображалося на консолі Xcode).

Написання в STDERR не звучить складно. Це можна досягти за допомогою fprintf та посилання на дескриптор файлу stderr. А як щодо Асл?

Найкраща документація, яку я знайшла про ASL, - це 10-часова публікація в блозі від Пітера Хосі: посилання

Не вдаючись до занадто багато деталей, головним моментом (що стосується продуктивності) є таке:

Щоб надіслати повідомлення журналу до об'єкту ASL, ви в основному відкриваєте підключення клієнта до демона ASL і відправляєте повідомлення. АЛЕ - кожен потік повинен використовувати окреме клієнтське з'єднання. Отже, щоб бути безпечним для потоку, кожен раз, коли викликається NSLog, він відкриває нове з'єднання клієнта asl, відправляє повідомлення і потім закриває з'єднання.

Ресурси можна знайти тут і тут .

Як зазначено в інших відповідях, ви можете використовувати #define, щоб змінити, чи використовується NSLog під час компіляції чи ні.

Однак більш гнучким способом є використання бібліотеки лісозаготівлі, наприклад, Cocoa Lumberjack, що дозволяє вам змінювати, чи щось також входить під час виконання.

У своєму коді замініть NSLog DDLogVerbose або DDLogError тощо, додайте #import для визначення макросів тощо і налаштуйте реєстратори, часто методом applicationDidFinishLaunching.

Щоб мати той самий ефект, що і NSLog, є конфігураційний код

[DDLog addLogger:[DDASLLogger sharedInstance]];
[DDLog addLogger:[DDTTYLogger sharedInstance]];

З точки зору безпеки, це залежить від того, що реєструється. Якщо NSLog(або інші реєстратори) записують конфіденційну інформацію, слід видалити реєстратор у виробничому коді.

З точки зору аудиту, аудитор не хоче дивитись на кожне використання, NSLogщоб переконатися, що його не зберігається конфіденційна інформація. Він / вона просто скаже вам зняти лісоруб.

Я працюю з обома групами. Ми перевіряємо код, пишемо посібники з кодування тощо. У нашому посібнику потрібно вимкнути журнал у виробничому коді. Тож внутрішні команди знають, що не пробувати;)

Ми також відхилимо зовнішнє додаток, яке реєструється у виробництві, оскільки ми не хочемо приймати ризик, пов’язаний із випадковим витоком конфіденційної інформації. Нам все одно, що нам каже розробник. Нашого часу просто не варто досліджувати.

І пам’ятайте, ми визначаємо "чутливий", а не розробник;)

Я також сприймаю додаток, який виконує багато журналів, як додаток, готовий до імплодування. Є причина, через яку ведеться / потрібна велика кількість журналів, і зазвичай це не стабільність. Її праворуч там з "сторожовими" потоками, які перезапускають вивішені служби.

Якщо ви ніколи не проходили огляд архітектури безпеки (SecArch), це такі речі, які ми дивимося.

Вам не повинно бути багатослівне з printf або NSLog у коді випуску. Спробуйте робити тільки printf або NSLog, якщо з програмою трапилося щось погане, IE - невідправна помилка.

Майте на увазі, що NSLogs можуть сповільнити інтерфейс користувача / основний потік. Найкраще видаляти їх з версій версій, якщо це абсолютно не потрібно.

Я дуже рекомендую використовувати TestFlight для ведення журналу (безкоштовно). Їх метод замінить NSLog (за допомогою макросу) і дозволить увімкнути / вимкнути вхід на їх сервер, журнал Apple System і журнал STDERR для всіх існуючих викликів до NSLog. Приємно в тому, що ви все ще можете переглянути свої журнальні повідомлення на програми, розгорнуті до тестерів та додатки, розгорнуті в App Store, без журналів, які з’являються в системному журналі користувача. Найкраще з обох світів.