LoginSignup
1
2

More than 1 year has passed since last update.

@kami_teru(Atsuteru Kamiya)inピープルソフトウェア株式会社

【超初心者向け】VSCodeでJAX-RS(Grizzly&Jersey)の開発を超速ではじめる(Windows10版)

Last updated at Posted at 2021-12-17

最速の手順を追い求めてみました。

想定する対象読者は、【超初心者向け】とある通り、
「プログラムをこれから学ぶひと」や「JAX-RSは初めのひと」です。
画像多めです。

はじめに

Java言語でも、サクっとWebサービスの開発を始められるんだよというのを伝えたくて、やり方をまとめました。
「超速ではじめる」と題しましたが、テストの実行までをカバーした実用的な内容を心掛けたつもりです。

なお、以下の手順はWindows 10 Enterprise LTSC (Build 19041.vb_release.191206-1406) の 標準ユーザー で確認しました。

本編

1. VSCodeのインストール

これがなきゃ始まりません。ということで以下からダウンロードしてインストールします。

ここからダウンロード。
※特にこだわりなければ、User 64bit で良いと思います。
Download Visual Studio Code

この記事の時点では、 VSCodeUserSetup-x64-1.6.2.exe がダウンロードされました。

続けてこれを起動し、VSCodeをインストールしましょう。
インストールはすべてデフォルトの設定で構いませんが、私は以下を追加でチェックしました（あとで便利なので）。

  • ✅ エクスプローラーのファイル コンテキスト メニューに [Codeで開く] アクションを追加する
  • ✅ エクスプローラーのディレクトリ コンテキスト メニューに [Codeで開く] アクションを追加する

インストール後、起動するとこんな感じです。

image.png

画面右下に視点を。
「表示言語を日本語に変更するには・・・」と親切に教えてくれていますね！
「インストールして再起動」ボタンを押しちゃいましょう。

するとこんな感じ。
image.png

これでとりあえず VSCodeのインストールができました。

2. VSCodeに Extension Pack for Java 拡張を追加

画面右端のメニューから、 拡張機能 を表示しましょう。
image.png

検索欄に、Extension Pack for Javaを入力します。
検索結果から、同名で、かつ Microsoft 提供のものを選択。

image.png

「インストール」ボタンを押してインストールします。

インストールが終わると、こんな画面が出ますので、ここからJDKをインストールしましょう。
image.png

「Install a New JDK」ボタンをクリック。
すると選択肢が表示されるので、17 (LTS) hotspot が選択されていることを確認し、「Download」をクリック。
image.png

するとインストーラがダウンロードされます。
私の場合、OpenJDK17U-jdk_x64_windows_hotspot_17.0.1_12.msi がダウンロードされました。
ではこれを起動してインストールしましょう。
※標準ユーザーの場合、ここで管理者ユーザーのパスワードが必要です！
※管理者ユーザーのパスワードを得られない場合、他のやり方があります。が、この記事では触れません。超速なので。

インストール時、次の１点だけ、設定を変更してください。

  • Set JAVA_HOME variable を ローカル ハード ドライブにインストール に変更する

※これを忘れると、次の「JAX-RS(Grizzly&Jersey) のプロジェクトを作成する」でエラーが起きます。

インストールが終わったら、VSCodeを再起動しましょう。

これで Extension Pack for Java拡張 の追加は完了です。
では早速、JAX-RS(Grizzly&Jersey)の開発を始めましょう！

3. JAX-RS(Grizzly&Jersey) のプロジェクトを作成する

VSCodeの「表示」メニューから「コマンドパレット (Ctrl+Shift+P)」を選択します。
入力欄が表示されるので、Mavenと入力。
するとコマンド候補が一覧表示されるので、 Maven: Create Maven Project を選択。
image.png

続けて、Moreを選択。
image.png

続けて、jersey-quickstart-grizzly2 org.glassfish.jersey.arcetypesを選択。
※似たのがあるので、気を付けて！
image.png

続けて、3.0.1 を選択。
image.png

次はこれから作るプロジェクトの「製作者グループのID」を入力。
とりあえずお試しなら、 com.example.あなたのニックネーム的なID でいいと思います。
私は com.example.kami_teru を入力しました。
image.png

次はこれから作るプロジェクトの「製品のID」を入力。
私は hello_slack_bot_service_20211217 を入力しました。 ※slack_botってのは別件でちょうどやっていたので。
image.png

すると次に、フォルダ選択ダイアログが表示されます。
特にこだわりなければ、私は次のパスにしました。　※source\repos\はVisualStudioが自動的に作るフォルダパス。※master\はあとでGitを導入することを想定。
C:\Users\{あなたのユーザー}\source\repos\hello_slack_bot_service_20211217\master
image.png

フォルダを選ぶと、「ターミナル」が表示されてなにやら始まります。
image.png

たくさんのダウンロードが走りますが、これは JAX-RS(Grizzly&Jersey) の開発に必要なライブラリ(jar)をまとめて集めてくれているのです。便利ですね。

しばらくすると、次のような入力待ち状態になります。
これは「製品のバージョン」の入力待ちです。
とりあえずお試しなら、(ターミナルをクリックしてから) Enter を入力します。　※1.0-SNAPSHOTっていう、ベータ版的なバージョンになります。
image.png

