サイゼントの技術ブログ – Just another WordPress site

2020年7月4日

C#：Mutexでの排他制御

排他制御の方法の一つとして、C#にはMutexと呼ばれる機能が用意されています。
何れか一つのスレッドがMutexによるロックを取得することができます。
他のスレッドによりロックが取得されている場合の処理を別途記述すれば、この機能を使用して排他制御が可能となります。

以下、サンプルコードです。

【サンプルコード】

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace MutexTest
{
    class Program
    {
        static void Main(string［］ args)
        {
            using (Mutex mutex = new Mutex(false)) // 使い終わったらスレッド解放
            {
                const int N = 3;
                // id0…0.7秒目～1.7秒目に掴む
                // id1…1.4秒目から待機、1.7～2.7秒目に掴む
                // id2…2.1秒目から待機、2.6秒目に諦める
                Parallel.For(0, N, id =＞ // id0～2のスレッドを生成
                {
                    Thread.Sleep(id * 700);
                    // ロック取得、成功ならtrue
                    // 第一引数は待ち時間
                    if (mutex.WaitOne(500, false))
                    {
                        try
                        {
                            Console.WriteLine("ID" + id + "が掴みました。");
                            Thread.Sleep(1000);
                        }
                        finally
                        {
                            // Mutex資源解放
                            // 忘れてCloseすると待機待ち側でAbandonedMutexException
                            // Disposeでは実行されないためusingに頼るのは不可
                            mutex.ReleaseMutex();
                            Console.WriteLine("ID" + id + "が解放しました。");
                        }
                    }
                    else
                    {
                        Console.WriteLine("ID" + id + "は掴めませんでした。");
                    }
                });
            }
            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading;

using System.Threading.Tasks;

namespace MutexTest

{

class Program

{

static void Main(string［］ args)

{

using (Mutex mutex = new Mutex(false)) // 使い終わったらスレッド解放

{

const int N = 3;

// id0…0.7秒目～1.7秒目に掴む

// id1…1.4秒目から待機、1.7～2.7秒目に掴む

// id2…2.1秒目から待機、2.6秒目に諦める

Parallel.For(0, N, id =＞ // id0～2のスレッドを生成

{

Thread.Sleep(id * 700);

// ロック取得、成功ならtrue

// 第一引数は待ち時間

if (mutex.WaitOne(500, false))

{

try

{

Console.WriteLine("ID" + id + "が掴みました。");

Thread.Sleep(1000);

}

finally

{

// Mutex資源解放

// 忘れてCloseすると待機待ち側でAbandonedMutexException

// Disposeでは実行されないためusingに頼るのは不可

mutex.ReleaseMutex();

Console.WriteLine("ID" + id + "が解放しました。");

}

else

{

Console.WriteLine("ID" + id + "は掴めませんでした。");

}

});

}

Console.ReadKey();

}

【実行結果】

ID0が掴みました。
ID0が解放しました。
ID1が掴みました。
ID2は掴めませんでした。
ID1が解放しました。

ID0が掴みました。

ID0が解放しました。

ID1が掴みました。

ID2は掴めませんでした。

ID1が解放しました。

また、Mutexには、名前を付けることができます。
名前を付けることで、プロセス間でも排他制御が可能となります。
ただし、意図せずMutex名が被ると意図しないロックがかかってしまうため、扱いには注意が必要です。

【サンプルコード】

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;

namespace MutexTest2
{
    class Program
    {
        static void Main(string［］ args)
        {
            // 名前付きMutexだとプロセス間で共有できる
            //using (Mutex mutex = new Mutex(false))
            using (Mutex mutex = new Mutex(false,"hoge"))
            {
                // プロセス名取得（表示用）
                System.Diagnostics.Process p
                    = System.Diagnostics.Process.GetCurrentProcess();

                Console.WriteLine(DateTime.Now);
                Console.WriteLine(p.Id + "が掴もうとしています。");
                if (mutex.WaitOne(5000, false))
                {
                    try
                    {
                        Console.WriteLine(DateTime.Now);
                        Console.WriteLine(p.Id + "が掴みました。");
                        Thread.Sleep(10000);
                    }
                    finally
                    {
                        mutex.ReleaseMutex();
                        Console.WriteLine(DateTime.Now);
                        Console.WriteLine(p.Id + "が解放しました。");
                    }
                }
                else
                {
                    Console.WriteLine(DateTime.Now);
                    Console.WriteLine(p.Id + "は掴めませんでした。");
                }
            }
            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading;

using System.Threading.Tasks;

namespace MutexTest2

{

class Program

{

static void Main(string［］ args)

{

// 名前付きMutexだとプロセス間で共有できる

//using (Mutex mutex = new Mutex(false))

using (Mutex mutex = new Mutex(false,"hoge"))

{

// プロセス名取得（表示用）

System.Diagnostics.Process p

= System.Diagnostics.Process.GetCurrentProcess();

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が掴もうとしています。");

if (mutex.WaitOne(5000, false))

{

try

{

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が掴みました。");

Thread.Sleep(10000);

}

finally

{

mutex.ReleaseMutex();

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "が解放しました。");

}

else

{

Console.WriteLine(DateTime.Now);

Console.WriteLine(p.Id + "は掴めませんでした。");

}

Console.ReadKey();

}

【実行結果】

※exeファイルを３回起動した結果。
　１つ目のプロセス…掴んで解放
　２つ目のプロセス…解放を待って掴んで解放
　３つ目のプロセス…解放を待って掴めず諦める

2020/04/18 7:01:44
10420が掴もうとしています。
2020/04/18 7:01:44
10420が掴みました。
2020/04/18 7:01:54
10420が解放しました。

2020/04/18 7:01:50
2416が掴もうとしています。
2020/04/18 7:01:54
2416が掴みました。
2020/04/18 7:02:04
2416が解放しました。

2020/04/18 7:01:56
7524が掴もうとしています。
2020/04/18 7:02:01
7524は掴めませんでした。

2020/04/18 7:01:44

10420が掴もうとしています。

2020/04/18 7:01:44

10420が掴みました。

2020/04/18 7:01:54

10420が解放しました。

2020/04/18 7:01:50

2416が掴もうとしています。

2020/04/18 7:01:54

2416が掴みました。

2020/04/18 7:02:04

2416が解放しました。

2020/04/18 7:01:56

7524が掴もうとしています。

2020/04/18 7:02:01

7524は掴めませんでした。

いかがでしたでしょうか？

C#には排他制御のための機能が色々と用意されています。
その内の一つが今回紹介したMutexであり、名前を付けることでプロセス間の排他制御も可能になります。
名前付きMutexは、プロセスをまたいだスレッドの制御だけでなく、同じ画面が複数立ち上がらないようにする、といった使われ方もします。
仕組みが単純なので使用しやすく、排他制御の機能の中では使用頻度は高いと思います。

排他制御の機能は他にも色々と用意されているので、今後も紹介していきたいと思います！

2020年6月27日

Windowsバッチが正常に動作しない場合に見直すポイント（文字コード、改行コード）

Windowsのバッチファイルは、特定の文字コードや改行コードを使用しないと正常に動作しません。
具体的には、以下の文字コードや改行コードを用いる必要があります。

・文字コードは「SJIS」を使用する（chcpコマンドで文字コードを変更しない場合）

・改行コードは「CRLF」を使用する

既存のファイルをコピーしてそれをベースにバッチファイルを作成するような時に、文字コードを誤ってしまうことが多いです。
また、FTP（FFFTP）やGitを用いてサーバ間でファイルのやりとりをする時に、意図せずに改行コードが変わってしまうことも多いです。
既存のファイルをコピーしたり、サーバからバッチファイルを落としてきたりする場合には注意する必要があります。

以下では、文字コードや改行コードを誤るとどのように挙動が変わるのかを見ていきます。
文字コードを誤ると、２バイト文字（日本語等）の部分が文字化けします。フォルダ名やファイル名に２バイト文字が含まれていたり、データに２バイト文字が含まれていたりするような場合は、正常に動作しなくなります。
また、改行コードを誤ると、改行が無視されてコマンドが実行されます。通常のバッチファイルでは改行でコマンドを区切るため、コマンドを上手く区切られなくなり、正常に動作しなくなります。

【サンプル】

@echo off
echo こんにちは世界！
pause

@echo off

echo こんにちは世界！

pause

【文字コード・改行コードが正しい場合の動作】

こんにちは世界！
続行するには何かキーを押してください . . .

1 2	こんにちは世界！続行するには何かキーを押してください . . .

【文字コードが「UTF-8」の場合の動作】

縺薙ｓ縺ｫ縺｡縺ｯ荳也阜・・
続行するには何かキーを押してください . . .

1 2	縺薙ｓ縺ｫ縺｡縺ｯ荳也阜・・続行するには何かキーを押してください . . .

【改行コードが「LF」の場合の動作】

'ﾉちは世界！' は、内部コマンドまたは外部コマンド、
操作可能なプログラムまたはバッチ ファイルとして認識されていません。
続行するには何かキーを押してください . . .

'ﾉちは世界！' は、内部コマンドまたは外部コマンド、

操作可能なプログラムまたはバッチファイルとして認識されていません。

続行するには何かキーを押してください . . .

いかがでしたでしょうか？

今回は、Windowsバッチが正常に動作しない理由として、ありがちな２つの理由を紹介しました。
（現在私が担当している案件でも、Gitの設定の問題でサーバから落としてきたバッチファイルが動かなくなるという問題に出くわしていました。本当によくあることです。）

今回紹介したように、文字コードや改行コードを誤るとHello Wolrdすら正常に動作しなくなるので、簡単なスクリプトすら動作しなくなることをもって原因調査であたりをつけることができます。
正常に動作しない場合は、コメントアウトやexitコマンドを入れて簡単なコードに書き変えてみて原因を探ると良いでしょう。
（ちなみに、Windowsバッチに限らず、この手の誤りはスクリプト言語全般にありがちです）

原因調査に時間を取られる人が一人でも減れば幸いです！

2020年6月20日

初めてのWindowsバッチ

Windowsバッチを作ったことが無い方向けに、Windowsバッチの用途や使い方を書いた入門的な記事です。
詳しいコマンドの使い方は記載しませんので、必要に応じて調べてみて下さい。

【Windowsバッチとは】

WindowsOSに標準で用意されている実行ファイル形式であり、拡張子は.batである。
エクスプローラ上でダブルクリックすることで、記述されたDOSコマンド（スクリプト）を自動実行することができる。
簡単な制御や実行ファイル呼び出しを記述可能で、要件に合わせて一連の処理を取りまとめたい時に使用される。

【WindowsバッチでHello World（Windowsバッチの導入）】

WindowsOSであることが前提です。

１．エクスプローラを開き、表示 > ファイル名拡張子のチェックを入れる。

２．任意の名前でテキストドキュメントを新規作成した後、ファイルの名前を変更する。拡張子を「.txt」から「.bat」に変更する。

３．２で作成したファイルを右クリック > 編集で選択し、下記のように入力して保存する。

@echo off
echo Hello World!
pause

@echo off

echo Hello World!

pause

４．３で編集したファイルをダブルクリックする。コンソールが表示され、下記のように表示されればOK。

Hello World!
続行するには何かキーを押してください . . .

1 2	Hello World! 続行するには何かキーを押してください . . .

【Windowsバッチでできること】

Windowsバッチは複雑な処理を記述するには不向きですが、下記で挙げるような処理であれば記述可能です。
実行ファイルを部品として組み合わせる分には困ることは少なく、「WindowsOSであれば初期設定無しで動く」「習得が容易で、エンジニアであればメンテナンスできる人も多い」といった特徴から、気軽に導入することができます。

１．コンソールへの文字列表示（標準出力）

Hello Worldの例の通り、コンソールへの文字列表示が可能です。
“echo “の後に表示させたい文字列を記述することで、その文字列を表示することができます。
なお、Windowsバッチでは実行されるコマンドもコンソールに表示されるのですが、”@echo off”と記述すれば以降はコマンドのコンソール表示を抑止することができます。
また、Windowsバッチは全てのコマンドの実行が完了したら自動的にウインドウを閉じてしまうので、表示内容を確認したい場合は”pause”と記述して一時的に処理を中断（任意のキー押下で再開）する必要があります。

２．外部の実行ファイルの実行

実行ファイルのパスを記述することで、Windowsバッチから外部の実行ファイルを実行することができます。
実行ファイルのパスの後にスペース区切りで文字列を入力すれば、その文字列を引数として与えることもできます。

例えば、下記のように記述すれば、WindowsOS標準のプログラム言語「C#」のコンパイラを起動することができます。

C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe コンパイルしたいC#ソースファイルのパス

1	C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe コンパイルしたいC#ソースファイルのパス

C#のコンパイル済み実行ファイル(.exe)やjavaのコンパイル済み実行ファイル(.jar)があるなら、そのファイルのパスを記述することでその実行ファイルを実行することができます。
下記は、C#の実行ファイル C:\tmp\Program.exe を実行する例です。

C:\tmp\Program.exe

1	C:\tmp\Program.exe

また、Windowsバッチよりも強力な機能を持ったWindowsOS標準のスクリプト言語「Windows Power Shell」は、OSの設定によってはダブルクリックで実行できないという難点があるのですが、下記のように記述することで設定問わずダブルクリックで実行できるようになります。
（Windows Power Shell は環境変数でパスが通っているので、実行ファイルのパスの指定は不要です）

powershell -ExecutionPolicy RemoteSigned -File 実行したいWindowsPowerShellファイルのパス

1	powershell -ExecutionPolicy RemoteSigned -File 実行したいWindowsPowerShellファイルのパス

ダブルクリックするだけで引数付きで実行ファイルを実行したり、複数の実行ファイルを実行したり、Windows Power Shell のスクリプトを実行したりできるので、単純に外部の実行ファイルの実行したい時にもWindowsバッチのファイルを作る価値があります。
難しい処理はC#やWindows Power Shell等で記述し、実行はバッチファイルから行う、というスタイルがWindowsOSの場合は馴染みやすいと思います。

３．現在のパス（カレントディレクトリ）の変更

Windowsバッチでは、実行直後はWindowsバッチのファイルが存在するパスを指しています。
例えば、C:\tmp\hoge.bat を実行した場合、実行直後のパスは C:\tmp\ となります。
ファイルのパス指定は現在のパスを起点に相対パスで指定することができ、例えば C:\tmp\ にいる場合は、C:\tmp\Program.exe を

.\Program.exe

1	.\Program.exe

と指定して実行することが可能です。
（.\は省略することも可能です）

現在のパス（カレントディレクトリ）を変更したい場合は、cdコマンドで変更することができます。
cdコマンドのパス指定は絶対パスでも相対パスでも可能で、例えば C:\tmp\ から C:\hoge\ に移動したい場合は、

cd ..\hoge\

1	cd ..\hoge\

で移動できます。

他の環境でもWindowsバッチを動かしたい場合は、相対パスが便利です。

４．フォルダの作成

Windowsバッチでは、mkdirコマンドでフォルダを作成することができます。フォルダ名には絶対パス・フルパス両方指定可能です。

mkdir フォルダ名

1	mkdir フォルダ名

なお、フォルダを削除することもでき、コマンドはrmdirコマンドです。

５．ファイルの作成

Windowsバッチでは標準出力の内容をファイルに出力することが可能です。
（出力先は絶対パス・フルパス両方指定可能です）

例えば、以下のように記述することで、Hello World! と書かれたテキストが C:\tmp\hoge.txt に出力されます。
（表示の都合上、大なり記号は全角で入力しています。コピペする際はご注意下さい。）

echo Hello World!＞C:\tmp\hoge.txt

1	echo Hello World!＞C:\tmp\hoge.txt

“>”の部分はリダイレクトと呼ばれており、”>”と記述すれば上書きで出力、”>>”と記述すれば改行して追記で出力となります。

なお、空ファイルを出力するには、下記のように記述すれば良いです（空の文字を入力する、という意味です）。

type nul ＞C:\tmp\hoge.txt

1	type nul ＞C:\tmp\hoge.txt

６．変数の利用

Windowsバッチでは変数を利用することが可能です。

以下は、変数を利用してHello World!を出力する例です。SETで変数を定義、%%で囲むことで変数の参照（正確には展開）が可能です。

@echo off
SET NAME=World
echo Hello %NAME%!
pause

@echo off

SET NAME=World

echo Hello %NAME%!

pause

例えば、実行したWindowsバッチのフルパスの取得や、システム時刻の取得で変数を使う場合が多いです。
実行したWindowsバッチのフルパスの取得は

SET hoge=%~dp0

1	SET hoge=%~dp0

システム時刻（YYYYMMDDHHMMSS）の取得は

SET time0=%time: =0%
SET hoge=%date:~0,4%%date:~5,2%%date:~8,2%%time0:~0,2%%time0:~3,2%%time0:~6,2%

1 2	SET time0=%time: =0% SET hoge=%date:~0,4%%date:~5,2%%date:~8,2%%time0:~0,2%%time0:~3,2%%time0:~6,2%

で可能です。

７．IF文の制御

WindowsバッチではIF文で簡単な制御を行うことができます。

例えば、ファイル・フォルダの存在確認は下記のような記述で実現可能です。

IF EXIST hoge (
  echo OK
) ELSE (
  echo NG
)

IF EXIST hoge (

echo OK

) ELSE (

echo NG

)

ここで、hoge を hoge\ とすることで、フォルダのみの存在確認が可能になります。
hoge という名前のファイルが存在していても偽とすることができます。
また、”IF”の直後に”NOT”を繋げることで、真偽判定を逆にすることができます。

文字列比較も可能で、下記のように記述します。

IF %HENSU%==hoge (
  echo OK
) ELSE (
  echo NG
)

IF %HENSU%==hoge (

echo OK

) ELSE (

echo NG

)

数値の比較も可能ですが、比較演算子として”==”の代わりに”equ”(等しい)、”neq”(等しくない)、”lss”(左辺が右辺より小さい)、”leq”(左辺が右辺以下)、”gtr”(左辺が右辺より大きい)、”geq”(左辺が右辺以上)を使うことに注意が必要です。

８．その他の制御

forループやcall・gotoによるジャンプ、exitでのバッチ終了も可能です。
この記事では例を１つ挙げるだけに留めますが、下記はworkフォルダの中の各々のファイルを、順番に C:\tmp\Program.exe の引数として与えて実行する例です。
for文で順番に従って”%%a”にファイル名を格納、”%%a”を第一引数としてmethodルーチンへ飛ばし、methodルーチンでは受け取った引数を C:\tmp\Program.exe の引数として与えて実行、for文が終了したら（全てのファイルに対して処理が終了したら）exitでバッチファイルを終了、ということをしています。

cd work
for %%a in (*) do (call :method %%a)
exit
:method
C:\tmp\Program.exe %1
goto :eof

cd work

for %%a in (*) do (call :method %%a)

exit

:method

C:\tmp\Program.exe %1

goto :eof

いかがでしたでしょうか？

今回は、新人にWindowsバッチを教えるために、入門的な記事を執筆してみました。
Windowsバッチは文法的にはある意味独特の世界が広がっており、意外と奥が深いのですが、今回は入門者がすぐにWindowsバッチで簡単な制御が行えるようになることを念頭に、内容を絞りました。
ここに書かれていることを使えるようになるだけでも、開発作業の効率化は十分可能ですし、実行環境配布や運用作業に向けたバッチも簡単なものなら作れるようになると思います。

また、経験者でもWindowsバッチの文法を度忘れすることがあるので、そのような時にも見返すと便利なのではないかと思います。

これからも参考になる記事を執筆していきたいと思います！

2020年6月13日

C#：イベントハンドラとは

イベントハンドラとはC#で標準で用意されている文法であり、イベント送受信の処理を記述するために用意されています。

クラスAでボタンのクリック等のイベントを発行する
↓
クラスBはクラスAからイベントを受け取り業務処理を行う
↓
クラスBは業務処理終了時にクラスAに何かしらの処理を返す

という動きを実現するための文法です。

文法的にはdelegateの応用であり、
public delegate void EventHandler(object sender, EventArgs e);
というdelegateが標準で用意されていると考えて問題ありません。
（自分で上記の定義を行っても同じ動きをします）
なお、”object sender”とは業務処理を行ったオブジェクト、”EventArgs e”とはイベント発行側のクラスに返すデータ、を指します。

上記の通り、イベントハンドラとは、引数に object sender と EventArgs e を持つdelegateです。
そのため、delegateを理解していれば、イベントハンドラの文法も理解できます。
自分で使うかどうかは別として、Visual Studio で Windows Form を作成した時に自動生成されるソースコードや、他の人のソースコードを読む分には問題ないでしょう。

以下、サンプルコードです。

【サンプルコード】

・Program.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace EventHandlerTest
{
    class Program
    {
        // イベント発生（exe実行）
        static void Main(string［］ args)
        {
            EventReceiver eventReceiver = new EventReceiver();
            // イベントハンドラの登録
            eventReceiver.EventHandlerObj += new EventHandler(NoticeOfEnd);
            eventReceiver.Start();
            Console.ReadKey();
        }

        // イベント終了時に実行して欲しい処理
        static void NoticeOfEnd(object sender, EventArgs e)
        {
            // "object sender"は処理を行ったオブジェクト
            Console.WriteLine("処理実行オブジェクト：" + sender.ToString());

            // "EventArgs e"はイベント終了時に返されるデータ（今回は無し）
            if (e.Equals(EventArgs.Empty))
            {
                Console.WriteLine("返されるデータ：" + EventArgs.Empty);
            }

            // 終了通知
            Console.WriteLine("Notice Of End");
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace EventHandlerTest

{

class Program

{

// イベント発生（exe実行）

static void Main(string［］ args)

{

EventReceiver eventReceiver = new EventReceiver();

// イベントハンドラの登録

eventReceiver.EventHandlerObj += new EventHandler(NoticeOfEnd);

eventReceiver.Start();

Console.ReadKey();

}

// イベント終了時に実行して欲しい処理

static void NoticeOfEnd(object sender, EventArgs e)

{

// "object sender"は処理を行ったオブジェクト

Console.WriteLine("処理実行オブジェクト：" + sender.ToString());

// "EventArgs e"はイベント終了時に返されるデータ（今回は無し）

if (e.Equals(EventArgs.Empty))

{

Console.WriteLine("返されるデータ：" + EventArgs.Empty);

}

// 終了通知

Console.WriteLine("Notice Of End");

}

・EventReceiver.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace EventHandlerTest
{
    class EventReceiver
    {
        // 下記の定義がされたdelegateが予め用意されている。
        // public delegate void EventHandler(object sender, EventArgs e);

        // データを持たないイベントデリゲートの宣言
        public event EventHandler EventHandlerObj;

        // 当クラスを継承することを考え protected virtual
        // （オーバーライド可能）
        protected virtual void EndProcedure(EventArgs e)
        {
            // 登録されたイベントハンドラがあれば、それを実行する。
            if (EventHandlerObj != null)
            {
                EventHandlerObj(this, e);
            }
        }

        // イベント受取時の処理
        public void Start()
        {
            Console.WriteLine("Business Logic");
            System.Threading.Thread.Sleep(3000);

            // 今回はEventArgsで返すデータは無し。
            // 返すデータがある場合はEventArgsを継承して定義し、
            // 継承したEventArgsを使うEventHandlerも独自に定義する。
            EndProcedure(EventArgs.Empty);
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace EventHandlerTest

{

class EventReceiver

{

// 下記の定義がされたdelegateが予め用意されている。

// public delegate void EventHandler(object sender, EventArgs e);

// データを持たないイベントデリゲートの宣言

public event EventHandler EventHandlerObj;

// 当クラスを継承することを考え protected virtual

// （オーバーライド可能）

protected virtual void EndProcedure(EventArgs e)

{

// 登録されたイベントハンドラがあれば、それを実行する。

if (EventHandlerObj != null)

{

EventHandlerObj(this, e);

}

// イベント受取時の処理

public void Start()

{

Console.WriteLine("Business Logic");

System.Threading.Thread.Sleep(3000);

// 今回はEventArgsで返すデータは無し。

// 返すデータがある場合はEventArgsを継承して定義し、

// 継承したEventArgsを使うEventHandlerも独自に定義する。

EndProcedure(EventArgs.Empty);

}

【実行結果】

Business Logic
処理実行オブジェクト：EventHandlerTest.EventReceiver
返されるデータ：System.EventArgs
Notice Of End

Business Logic

処理実行オブジェクト：EventHandlerTest.EventReceiver

返されるデータ：System.EventArgs

Notice Of End

いかがでしたでしょうか？

イベントハンドラはC#で画面開発をしていると良く出てくる文法なのですが、馴染みのない人も少なくないかと思います。
イベントハンドラはイベント送受信のためのものであること、文法的には以前に紹介したdelegateの応用であることさえ押さえれば、保守開発等で出くわしてもとりあえず対応できるのではないかと思います。

これからも、C#ならではの文法を紹介していきたいと思います！

2020年6月6日

Eclipse + Maven で Apache POI を用いてExcelファイルを出力する環境の構築（HelloWorldまで）

Apache POI を用いることで、javaでExcelファイルを出力するプログラムを作成することができるようになります。
今回は、環境設定を行い、HelloWorldを試す所まで記事にしました。
ライブラリを落としてきたりパスの設定をするのに手間がかかるので、今回は Eclipse + Maven で設定を行っています。

【Mavenプロジェクトの作成】

１．Eclipseを立ち上げ、ファイル > 新規 > Mavenプロジェクトを選択。

２．「シンプルなプロジェクトの作成」「デフォルト・ワークスペース・ロケーションの使用」にチェックを入れて次に進む。

３．グループIdに任意の名前（プロジェクトを一意に識別する名前）、アーティファクトIdにプロジェクト名を入力し、完了を押下する。

４．作成されたプロジェクトについて、JREシステム・ライブラリー > プロパティーを選択。

５．適切な実行環境を設定（今回は「JavaSE-1.8」を選択）

【ライブラリのインストール・設定】

１．作成されたプロジェクトに存在するpom.xmlを開き、下記のように入力する。

<project xmlns=”http://maven.apache.org/POM/4.0.0″ xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:schemaLocation=”http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd”>
  <modelVersion>4.0.0</modelVersion>
  <groupId>hoge</groupId>
  <artifactId>ProjectName</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <dependencies>
    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi</artifactId>
      <version>4.1.2</version>
    </dependency>
    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi-ooxml</artifactId>
      <version>4.1.2</version>
    </dependency>
    <dependency>
      <groupId>org.apache.poi</groupId>
      <artifactId>poi-ooxml-schemas</artifactId>
      <version>4.1.2</version>
    </dependency>
  </dependencies>
</project>

※
dependenciesタグを自分で追記する。
※
dependencyタグ内の記述については、自分で調べる場合はMVNrepositoryで調べる。ライブラリ名で検索すると、dependencyタグの記述する内容が記載されているページにたどり着く。

２．pom.xmlを保存すると、dependencyタグに記載されたライブラリが自動的にインストール・設定される。

【Excelファイルを出力】

１．src/main/java 直下で右クリックし、新規 > クラスを選択。その後、クラス名（今回は「POITestMain」）を入力し、クラスを生成する。

２．下記のようにソースを記述する。

import java.io.FileOutputStream;

import org.apache.poi.xssf.usermodel.XSSFCell;
import org.apache.poi.xssf.usermodel.XSSFCellStyle;
import org.apache.poi.xssf.usermodel.XSSFFont;
import org.apache.poi.xssf.usermodel.XSSFRow;
import org.apache.poi.xssf.usermodel.XSSFSheet;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class POITestMain {

    public static void main(String［］ args) {

        FileOutputStream fos = null;
        XSSFWorkbook workbook = null;

        try {

            // ワークブック→シート→行→セルの生成
            workbook = new XSSFWorkbook();
            XSSFSheet sheet = workbook.createSheet();
            XSSFRow row = sheet.createRow(0);
            XSSFCell cell = row.createCell(0);

            // セルの書式の生成
            XSSFCellStyle cellStyle = workbook.createCellStyle();
            XSSFFont font = workbook.createFont();
            font.setFontName("ＭＳ ゴシック");
            cellStyle.setFont(font);
            cell.setCellStyle(cellStyle);

            // セルに書き込み
            cell.setCellValue("Hello World!");

            // ファイル書き込み
            fos = new FileOutputStream("C:\\tmp\\test.xlsx");
            workbook.write(fos);

        } catch(Exception e) {
            e.printStackTrace();
        } finally {
             try {
                 if (fos != null) {
                     fos.close();
                 }
                 if (workbook != null) {
                     workbook.close();
                 }
             } catch(Exception e) {
                 e.printStackTrace();
             }
        }
    }
}

import java.io.FileOutputStream;

import org.apache.poi.xssf.usermodel.XSSFCell;

import org.apache.poi.xssf.usermodel.XSSFCellStyle;

import org.apache.poi.xssf.usermodel.XSSFFont;

import org.apache.poi.xssf.usermodel.XSSFRow;

import org.apache.poi.xssf.usermodel.XSSFSheet;

import org.apache.poi.xssf.usermodel.XSSFWorkbook;

public class POITestMain {

public static void main(String［］ args) {

FileOutputStream fos = null;

XSSFWorkbook workbook = null;

try {

// ワークブック→シート→行→セルの生成

workbook = new XSSFWorkbook();

XSSFSheet sheet = workbook.createSheet();

XSSFRow row = sheet.createRow(0);

XSSFCell cell = row.createCell(0);

// セルの書式の生成

XSSFCellStyle cellStyle = workbook.createCellStyle();

XSSFFont font = workbook.createFont();

font.setFontName("ＭＳゴシック");

cellStyle.setFont(font);

cell.setCellStyle(cellStyle);

// セルに書き込み

cell.setCellValue("Hello World!");

// ファイル書き込み

fos = new FileOutputStream("C:\\tmp\\test.xlsx");

workbook.write(fos);

} catch(Exception e) {

e.printStackTrace();

} finally {

try {

if (fos != null) {

fos.close();

}

if (workbook != null) {

workbook.close();

}

} catch(Exception e) {

e.printStackTrace();

}

３．クラスを実行すると、ソース内で記述したパスに下記のような内容のファイルが生成される。

※
実行時にjava.lang.NoClassDefFoundErrorが出る可能性があります（私の環境では出ました）。
その場合は、Eclipseを一度落とし、C:\Users\ユーザ名\.m2 にある repository フォルダを削除し、もう一度Eclipseを立ち上げ、プロジェクトで右クリック > 実行 > Maven Clean を実施し、pom.xmlをもう一度保存し直したりしてみて下さい。
良く起こる事象のようで、「Maven NoClassDefFoundError」でWebで検索すると色々情報が出てきます。

いかがでしたでしょうか？

Apache POIはよく使われているライブラリのようで、Webで検索すると色々と情報が見つかりますが、導入するまでの所で意外とつまずくポイントが少なくないと感じたので、今回の記事を執筆しました。
個人的に、新しい技術を学ぶ時には、「概要の理解→導入→できる限りシンプルなコードで動作確認（多くの場合はHelloWorld）」という流れを大事にしています。
（動いて終わりではなく、なぜ動いたのかを自分で調べて理解することが大事です）
ここまでできれば、詳しい使い方を調べてコードを付け加えていくことで、実務にも耐え得る成果物を作ることができるからです。

これからも、技術を導入する際に役に立つ記事を書いていきたいと思います！

【サンプルコード】

【実行結果】

【サンプルコード】

【実行結果】

・文字コードは「SJIS」を使用する（chcpコマンドで文字コードを変更しない場合）

・改行コードは「CRLF」を使用する

【サンプル】

【文字コード・改行コードが正しい場合の動作】

【文字コードが「UTF-8」の場合の動作】

【改行コードが「LF」の場合の動作】

【Windowsバッチとは】

【WindowsバッチでHello World（Windowsバッチの導入）】

１．エクスプローラを開き、表示 > ファイル名拡張子 のチェックを入れる。

２．任意の名前でテキストドキュメントを新規作成した後、ファイルの名前を変更する。拡張子を「.txt」から「.bat」に変更する。

３．２で作成したファイルを 右クリック > 編集 で選択し、下記のように入力して保存する。

４．３で編集したファイルをダブルクリックする。コンソールが表示され、下記のように表示されればOK。

【Windowsバッチでできること】

１．コンソールへの文字列表示（標準出力）

２．外部の実行ファイルの実行

３．現在のパス（カレントディレクトリ）の変更

４．フォルダの作成

５．ファイルの作成

６．変数の利用

７．IF文の制御

８．その他の制御

【サンプルコード】

・Program.cs

・EventReceiver.cs

【実行結果】

【Mavenプロジェクトの作成】

１．Eclipseを立ち上げ、ファイル > 新規 > Mavenプロジェクト を選択。

２．「シンプルなプロジェクトの作成」「デフォルト・ワークスペース・ロケーションの使用」にチェックを入れて次に進む。

３．グループIdに任意の名前（プロジェクトを一意に識別する名前）、アーティファクトIdにプロジェクト名を入力し、完了を押下する。

４．作成されたプロジェクトについて、JREシステム・ライブラリー > プロパティー を選択。

５．適切な実行環境を設定（今回は「JavaSE-1.8」を選択）

【ライブラリのインストール・設定】

１．作成されたプロジェクトに存在するpom.xmlを開き、下記のように入力する。

２．pom.xmlを保存すると、dependencyタグに記載されたライブラリが自動的にインストール・設定される。

【Excelファイルを出力】

１．src/main/java 直下で右クリックし、新規 > クラス を選択。その後、クラス名（今回は「POITestMain」）を入力し、クラスを生成する。

２．下記のようにソースを記述する。

３．クラスを実行すると、ソース内で記述したパスに下記のような内容のファイルが生成される。

１．エクスプローラを開き、表示 > ファイル名拡張子のチェックを入れる。

３．２で作成したファイルを右クリック > 編集で選択し、下記のように入力して保存する。

１．Eclipseを立ち上げ、ファイル > 新規 > Mavenプロジェクトを選択。

４．作成されたプロジェクトについて、JREシステム・ライブラリー > プロパティーを選択。

１．src/main/java 直下で右クリックし、新規 > クラスを選択。その後、クラス名（今回は「POITestMain」）を入力し、クラスを生成する。