目次

はじめに

対象読者
利用バージョン
本書の読み方
免責事項
表記関連について

第1章 Visual Studio Code の導入

1.1 Visual Studio Codeのインストール
1.2 Java開発環境の整備

第2章 Javaアプリケーションの作成と実行

2.1 プロジェクトを作成する
2.2 利用するJavaバージョンを変更する
2.3 アプリケーションを実装する
2.4 アプリケーションを実行する

第3章 Java 開発の準備

3.1 文字エンコードと改行コードを設定する
3.2 コードフォーマッタを設定する
3.3 静的チェックを設定する
3.4 Mavenを設定する
3.5 新規プロジェクトを作成する
3.6 既存プロジェクトをインポートする
3.7 プロジェクトにJavaファイルを追加する
3.8 プロジェクトをビルドする
3.9 プロジェクト内のアプリケーションを実行する

第4章 Java 開発の実践

4.1 クラス、メソッド、変数の定義を表示する
4.2 クラスやメソッドなどの利用箇所を特定する
4.3 クラスの型階層を確認する
4.4 簡単なリファクタリングを実施する
4.5 ライブラリーを自動編成する
4.6 フィールドアクセッサなどを作成する
4.7 コメントアウトを適用する、解除する
4.8 キャメルケース/スネークケースを相互変換する
4.9 ファイルのアウトラインを表示する
4.10 ワークスペース内を検索する
4.11 プロパティーファイルを編集する
4.12 JUnitテストケースを作成して実行する
4.13 JUnit実行時のカバレッジを確認する
4.14 実行時の設定を実行構成として作成する
4.15 実行構成を保存、配布する
4.16 デバッグ実行する
4.17 Tomcatにデプロイして実行する

第5章 基本的な操作

5.1 表示しているエディターを全て閉じる
5.2 エディターウィンドウの幅ですぐに折り返しする
5.3 マルチカーソルで文字列を一括編集する

付録A その他

A.1 Visual Studio Codeの初期化
A.2 設定ファイルの格納場所
A.3 複数の環境でSettings.jsonを共有する
A.4 検索結果を分かりやすくする
A.5 検索機能の注意点 1
A.6 検索機能の注意点 2
A.7 本誌で利用した拡張機能一覧
A.8 便利な拡張機能の紹介

あとがき

謝辞

はじめに

 本書は、Java 開発を行う際に、Eclipse で利用してきた機能や操作を、Visual Studio Code でどうすればできるのかを解決する入門書です。

 開発者にとって、今まで慣れ親しんだエディターや IDE という道具を変えることは、非常に抵抗があることです。操作や設定方法を覚えなおすだけではなく、今まで使っていた IDE では簡単にできるのに、新しい IDE ではどうすれば良いのか、というストレスを解消するのは容易ではありません。

 筆者は、長年 Java 開発に Pleiades All in One Eclipse 1 を愛用してきました。しかし、昨今の開発では Java 以外の言語で開発する機会も増えてきており Visual Studio Code 2を選択するケースがあります。「IDE を切り替えるのが面倒だから一本化したい」という思いから、Java 開発に Visual Studio Code を利用してみることにしました。しかし、当然ながら、やりたい開発とは別に、IDE の操作や設定を調べるということにハマり、非常に多くの時間を浪費することになります。今後、同じ境遇にあう方々がいらっしゃると思いますので、そのナレッジをできるだけ共有し、無駄な時間を過ごさないようにできたらと考えています。また、IDE の選択肢として Visual Studio Code が Java 開発の実用レベルに到達しているか、本書を通して判断して頂く一助になれば幸いです。

対象読者

 ・Eclipse で開発を行っている Java 開発者

 ・Visual Studio Code 初心者

利用バージョン

 ・Pleiades All in One : Eclipse 2021(リリース 2021-06)

 ・Visual Studio Code : 1.59.0

