仕事の関係でJSF(JavaServer Faces)を勉強する必要に迫られ、J2EEの書籍を購入したところ書籍内で使用する統合開発環境(IDE)がNetBeansでした。しかし、使い慣れているIDEも仕事で使うIDEもEclipseなので、Eclipseを使ったJSF開発環境を構築して書籍を勉強をしました。その際の環境構築のメモ書きとなります。

先日も「Eclipse + Payara5によるJSF開発環境の構築手順」の記事を書いたのですが、その時は折角Payara5がJSF v3.0に対応しているのにEclipse設定でJSF v2.2としていました。

今回はEclipse設定を

動的Webモジュールバージョン：v4.0
JSF：v3.0

でプロジェクトを構築するパターンです。 Payara Toolsのバージョンは、上記設定だと、2023/3/19現在の最新版(v2.1.0)ではエラーが起きるので手動でv1.4.3を導入しています。

他バージョンでの構築手順は以下のリンクからご参照下さい。
blog.holyblue.jp blog.holyblue.jp

1. 前提
- 1.1. 環境
- 1.2. 前提
2. 環境構築
3. Eclipse設定
4. Eclipseプロジェクトの作成
- 4.1 動的Webプロジェクトの作成
- 4.2 動的WebプロジェクトをPayara Serverへ登録
5. JSF動作確認
- 5.1 動作確認用プログラムの作成
  - 5.1.1 バッキングビーンの作成
  - 5.1.2 JSFページの作成
- 5.2 JSF動作確認
6. 追加設定
- 6.1 Propertiesファイルを配置する場所の設定
備考
- 「Unable to find CDI BeanManager.」エラーについて
後書き

1. 前提

1.1. 環境

OS : Windows 11
IDE : Pleiades All in One Eclipse 2022-12 Java Full Edition
JDK : Amazon Corretto v11.0.17_8
AP Server : Payara Server 5.2022.5(full) Community Edition (※Java EE8準拠、JSF2.3サポート)
Eclipse Plugin : Payara Tools v1.4.3

1.2. 前提

各種ソフトウェアのインストールルートフォルダは「C:\Prg」を使用します。

2. 環境構築

2.1. JDK

2.1.1. ダウンロード

以下のURLからAmazon Corretto v11 のZIPファイルをダウンロードします。

Amazon Corretto 11 のダウンロード - Amazon Corretto

2.1.2. インストール

ダウンロードしたZIPファイルを、以下のフォルダへ解凍します。

C:\Prg\jdk11.0.17_8

2.2. Payara Server

2.2.1. ダウンロード

以下のURLからPayara Server 5 Community EditionのFull形式のZIPファイルをダウンロードします。

Payara Platform Community Edition – Payara Services Ltd

2.2.2. インストール

ダウンロードしたZIPファイルを、以下のフォルダへ解凍します。

C:\Prg\payara5

2.3. IDE(Eclipse)

2.3.1. ダウンロード

以下のURLからEclipseの圧縮ファイルをダウンロードします。

統合開発環境 Eclipse 日本語化プロジェクト - Pleiades

2.3.2. インストール

ダウンロードした圧縮ファイルを実行し、以下の解凍先を入力して解凍します。

C:\Prg\pleiades\2022-12

3. Eclipse設定

3.1 Eclipse 起動

以下ファイルを実行し、Eclipseを起動します。

C:\Prg\pleiades\2022-12\eclipse\eclipse.exe

3.2 JDKの設定

手順2.1でインストールしたJDKをEclipseに設定します。

メニューから[ウィンドウ] - [設定]をクリックします。

左のツリーメニューから [Java]-[インストール済みのJRE]を選択し、[追加]ボタンをクリックします。

[標準VM]を選択し、[次へ]ボタンをクリックします。

「JREホーム」に手順2.1でインストールしたJDKパスを入力し、[JRE名]を入力し、[完了]ボタンをクリックします。

今追加したJDKをチェックして、[適用して閉じる]ボタンをクリックします。

3.3 Payara Toolのインストール・設定

3.3.1 Payara Toolのインストール

最初に記載した通り、動的Webモジュールv4.0／JSFv3.0の設定では、執筆時点(2023/3/19)のPayara Tool最新バージョンv2.1.0では動的Webプロジェクトを作成してPayara Serverに登録した際にエラーが発生してしまうため、今回は以下手順でv1.4.3を手動インストールしています。

blog.holyblue.jp

3.3.2 Payara Toolの設定

Payara Toolに、Paraya Serverの設定を行います。

Eclipseメニューから [ファイル] - [新規] - [その他] を選択します。

ウィザード画面で、[サーバー]を選択して、[次へ]ボタンをクリックします。

