Traceを使用してログを出力するときの設定例(Filter)

ログに要求される機能の1つとして、レベルによるフィルタリングがあります。
Traceを使用したログ出力にも、同様の機能があります。
具体的には、<filter>タグを使用します。

設定例

<configuration>
  <system.diagnostics>
    <trace autoflush="true">
      <listeners>
        <clear />

        <add name="file"
             type="System.Diagnostics.TextWriterTraceListener"
             initializeData="TEXT-WRITER.log">
            <!-- Warning以上を出力 -->
            <filter type="System.Diagnostics.EventTypeFilter"
                    initializeData="Warning" />
        </add>

      </listeners>
    </trace>
  </system.diagnostics>

</configuration>

出力例

TraceTest Warning: 0 : TraceWarning
TraceTest Error: 0 : TraceError

Informationレベルのログが出力されなくなりました。

参考
<filter> Element for <add> for <listeners> for <trace>

関連記事
Traceを使用してログを出力するときの設定例(TraceListener)
Traceを使用してログを出力するときの設定例(TraceOutputOptions)

Traceを使用してログを出力するときの設定例(TraceOutputOptions)

Traceを使用してログを出力するときの設定例(TraceListener)でTraceListenerの設定方法を書きました。
しかし、あれだけでは最低限のメッセージしか表示されません。
この記事では、日時などを表示する方法について書きます。

メッセージ以外を表示するには、<listeners>の<add>のtraceOutputOptions属性を使用します。

例

<configuration>

  <system.diagnostics>
    <trace autoflush="true">
      <listeners>
        <clear />

        <!-- テキストファイル -->
        <add name="file"
             type="System.Diagnostics.TextWriterTraceListener"
             initializeData="TEXT-WRITER.log"
             traceOutputOptions="Callstack, DateTime, LogicalOperationStack, ProcessId, ThreadId, Timestamp" />

      </listeners>
    </trace>
  </system.diagnostics>

</configuration>

この属性を設定した時の出力例は、以下のようになります。

TraceTest.exe Information: 0 : TraceInformation
    ProcessId=5700
    LogicalOperationStack=
    ThreadId=1
    DateTime=2014-02-02T12:47:28.3398027Z
    Timestamp=6032477769
    Callstack=   場所 System.Environment.GetStackTrace(Exception e, Boolean needFileInfo)
   場所 System.Environment.get_StackTrace()
   場所 System.Diagnostics.TraceEventCache.get_Callstack()
   場所 System.Diagnostics.TraceListener.WriteFooter(TraceEventCache eventCache)
   場所 System.Diagnostics.TraceListener.TraceEvent(TraceEventCache eventCache, String source, TraceEventType eventType, Int32 id, String message)
   場所 System.Diagnostics.TraceInternal.TraceEvent(TraceEventType eventType, Int32 id, String format, Object[] args)
   場所 TraceTest.TraceTest.Main(String[] args)

属性の詳しい説明については、TraceOutputOptions Valuesを参照してください。

Lispでxmlの実体参照変換

当ブログでは、プログラムをハイライト表示するときにSyntaxHighlighterを使用しています。
XMLを表示するときは、実体参照へ変換しなければいけません。
「普段使用しているエディタから変換できれば楽ちんだよね」と思い、xyzzy Lispで変換プログラムを書いてみました。

プログラム

