サイゼントの技術ブログ

2020年4月18日

C#でのHelloWorld（コンソールアプリ）

C#のコンソールアプリ（コンソール上で動くアプリケーション）をビルド（実行ファイルを作成）して実行手順をまとめてみました。IDEである Visual Studio Community を使う方法と、Windows OS に標準でついてくるコンパイラ csc.exe を使う方法を紹介します。

前者の方法については既にMicrosoftの公式ドキュメント等で公開されているのですが、環境次第では指示通り動かしても上手く動かないことがあるので、私の環境（Windows8.1、Visual Studio Community 2017、元々別件作業で入れたものなのでビルドに関する設定を弄ってしまったかもしれない）で試した手順を参考のため載せます。
（Visual Studio Community のインストール手順は省略します）

後者の方法については、Visual Studio Community が入っていない環境でビルドする際に便利です。

【Visual Studio Community を使う方法】

１．Visual Studio Community を開く。

２．「ファイル > スタートページ」でスタートページを表示させ、スタートページ上の「新しいプロジェクトを作成」をクリック。

３．「コンソールアプリ」を選択する。名前は任意で良い。これで「OK」を押下すると、「場所」で指定した場所にプロジェクト（作業フォルダ）が生成される。

４．ビルド設定を確認する。「プロジェクト > (プロジェクト名)のプロパティ」の「ビルド」リボンでは、どのフォルダに実行ファイルが出力されるのかを確認できる（画面左上）。また、「ツール > オプション」の「プロジェクトおよびソリューション > ビルド/実行」にて、「実行時に、プロジェクトが最新の状態ではないとき」が「常にビルドする」を設定すると、ソースコード等を更新してから実行する際に自動的にビルドされるようになる（画面右下）。

５．「Program.cs」を下記のように書き換え、「ファイル > Program.cs の保存」を押下するか Ctrl+S で保存する。「Console.WriteLine(“Hello World!”);」は画面上に「Hello World!」と出力する命令である。また、「Console.ReadKey(true);」はキーの入力待ちをする命令である（この命令がないと、設定次第では画面上に「Hello World!」と出力されてから一瞬でコンソールが閉じられてしまい、動作を確認できなくなることがある）。

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

namespace HelloWorld
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");
            Console.ReadKey(true);
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace HelloWorld