サーバータイプで [Payara] を選択して、[次へ]ボタンをクリックします。

ParayaとJDKのインストールフォルダを入力し、[次へ]ボタンをクリックします。

Payaraロケーション：C:\Prg\payara5
Javaロケーション：C:\Prg\jdk11.0.17_8

Payaraアプリケーションサーバーの設定画面は、ここでは全てデフォルト設定のままにしました。
[次へ]ボタンをクリックします。

最後の画面では、まだPayara Serverで動作させるJ2EEアプリケーションのプロジェクトがないので、何もせずに[完了]ボタンをクリックします。

設定が全て完了すると、Eclipseの [サーバー]タブ内に、「Payara Server5」が表示されます。

3.3.3 Payara Serverの動作確認

Eclipseの [サーバー]タブ内の「Payara Server5」を選択し、開始ボタンをクリックします。

初回実行時は、ファイアウォールの警告がでますので、[アクセスを許可する]ボタンをクリックします。

待っていると、コンソールタブに以下のメッセージが表示されます。
※一部文字化けしていますが、後ほど設定を変更して、文字化けしないようにします。

そして、サーバータブの「Payara Server5」のところが、「起動済み,同期済み]と表示されたら起動完了です。

ブラウザを起動し、以下のURLにアクセスして、Paraya Serverの画面が表示されていれば、起動が成功した証です。

http://localhost:8080

また、以下URLにアクセスすると Payara Serverの管理画面にアクセスできます。

http://localhost:4848

3.4 Payara設定変更(コンソール文字化け対応)

コンソールタブに表示されるメッセージが文字化けしないようにする設定を行います。
以下のファイルを開きます。

C:\Prg\payara5\glassfish\domains\domain1\config\domain.xml

そして"Java-config"タグの一番下に、以下を追記します。

        <jvm-options>-Dfile.encoding=UTF-8</jvm-options>

Payara Serverを再起動すると、以前は文字化けしていた漢字情報が正常に表示されるようになります。

4. Eclipseプロジェクトの作成

4.1 動的Webプロジェクトの作成

JSFを動作させるための動的Webプロジェクトを作成していきます。

Eclipseのメニューから[ファイル]-[新規]-[動的Webプロジェクト]を選択します。

最初に表示される設定画面では以下の項目を入力・設定します。そして、構成欄の[変更]ボタンをクリックします。

設定項目	設定値	備考
プロジェクト名	任意の名前	ここでは"sample01"と設定
ターゲットランタイム	Payara Server 5	「3.3.2 Payara Toolの設定」で設定した Payara Serverのこと
動的Webモジュールバージョン	4.0	デフォルト設定

JSFを利用するので、「Java Server Faces」にチェックを入れます。バージョンは「2.3」のままで、[OK]ボタンをクリックします。

再び先ほどの設定画面に戻りますので、[次へ]ボタンをクリックします。

ここでは何もせずに[次へ]ボタンをクリックします。

ここでも何もせずに[次へ]ボタンをクリックします。

JSF機能に関する設定画面が表示されます。
ここで上部の「JSF実装ライブラリ」と記載されている所に「Payara System Library」というのがデフォルト設定されています。ここは「ライブラリー構成を無効」に設定します。無効にしても問題ない理由として、この動的Webプロジェクトには先ほどサーバーランタイムとして「Payara Server」を設定したので必要なJSF実装ライブラリはそこの中に含まれていて追加では不要なためです。

4.2 動的WebプロジェクトをPayara Serverへ登録

先ほど作成した動的Webプロジェクトを、Payara Serverへ登録します。 [サーバー]タブで、「Payara Server 5(5.2022.5)」を右クリックし、[追加および除去]を選択します。

使用可能欄に表示されている動的Webプロジェクト(ここでは"sample01")を選択し、[追加]ボタンをクリックし、構成済み欄へ移動させて、[完了]ボタンをクリックします。

5. JSF動作確認

これまで設定した環境で正常にJSFが動作することを確認するため、一番最小構成のJSFプログラムを作成します。

5.1 動作確認用プログラムの作成

5.1.1 バッキングビーンの作成

以下のJavaクラスを作成します。

パッケージ：sample01.beans
クラス名：IdCardBean

以下の内容で実装します。
※Payara Server5はまだJ2EEのパッケージが「javax.*」となっている。

package sample01.beans;

import javax.enterprise.context.RequestScoped;
import javax.inject.Named;

@Named
@RequestScoped
public class IdCardBean {

    private Integer id;
    private String name;
    
    // 画面から受け取った情報をコンソールへ出力するメソッド
    public void toConsole() {
        System.out.println("id="+this.id+" / name="+this.name);
    }
    