; convert-xml
(defparameter *conversion-alist*
  '((#\< . "&lt;")
    (#\> . "&gt;")
    (#\& . "&amp;")
    (#\" . "&quot;")
    (#\' . "&apos;")))

(defun convert-xml ()
  (interactive "*")
  (let ((input-buffer (window-buffer (selected-window))))
    (with-output-to-temp-buffer ("*Converted*")
      (with-open-stream (s (make-buffer-stream input-buffer))
        (loop 
          (let ((c (read-char s nil)))
            (if c (format t "~A" (convert-char c *conversion-alist*))
              (return nil))))))))

(defun convert-char (c alist)
  (let ((conversion (assoc c alist)))
    (if conversion (cdr conversion)
      c)))

実行すると現在のバッファを読み込み、一時バッファへ変換後のxmlを表示します。
工夫したところは、変換の定義をalistにしたところです。

参考

• SyntaxHighlighter
• 文字実体参照（実体参照）

Traceを使用してログを出力するときの設定例(TraceListener)

.Netでログを出力するときの選択肢の1つとして、System.Diagnostics.Traceクラスを使用する方法があります。
この時のアプリケーション構成ファイルの記述例を記載します。
テストプログラムとして、次のプログラムを使用します。

namespace TraceTest 
{
  using System.Diagnostics;
  
  public class TraceTest {
    
    public static void Main(string[] args) {
      Trace.TraceInformation("TraceInformation");
      Trace.TraceWarning("TraceWarning");
      Trace.TraceError("TraceError");
    }
  }
}

次にTraceListenerの設定例を記載します。

<configuration>

  <system.diagnostics>
    <trace autoflush="true">
      <listeners>
        <clear />

        <!-- 標準出力 -->
        <add name="console"
             type="System.Diagnostics.ConsoleTraceListener" />

        <!-- 区切りリスト -->
        <add name="delimited-list"
             type="System.Diagnostics.DelimitedListTraceListener"
             initializeData="DELIMITED-LIST.log" />

        <!-- イベントログ -->
        <add name="eventlog"
             type="System.Diagnostics.EventLogTraceListener"
             initializeData="Application" />

        <!-- テキストファイル -->
        <add name="file"
             type="System.Diagnostics.TextWriterTraceListener"
             initializeData="TEXT-WRITER.log" />

        <!-- XML形式 -->
        <add name="xml-writer"
             type="System.Diagnostics.XmlWriterTraceListener"
             initializeData="XML-WRITER.log" />

      </listeners>
    </trace>
  </system.diagnostics>

</configuration>

参考
<trace> の <listeners> の <add> 要素

FormでShowing/Hidingイベントを実装

System.Windows.Forms.Formにありそうでないイベントの一つに、表示前/非表示前イベントがあります。
なければ作っちゃえということで、SetVisibleCoreをオーバーライドして実装してみました。
処理の流れは以下のようになります。

1. 引数と現在のVisibleを比較し、等しければイベントを発生させずにSetVisibleCoreを呼んで終了する。
2. 引数がtrueのとき、Showingイベントを発生させる
3. 引数がfalseのとき、Hidingイベントを発生させる
4. 2,3の結果、CancelEventArgs.Cancelがtrueのとき、引数を逆にしてSetVisibleCoreを呼び、終了する。
5. SetVisibleCoreを呼び、終了する。

なお、注意点として、SetVisibleCoreでShow/Hideメソッドを呼ばないこと、Visibleプロパティを更新しないことがあります。これらに違反すると、StackOverflowExceptionが発生してしまいます。

サンプル

	using System;
	using System.ComponentModel;
	using System.Windows.Forms;
	namespace Sample {
	public class ShowingHidingForm : Form {
	private event FormShowingEventHandler formShowing;
	private event FormHidingEventHandler formHiding;
	public event FormShowingEventHandler FormShowing {
	add { formShowing += value; }
	remove { formShowing -= value; }
	}
	public event FormHidingEventHandler FormHiding {
	add { formHiding += value; }
	remove { formHiding -= value; }
	}
	public ShowingHidingForm() {
	formShowing += (sender, e) => {};
	formHiding += (sender, e) => {};
	}
	protected override void SetVisibleCore (bool value) {
	var current = Visible;
	var toBe = value;
	if (current == toBe) {
	base.SetVisibleCore(toBe);
	return;
	}
	if (toBe && !current) {
	var e = new FormShowingEventArgs();
	formShowing(this, e);
	if (e.Cancel) {
	toBe = current;
	}
	}
	if (!toBe && current) {
	var e = new FormHidingEventArgs();
	formHiding(this, e);
	if (e.Cancel) {
	toBe = current;
	}
	}
	base.SetVisibleCore(toBe);
	}
	public static void Main(string[] args) {
	var form = new ShowingHidingForm();
	form.FormShowing += (sender, e) => {
	Console.WriteLine("Showing");
	};
	form.FormHiding += (sender, e) => {
	Console.WriteLine("Hiding");
	};
	form.FormClosing += (sender, e) => {
	form.Hide();
	Console.WriteLine("Closing");
	};
	Application.Run(form);
	}
	}
	public delegate void FormShowingEventHandler(object sender, FormShowingEventArgs e);
	public delegate void FormHidingEventHandler(object sender, FormHidingEventArgs e);
	public class FormShowingEventArgs : CancelEventArgs { }
	public class FormHidingEventArgs : CancelEventArgs { }
	}

view raw ShowingHidingForm.cs hosted with ❤ by GitHub

参考

Form.SetVisibleCore メソッド

CからC#を呼ぶ面倒な方法の1つ

今回は、CからC#で作ったDLLを呼ぶ方法について書きます。タイトルにも書きましたが、かなり面倒なやり方なので、みなさんは頑張って回避してください。

さて、手順は次のようになります。

1. C#でDLLを作成する
2. 上で作成したDLLをレジストリへ登録する
3. Cでプログラムを作成する

C#でDLLを作成する
Cから呼び出されるライブラリをC#で作成します。

DLLをレジストリへ登録する
警告が出ますが気にしない。だってサンプルですもの。

Cでプログラムを作成する
さあ、ここからが本番です。先ほど登録したDLLからクラス名とメソッド名を指定してオブジェクトに働いてもらいましょう。大まかなイメージはJavaやC#のリフレクションに近いです。

1. 初期化
2. クラス名からCLSIDを取得
3. インスタンス作成
4. IDispatchへキャスト
5. メソッド名からDISPIDを取得
6. パラメータの設定
7. メソッドの呼び出し
8. 終了処理

ここで注意が必要なのが、パラメータの設定です。適切なVariantTypeと適切なプロパティを選ばなくてはいけないところ、さらに、パラメータの順番が逆転するところに注意してください。

	// cl callCOM.c ole32.lib oleaut32.lib
	#include <Objbase.h>
	int main() {
	HRESULT hr;
	CLSID clsid;
	DISPID dispid;
	VARIANTARG rgvArg[2];
	int result = 0;
	DISPPARAMS dispParams = {NULL, NULL, 0, 0};
	VARIANT varResult;
	EXCEPINFO excepInfo;
	UINT uArgErr;
	OLECHAR *lpszProgID = L"NamespaceSample.ClassSample";
	OLECHAR *rgszNames = {L"MethodSample"};
	IUnknown *pUnknown = NULL;
	IDispatch *pDispatch = NULL;
	// 1. 初期化
	hr = CoInitialize(NULL);
	if (FAILED(hr)) {
	return -10;
	}
	// 2. クラス名からCLSIDを取得
	hr = CLSIDFromProgID(lpszProgID, &clsid);
	if (FAILED(hr)) {
	CoUninitialize();
	return -20;
	}
	// 3. インスタンス作成
	hr = CoCreateInstance(&clsid, NULL, CLSCTX_INPROC_SERVER, &IID_IUnknown, (void **)&pUnknown);
	if (FAILED(hr)) {
	CoUninitialize();
	return -30;
	}
	// 4. IDispatchへキャスト
	hr = pUnknown->lpVtbl->QueryInterface(pUnknown, &IID_IDispatch, (void **)&pDispatch);
	if (FAILED(hr)) {
	pUnknown->lpVtbl->Release(pUnknown);
	CoUninitialize();
	return -40;
	}
	// 5. メソッド名からDISPIDを取得
	hr = pDispatch->lpVtbl->GetIDsOfNames(pDispatch, &IID_NULL, &rgszNames, 1, LOCALE_SYSTEM_DEFAULT, &dispid);
	if (FAILED(hr)) {
	pUnknown->lpVtbl->Release(pUnknown);
	CoUninitialize();
	return -50;
	}
	// 6. パラメータの設定
	VariantInit(&rgvArg[0]);
	rgvArg[0].vt = VT_I4;
	rgvArg[0].lVal = 99;
	VariantInit(&rgvArg[1]);
	rgvArg[1].vt = VT_BSTR;
	rgvArg[1].bstrVal = SysAllocString(L"HOGE");
	dispParams.rgvarg = rgvArg;
	dispParams.cArgs = 2;
	VariantInit(&varResult);
	// 7. メソッドの呼び出し
	hr = pDispatch->lpVtbl->Invoke(pDispatch, dispid, &IID_NULL, LOCALE_SYSTEM_DEFAULT, DISPATCH_METHOD, &dispParams, &varResult, &excepInfo, &uArgErr);
	if (FAILED(hr)) {
	pUnknown->lpVtbl->Release(pUnknown);
	CoUninitialize();
	return -60;
	}
	// 8. 終了処理
	printf("%S\n", varResult.bstrVal);
	pUnknown->lpVtbl->Release(pUnknown);
	CoUninitialize();
	return 0;
	}

view raw callCOM.c hosted with ❤ by GitHub

	// csc /target:library ClassSample.cs
	// regasm /codebase ClassSample.dll
	// regasm /u ClassSample.dll
	namespace NamespaceSample {
	using System.Runtime.InteropServices;
	// ComVisibleAttributeをCOM経由で呼び出したいクラスへ設定する
	[ComVisible(true)]
	public class ClassSample {
	public string MethodSample(string arg1, int arg2) {
	return string.Format("arg1={0} arg2={1}", arg1, arg2);
	}
	}
	}

view raw ClassSample.cs hosted with ❤ by GitHub

お疲れ様でした。

WicketでWebSocketを使ってみた

Wicketの6からWebSocketに対応したらしいので使ってみた。

• 作ったもの
• 感想
• 引っかかったところ

作ったもの
簡単にいうと、チャットアプリケーション。
メッセージをAjaxで受け取り、チャット参加者へWebSocketでpush通知する。
クライアント側はjQueryで受け取ったメッセージをDOMへ追加する。

引っかかったところ
IWebSocketConnectionにはComponentをaddできない。送信できるのは文字列またはbyte配列。WebSocketRequestHandlerにはaddできるので、WebSocketBehaviorのonMessageで実装すればよいが、それってAjaxとなにが違うのかな？

web.xmlで、サーブレットコンテナに対応したfilterを設定しなければならない。wikiのCustom WicketFilterを参照。

JavaScriptの依存関係を設定しなければいけない。サンプルを参照。

感想
IWebSocketConnectionで送受信できるデータが文字列かバイト配列なので、実際はJSONを送受信することになると思われる。Javaオブジェクトとの相互変換を考慮する必要があると思う。

push通知が動作するまでは、手間がかかる割に動作はAjaxと変わらないのでモチベーションが上がらなかった。が、push通知で画面が更新されるようになると一気に楽しくなった。

やや話はそれるが、JavaScriptのライブラリがｊQueryになったのも大きいと思う。