どうも皆さん、新卒研修でEclipseが推薦されている中、気分転換でJUnitがVSCodeでの環境構築手順を書いていこうと思います(Eclipseアンチだとかはではないです)
全体の手順としては以下:
1.VSCodeをインストール
2.VSCodeにおけるJava環境の構築
3.Mavenをインストール・構築
4.JUnit4を利用する場合
5.JUnit5を利用する場合
追加:新しいテストファイルを作る手順
1.VSCodeをインストール
まずVSCodeのダウンロードリンクはこちらです:
Download Visual Studio Code - Mac, Linux, Windows
インストールの方法・日本語化の方法についてネットでいろんな記事があるので、割愛します。
VSCodeのインストール方法について解説する【初心者向き】
2.Java環境の構築
・JDKをダウンロード
公式サイトで最新バージョンをダウンロードできます:
Java Downloads | Oracle 日本
私の場合はJDK20をダウンロードしました。(2023.04.12時点)
インストール後、JDKがどこに保存されているかを記録する必要があります。
私の場合、JDKのディレクトリーは:
C:\Program Files\Java\jdk-20
後ほどVSCodeのJava環境構築で、\を/に変える必要がありますが、その時また紹介します。
・Java Extensionをインストール
VSCodeを起動し、左側にあるExtensionsをクリック
Windowsのショットカットは
Ctrl + Shift + X
検索欄に「java」を入力すると、一番最初に出てくるこの「Extension Pack for Java」をインストールしてください。
・VSCodeでJavaの環境設定
続けて、左下の「Manage」のボタンを押して、「Settings」に行きます。
Windowsのショットカットは
Ctrl + ,
サーチ欄に、「java:HOME」を入力し、出てきた画面の下にある「Edit in settings.json」を押して、settings.jsonが開きます。
先ほど記録してもらったJDKの保存先をここに記入します。
パスの\を/に変換することを忘れないでね。
3.Mavenをインストール・構築
・Mavenのダウンロードと保存
Mavenの公式ダウンロードページ:Maven – Download Apache Maven
「Binary zip archive」のところにあるZIPファイルをダウンロードしましょう。
ダウンロードしたら、こんな感じになるかと思います。
ダウンロードに保存するのは個人的にいやなので、管理しやすいため、「apache-maven-3.9.1」フォルダの場所を移動します。私の場合は、
C:\Program Files\maven
に移動しました。
皆さんもダウンロードしたら、このフォルダの位置をメモしておきましょう。
・MAVEN 環境変数の設置
windowsのショットカットで「win+R」を押して、「sysdm.cpl」を入力します。
「OK」あるいはEnterキーを押すと、「システムのプロパティ」の画面に。
この画面の上にある「詳細設定」を選択。
そして「詳細設定」の画面下にある「環境変数」というのを開きます。
「環境変数」画面を開いたら、下方の「新規作成」を選択し、変数名を「MAVEN_HOME」に、変数値は先ほど記録してもらった「apache-maven-3.9.1」のフォルダのディレクトリー。
これで一旦「OK」で、「環境変数」画面に戻ります。続けて、下の「システム環境変数」の中にある「Path」という変数を探してみましょう。見つかったらダブルクリックして開きます。
「新規」を押して、「%MAVEN_HOME%\bin」を入力し、Enterキーを押します。
これでMavenの設定が全部終わりました。お疲れ様です。
・Maven設置がうまく行ったかの確認
Mavenが本当にうまく設置できたかどうかを確認する方法として、cmd(git bashでもいい)を開いて、「mvn -v」のコマンドを打って、以下のようなコードが出てきたらおっけーです。
4.JUnit4を利用する場合
・Mavenによるプロジェクトの作成
Mavenによるプロジェクトの作成は自動的というか、ディフォルト的にJUnit4を使っています。VSCodeを開き、左下の「Manage」ボタンを押して、「Command Palette」を開きましょう。
Windowsのショットカットは
Ctrl+Shift+P
下の画面が出てくると、「Java: Create Java Project…」を検索して選択
この後「Maven」→ 「maven-archetype-quickstart」→「1.4」で選択
「group Id」と「artifact Id」は自身で入力してください。私は「test」と「demo」で今回作ってみます。
どこに保存するかの画面が出てくるので、保存するディレクトリーを選択したら、プロジェクトの作成が始まります。おそらくこんな感じになって、止まってしまうと思いますが、私はシンプルにEnterキーを押して次に進みました。
下の画面になると、「y」を入力して、Enterキーを押します。
プロジェクトの作成は成功し、右に飛んできたメッセージで「Open」をクリック。
そしたら画面がこんな感じになると思います。左側の「EXPLORER」に、新規作成されたJavaプロジェクトを確認することができます。
「src」を見てみると、こんな構造になっていることが確認できます:
以上がJUnit4編でした。お疲れ様です。
5.JUnit5を利用する場合
先ほど作成したプロジェクトをそのままもう少しいじってみましょう。
JUnit5はデフォルトではないので、自分で設置しないといけないので、その過程がやや複雑でここで紹介します。これができると、@Nestedなどのタグが使えるようになるかと思います。
・JUnit5ライブラリーの追加
まず、JUnit5がdemoプロジェクトに使えるために、プロジェクトにJUnit5のライブラリーを追加しないといけません。その手順はこちらです:
まず、左下の「MAVEN」を選択して、中にある「Dependencies」を開きます。
そして右の「+」を押します。
上にサーチ欄が出てくるので、そこに「junit.jupiter」を入力して検索
検索した結果から、「junit-jupiter-api」、「juit-jupiter-engine」、「junit-jupiter-params」を選択します。
選択すると、「pom.xml」というファイルが自動的に開かれます。赤い部分はさっきの操作によって更新された部分、私はさっき「junit-jupiter-api」を選択しましたので、ここに更新されています。
三回分けて一個ずつ入れるしかないのですが、全部終わったら、
「pom.xml」を一旦保存しましょう!(大事)
保存すると、右下にメッセージが飛んできて、素直に「Yes」を選択。実行環境にかかわるファイルがいじられたので、環境をアップデートするかの問い合わせです。
これでJUnit5ライブラリーは準備おっけーです。お疲れ様です。
・新しいテストクラスを作成する手順
まず新しいクラスを作成
上の検索欄に「>」を入れる、あるいはWindowsのショットカット「Ctrl+Shift+P」を使ってこの画面になります。「Java: New Java Class」で検索すると、黄色の選択が出てくると思います。よく使うアクションなので、右の赤の部分にマウスを移動させればショットカットの設定ができると思います。私の場合は「Alt+N」にしました。
クラス名を入力して作成、私は「Pokemon」というクラスを作りました(なんとなく)。クラスの中にコードを適当に書きます。
「Pikachuuuu」を出力するコードになります。(なんとなく×2)
先ほどと同様に、「Java: Go to Test」のアクションを探します。
このクラスは新規作成されてテストがありません。「Tests not found for current file」となりますので、「Generate tests…」しましょう。
そしたら、先JUnit5の設置をしたらここでは選べるはずです。JUnit5にしてみます。
ここのクラスネームは自動で生成されるのでこのまま前進(Enterキー)
先作成された「main」メソッドが出てきました、選択して「OK」!
無事テストクラスが作成されました
以上が全部の内容でした。お疲れ様です。