🐠

PayaraアプリケーションをDocker&VSCodeで開発する

2023/09/01に公開

背景

Payaraの環境を触ることがあったので、VSCode & Dockerを使った開発手順をメモ📝

前提条件

  • Payara6系はPayara Tools(VSCodeのExtension)が対応していないので、ここではPayara5系で試している🐟
  • この記事はmacOS環境下で動かしている🍎

できること

  • VSCodeからDocker/Remote環境で立ち上がったサーバーにデプロイ
  • VSCode上で実装
  • ブレークポイントを張ったデバック

手順

1. PayaraのExtension(Payara Tools)をVSCodeにインストールする

Payara Tools

2. Payara Tools上のServerに起動するサーバーの設定を追加する

1. +ボタンを押す

2. Remote Domainを選択する

(ローカルマシン内で直接Payara Serverを起動する場合はLocal Domainを選択する)

3. Defaultを選択

4. unique nameを入力

ここで入力した値がServersの一覧に表示されます。
他と重複しなければなんでもOK

5. ドメイン名を入力

Payara起動時に指定する値。
初期値は domain1 なのでここではそれを入力

6. ホスト名を入力。ローカルで起動するDockerなので、localhostと入力

7. admin portとhttp portを入力。変えてなければそのままyes

8. usernameとpassを入力

9. 入力が完了後、Server一覧に追加されていることを確認する

※ 一度unique名で追加をした後、値をServer一覧から設定を消してもVSCode上に残っているのか、値が反映されないことがあるので注意。
その場合は別のunique名で値を追加するか、消去した後VSCodeを立ち上げ直すとハマらない。

4. Dockerを起動する

FROM payara/server-full:5.2022.5-jdk11

ENV PAYARA_ARGS --debug
ENV HOME_DIR=/opt/payara
USER root
RUN apt update
RUN apt install maven -y
ENV MAVEN_HOME /usr/share/maven
ENV PATH $PATH:/usr/share/maven/bin
docker build -t payara-dev .
docker run --platform linux/amd64 \
 -p 4848:4848 \
 -p 8080:8080 \
 -v $PWD:/opt/payara/deployments \
 payara-dev

5. ビルド&デプロイ

mvn clean, installを実行する

.warを選択してデプロイ


6. ブラウザでアクセス

http://localhost:8080/demo/api/hello

7. デバッグ

VSCodeでbreakpointを設定すると、コールした時にそこで止まります。

まとめ

昔からあるフレームワークでもVSCodeのExtensionが開発されており、デバッグ実行も含めた開発ができるようになっていました。
JetbrainsのIDEでもPluginがあったので、好みによって使い分けできそうですね🕺

レスキューナウテックブログ

Discussion