本書の読み方

 本書では、Visual Studio Code の初期設定、および Java 開発環境の準備を行った後、実際の開発ユースケースに従って Eclipse と Visual Studio Code の設定や操作を説明していきます。Visual Studio Code 自体のインストールや基本的なことについては、本書の目的上、必要最低限しか説明しませんが、Visual Studio Code で初めて開発する場合は、順を追って読み進めることをお勧めします。既に Visual Studio Code を導入している場合は、辞書的な使い方も想定しております。読者の用途に合わせてお使いいただけたらと思います。


 表記方法について、以下の通りとします。

 ・図のキャプションでは、"Visual Studio Code" を "VSCode" と表記する

 ・"Pleiades All in One Eclipse" を "Eclipse" として表記する

 ・複数の操作が存在する場合は、番号なしリストで表記する

 ・手順を示す場合は、番号付きリストで表記する

免責事項

 ・本書の内容は、2021年8月現在のものを掲載しているため、記載された内容は予告なく変更される場合があります

 ・本書を用いた開発、製作、運用、およびその結果について、著者や関係者はいかなる責任も負いません

 ・本書に記載されているサンプルプログラムやスクリプト、および画面イメージなどは、特定の設定に基づいた環境にて再現される一例です

 ・本書の編集上の間違い、欠落について、著者や関係者はいかなる責任も負いません

表記関連について

本書に記載されている会社名、製品名などは、一般に各社の商標登録または商標、商品名です。会社名、製品名については、本文中では©、®、™マークなどは表示していません。

1. Pleiades All in One Eclipse : https://mergedoc.osdn.jp/

2. Visual Studio Code : https://code.visualstudio.com/

第1章 Visual Studio Code の導入

 本章では、Visual Studio Codeをインストールし、最低限のJava開発環境を整えることを目的とします。また、Visual Studio Codeで覚えておくべき基本的な概念や操作方法について、あわせて説明をします。本書では、Windows 10の環境を前提としています。

1.1 Visual Studio Codeのインストール

 Visual Studio Codeをインストールして、日本語化を行います。

1.1.1 インストール

 WebブラウザーからVisual Studio Codeの公式ページ 1 にアクセスし、右上の "Download" ボタンを押下して、自分の環境に応じたインストーラーをダウンロードしてインストールします。インストール後、Visual Studio Codeを起動するとWelcome画面が起動します。

図1.1: Visual Studio Code の公式ページ
図1.2: ダウンロードページ
図1.3: Welcome 画面

codeコマンドで素早く起動する

 Visual Studio Codeをインストールすると環境変数のパスに "C:\Program Files\Microsoft VS Code\bin" が追加されます。コマンドプロンプト、ターミナル、ファイル名を指定して実行(Windowsキー + R) から "code" コマンドでVisual Studio Codeを起動することができます。

1.1.2 日本語化

 "Ctrl + Shift + P" または、上部のメニューから[View]→[Command Palette...]を選択し、"Configure Display Language" と入力します。"en" と "Install additional languages..." が表示されるので、"Install additional languages" を選択します。

図1.4: 日本語化パック選択画面

 "Japanese Language Pack for Visual Studio Code" を選択し〔Install〕ボタンを押下します。右下に通知ポップアップが表示されるので、〔Restart〕ボタンを押下します。再起動を促す通知が出てこない場合や、通知を誤って消した場合は、Visual Studio Codeを再起動すれば、日本語化が反映されます。

図1.5: 日本語化パック適用後の起動画面

1.2 Java開発環境の整備

 Visual Studio CodeでJava開発ができる環境を整えます。以下では、マニュアルで自環境への構築をしていますが、公式ドキュメントを見ながら導入してもいいかと思いますので、Visual Studio Codeのドキュメント "Java in Visual Studio Code" 2 も参照してみてください。

1.2.1 JDKのインストール

ゴール

 ・コマンドプロンプトで "java -version" でJavaのバージョン情報が表示されること

 ・環境変数に "JAVA_HOME" が設定されていること

