サービスプログラムの作り方について・その２｜VB.NET-TIPS などプログラミングについて

2018/10/26

前回「その１」ではサービスの処理として何もしなかったのですが、今回は少しだけ処理を追加していきます。
タイマコントロールを追加し、タイマイベント処理の中で、Windowsのイベントログに時刻の出力を行います。

TestService.vb[デザイン] のフォームを開き、タイマコントロールを設置するのですが、 「ツールボックス」にはタイマコントロールが現れていないと思いますので、 「ツールボックス」のウインドウの上でマウス右クリックして「アイテムの選択」を実行します。さらに「.NET Framework コンポーネント」の名前が Timer で、名前空間が System.Timers をチェックし「OK」を押下します。
System.Timers.Timer を TestService.vb[デザイン] へドラッグ＆ドロップし、タイマコントロールを設置します。 Timer1 のプロパティで以下の設定にします。

Enabled：False
Interval：10000　（10秒毎のタイマイベントの発生）

尚、ServiceBase の TestService のプロパティ「AutoLog」が「True」になっているのを確認して下さい。デフォルトで「True」なのですが、Microsoftのサイトによりますと、以下の様に書かれています。

既定では、すべての Windows サービスプロジェクトはアプリケーションイベントログとやり取りして、そこに情報および例外を書き込むことができます。
アプリケーションにこの機能が必要かどうかを指定するには、 AutoLog プロパティを使用します。
既定では、Windows サービスプロジェクトテンプレートで作成したサービスには、ログが有効にされます。
EventLog クラスの静的フォームを使用すると、 EventLog コンポーネントのインスタンスを作成したり、手動でソースを登録したりすることなく、ログにサービス情報を書き込むことができます。

では今回のソースとしては以下の様になります。
OnStart ではイベントログに開始メッセージを登録し、タイマの開始を指示します。
OnStop ではイベントログに停止メッセージを登録し、タイマの停止を指示します。
タイマイベントの Timer1_Elapsed では現在時刻をイベントログに登録します。

Public Class TestService
 
    Protected Overrides Sub OnStart(ByVal args() As String)
        ' サービスを開始するコードをここに追加します。このメソッドによって、
        ' サービスが正しく実行されるようになります
 
        Me.EventLog.WriteEntry("サービスを開始します。")
        ' タイマの開始
        Me.Timer1.Enabled = True
        Me.EventLog.WriteEntry("サービスを開始しました。")
    End Sub
 
    Protected Overrides Sub OnStop()
        ' サービスを停止するのに必要な終了処理を実行するコードをここに追加します。
        Me.EventLog.WriteEntry("サービスを停止します。")
        ' タイマの停止
        Me.Timer1.Enabled = False
        Me.EventLog.WriteEntry("サービスを停止しました。")
    End Sub
 
    ' タイマイベント処理
    Private Sub Timer1_Elapsed(sender As Object, e As Timers.ElapsedEventArgs) Handles Timer1.Elapsed
        Try
            'この段階では特に行う処理が無いのでイベントログへの出力を行う
            Me.EventLog.WriteEntry("タイマイベント:" & Now.ToString("yyyy/MM/dd HH:mm:ss"))
        Catch ex As Exception
        End Try
    End Sub
 
End Class

特にどうといった処理ではないので簡単な処理です。
このサービスプログラムですが、何かイベントが起こるのをこのプログラムの裏？で待っているわけで、今回はタイマコントロールによるイベントを受け付ける様になっています。

「コントロールパネル」⇒「管理ツール」⇒「イベントビューアー」で起動し、実際にイベントログが登録されているかを見てみます。

イベントログに「タイマイベント:YYYY/MM/DD HH:mm:ss」が正しく登録されている様です。

尚、「AutoLog」が「True」の場合には、 OnStart OnStop などではシステムがイベントログにそれぞれのメッセージを登録するため、本当は上記の「サービスを開始しました。」「サービスを停止しました。」の登録は必要ありません。

ところで、OnStart OnStop の処理は長時間実行可能なわけでは無く、すぐに終わらせる必要があります。その為、OnStart の中ではタイマコントロールをEnable にして、すぐに処理を終わっています。

実際のところタイマコントロールでは面白くないので、別スレッドを起動して、スレッド側でメイン処理として行う方がいいと思います。次の記事ではメイン処理をスレッドにしたもので行います。