    // getter/setter
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

5.1.2 JSFページの作成

パッケージエクスプローラーにて、「src/main/webapp」を右クリックし、[新規]-[その他]を選択します。

作成対象として「HTMLファイル」を選択し、[次へ]ボタンをクリックします。

「src/main/webapp]が選択されていることを確認します。
[ファイル名]に「index.xhtml」と入力し、[次へ]ボタンをクリックします。

「新規XHTMLファイル (1.0 transitional)」を選択し、[完了]ボタンをクリックします。

作成された「src/main/webapp/index.xhtml」ファイルを以下のように編集します。

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:h="http://xmlns.jcp.org/jsf/html">
<h:head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>sample index.xhtml</title>
</h:head>
<h:body>
    <h2>ID情報入力</h2>
    <h:form>
        ＩＤ：<h:inputText value="#{idCardBean.id}" /><br/>
        氏名：<h:inputText value="#{idCardBean.name}" /><br/>
        <h:commandButton value="送信" actionListener="#{idCardBean.toConsole()}"/>
    </h:form>
</h:body>
</html>

5.2 JSF動作確認

Payara Server 5を起動します。

ブラウザを起動し、以下のURLにアクセスします。

URL：http://localhost:8080/sample01/faces/index.xhtml

通常「src/main/webapp」配下に作成したHTMLファイルにアクセスするURLは

http://localhost:8080/sample01/index.xhtml

となりますが、JSFページの場合はURLの途中に「faces」という文字列を入れる必要があります。

http://localhost:8080/sample01/faces/index.xhtml

以下のページが表示されますので、「ID」と「氏名」に任意の情報を入力し、[送信]ボタンをクリックします。

Eclipseのコンソールタブに、JSFページで入力した情報が出力されれば、JSFが正常に動作している事が確認できます。

6. 追加設定

6.1 Propertiesファイルを配置する場所の設定

Propertiesファイルを配置する為の "resources" フォルダを作成します。

Eclipseのメニューから[ファイル]-[新規]-[フォルダ]を選択します。

プロジェクト「sample01」を選択し、フォルダ名「resources」を入力し、[完了]ボタンをクリックします。

「パッケージエクスプローラー」にて「sample01」プロジェクトを右クリックし、[プロパティ]をクリックします。

ツリーメニューから「Javaビルド・パス」を選択し、[フォルダの追加]ボタンをクリックします。

「resources」フォルダをチェックし、[OK]ボタンをクリックします。

「ビルドパス上のソースフォルダ」に「resources」フォルダが追加されていることを確認し、[適用して閉じる]をクリックします。

備考

「Unable to find CDI BeanManager.」エラーについて

「4. Eclipseプロジェクトの作成」の後「5. JSF動作確認」をする前にPayara Serverを起動すると、Payara Serverで以下のエラーが発生します。

cannot Deploy sample01
deploy is failing=Error occurred during deployment: Exception while loading the app : java.lang.IllegalStateException: ContainerBase.addChild: start: org.apache.catalina.LifecycleException: java.lang.RuntimeException: javax.faces.FacesException: Unable to find CDI BeanManager. Please see server.log for more details.

このエラー「Unable to find CDI BeanManager.」をネットで検索すると、以下の記事がまず見つかります。

qiita.com

わたしも最初はこの記事を見て動的Webプロジェクトの動的WebモジュールとJSFのバージョンを下げていたのですが、さらに調べると以下の記事が見つかりました。

stackoverflow.com

このStack OverflowのQAは、ターゲットランタイムがPayaraではなくWildFly ですが、ここに書いてある方法を行ったところ、エラーは発生しなくなりました。その方法は、以下の「beans.xml」ファイルを「/src/main/webapp/WEB-INF」に作成するという物です。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 
    http://xmlns.jcp.org/xml/ns/javaee/beans_2_0.xsd"
    version="2.0" bean-discovery-mode="annotated">
</beans>

ただ「5. JSF動作確認」でバッキングビーンとJSFを作成しておくとこのエラーは発生しません。理由はよくわかりません。。。

後書き

この環境の構築で一番詰まるところは、備考に書いた「Unable to find CDI BeanManager.」エラーでしょうか？

また、私は現時点ではPayara Serverの最新バージョン 6 では Eclipseで開発環境を構築できていません。今後の課題として考えています。

本記事が、Eclipse + Payaraの環境を構築しようとして困っている人の一助になれたら幸いです。

最後まで読んで頂きありがとうございました。

holyblueのブログ

Eclipse + Payara5によるJSF開発環境の構築手順（動的Webモジュールv4.0、JSFv3.0）