JUnitの設定を行う。

EclipseでJUnitの設定を行います。

1. プロジェクトを右クリック
2. ビルドパスを選択する
3. ライブラリの追加を選択
4. JUnitを選択

テストするためのクラスを作成する。

今回は、サンプルなので簡単なものです。
ずばり、下のようなクラスを作成しました。

package jp.zenryoku.sample;

/**
 * JUnitの作成から実行までのサンプルクラス
 * @author 作成者の名前
 *
 */
public class JUnitSample {
    /** 定数 */
    private static final String TITLE = "JUnitサンプル";
    /** フィールド変数 */
    private int age;

    public JUnitSample() {
        // 年齢を設定する
        age = 10; // とりあえずは１０歳にする
    }

    /**
     * @return age
     */
    public int getAge() {
        return age;
    }

    /**
     * @param age セットする age
     */
    public void setAge(int age) {
        this.age = age;
    }

}

• 定数として「TITLE」を定義
• フィールド変数に年齢を定義
• コンストラクタで年齢を１０に設定
• メソッドとして年齢のGetterSetterを作成

JUnitテストクラスを作成

テストクラスを作成するときは、(自分の常識内では)以下のように作成します。

1. パッケージ名はテスト対象クラスと同じ
2. テスト対象クラス＋Testという名前にする

テストクラスを作成するときには、テスト対象クラスを定数として保持してしまうと楽なのでそのようにしています。状況によりstatic(静的)でやるべきか、そうしないべきかの判断は、使用したいアノテーションで判断するとよいと思います。

例:
１．テストクラスを起動するときに一度だけ起動するのを「@BeforeClass」アノテーションを使用するならば、static修飾子をつける必要がある。
２．テストケースの実行時に必ずコンストラクタを起動するのであれば、「@Before」を使用するとよい

\@Beforeを使用する場合

上に作成したテストケースを修正して、「@BeforeClass」アノテーションを使用しないパターンで実装してみます。

ここでコンストラクタに引数を追加したものを追加します。具体的には下のようなコードになります。

public JUnitSample(int age) {
    this.age = age;
}

そして、実行するテストに関しては、下のようになります。

package jp.zenryoku.sample;

import static org.junit.jupiter.api.Assertions.*;

import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;

/**
 * JUnitテストクラス: パッケージ名が同じなのでインポートしなくてよい
 * @author 作成者の名前
 */
public class JUnitSampleTest {
    /** テスト対象クラス(テスト実行時には必ず１つなのでstaticでよい) */
    private JUnitSample target;

    /**
     * このテストクラスをインスタンス化するときの処理。
     * このメソッドは１度だけ動く
     */
    @BeforeClass
    public static void initClass() {
        // テスト対象クラスをインスタンス化
//      target = new JUnitSample();
    }

    /**
     * controll + spaceでインポートできる。
     * テストを実行する前の準備処理、テストケースが動くたびに動く
     */
    @Before
    public void initTest() {
//      // １５歳に設定しなおす。
//      target.setAge(15);
        target = new JUnitSample(12);
    }

    /**
     * テストケース１：年齢(age)が１５歳に設定されているか確認する。
     */
    @Test
    public void test01() {
        // 警告が出るのでstaticインポートに変更する。
        assertEquals(12, target.getAge());
    }
}

そして、コンストラクタ以外でも年齢の設定を変更できることを確認するテストケースを追加します。

/**
 * テストケース２：年齢を５歳に設定しなおしたときのテスト
 */
@Test
public void test02() {
    target.setAge(5);
    assertEquals(5, target.getAge());
}

関連ページ一覧

Eclipseセットアップ(Windows版)

Eclipse セットアップ(MAC版)

