Log Средства логирования в FireMonkey

[Brovin Yaroslav]

Какими доступными средствами можно осуществлять логирования под Андроид?

[Brovin Yaroslav]

RAD Studio XE5 предоставляет несколько способов логирования под платформы Андроид и iOS. Давайте их рассмотрим:

1. Встроенный в FIreMonkey механизм логирования (кроссплатформенный).
2. Использование системных функция каждой платформы для логирования
3. Использование файлов для вывода логов.
4. Использование сети для передачи сообщений лога

1. Встроенный механизм логирования

FireMonkey содержит специальный класс FMX.Types.Log для осуществления логирования на всех платформах.

Этот класс использует на каждой платформе системные средства вывода лога.

Log = class abstract
public
  class procedure d(const Msg: String); overload;
  class procedure d(const Fmt: String; const Args: array of const); overload;
  class procedure d(const Tag: String; const Instance : TObject; const Msg : String); overload;
  class procedure d(const Tag: String; const Instance : TObject; const Method : String; const Msg : String); overload;
  class procedure TimeStamp(const Msg: String); overload;
  class function ObjToString(const Instance : TObject) : String;
  class function ArrayToString(const AArray : TEnumerable<TFmxObject>) : String; overload;
  class function ArrayToString(const AArray : TEnumerable<TFmxObject>; MakeStr : ToStringFunc) : String; overload;
  class procedure DumpFmxObject(const O: TFmxObject; Nest: Integer = 0);
end;

Он предоставляет довольно много методов по вывода лога. 

Чтобы его использовать достаточно вызвать любой нужный классовый метод. Например в моем приложении по нажатию на кнопку я буду выводить сообщение: "Log message from FireMonkey application"

procedure TFormPhone.Button1Click(Sender: TObject);
begin
  Log.d('Log message from FireMonkey application');
end;

Далее нужно понять, куда будет выведено это сообщение.

 

1.1. Андроид

Под андроид это сообщение попадает в системный журнал. Прочитать его можно в утилите Андроида LogCat - это специальная утилита для просмотра системного лога. Ее можно запустить двумя способами:

1. C GUI оболочкой
2. Из командной оболочки (консольный вариант).

Первый способ (с GUI). В Eclipse с Android SDK открыть Window->ShowView->LogCat. Откроется окно с GUI интерфейсом, в котором вы сможете увидеть все сообщения, которые отправляют все приложения на телефоне. Стоит отметить, что это вариант LogCat в эклипсе содержит ряд полезных функций по фильтрации лога и его управлению. Поэтому я предпочитаю этот способ, нежели использовать консольный вариант этой же утилиты. Сразу же перед использования советую полностью очистить текущий журнал логов телефона, так как он вначале будет содержать огромное количество сообщений. Для очистки нажмите кнопку очистки лога в окне (кнопка с листком и красным крестиком).

 

Второй способ (консольный режим). Второй вариант запуска утилиты LogCat заключается в вызове утилиты из командной строки. Утилита просмотра журналов логов входит в общую утилиту ADB.exe. Чтобы запустить лог изз командой строки воспользуйтесь следующей командой:

.\sdk\platform-tools\adb.exe logcat

Утилита лежит в папке platform-tools Android SDK. В вашем случае вы должны указать свой путь к этому файлу. Ключ logcat запускает просмотр журнала логирования.

Так же как и в первом варианте я советую предварительно очистить лог вызвав logcat с ключом -c:

.\sdk\platform-tools\adb.exe logcat -с

Описание всех ключей утилиты logcat: logcat

После того, как мы открыли Logcat любым из предложенных способов, запускаем нашу программу и смотрим сообщение в логе:

 

1.2 Йос

В йос лог попадает в два журнала в зависимости от того, где вы запускаете свою программу (Симулятор или устройство).

 

iOS Симулятор. Открываем журнал лога в меню симулятора Отладка->Открыть системный журнал...

 

 

iOS устройство. Открываем XCode Органайзер и выбираем вкладку Console у вашего устройства.

 

2. Использование системных функций логирования

Для тех, кто по каким-то причинам не хочет использовать FireMonkey для этих целей может использовать на каждой платформе системные функции логирования.

 

2.1 Андроид

Для андроида в Delphi предусмотрены системные функции из Androidapi.Log:

{ Helper functions }
function LOGI(Text: MarshaledAString): Integer;
function LOGW(Text: MarshaledAString): Integer;
function LOGE(Text: MarshaledAString): Integer;
function LOGF(Text: MarshaledAString): Integer; 

Каждая из которых выводит сообщение с указанным типом (I - информационное сообщение, W - предупреждение, E - ошибка, F - фатальная ошибка)

 

2.2 iOS

В IOS вы можете использовать системную функцию iOSapi.Foundation.NSLog.

procedure NSLog(format: PNSString); cdecl; varargs; external libFoundation name _PU + 'NSLog';

3. Логирование в файл

Является самым стандартным средством. Для его использования вы можете использовать стандартные способы работы с текстовыми файлами, которые полностью работают на всех платформах.

 

4. Логирование по сети

Этот способ так же имеет место быть и заключается в создании простого TCP клиента на стороне вашего приложения и FTP сервера на Windows. С приложения вы просто шлете на указанный адрес сервера сообщения, а на стороне сервера просто отображаете. Для этих целей можно использовать стандартные Indy компоненты.