設定方法

 Pleiades All in One EclipseのFull Editionを利用している場合、複数バージョンのJDKが同梱されており、わざわざ自環境にJDKをインストールするという手間が省かれて重宝しておりましたが、Visual Studio Codeでは、自分でJDKをインストールする必要があります。

 Visual Studio Code で Java を利用するためには、JDK 11以上をインストールする必要 3 があるので注意してください。JDKインストールについては、これ以上の説明はしませんが、以下のJDKをインストールしたとして話を進めます。

 ・AdoptOpenJDK → OpenJDK 11 (LTS) + HotSpot

 ・インストールパス(デフォルト): "%PROGRAMFILES%\AdoptOpenJDK\jdk-11.0.10.9-hotspot"

 AdoptOpenJDK 4 をインストールした場合は、OSの環境変数であるPathの先頭にJDKをインストールしたディレクトリー+ binのパスが自動的に追加されます。コマンドプロンプトで以下が表示されることを確認します。

> java -version

openjdk version "11.0.10" 2021-01-19

OpenJDK Runtime Environment AdoptOpenJDK (build 11.0.10+9)

OpenJDK 64-Bit Server VM AdoptOpenJDK (build 11.0.10+9, mixed mode)

 次に、環境変数 "JAVA_HOME" を設定します。Windowsの場合は、設定画面を表示する方法は様々ありますが、"Windowsキー + S" で表示される検索画面に "環境変数" と入力すると "システム環境変数の編集" という検索結果が表示されるので、すぐに[システムのプロパティ]画面を表示することができます。[システムのプロパティ]画面の右下にある〔環境変数〕ボタンを押下することで、環境変数の設定画面を表示することができます。ユーザー環境変数でもシステム環境変数でもいいので、"JAVA_HOME"という変数に、"%PROGRAMFILES%\AdoptOpenJDK\jdk-11.0.10.9-hotspot" の値を設定します。

 コマンドプロンプトで以下が表示されることを確認します。コマンドプロンプトは、設定変更後に必ず立ち上げなおしてください。

> echo %JAVA_HOME%

C:\Program Files\AdoptOpenJDK\jdk-11.0.10.9-hotspot


JDKをインストールせずに利用する

 複数バージョンのJDKを切り替えて利用したい場合や、Windows自体にJDKをインストールしたくない場合があります。インストーラー付きのJDKではなく、圧縮ファイル形式で提供されているJDKを利用します。圧縮ファイルを解凍し後、JAVA_HOMEとパスの設定をするだけで、Javaを利用することができます。Pleiades All in One Eclipseは、複数バージョンのJDKを同梱して配布されており、複数のJDKバージョンを一括して入手することができ、非常に便利です。

1.2.2 Java Extension Packのインストール

ゴール

 ・Java Extension Packがインストールされていること

設定方法

 "Java Extension Pack" をインストールすることで、Java開発に必要な数種類の拡張機能が同時にインストールされます。ここでは詳細について割愛しますが、Java言語サポート、デバッガ、テスト実行、Maven実行、入力補助などの機能が追加されます。

 Visual Studio Codeの左にあるアクティビティーバーから"拡張機能"を選択し、"Marketplaceで拡張機能を検索する" 部分に "java extension pack" と入力し、表示された "Java Extension Pack" を選択し〔Install〕ボタンを押下します。Visual Studio Codeの再起動は必要なくインストールされますが、設定項目が出てこない場合などは、一度、Visual Studio Codeを再起動してみてください。

図1.6: Java Extension Pack選択画面

 インストールしたJDKで問題ない場合は、以降の説明は読み飛ばしても構いません。

 JDKのバージョンに応じて、利用するJDKを変更したい場合、以下の手順で設定することができます。

 〔歯車マーク〕ボタン →[設定]メニュー、または "Ctrl + ," から[設定]画面を表示します。[設定の検索]に "java.configuration.runtimes" と入力し[Java>Configuration:Runtimes]項目を表示します。"settings.json で編集" を押下すると、settings.json ファイルを編集する画面になるので、以下の通りsettings.jsonを編集します。設定したいJDKのバージョン毎にJDKのパスを入力していきます。name属性はsettings.jsonで指定できる値が決まっているため、自由に設定することはできません。