次に、最終確認が表示されるので、Yを入力してから Enter を入力します。
image.png

これで、処理が終了します。
視点を画面右下に移すと、「ここにできたよ！」的なダイアログが。親切ですね。「Open」をクリックしましょう。
image.png

すると、作成されたプロジェクトのフォルダが開くのですが、こんなダイアログが出ます。
作成者はこれからの自分なので、信頼してあげましょう。
image.png

これで、JAX-RS(Grizzly&Jersey) のプロジェクトを作成できました。
エクスプローラーパネルでツリーを展開すると、おぉ、いろいろできていますね！
image.png

次は実際に動かしてみましょう。

4. JAX-RS(Grizzly&Jersey) のプロジェクトを実行する

エクスプローラーパネルのJAVA PROJECTS欄から、プロジェクトを実行(Run)できます。
image.png

※このようなセキュリティの警告が出ます。ファイアウォールの設定に関するものなので、今は無視（キャンセル）で構いません。
image.png

するとターミナルに、Jersey app startedとでましたね！
image.png

ではブラウザを立ち上げて、つぎのURLにアクセスしてみてください。
http://localhost:8080/myapp/myresource
image.png

何か表示されましたね！
これは、作成したプロジェクトがテンプレートとして用意している次のソースコードが実行された結果です。

簡単に解説すると...

  • Main.java ・・・ Webサービス(Grizzly HTTP server)を起動。基本URL http://localhost:8080/myapp/を設定。
  • MyResource.java ・・・ URL myresource に対して応答。このクラスのようにして、いろんな処理を実装できる。

です。

実行されたプロジェクトは、ターミナルで Enterキーを打てば停止するように作られています(Main.javaにて)。
停止しておきましょう。

では最後に、テスト機能を紹介しましょう。

5. JAX-RS(Grizzly&Jersey) のプロジェクトをテストする

テスト中パネルを表示すると、既に何かありますね。さっそく実行してみましょう。

image.png

おぉ、成功したようです！
image.png

では何をテストしたのか？ですが、これは次のソースコードに書かれたテストコードが実行されたものです。

  • MyResourceTest.java ・・・ MyResourceソースコードをテストするためのテストコード。

簡単に説明すると、以下のステップをテストコードで実行しています。

  1. Webサービス(Grizzly HTTP server)の起動
  2. URLhttp://localhost:8080/myapp/myresourceにアクセス
  3. アクセス結果を確認
  4. Webサービス(Grizzly HTTP server)の停止

便利ですね！

おわりに

以上で、VSCodeでJAX-RS(Grizzly&Jersey)の開発を超速ではじめる環境が整いました。

Java言語でWebサービスを作るのも、結構簡単だなって思っていただければ幸いです。
色々調べながら、開発を楽しんでください！

2021.12.27 追記

よろしければ以下の続編もご利用ください。

おまけ

Mavenコマンドを使う

学習が進むと Mavenコマンドを実行することもあると思います。
ひとつ設定が必要なので書いておきます。

まずは エクスプローラーパネル のMAVEN欄を開き、 Lifecycle clean を実行してみましょう。
image.png

視点を画面右下に移すと、Maven executable not found in PATHとの情報が。
これが、ひとつ必要な設定です。「Open Settings」をクリックしましょう。
するとMaven executable PATHの入力欄が表示されます。
image.png

ところで実はその Maven executable、既に入っているんですよね。
次のフォルダを開いてください。
C:\Users\{あなたのユーザー}\.m2\wrapper\dists
そこで、mvnを検索してください。次のように、見つかるはずです。
見つかったら、mvnを Shiftキーを押しながら右クリックし、「パスのコピー」を実行しましょう。
image.png

これをさっきの入力欄に貼り付ける・・・のですが、先頭と末尾の "は取り除いてください。
そして再度 Lifecycle clean を実行すると・・・成功しましたね！（ターミナル欄）

image.png

cleanの他にも compile、testなども成功するはずです。
ぜひいろいろ試してみてください。

ところで Maven とか JAX-RS、Grizzly、Jersey、とか ってなにもの？

超ざっくり説明します。
※間違ってはいないと思いますが、誤解を招く表現があればコメントください。。。

Maven(メイブン)

Java開発の便利屋さん。複数のJavaソースやライブラリが絡んだコンパイルをサクっとこなしてくれるだけでなく、皆が開発したライブラリをインターネット上で一元管理してしてもくれてるすごいやつ。

JAX-RS(ジャックス・アールエス)

Java API for RESTful Web Services。 JavaでWebサービスを作るときは、HTTPのメソッド(GET,POST,PUT,DELETE等)をうまく使ってこう作ろうね、を決めた仕様書。実装はない。

Grizzly(グリズリー)

URLからのアクセスを受け付けて処理を行う常駐アプリケーション「サーブレットコンテナ」の実装。つまりWebサーバーアプリケーションたる部分。

Jersey(ジャージー)

JAX-RSに定義された仕様を実装するもののひとつ。つまり RESTful たる部分の実体。

以上。

1
2
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
1
2