1. Java Install Eclipse〜開発ツールのインストール〜
2. TensorFlow C++環境〜EclipseにCDTをインストール〜
3. Setup OpenGL with Java〜JOGLを使う準備 for Eclipse〜
4. Eclipse Meven 開発手順〜プロジェクトの作成〜
5. Java OpenCV 環境セットアップ(on Mac)
6. Eclipse SceneBuilderを追加する
7. JavaFX SceneBuilder 〜EclipseとSceneBuilder連携~

Java Basic一覧

1. Java Basic Level 1 〜Hello Java〜
2. Java Basic Level2 〜Arithmetic Calculate〜
3. Java Basic Level3 〜About String class〜
4. Java Basic Level 4〜Boolean〜
5. Java Basic Level 5〜If Statement〜
6. Java Basic Summary from Level1 to 5
7. Java Basic Level 6 〜Traning of If statement〜
8. Java Basic Level8 〜How to use for statement〜
9. Java Basic Level 8.5 〜Array〜
10. Java Basic Level 9〜Training of for statement〜
11. Java Basic Level 10 〜While statement 〜
12. Java Basic Swing〜オブジェクト指向〜
13. Java Basic Swing Level 2〜オブジェクト指向2〜
14. サンプル実装〜コンソールゲーム〜
15. Java Basic インターフェース・抽象クラスの作り方
16. Java Basic クラスとは〜Step2_1〜
17. Java Basic JUnit 〜テストスイートの作り方〜

Git関連

1. Java Git clone in Eclipse 〜サンプルの取得〜
2. Eclipse Gitリポジトリの取得 〜GitからソースをPullしよう〜
3. IntelliJ IDEA Git〜Gitリポジトリからクローン〜

JavaFX関連ページ

1. Eclipse SceneBuilderを追加する
2. JavaFX SceneBuilder 〜EclipseとSceneBuilder連携~
3. JavaFX SceneBuilder〜ボタンにメソッドを割り当てるワンポイント〜
4. Java プロコンゲーム 〜見た目の作成(SceneBuilderの使用)〜

ステップアップ関連ページ一覧

1. Java 初めてでも大丈夫〜ステップアッププログラミングのススメ〜
2. ステップアッププログラミング〜Java FxでHelloWorld解説〜
3. Java StepUpPrograming〜JavaFX で四則計算〜
4. Java StepUpPrograming〜JavaFXで画面切り替えを作る1〜
5. Java StepUpPrograming〜JavaFXで画面切り替え2ボタン作成〜
6. Java StepUpPrograming〜JavaFXで画面切り替え3アクション〜
7. Java StepUpPrograming〜JavaFXで画面切り替え4Pane切り替え〜
8. Java StepUpPrograming〜JavaFXで画面切り替え5WebEngine

JavaFX + ND4Jで機械学習準備

1. JavaFX + ND4J〜数学への挑戦1：ND4Jのインストール〜
2. JavaFX + ND4J〜数学への挑戦2: 行列の計算〜
3. Java + ND4J 〜数学への挑戦3: ベクトル(配列)の作成方法〜

オブジェクト指向関連ページ