リスト1.1: settings.json

 1: "java.configuration.runtimes": [
 2:   {
 3:     "name": "JavaSE-1.8",
 4:     "path": "C:\\path\\to\jdk-8",
 5:   },
 6:   {
 7:     "name": "JavaSE-11",
 8:     "path": "C:\\path\\to\jdk-11",
 9:   },
10:   {
11:     "name": "JavaSE-15",
12:     "path": "C:\\path\\to\jdk-15",
13:     "default": true
14:   },
15: ]

 Windows環境の場合、設定ファイルであるsettings.jsonは "%APPDATA%\Code\User" に格納されており、直接修正することも可能ですが、設定内容の補完が効くため、慣れるまでは、Visual Studio Codeの設定から編集することをお勧めします。

Visual Studio Codeに設定が反映されない場合

 Java開発をしている場合に、設定したJDK情報を削除したにも関わらず、変更されない場合があります。"%APPDATA%\Code\User\workspaceStorage" に利用したJavaプロジェクトの情報が保持されているためです。配下の各ディレクトリー内のworkspace.json内で初期化したいフォルダー設定が入っているディレクトリーを見つけ、対象フォルダーを削除することでJDK情報をリセットできます。

1. Visual Studio Code Home : https://code.visualstudio.com/

2. https://code.visualstudio.com/docs/languages/java

3. https://github.com/redhat-developer/vscode-java/wiki

4. AdoptOpenJDK : https://adoptopenjdk.net/



第2章 Javaアプリケーションの作成と実行

 本章では、前章で作成した環境で、簡単なJavaアプリケーションの作成と実行を通して、最低限ではありますが、基本的な操作方法を説明します。

 作成するアプリケーションは、現在のシステムプロパティーを表示する簡単なアプリケーションとなります。

2.1 プロジェクトを作成する

 Mavenを利用して、Javaプロジェクトを作成していきます。

 画面上に表示されている "Create Java Project" を押下するか、"Ctrl + Shift + P" → "create java project" と入力することで、Javaプロジェクトを作成するメニューが表示されますので、今回は以下の通り選択し、入力していきます。

図2.1: Create Java Project押下後

 1.選択 : Maven create from archetype

 2.選択 : maven-archetype-quickstart

 3.選択 : 1.4

 4.入力 : groupId : "com.example" を入力

 5.入力 : artifactId : "exam01" を入力

 6.選択 : Mavenで生成した雛形プロジェクトを出力するディレクトリーを指定(本例では"D:\temp\vscode_java_exam" ディレクトリーを作成して指定)

 7.Terminal画面が開き、Maven実行に必要なライブラリーの自動ダウンロード 1 が開始

 8.入力 : version : リターン(入力なし)

 9.入力 : "y" を入力

 これで、Mavenが作成したJavaプロジェクトが、指定したディレクトリー配下に作成されます。プロジェクト作成完了と同時に、作成されたプロジェクトを開くための "通知ウィンドウ" が表示されるので〔Open〕を押下します。通知ウィンドウは、時間が経つと消えてしまいますが、下部の通知マーク(ベルの形)を押下することで、再表示することができます。また、「このフォルダー内のファイルの作成者を信用しますか?」というダイアログが表示されますが、自分で作成したフォルダーですので〔はい、作成者を信頼します〕を押下します。

図2.2: maven-archetype-quickstartを選択
図2.3: 1.4を選択
図2.4: Group Idを入力
図2.5: Artifact Idを入力
図2.6: Maven Project作成準備完了
図2.7: Maven Project作成完了
図2.8: 作成したMaven ProjectをOpen

 [エクスプローラ]の[JAVA PROJECTS]から "App.java" を選択し、実行します。8行目, 9行目のmainメソッドの上部に表示される〔Run | Debug〕の〔Run〕ボタンを押下するか、"exam01" にマウスポインタを近づけると〔Run〕ボタンが表示されるので、押下します。雛形として生成されたプロジェクトが実行されて、ターミナル画面に "Hello World!" が表示されます。

図2.9: JAVA PROJECTSを開き、App.javaを表示
図2.10: App.java実行画面

 ここまでで、雛形プロジェクトを作成し、実行するところまでできるようになりました。次は、アプリケーションに手を加えていきます。

試し読みはここまでです。
この続きは、製品版でお楽しみください。