5分で使えるLoggingフレームワーク - POCO::Foundation -

オープンソースC++用クラスライブラリPOCO活用講座（2）

SplitterChannel

　複数のChannelオブジェクトに、同時に同じメッセージを出力したい場合に使います。使い方はカンタンで、addChannel関数を用いて出力したいChannelオブジェクトを追加します。サンプルコードは次のとおりです。

SplitterChannelのサンプルコード

Poco::SplitterChannel* pSChannel = new Poco::SplitterChannel();
            
pSChannel->addChannel( new Poco::FileChannel("test.log") );
pSChannel->addChannel( new Poco::ConsoleChannel );

Poco::Logger& SplitterLogger = Poco::Logger::create( "SplitterLogger",
                                pSChannel, Poco::Message::PRIO_INFORMATION );

SplitterLogger.error( "エラーが発生しました" );

コンストラクタ

　コンストラクタは、引数のないものだけです。

　SplitterChannelクラスでは、addChannel関数で追加されたChannelオブジェクトのポインタを、std::vectorの変数で保持しています。FormattingChannelクラスのように、リンク構造にはなっていません。また、removeChannel関数を使うと、Channelオブジェクトを取り除くこともできます。

EventLogChannel

　Windowsのイベントログサービスに出力するChannelクラスです。イベントログに出力するには、メッセージ用のDLLを用意したり、前もってレジストリに値を書き込んだりの手続きが必要で、けっこう面倒です。当然、そういう面倒な処理は、このクラスに隠蔽されていますので、深く考えなくても出力することができます。

SplitterChannelのサンプルコード

Poco::EventLogChannel* pEvChannel = new Poco::EventLogChannel();
Poco::Logger& EventLogger = Poco::Logger::create( "EventLogger",
                                pEvChannel, Poco::Message::PRIO_INFORMATION );

std::string    utf8str;

//UTF8コードに変換
Poco::UnicodeConverter::toUTF8( L"エラーが発生しました", utf8str );
EventLogger.error( utf8str );

コンストラクタ

　何も引数を指定しない場合は、イベントログの「ソース」には実行ファイル名が、「コンピュータ」にはホスト名が設定されます。次のように、「ソース」と「コンピュータ」を指定することもできます。

コンストラクタ例

Poco::EventLogChannel( "ソース名" );
Poco::EventLogChannel( "ソース名", "コンピュータ名" );

イベントビューア画面

優先度マッピング

　イベントログでは、メッセージの優先レベルが3種類（エラー、警告、情報）しかありませんので、クラス内部で次のように変換しています。

メッセージ優先度マッピング

POCOでの優先度	イベントログの種類
PRIO_TRACE、PRIO_DEBUG、PRIO_INFORMATION	情報
PRIO_NOTICE、PRIO_WARNING	警告
その他	エラー

日本語メッセージ出力

　POCOは、Windows環境でのUnicodeに対応しています。デフォルトで、「POCO_WIN32_UTF8」というシンボルがdefine定義されており、Unicode対応版のコードがコンパイルされます。「POCO_WIN32_UTF8」が定義されていると、文字列はUTF-8コードで書かれているものと見なして、Unicode版のWin32APIを呼び出す際に、POCOライブラリ内でUTF-16にコード変換しています。

　イベントログに日本語文字を出力するには、Unicodeに変換する必要がありますので、前準備としてUTF-8に変換しておきます。

　なお、実は、EventLogChannelクラスにはバグがあり、レジストリが正しく更新されません。

　「EventLogChannel.cpp」ファイルのsetUpRegistry関数を、次のように修正してください。レジストリに書き込む長さを、２倍（正確にはsizeof(wchar_t)倍）にします。

EventLogChannel.cppのオリジナル

RegSetValueExW(hKey, L"CategoryMessageFile",
    0, REG_SZ, (const BYTE*)path.c_str(), (DWORD)path.size() + 1);
RegSetValueExW(hKey, L"EventMessageFile",
    0, REG_SZ, (const BYTE*)path.c_str(), (DWORD)path.size() + 1);

EventLogChannel.cppの修正ソース

RegSetValueExW(hKey, L"CategoryMessageFile",
    0, REG_SZ, (const BYTE*)path.c_str(), (DWORD)path.size()*sizeof(wchar_t) + 1);
RegSetValueExW(hKey, L"EventMessageFile",
    0, REG_SZ, (const BYTE*)path.c_str(), (DWORD)path.size()*sizeof(wchar_t) + 1);

　オリジナルのソースでは、レジストリに半分の長さの文字列しか登録されません。ここはpathの文字長ではなく、バイト長を設定しないとダメです。

NullChannel

　何もしないChannelクラスです。Loggerオブジェクトに設定するChannelオブジェクトをNullChannelに変更することで、一時的にログの出力を止めることができます。

最後に

　紹介した以外のChannelクラスも実践的なものが多く、すぐに使えるものばかりだと思います。ログ出力と言うと、普通はアプリケーションのメイン処理ではないでしょうから、なるべく手間はかけたくないですよね。今回のLoggingフレームワークを、さくっと使ってみてはいかがでしょうか。

　POCO::Foundationライブラリのパッケージは、なかなかの粒ぞろいです。今回はフレームワークとして、ある意味完成したパッケージの解説でしたが、次回は他の少し低レイヤーなパッケージも紹介したいと思います。

参考資料

• POCO C++ Libraries Reference
• 『詳説C++ 第2版』 大城正典 著、ソフトバンククリエイティブ、2005年5月