1. [オブジェクト指向の概念1〜OracleDocのチュートリアル１〜](https://zenryokuservice.com/wp/2019/10/301. /%e3%82%aa%e3%83%96%e3%82%b8%e3%82%a7%e3%82%af%e3%83%88%e6%8c%87%e5%90%91%e3%81%ae%e6%a6%82%e5%bf%b5-%e3%80%9coracledoc%e3%81%ae%e3%83%81%e3%83%a5%e3%83%bc%e3%83%88%e3%83%aa%e3%82%a2%e3%83%ab%ef%bc%91/)
2. オブジェクト指向の概念2〜クラスとは〜

コンソール版のじゃんけんゲームを作成しました。
しかし、とりあえず動く状況なので。。。

これに、細かい部分を作ってしまおうと思います。
まずは、バグ退治です。。。がしかしその前に処理の概要をいかに記載します。

1. プログラムを起動する(Mainクラスのメインメソッド)
2. コマンドで「exe」を入力してエンターキー押下
3. じゃんけんゲームの起動(FirstCls#execute())
4. じゃんけんゲームの入力を待つ
5. 「１〜３」の入力かチェック
6. 乱数を生成し CPUの手とする
7. 両者の勝敗判定を行う

そして、修正した結果(差分)はこちらのリンクで確認できます。

バグのないようですが、じゃんけんゲームの入力時に「１〜３以外の値」が入力された時にMapから値が取得できず。。。
playerの手がnullになります。そして、処理は次へ行ってしまうので、「？？？」となります。

具体的なコードは下の部分です。
メインメソッドは下の部分で、FirstCls#handleInput()を呼び出しています。
【Mainクラス】

public class Main {
    public static void main(String[] args) {
        Scanner scan = new Scanner(System.in);
        String input = scan.next();

        FirstCls first = new FirstCls();
        if ("exe".equals(input)) {
            first.execute(scan);
        }
        boolean isNumber = first.isNumberString(input);
        if (isNumber) {
            System.out.println(input + "は数字です。");
        } else {
            System.out.println(input + "は数字ではありません。");
        }
    }
}

FirstCls#execute()でじゃんけんゲームが開始されます。

【FirstClsクラス】

public void handleInput(String input) {
    System.out.println("入力値: " + input);
    if (isNumberString(input)) {
        System.out.println(input + "は、数字です");
    } else {
        System.out.println(input + "は、数字ではありません");
    }
}

クラス名がリンクになっていますが、これはGithubへのリンクになります。

修正する(修正内容)

修正方法としては、チェック処理を入れてやります。
そして「クラスの使い方」という観点から、チェッククラスを作成します。

余計な音が履いていますが、これを作成した時の動画です。

ここで追加した実装はCheckUtilクラスです。
このクラスは、実装の過程で、メソッドが増えていきましたが、まぁそんなもんでしょう。

ちなみに、このクラスのメソッドは、全て「静的メソッド」と呼ばれるメソッドです。
呼び出す時にクラス名.メソッド名という形で、呼び出します。

チェック処理

このチェック処理のポイントはズバリ「正規表現」です。
使用している以下の正規表現は0〜9の文字にマッチするのであればTRUEを変えす(そうでなければFALSEを返す)メソッドを使用しています。
そして、同じ名前のメソッドがあります。並べてみると違いが一目瞭然です。

public static boolean isNumber(String numberStr) {};
public static boolean isNumber(String numberStr, String range) {};

そして、Stringクラスにあるメソッドを使用しています。この引数に渡す文字列が「正規表現」であり、このメソッドの返り値が判定結果になります。

numberStr.matches(range)

オーバーロード

上のような実装のことを「メソッドのオーバーロード」と言います。親クラスのメソッドを上書きする「オーバーライド」とこんがらないように気をつけてください。

処理の内容に関してですが
・引数が１つのメソッドは単純に「数字の入力かチェック」
・引数が２つのメソッドは、数字の範囲を指定してチェック」
というように、処理の内容が若干違います。

初めに「0-9の入力(数値入力)チェック」を作成したのですが、じゃんけんで使用するのは1〜３までだけではないか。。。と気がついたので、数字入力チェックに「範囲」を追加しました。

public class CheckUtil {
    /** 0-9(数字)判定をする時の正規表現 */
    public static final String REGREX = "[0-9]";

    /** 1-3までの判定に使用する正規表現 */
    public static final String REG_1_TO_3 = "[1-3]";

    /**
     * 必須入力チェック、第二引数にあう正規表現でのチェックを行う
     * 
     * @param numberStr 検証する文字列
     * @param range 判定用の正規表現
     * @return true: 正規表現にマッチ false: マッチしない
     */
    public static boolean isNumber(String numberStr, String range) {
        // 正規表現で判定します。数字のrangeに当てはまる時にtrue
        if (isEmpty(numberStr) && numberStr.length() != 1) {
            return false;
        }
        if (numberStr.matches(range)) {
            return true;
        }
        return false;   }
    /**
     * 引数の１文字が数字かどうかの判定をする。。
     * 
     * @param numberStr
     * @return true: 引数が0-9 false: 0-9ではない
     */
    public static boolean isNumber(String numberStr) {
        // 正規表現で判定します。数字の0-9に当てはまる時にtrue
        if (isEmpty(numberStr) && numberStr.length() != 1) {
            return false;
        }
        if (numberStr.matches("[0-9]")) {
            return true;
        }
        return false;
    }

    /**
     * 引数に渡した文字列が、Null、またはから文字("")
     * @param str 判定する文字列
     * @return ture; 
     */
    public static boolean isEmpty(String str) {
        if (str == null || "".equals(str)) {
            return true;
        }
        return false;
    }
}

ちなみに、静的メソッドは、static修飾子をつけて実装します。インスタンスを生成しないので、メモリの節約になりますが、作りすぎると余計な負担(メモリ使用)になるので注意です。

まとめ

今までに作成したクラスFirstClsでの処理を修正しました。
くどいようですが、Mainメソッドは修正していません。

そして、追加したCheckUtilクラスはチェック担当のクラスです。

なので、このクラスにはチェック処理しか追加しません。

関連ページ一覧

Eclipse セットアップ

1. Java Install Eclipse〜開発ツールのインストール〜
2. TensorFlow C++環境〜EclipseにCDTをインストール〜
3. Setup OpenGL with Java〜JOGLを使う準備 for Eclipse〜
4. Eclipse Meven 開発手順〜プロジェクトの作成〜
5. Java OpenCV 環境セットアップ(on Mac)
6. Eclipse SceneBuilderを追加する
7. JavaFX SceneBuilder 〜EclipseとSceneBuilder連携~

Java Basic一覧

1. Java Basic Level 1 〜Hello Java〜
2. Java Basic Level2 〜Arithmetic Calculate〜
3. Java Basic Level3 〜About String class〜
4. Java Basic Level 4〜Boolean〜
5. Java Basic Level 5〜If Statement〜
6. Java Basic Summary from Level1 to 5
7. Java Basic Level 6 〜Traning of If statement〜
8. Java Basic Level8 〜How to use for statement〜
9. Java Basic Level 8.5 〜Array〜
10. Java Basic Level 9〜Training of for statement〜
11. Java Basic Level 10 〜While statement 〜
12. Java Basic Swing〜オブジェクト指向〜
13. Java Basic Swing Level 2〜オブジェクト指向2〜
14. サンプル実装〜コンソールゲーム〜
15. Java Basic インターフェース・抽象クラスの作り方
16. Java Basic クラスとは〜Step2_1〜
17. Java Basic JUnit 〜テストスイートの作り方〜

Git関連

1. Java Git clone in Eclipse 〜サンプルの取得〜
2. Eclipse Gitリポジトリの取得 〜GitからソースをPullしよう〜
3. IntelliJ IDEA Git〜Gitリポジトリからクローン〜

JavaFX関連ページ

1. Eclipse SceneBuilderを追加する
2. JavaFX SceneBuilder 〜EclipseとSceneBuilder連携~
3. JavaFX SceneBuilder〜ボタンにメソッドを割り当てるワンポイント〜
4. Java プロコンゲーム 〜見た目の作成(SceneBuilderの使用)〜

ステップアップ関連ページ一覧

1. Java 初めてでも大丈夫〜ステップアッププログラミングのススメ〜
2. ステップアッププログラミング〜Java FxでHelloWorld解説〜
3. Java StepUpPrograming〜JavaFX で四則計算〜
4. Java StepUpPrograming〜JavaFXで画面切り替えを作る1〜
5. Java StepUpPrograming〜JavaFXで画面切り替え2ボタン作成〜
6. Java StepUpPrograming〜JavaFXで画面切り替え3アクション〜
7. Java StepUpPrograming〜JavaFXで画面切り替え4Pane切り替え〜
8. Java StepUpPrograming〜JavaFXで画面切り替え5WebEngine

JavaFX + ND4Jで機械学習準備

1. JavaFX + ND4J〜数学への挑戦1：ND4Jのインストール〜
2. JavaFX + ND4J〜数学への挑戦2: 行列の計算〜
3. Java + ND4J 〜数学への挑戦3: ベクトル(配列)の作成方法〜

クラスを使用すると

メインメソッドを変更しなくても処理を変更できます。

具体的に、下のようにやります。
以前作成したメインメソッド

public class Main {
    public static void main(String[] args) {
        Scanner scan = new Scanner(System.in);
        String input = scan.next();

        FirstCls first = new FirstCls();
        boolean isNumber = first.isNumberString(input);
        if (isNumber) {
            System.out.println(input + "は数字です。");
        } else {
            System.out.println(input + "は数字ではありません。");
        }
    }
}

このクラスから呼び出しているFirstClsを修正してやれば、Mainクラスは修正する必要がありません。

なんか「とんち」のような話ですが(笑)

応用レベル１

現段階では、応用幅が小さいのでMainメソッドを修正します。

public class Main {
    public static void main(String[] args) {
        Scanner scan = new Scanner(System.in);
        String input = scan.next();

        FirstCls first = new FirstCls();
        if ("exe".equals(input)) {
            first.execute();
        }
        boolean isNumber = first.isNumberString(input);
        if (isNumber) {
            System.out.println(input + "は数字です。");
        } else {
            System.out.println(input + "は数字ではありません。");
        }
    }
}

FirstClsのexecuteメソッドを起動するように修正しました。

クラスに処理を追加する

はじめの入力で「exe」と入力するとFirdtClsのexecuteメソッドが起動します。

単純に、FirstClsの中に、適当な処理を実装しただけです。

public void execute(Scanner scan) {
    System.out.println("*** EXECUTEを起動します ***");
    Map<String, String> map = new HashMaplt;>();
    map.put("test", "Testing this program!");
    map.put("prac", "Practice this program!");
    map.put("try", "Try this program!");
    while(true) {
        System.out.print("コマンドを入力してください: ");
        String str = scan.next();
        if (map.containsKey(str) == false) {
            break;
        }
        System.out.println(map.get(str));
    }
}

今回は、Mapインターフェースを使用して見ました。
キーと値がセットになって、データの取り出し、保存を行うことができます。
ここで言う保存はJavaが起動している間だけの保存です。

このままでは、大した発展があったようには思えませんので、一捻り加えます。ちなみに、execute()の処理が終わった後に、何かしらの文言が出ます。

一捻り

単純ですが、FirstClsにあるメソッドisNumberString()を呼び出すように修正します。

public void execute(Scanner scan) {
    System.out.println("*** EXECUTEを起動します ***");
    Map<String, String> map = new HashMap<>();
    map.put("test", "Testing this program!");
    map.put("prac", "Practice this program!");
    map.put("try", "Try this program!");
    while(true) {
        System.out.print("コマンドを入力してください: ");
        String str = scan.next();
        if (map.containsKey(str) == false) {
            break;
        }
        isNumberString(str);
        System.out.println(map.get(str));
    }
}

こんな感じです。
今日のところは、ここまでにしておきます。

でわでわ。。。

前回は、クラスを作成してそれを撃とかして見ました。

しかし、コードと説明だけで実行していませんでした。今回は、それを実行してみようと思います。

前回やったこと

メインメソッドがプログラムの起動する主軸になります。

public class Main {
    public static void main(String[] args) {
        Scanner scan = new Scanner(System.in);
        String input = scan.next();

        FirstCls first = new FirstCls();
        first.handleInput(input);
    }
}

この処理は、標準入力を受け付け、受け取った文字列をFirstClsのメソッドhandleInput()に渡しています。

String[] args -> プログラム引数
System.in -> 標準入力
System.out -> 標準出力

これを下のような書き方で表現できます。
「FirstCls#handleInput()に受け取った文字列を渡す」

実際に作成したFirstClsの内容は以下のようになっています。

public class FirstCls {

    public void handleInput(String input) {
        System.out.println("入力値: " + input);
        if (isNumberString(input)) {
            System.out.println(input + "は、数字です");
        } else {
            System.out.println(input + "は、数字ではありません");
        }
    }

    public boolean isNumberString(String str) {
        // [0-9]は正規表現と言います。
        boolean isNumber = str.matches("[0-9]");
        return isNumber;
    }

    /** 使用しないので下のアノテーションをつける */
    @Deprecated
    public void printSomething(String[] args) {
        //  プログラム引数に値があるときは表示する
        if (args.length != 0) {
            for (int i = 0; i < args.length; i++) {
                System.out.println("プログラム引数[" + i + "]: " + args[i]);
            }
        }
        System.out.println("1 + 1 = " + (1 + 1));
    }
}

呼び出しているメソッドはhandleInputなので、他のメソッドは関係ありません。(影響がありません)

なので、今回は、別のメソッドを呼び出すように変えて見ました。

処理概要

Mainクラス=メインメソッドのあるクラス
FirstCls=入力値を操作するクラス

1. 標準入力を受ける
2. 入力値に対して何かしらの処理をする
   ※今回は、入力値が数字かどうか判定する処理

【FirstClsクラスについて】
このクラスには、複数のメソッドを実装しているが、必要なものは使用する。必要ないものは使用しない。
つまり、処理を実装するためのクラスです。

【クラス構成について】
・Mainクラスは、Mainメソッドを起動するためのクラス
・FirstClsクラスは、処理を実装するためのクラス

この実装に対して、処理の結果を変更したいのであれば、FirstCls#handleInput()を修正すれば良いのです。

処理詳細

【メインメソッド】

// 標準入力を受け取る準備
Scanner scan = new Scanner(System.in);
// 標準入力受付と受け取り
String input = scan.next();
// FirstClsのインスタンスを生成
FirstCls first = new FirstCls();
// FirstCls#handleInput()を呼び出す
first.handleInput(input);

// 処理終了

【FirstCls】
実装したメソッドのうち「isNumberString」と「handleInput」を使用しています。

ポイント

クラスといっても結局はメソッド呼び出しを行なっているのと変わりません。
なので、下のようにメソッドを呼び出すのも、クラスのインスタンスを取得してメソッドを呼び出すのも大した違いはありません。
【パターンA】: FirstCls#isNumberString()を使用する

public static void main(String[] args) {
    Scanner scan = new Scanner(System.in);
    String input = scan.next();

    FirstCls first = new FirstCls();
    boolean isNumber = first.isNumberString(input);
    if (isNumber) {
        System.out.println(input + "は数字です。");
    } else {
        System.out.println(input + "は数字ではありません。");
    }
}

【パターンB】: FirstCls#isNumberString()に実装してある処理をここでも実装する

public static void main(String[] args) {
    Scanner scan = new Scanner(System.in);
    String input = scan.next();

    FirstCls first = new FirstCls();
    boolean isNumber = input.matches("[0-9]{1,}");
    if (isNumber) {
        System.out.println(input + "は数字です。");
    } else {
        System.out.println(input + "は数字ではありません。");
    }
}

このように、「クラス」と言うオブジェクトの中に様々な処理を実装して、インスタンスを取得すれば、その処理を呼び出すことができます。

インスタンスを取得しなくても、呼び出す方法がありますが、それはまた別の機会にしましょう。
ちなみに、それは「静的呼び出し」といいstatic修飾子を使用します。

ちなみに、このコードにはバグがあります。それはどこでしょうか？
=> 入力した文字列が複数の場合、想定と違う結果が返ってくる
とりあえずは、こんなところで。。。

でわでわ。。。