{

class Program

{

static void Main(string[] args)

{

Console.WriteLine("Hello World!");

Console.ReadKey(true);

}

６．「開始」ボタンを押下するかF5キーを押下して実行する。実行すると、４の手順で確認したフォルダに実行ファイル（～.exe）が生成され、コンソール上でプログラムが実行される。以降、実行ファイルをダブルクリックすることで、Visual Studio Community 上でなくてもプログラムを実行することができるようになる（実行ファイルの配布等が可能になる）。

【csc.exe を使う方法】

１．任意のフォルダ（今回は C:\tmp\）で「Program.cs」というファイル名でファイルを作成し、任意のテキストエディタで以下の内容を入力する。

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

namespace HelloWorld
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");
            Console.ReadKey(true);
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace HelloWorld

{

class Program

{

static void Main(string[] args)

{

Console.WriteLine("Hello World!");

Console.ReadKey(true);

}

２．「C:\Windows\Microsoft.NET\Framework\v4.0.30319」に「csc.exe」が存在することを確認する。環境次第では「v4.0.30319」というフォルダがないかもしれないので、その場合は別のバージョンのフォルダを使用する。

３．コマンドプロンプトを立ち上げ、１の手順で使用したフォルダへcdコマンドで移動した後、２の手順で確認したcsc.exeを使用してビルドを行う。コマンドとしては下記のように打ち込む。

c:\＞cd c:\tmp

c:\tmp＞C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Program.cs
Microsoft (R) Visual C# Compiler version 4.7.3062.0
for C# 5
Copyright (C) Microsoft Corporation. All rights reserved.

This compiler is provided as part of the Microsoft (R) .NET Framework, but only
supports language versions up to C# 5, which is no longer the latest version. Fo
r compilers that support newer versions of the C# programming language, see http
://go.microsoft.com/fwlink/?LinkID=533240


c:\tmp＞

c:\＞cd c:\tmp

c:\tmp＞C:\Windows\Microsoft.NET\Framework\v4.0.30319\csc.exe Program.cs

Microsoft (R) Visual C# Compiler version 4.7.3062.0

for C# 5

This compiler is provided as part of the Microsoft (R) .NET Framework, but only

supports language versions up to C# 5, which is no longer the latest version. Fo

r compilers that support newer versions of the C# programming language, see http

://go.microsoft.com/fwlink/?LinkID=533240

c:\tmp＞

４．実行ファイル（Program.exe）が１のフォルダ上に生成されるので、下記のようなコマンドを入力して実行する。なお、実行ファイルを直接ダブルクリックすることでも実行できる。

c:\tmp＞Program.exe
Hello World!

c:\tmp＞

c:\tmp＞Program.exe

Hello World!

c:\tmp＞

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

今回、初めてC#の記事を上げてみました。
文法はjavaに近いので、javaに慣れている方ならC#にも馴染みやすいのではないかと思います。
また、Microsoft社が開発した言語だけあって、Windowsとの相性は抜群で、今回の記事で紹介したようにコンパイラや実行環境もOS標準で入っています。
Windows用のアプリを作りたい時や、Windows向けにちょっとしたツールを作りたい時に適しているのではないかと思います。

今後もC#の記事を上げていきたいと思いますので、よろしくお願いします！

2020年4月11日

java：並行開発を行うためのテクニック

何も考えずにクラス分割を行いクラス毎に開発者を割り当てると、未完成のクラスを取り込むことができず、他のクラスが完成するのを待つ必要が出てきてしまいます。
今回は、他のクラスが完成するのを待たずに並行開発するテクニックを、javaの例を用いて説明します。

下記は何も考えずにクラス分割した場合の例です。
HelloProductクラスを取り込みたいのですが、HelloProductクラスが完成していないため、コンパイルができず、HelloProductクラスが完成するまで実行確認を行うことができません。

【サンプルコード】

・HelloMain.java（新規）

public class HelloMain {

    public static void main(String[] args) {
        HelloProduct helloProduct = new HelloProduct();
        helloProduct.print();
    }

}

public class HelloMain {

public static void main(String[] args) {

HelloProduct helloProduct = new HelloProduct();

helloProduct.print();

}

【実行結果】

HelloProductクラスが作成されていないためにコンパイルエラー。

1	HelloProductクラスが作成されていないためにコンパイルエラー。

そこで、Interfaceを用いる手があります。
Interfaceの下に、最終的に取り込みたいクラス（HelloProductクラス）と、実行確認時に暫定的に取り込むクラス（HelloTestクラス）を定義することで、最終的に取り込みたいクラスの完成を待たずに、実行確認時に暫定的に取り込むクラスを用いてテストが可能になります。
下記は、暫定的にクラスを取りこんで実行確認を行う例です。

【サンプルコード】

・HelloMain.java（修正）

public class HelloMain {

    public static void main(String[] args) {
        HelloInterface hello = new HelloTest();
        hello.print();
    }

}

public class HelloMain {

public static void main(String[] args) {

HelloInterface hello = new HelloTest();

hello.print();

}

・HelloInterface.java（新規）

public interface HelloInterface {

    public abstract void print();

}

public interface HelloInterface {

public abstract void print();

}

・HelloTest.java（新規）

public class HelloTest implements HelloInterface {

    public void print() {
        System.out.println("Hello World! Test!");
    }

}

public class HelloTest implements HelloInterface {

public void print() {

System.out.println("Hello World! Test!");

}

【実行結果】

Hello World! Test!

1	Hello World! Test!

そして、最終的に取り込みたいクラスが完成したら、newの箇所を変更することでそのクラスの取り込みが可能になります。

【サンプルコード】

・HelloMain.java（修正）

public class HelloMain {

    public static void main(String[] args) {
        HelloInterface hello = new HelloProduct();
        hello.print();
    }

}

public class HelloMain {

public static void main(String[] args) {

HelloInterface hello = new HelloProduct();

hello.print();

}

・HelloProduct.java（新規）

public class HelloProduct implements HelloInterface {

    public void print() {
        System.out.println("Hello World! Product!");
    }

}

public class HelloProduct implements HelloInterface {

public void print() {

System.out.println("Hello World! Product!");

}

【実行結果】

Hello World! Product!

1	Hello World! Product!

以上のようにInterfaceの機能を用いて並行開発を行うのは、実際の開発でもよく使われる手段です。

補足すると、この手段は若干古典的な手段となります。
より発展的な手段としては、DI（Dependecy Injection）という手段があり、SpringFramework等のフレームワークの機能を用いることで容易に実現することが可能になります。
DIは、newの箇所（上記のサンプルコードで「 = new HelloTest();」や「 = new HelloProduct();」としていた箇所）の定義を何かしらの方法で不要とすることで、ソースコードを変更することなく取り込むクラスを変更できるようにする、という手段です。
SpringFrameworkでは、特定のアノテーションをソースコードに付与することで、取り込むクラスをxmlファイルで指定することが可能になります。上記のサンプルコードの例で言うと、HelloTestクラスを取り込むのかHelloProductクラスを取り込むのかをxmlファイルに定義することが可能になります。

DIについてはこの記事では詳しく触れませんが、現在の開発ではDIが使われることも多く、書籍やWebの文献も豊富です。
実際に使おうと思った時に実装方法がわからずに困る、ということは少ないでしょう。

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

実際に多人数で開発していると、全てのソースコードが完成しないとコンパイルできないというのはかなり不便で、スケジュールにも影響してきます。
多人数で開発する場合は、今回の記事のようにInterface、フレームワークを使用しているならDIの機能を使用すると良いでしょう。

javaの記事が続いてきましたが、今後はC#の記事も書いていきたいと思っています。
ではまた次回！

2020年4月3日

java：WEBからHTMLファイルを取得するサンプルプログラム

HTML形式のログを定期的に取得しているのですが、その時に使用しているサンプルプログラムを公開します。
Javaの実行環境が整っているWindowsOSで、LogGet.java と LogGet.bat を同じディレクトリに置き、LogGet.bat を実行すると、「html」フォルダが出来上がりそこにHTMLファイルが格納されます。
取得するHTMLファイルのURL、及びHTMLファイルのローカルでのファイル名は、LogGet.java を修正して変更します。
HTMLファイルの文字コードは「EUC-JP」を前提としていますので、他の文字コードが使用されている場合は LogGet.java の「EUC-JP」の箇所を適宜修正してください。

【サンプルコード】

・LogGet.java

import java.io.File;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.net.URL;
 
public class LogGet {
 
    public static void main(final String[] args){
        /*  利用者がいじる所はここです。
         *  　・"～.html"となっている箇所は取得ログのファイル名です。
         *  　　適宜書き換えてください。
         *  　　　※ファイル名が被った場合はログを取得しません
         *  　・取得する必要が無いログはコメントアウトしてください。
         */ 
        //LogGet("ログ１","http://hoge.html","ほげ.html");
          LogGet("ログ２","http://fuga.html","ふが.html");
    }
    
    public static void LogGet(String logName, String logUrl, String fileName){
        File f = new File("html\\" + fileName);
        if(f.exists()){
            System.out.println
                ("重複したファイル名 " + fileName + " が与えられたため " +
                 logName + " は取得しません。");
            return;
        }
        URL url = null;
        InputStream is = null;
        InputStreamReader isr = null;
        FileOutputStream fos = null;
        OutputStreamWriter osw = null;
        try {
            url = new URL(logUrl);
            is = url.openStream();
            isr = new InputStreamReader(is,"EUC-JP");
            fos = new FileOutputStream("html\\" + fileName);
            osw = new OutputStreamWriter(fos,"EUC-JP");
            while(true) {
                int i = isr.read();
                if (i == -1) {
                    break;
                }
                osw.write((char)i);
            }
            System.out.println
                (logName + " をファイル名 " + fileName + " で取得しました。");
        } catch (Exception e) {
            System.out.println(e.getMessage());
        } finally {
            try {
                isr.close();
                is.close();
                osw.close();
                fos.close();
            } catch (Exception e) {
                System.out.println(e.getMessage());
            }
        }
    }
}

import java.io.File;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.FileOutputStream;

import java.io.OutputStreamWriter;

import java.net.URL;

public class LogGet {

public static void main(final String[] args){

/* 利用者がいじる所はここです。

* 　・"～.html"となっている箇所は取得ログのファイル名です。

* 　　適宜書き換えてください。

* 　　　※ファイル名が被った場合はログを取得しません

* 　・取得する必要が無いログはコメントアウトしてください。

//LogGet("ログ１","http://hoge.html","ほげ.html");

LogGet("ログ２","http://fuga.html","ふが.html");

}

public static void LogGet(String logName, String logUrl, String fileName){

File f = new File("html\\" + fileName);

if(f.exists()){

System.out.println

("重複したファイル名 " + fileName + " が与えられたため " +

logName + " は取得しません。");

return;

}

URL url = null;

InputStream is = null;

InputStreamReader isr = null;

FileOutputStream fos = null;

OutputStreamWriter osw = null;

try {

url = new URL(logUrl);

is = url.openStream();

isr = new InputStreamReader(is,"EUC-JP");

fos = new FileOutputStream("html\\" + fileName);

osw = new OutputStreamWriter(fos,"EUC-JP");

while(true) {

int i = isr.read();

if (i == -1) {

break;

}

osw.write((char)i);

}

System.out.println

(logName + " をファイル名 " + fileName + " で取得しました。");

} catch (Exception e) {

System.out.println(e.getMessage());

} finally {

try {

isr.close();

is.close();

osw.close();

fos.close();

} catch (Exception e) {

System.out.println(e.getMessage());

}

・LogGet.bat

@echo off
rem JDKをインストールしていない場合はインストールしてください。
rem https://qiita.com/ko2a/items/69fa8a5366d7449500ca

rem 都度コンパイルを実施（javaをスクリプト言語っぽく利用）
if exist .\LogGet.class (del .\LogGet.class)
javac -encoding UTF-8 .\LogGet.java

rem 処理実行
if not exist html\ (mkdir html)
java -classpath . LogGet

rem 処理終了
del .\LogGet.class
pause
exit

@echo off

rem JDKをインストールしていない場合はインストールしてください。

rem https://qiita.com/ko2a/items/69fa8a5366d7449500ca

rem 都度コンパイルを実施（javaをスクリプト言語っぽく利用）

if exist .\LogGet.class (del .\LogGet.class)

javac -encoding UTF-8 .\LogGet.java

rem 処理実行

if not exist html\ (mkdir html)

java -classpath . LogGet

rem 処理終了

del .\LogGet.class

pause

exit

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

定期的にHTMLファイルを取得する機会があったので、javaでプログラムを作ってみました。
複雑なWebページを取得するには不向きですが、単純なHTMLで書かれたページを定期的に取得する時に便利だと思います。

便利な機能を見つけたら、また紹介したいと思います！

2020年3月28日

javaでのCommandパターン

Commandパターンとはデザインパターンの一種で、１つ１つのコマンド（命令）をそのままオブジェクトとして表現するパターンです。
コマンドをオブジェクトとして表現することで、コマンドの管理（追加・削除・実行）が可能になるというメリットがあります。

今回は、ファイルやフォルダを作成するコマンドを管理するサンプルコードを作成してみました。
Commandクラスが１つ１つのコマンドを表し、コマンドの管理はInvokerクラスで行い、コマンドの実際の処理はReceiverクラスで記述します。

【サンプルコード】

・Command.java

// コマンドの抽象クラス
public abstract class Command {

    protected String nameOfFileFolder;
    protected Receiver receiver;

    // コンストラクタ：生成するファイル名・フォルダ名をセット
    public Command(String nameOfFileFolder) {
        this.nameOfFileFolder = nameOfFileFolder;
    }

    // コマンドの受け手をセット
    public void setReceiver(Receiver receiver) {
        this.receiver = receiver;
    }

    // コマンドの受け手に処理を依頼
    public abstract void execute();

}

// コマンドの抽象クラス

public abstract class Command {

protected String nameOfFileFolder;

protected Receiver receiver;

// コンストラクタ：生成するファイル名・フォルダ名をセット

public Command(String nameOfFileFolder) {

this.nameOfFileFolder = nameOfFileFolder;

}

// コマンドの受け手をセット

public void setReceiver(Receiver receiver) {

this.receiver = receiver;

}

// コマンドの受け手に処理を依頼

public abstract void execute();

}

・ConcreteCommandForOperation.java

// 運用で使用するフォルダ・ファイル作成を指示するクラス
public class ConcreteCommandForOperation extends Command {

    public ConcreteCommandForOperation(String nameOfFileFolder) {
        super(nameOfFileFolder);
    }

    public void execute() {
        receiver.action
            ("C:\\pleiades\\workspace\\Hello\\conf\\" + nameOfFileFolder);
    }

}

// 運用で使用するフォルダ・ファイル作成を指示するクラス

public class ConcreteCommandForOperation extends Command {

public ConcreteCommandForOperation(String nameOfFileFolder) {

super(nameOfFileFolder);

}

public void execute() {

receiver.action

("C:\\pleiades\\workspace\\Hello\\conf\\" + nameOfFileFolder);

}

・ConcreteCommandForTemporary.java

// 一時フォルダ・ファイル作成を指示するクラス
public class ConcreteCommandForTemporary extends Command {

    public ConcreteCommandForTemporary(String nameOfFileFolder) {
        super(nameOfFileFolder);
    }

    public void execute() {
        receiver.action
            ("C:\\tmp\\" + nameOfFileFolder);
    }

}

// 一時フォルダ・ファイル作成を指示するクラス

public class ConcreteCommandForTemporary extends Command {

public ConcreteCommandForTemporary(String nameOfFileFolder) {

super(nameOfFileFolder);

}

public void execute() {

receiver.action

("C:\\tmp\\" + nameOfFileFolder);

}

・Receiver.java

// コマンドの受け手の抽象クラス
public interface Receiver {

    // 処理実行
    public abstract void action(String path);

}

// コマンドの受け手の抽象クラス

public interface Receiver {

// 処理実行

public abstract void action(String path);

}

・ConcreteReceiverMkfil.java

import java.io.File;
import java.io.IOException;
// ファイル作成を行うReceiver
public class ConcreteReceiverMkfil implements Receiver {

    public void action(String path) {
        File file = new File(path + ".txt");
        try {
            if (file.createNewFile()){
            }else{
                System.out.println(path + "作成に失敗しました。");
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

import java.io.File;

import java.io.IOException;

// ファイル作成を行うReceiver

public class ConcreteReceiverMkfil implements Receiver {

public void action(String path) {

File file = new File(path + ".txt");

try {

if (file.createNewFile()){

}else{

System.out.println(path + "作成に失敗しました。");

}

} catch (IOException e) {

e.printStackTrace();

}

・ConcreteReceiverMkdir.java

import java.io.File;
// フォルダ作成を行うReceiver
public class ConcreteReceiverMkdir implements Receiver {

    public void action(String path) {
        File file = new File(path);
        if (file.mkdir()){
        }else{
            System.out.println(path + "作成に失敗しました。");
        }
    }

}

import java.io.File;

// フォルダ作成を行うReceiver

public class ConcreteReceiverMkdir implements Receiver {

public void action(String path) {

File file = new File(path);

if (file.mkdir()){

}else{

System.out.println(path + "作成に失敗しました。");

}

・Invoker.java

import java.util.Iterator;
import java.util.Stack;
// コマンドの追加・取消・実行を管理するクラス
public class Invoker {

    private Stack＜Command＞ commandStack = new Stack＜Command＞();

    // コマンドを追加する
    public void addCommnad(Command command) {
        commandStack.push(command);
        System.out.println
            (commandStack.size() + "個目のコマンドを登録しました。");
    }

    // 直近のコマンドを削除する
    public void undoCommnad() {
        if(commandStack.empty()) {
            System.out.println("削除するコマンドがありません。");
        } else {
            commandStack.pop();
            System.out.println
                ((commandStack.size()+1) + "個目のコマンドを削除しました。");
        }
    }

    // コマンドを順番に実行する
    public void execute() {
        System.out.println
            (commandStack.size() + "個のコマンドを実行します。");
        Iterator&lt;Command> itetator = commandStack.iterator();
        while (itetator.hasNext()) {
            itetator.next().execute();
        }
        System.out.println("コマンドを実行しました。");
    }

}

import java.util.Iterator;

import java.util.Stack;

// コマンドの追加・取消・実行を管理するクラス

public class Invoker {

private Stack＜Command＞ commandStack = new Stack＜Command＞();

// コマンドを追加する

public void addCommnad(Command command) {

commandStack.push(command);

System.out.println

(commandStack.size() + "個目のコマンドを登録しました。");

}

// 直近のコマンドを削除する

public void undoCommnad() {

if(commandStack.empty()) {

System.out.println("削除するコマンドがありません。");

} else {

commandStack.pop();

System.out.println

((commandStack.size()+1) + "個目のコマンドを削除しました。");

}

// コマンドを順番に実行する

public void execute() {

System.out.println

(commandStack.size() + "個のコマンドを実行します。");

Iterator<Command> itetator = commandStack.iterator();

while (itetator.hasNext()) {

itetator.next().execute();

}

System.out.println("コマンドを実行しました。");

}

・CommandMain.java

// メインクラス
public class CommandMain {

    public static void main(String[] args) {

        // 初期処理
        Receiver receiverMkfil = new ConcreteReceiverMkfil();
        Receiver receiverMkdir = new ConcreteReceiverMkdir();
        Invoker invoker = new Invoker();

        // コマンドの作成（５個）
        System.out.println("Aファイルを作成するコマンドを登録します。");
        Command commandA = new ConcreteCommandForOperation("A");
        commandA.setReceiver(receiverMkfil);
        invoker.addCommnad(commandA);
        System.out.println("Bフォルダを作成するコマンドを登録します。");
        Command commandB = new ConcreteCommandForOperation("B");
        commandB.setReceiver(receiverMkdir);
        invoker.addCommnad(commandB);
        System.out.println("C一時ファイルを作成するコマンドを登録します。");
        Command commandC = new ConcreteCommandForTemporary("C");
        commandC.setReceiver(receiverMkfil);
        invoker.addCommnad(commandC);
        System.out.println("D一時フォルダを作成するコマンドを登録します。");
        Command commandD = new ConcreteCommandForTemporary("D");
        commandD.setReceiver(receiverMkdir);
        invoker.addCommnad(commandD);
        System.out.println("Eファイルを作成するコマンドを登録します。");
        Command commandE = new ConcreteCommandForOperation("E");
        commandE.setReceiver(receiverMkfil);
        invoker.addCommnad(commandE);

        // 直近のコマンドの削除
        invoker.undoCommnad();

        // コマンドの実行
        invoker.execute();

    }

}

// メインクラス

public class CommandMain {

public static void main(String[] args) {

// 初期処理

Receiver receiverMkfil = new ConcreteReceiverMkfil();

Receiver receiverMkdir = new ConcreteReceiverMkdir();

Invoker invoker = new Invoker();

// コマンドの作成（５個）

System.out.println("Aファイルを作成するコマンドを登録します。");

Command commandA = new ConcreteCommandForOperation("A");

commandA.setReceiver(receiverMkfil);

invoker.addCommnad(commandA);

System.out.println("Bフォルダを作成するコマンドを登録します。");

Command commandB = new ConcreteCommandForOperation("B");

commandB.setReceiver(receiverMkdir);

invoker.addCommnad(commandB);

System.out.println("C一時ファイルを作成するコマンドを登録します。");

Command commandC = new ConcreteCommandForTemporary("C");

commandC.setReceiver(receiverMkfil);

invoker.addCommnad(commandC);

System.out.println("D一時フォルダを作成するコマンドを登録します。");

Command commandD = new ConcreteCommandForTemporary("D");

commandD.setReceiver(receiverMkdir);

invoker.addCommnad(commandD);

System.out.println("Eファイルを作成するコマンドを登録します。");

Command commandE = new ConcreteCommandForOperation("E");

commandE.setReceiver(receiverMkfil);

invoker.addCommnad(commandE);

// 直近のコマンドの削除

invoker.undoCommnad();

// コマンドの実行

invoker.execute();

}

【実行結果】

・コンソール出力

Aファイルを作成するコマンドを登録します。
1個目のコマンドを登録しました。
Bフォルダを作成するコマンドを登録します。
2個目のコマンドを登録しました。
C一時ファイルを作成するコマンドを登録します。
3個目のコマンドを登録しました。
D一時フォルダを作成するコマンドを登録します。
4個目のコマンドを登録しました。
Eファイルを作成するコマンドを登録します。
5個目のコマンドを登録しました。
5個目のコマンドを削除しました。
4個のコマンドを実行します。
コマンドを実行しました。

Aファイルを作成するコマンドを登録します。

1個目のコマンドを登録しました。

Bフォルダを作成するコマンドを登録します。

2個目のコマンドを登録しました。

C一時ファイルを作成するコマンドを登録します。

3個目のコマンドを登録しました。

D一時フォルダを作成するコマンドを登録します。

4個目のコマンドを登録しました。

Eファイルを作成するコマンドを登録します。

5個目のコマンドを登録しました。

5個目のコマンドを削除しました。

4個のコマンドを実行します。

コマンドを実行しました。

・ファイルやフォルダの生成確認

C:\pleiades\workspace\Hello\conf＞cd C:\pleiades\workspace\Hello\conf

C:\pleiades\workspace\Hello\conf＞dir
 ドライブ C のボリューム ラベルは  です
 ボリューム シリアル番号は  です

 C:\pleiades\workspace\Hello\conf のディレクトリ

2020/02/08  10:02    ＜DIR＞          .
2020/02/08  10:02    ＜DIR＞          ..
2020/02/08  10:02                   0 A.txt
2020/02/08  10:02    ＜DIR＞          B
               1 個のファイル                   0 バイト
               3 個のディレクトリ  19,379,642,368 バイトの空き領域

C:\pleiades\workspace\Hello\conf＞
C:\pleiades\workspace\Hello\conf＞cd C:\tmp\

C:\tmp＞dir
 ドライブ C のボリューム ラベルは  です
 ボリューム シリアル番号は  です

 C:\tmp のディレクトリ

2020/02/08  10:02    ＜DIR＞          .
2020/02/08  10:02    ＜DIR＞          ..
2020/02/08  10:02                   0 C.txt
2020/02/08  10:02    ＜DIR＞          D
               1 個のファイル                   0 バイト
               3 個のディレクトリ  19,379,642,368 バイトの空き領域

C:\tmp＞

C:\pleiades\workspace\Hello\conf＞cd C:\pleiades\workspace\Hello\conf

C:\pleiades\workspace\Hello\conf＞dir

ドライブ C のボリュームラベルはです

ボリュームシリアル番号はです

C:\pleiades\workspace\Hello\conf のディレクトリ

2020/02/08 10:02 ＜DIR＞ .

2020/02/08 10:02 ＜DIR＞ ..

2020/02/08 10:02 0 A.txt

2020/02/08 10:02 ＜DIR＞ B

1 個のファイル 0 バイト

3 個のディレクトリ 19,379,642,368 バイトの空き領域

C:\pleiades\workspace\Hello\conf＞

C:\pleiades\workspace\Hello\conf＞cd C:\tmp\

C:\tmp＞dir

ドライブ C のボリュームラベルはです

ボリュームシリアル番号はです

C:\tmp のディレクトリ

2020/02/08 10:02 ＜DIR＞ .

2020/02/08 10:02 ＜DIR＞ ..

2020/02/08 10:02 0 C.txt

2020/02/08 10:02 ＜DIR＞ D

1 個のファイル 0 バイト

3 個のディレクトリ 19,379,642,368 バイトの空き領域

C:\tmp＞

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

デザインパターンに出てくる設計は、自力ではなかなか思いつかない勉強しがいがあるものが少なくないと思います。
「コマンドをオブジェクトとして表現することで、管理（追加・削除・実行）を可能とする」というCommandパターンの発想も、その一つなのではないかと思います。

ここしばらくの間はデザインパターンの紹介を行ってきましたが、一旦一区切りつけたいと思います。
次週からはまた別の観点で役に立つ記事を発信して行きたいと思いますので、今後もよろしくお願いします！

2020年3月20日

javaでのStateパターン

Stateパターンとはデザインパターンの一種で、１つ１つの状態をそのままクラスとして表現するパターンです。
通常のコーディングだとIF文で状態毎の処理を記述させるためそれぞれの状態でどのような処理が行われるのか読み取りにくいのですが、このパターンを適用すれば状態遷移図上の状態とクラスが１対１で結びつくようになるので、処理が単純明快になります。

今回は、朝・昼・夜の各状態で出現モンスターが変わるサンプルコードを作成してみました。
このパターンは記述内容としては決して難しくないので、サンプルコードを見た方が理解が早いと思います。

【サンプルコード】

・StateEnum.java

// Stateの番号や共通処理を定義するEnumクラス
//
// 今回のデザインパターンと直接関係ありませんが、
// 共通の定数を使用するため定義します。
public enum StateEnum {
    unknown(0),
    morning(1),
    day(2),
    night(3);

    private int id;

    private StateEnum (int id) {
        this.id = id;
    }

    public int getId() {
        return id;
    }

    public static StateEnum valueOf(int id) {
        StateEnum[] array = values();
        for(StateEnum num : array) {
            if (id == num.getId()){
                return num;
            }
        }
        return null;
    }

    public static int stateValidateJudge(int id) {
        if (id ＜ 0 || id ＞ 3) {
            System.out.println("不明なStateです。UnknownStateと仮定します。");
            return 0;
        } else {
            return id;
        }
    }

    public static int stateChangeJudge(int hour) {
        if (hour ＜ 0 || hour ＞ 23) {
            System.out.println("不正な時刻です。");
            return -1;
        } else if (hour ＞= 5 &amp;&amp; hour ＜ 10) {
            return morning.getId();
        } else if (hour ＞= 10 &amp;&amp; hour ＜ 18) {
            return day.getId();
        } else {
            return night.getId();
        }
    }

}

// Stateの番号や共通処理を定義するEnumクラス

// 今回のデザインパターンと直接関係ありませんが、

// 共通の定数を使用するため定義します。

public enum StateEnum {

unknown(0),

morning(1),

day(2),

night(3);

private int id;

private StateEnum (int id) {

this.id = id;

}

public int getId() {

return id;

}

public static StateEnum valueOf(int id) {

StateEnum[] array = values();

for(StateEnum num : array) {

if (id == num.getId()){

return num;

}

return null;

}

public static int stateValidateJudge(int id) {

if (id ＜ 0 || id ＞ 3) {

System.out.println("不明なStateです。UnknownStateと仮定します。");

return 0;

} else {

return id;

}

public static int stateChangeJudge(int hour) {

if (hour ＜ 0 || hour ＞ 23) {

System.out.println("不正な時刻です。");

return -1;

} else if (hour ＞= 5 && hour ＜ 10) {

return morning.getId();

} else if (hour ＞= 10 && hour ＜ 18) {

return day.getId();

} else {

return night.getId();

}

・State.java

// State毎に作成するクラス
// 本来のStateパターンではインターフェースですが、
// 今回は共通処理が存在するため、抽象クラスで定義します。
public abstract class State {

    protected int stateId;

    public State(int stateId) {
        this.stateId = StateEnum.stateValidateJudge(stateId);
    }

    // Stateの変更判定だけする形にします。
    // 本来のStateパターンではどのオブジェクトに変更するかも定義しますが、
    // 密結合を避けるため、今回は利用者側にそれを判断させる形にします。
    public int stateChangeJudge(int hour) {
        int futureStateId = StateEnum.stateChangeJudge(hour);
        if (stateId == futureStateId) {
            return 0; // 変更無し
        } else {
            return futureStateId;
        }
    };

    public abstract void stateMethod(Context context);

}

// State毎に作成するクラス

// 本来のStateパターンではインターフェースですが、

// 今回は共通処理が存在するため、抽象クラスで定義します。

public abstract class State {

protected int stateId;

public State(int stateId) {

this.stateId = StateEnum.stateValidateJudge(stateId);

}

// Stateの変更判定だけする形にします。

// 本来のStateパターンではどのオブジェクトに変更するかも定義しますが、

// 密結合を避けるため、今回は利用者側にそれを判断させる形にします。

public int stateChangeJudge(int hour) {

int futureStateId = StateEnum.stateChangeJudge(hour);

if (stateId == futureStateId) {

return 0; // 変更無し

} else {

return futureStateId;

}

};

public abstract void stateMethod(Context context);

}

・UnknownState.java

// １回も状態遷移をしていない場合のState
// 通常使わない想定です。
public class UnknownState extends State{

    private static State unknownState = new UnknownState();

    private UnknownState() {
        super(StateEnum.unknown.getId());
    }

    // 複数のインスタンスを用意する必要がないのでシングルトン
    public static State getInstance() {
        return unknownState;
    }

    public void stateMethod(Context context) {
        context.contextMethod("まおう");
    }

}

// １回も状態遷移をしていない場合のState

// 通常使わない想定です。

public class UnknownState extends State{

private static State unknownState = new UnknownState();

private UnknownState() {

super(StateEnum.unknown.getId());

}

// 複数のインスタンスを用意する必要がないのでシングルトン

public static State getInstance() {

return unknownState;

}

public void stateMethod(Context context) {

context.contextMethod("まおう");

}

・MorningState.java

// 朝の場合のState
public class MorningState extends State{

    private static State morningState = new MorningState();

    private MorningState() {
        super(StateEnum.morning.getId());
    }

    // 複数のインスタンスを用意する必要がないのでシングルトン
    public static State getInstance() {
        return morningState;
    }

    public void stateMethod(Context context) {
        context.contextMethod("とりモンスター");
    }

}

// 朝の場合のState

public class MorningState extends State{

private static State morningState = new MorningState();

private MorningState() {

super(StateEnum.morning.getId());

}

// 複数のインスタンスを用意する必要がないのでシングルトン

public static State getInstance() {

return morningState;

}

public void stateMethod(Context context) {

context.contextMethod("とりモンスター");

}

・DayState.java

// 昼の場合のState
public class DayState extends State{

    private static State dayState = new DayState();

    private DayState() {
        super(StateEnum.day.getId());
    }

    // 複数のインスタンスを用意する必要がないのでシングルトン
    public static State getInstance() {
        return dayState;
    }

    public void stateMethod(Context context) {
        context.contextMethod("いぬモンスター");
        context.contextMethod("ねこモンスター");
    }

}

// 昼の場合のState

public class DayState extends State{

private static State dayState = new DayState();

private DayState() {

super(StateEnum.day.getId());

}

// 複数のインスタンスを用意する必要がないのでシングルトン

public static State getInstance() {

return dayState;

}

public void stateMethod(Context context) {

context.contextMethod("いぬモンスター");

context.contextMethod("ねこモンスター");

}

・NightState.java

// 夜の場合のState
public class NightState extends State{

    private static State nightState = new NightState();

    private NightState() {
        super(StateEnum.night.getId());
    }

    // 複数のインスタンスを用意する必要がないのでシングルトン
    public static State getInstance() {
        return nightState;
    }

    public void stateMethod(Context context) {
        context.contextMethod("こうもりモンスター");
    }

}

// 夜の場合のState

public class NightState extends State{

private static State nightState = new NightState();

private NightState() {

super(StateEnum.night.getId());

}

// 複数のインスタンスを用意する必要がないのでシングルトン

public static State getInstance() {

return nightState;

}

public void stateMethod(Context context) {

context.contextMethod("こうもりモンスター");

}

・Context.java

// Stateの管理を行うクラス
public class Context {

    private State state = null;

    public Context() {
        state = UnknownState.getInstance();
    }

    public void setState(State state) {
        this.state = state;
    }

    public void stateChangeJudge(int hour) {
        int futureStateId = state.stateChangeJudge(hour);
        switch (futureStateId){
          case 1:
            setState(MorningState.getInstance());
            break;
          case 2:
            setState(DayState.getInstance());
            break;
          case 3:
            setState(NightState.getInstance());
            break;
          case -1:
            System.out.println("不正な操作のため状態変更はしません。");
            break;
          default: // 0が返る場合。状態変更無し。
            break;
        }

    }

    public void stateMethod() {
        state.stateMethod(this);
    }

    public void contextMethod(String monster) {
        System.out.println(monster + " があらわれた！");
    }

}

// Stateの管理を行うクラス

public class Context {

private State state = null;

public Context() {

state = UnknownState.getInstance();

}

public void setState(State state) {

this.state = state;

}

public void stateChangeJudge(int hour) {

int futureStateId = state.stateChangeJudge(hour);

switch (futureStateId){

case 1:

setState(MorningState.getInstance());

break;

case 2:

setState(DayState.getInstance());

break;

case 3:

setState(NightState.getInstance());

break;

case -1:

System.out.println("不正な操作のため状態変更はしません。");

break;

default: // 0が返る場合。状態変更無し。

break;

}

public void stateMethod() {

state.stateMethod(this);

}

public void contextMethod(String monster) {

System.out.println(monster + " があらわれた！");

}

・StateMain.java

// メインクラス
public class StateMain {
    public static void main(String[] args) {
        Context context = new Context();
        for (int i = 0; i ＜ 24; i++) {
            System.out.println("現在 " + i + "時");
            context.stateChangeJudge(i);
            context.stateMethod();
            System.out.println();
        }
    }
}

// メインクラス

public class StateMain {

public static void main(String[] args) {

Context context = new Context();

for (int i = 0; i ＜ 24; i++) {

System.out.println("現在 " + i + "時");

context.stateChangeJudge(i);

context.stateMethod();

System.out.println();

}

【実行結果】

現在 0時
こうもりモンスター があらわれた！

現在 1時
こうもりモンスター があらわれた！

現在 2時
こうもりモンスター があらわれた！

現在 3時
こうもりモンスター があらわれた！

現在 4時
こうもりモンスター があらわれた！

現在 5時
とりモンスター があらわれた！

現在 6時
とりモンスター があらわれた！

現在 7時
とりモンスター があらわれた！

現在 8時
とりモンスター があらわれた！

現在 9時
とりモンスター があらわれた！

現在 10時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 11時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 12時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 13時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 14時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 15時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 16時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 17時
いぬモンスター があらわれた！
ねこモンスター があらわれた！

現在 18時
こうもりモンスター があらわれた！

現在 19時
こうもりモンスター があらわれた！

現在 20時
こうもりモンスター があらわれた！

現在 21時
こうもりモンスター があらわれた！

現在 22時
こうもりモンスター があらわれた！

現在 23時
こうもりモンスター があらわれた！

現在 0時

こうもりモンスターがあらわれた！

現在 1時

こうもりモンスターがあらわれた！

現在 2時

こうもりモンスターがあらわれた！

現在 3時

こうもりモンスターがあらわれた！

現在 4時

こうもりモンスターがあらわれた！

現在 5時

とりモンスターがあらわれた！

現在 6時

とりモンスターがあらわれた！

現在 7時

とりモンスターがあらわれた！

現在 8時

とりモンスターがあらわれた！

現在 9時

とりモンスターがあらわれた！

現在 10時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 11時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 12時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 13時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 14時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 15時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 16時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 17時

いぬモンスターがあらわれた！

ねこモンスターがあらわれた！

現在 18時

こうもりモンスターがあらわれた！

現在 19時

こうもりモンスターがあらわれた！

現在 20時

こうもりモンスターがあらわれた！

現在 21時

こうもりモンスターがあらわれた！

現在 22時

こうもりモンスターがあらわれた！

現在 23時

こうもりモンスターがあらわれた！

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

設計を行う際に、状態遷移図を書くことがあると思います。
その状態遷移図をコードとして表したものが、Stateパターンです。
コードの可読性が上がるだけでなく、状態を追加するような時にも影響を局所化できるので、覚えておいて損は無いパターンだと思います。

次回は、Commandパターンについて取り扱いたいと思います！