openjdk version "21.0.x" 2024-xx-xx LTS
OpenJDK Runtime Environment Temurin-21.0.x+x (build 21.0.x+x-LTS)
OpenJDK 64-Bit Server VM Temurin-21.0.x+x (build 21.0.x+x-LTS, mixed mode, sharing)

環境変数の設定

Linux/macOS:

~/.bashrc または ~/.zshrc に以下を追加：

export JAVA_HOME=/path/to/java21
export PATH=$JAVA_HOME/bin:$PATH

Windows:

「システム環境変数の編集」を開く
「環境変数」をクリック
JAVA_HOME を追加：C:\Program Files\Eclipse Adoptium\jdk-21.x.x.x-hotspot
PATH に %JAVA_HOME%\bin を追加

Maven のインストール

Maven 3.x 以降をインストールします。

ダウンロードとインストール

Maven ダウンロードページにアクセス
Binary zip/tar.gz archive をダウンロード
解凍して適切な場所に配置

Linux/macOS:

tar xzvf apache-maven-3.x.x-bin.tar.gz
sudo mv apache-maven-3.x.x /opt/
sudo ln -s /opt/apache-maven-3.x.x /opt/maven

Windows:

ZIP ファイルを解凍
C:\Program Files\Apache\maven などに配置

環境変数の設定

Linux/macOS:

~/.bashrc または ~/.zshrc に以下を追加：

export MAVEN_HOME=/opt/maven
export PATH=$MAVEN_HOME/bin:$PATH

Windows:

MAVEN_HOME を追加：C:\Program Files\Apache\maven
PATH に %MAVEN_HOME%\bin を追加

インストール確認

mvn -version

以下のような出力が表示されれば成功です：

Apache Maven 3.x.x
Maven home: /opt/maven
Java version: 21.0.x, vendor: Eclipse Adoptium

Git のインストール

Git がインストールされていない場合は、以下からインストールします。

Windows: Git for Windows
macOS: brew install git または Git ダウンロードページ
Linux: sudo apt install git (Ubuntu/Debian) または sudo yum install git (RHEL/CentOS)

インストール確認：

git --version

IDE のセットアップ

Eclipse の場合

Eclipse は Fess の公式ドキュメントで推奨されている IDE です。

Eclipse のインストール

Eclipse ダウンロードページにアクセス
"Eclipse IDE for Enterprise Java and Web Developers" をダウンロード
インストーラーを実行し、指示に従ってインストール

推奨プラグイン

Eclipse には以下のプラグインがデフォルトで含まれています：

Maven Integration for Eclipse (m2e)
Eclipse Java Development Tools

プロジェクトのインポート

Eclipse を起動
File > Import を選択
Maven > Existing Maven Projects を選択
Fess のソースコードディレクトリを指定
Finish をクリック

実行構成の設定

Run > Run Configurations... を選択
Java Application を右クリックして New Configuration を選択
以下を設定：
- Name: Fess Boot
- Project: fess
- Main class: org.codelibs.fess.FessBoot
Apply をクリック

IntelliJ IDEA の場合

IntelliJ IDEA も広く使用されている IDE です。

IntelliJ IDEA のインストール

IntelliJ IDEA ダウンロードページにアクセス
Community Edition（無料）または Ultimate Edition をダウンロード
インストーラーを実行し、指示に従ってインストール

プロジェクトのインポート

IntelliJ IDEA を起動
Open を選択
Fess のソースコードディレクトリの pom.xml を選択
Open as Project をクリック
Maven プロジェクトとして自動的にインポートされます

実行構成の設定

Run > Edit Configurations... を選択
+ ボタンをクリックして Application を選択
以下を設定：
- Name: Fess Boot
- Module: fess
- Main class: org.codelibs.fess.FessBoot
- JRE: Java 21
OK をクリック

VS Code の場合

軽量な開発環境を好む場合は、VS Code も選択肢です。

VS Code のインストール

VS Code ダウンロードページにアクセス
インストーラーをダウンロードして実行

必要な拡張機能のインストール

以下の拡張機能をインストールします：

Extension Pack for Java: Java 開発に必要な拡張機能のセット
Maven for Java: Maven サポート

プロジェクトを開く

VS Code を起動
File > Open Folder を選択
Fess のソースコードディレクトリを選択

ソースコードの取得

GitHub からのクローン

Fess のソースコードを GitHub からクローンします。

git clone https://github.com/codelibs/fess.git
cd fess

SSH を使用する場合：

git clone git@github.com:codelibs/fess.git
cd fess

Tip

フォークして開発する場合は、まず GitHub で Fess リポジトリをフォークし、フォークしたリポジトリをクローンします：

git clone https://github.com/YOUR_USERNAME/fess.git
cd fess
git remote add upstream https://github.com/codelibs/fess.git

プロジェクトのビルド

OpenSearch プラグインのダウンロード

Fess の実行には、OpenSearch 用のプラグインが必要です。以下のコマンドでダウンロードします：

mvn antrun:run

このコマンドは以下を実行します：

OpenSearch のダウンロード
必須プラグインのダウンロードとインストール
OpenSearch の設定

注釈

このコマンドは初回のみ、またはプラグインを更新する際に実行します。毎回実行する必要はありません。

初回ビルド

プロジェクトをビルドします：

mvn clean compile

初回ビルドには時間がかかる場合があります（依存ライブラリのダウンロードなど）。

ビルドが成功すると、以下のようなメッセージが表示されます：

[INFO] BUILD SUCCESS
[INFO] Total time: xx:xx min
[INFO] Finished at: 2024-xx-xxTxx:xx:xx+09:00

Fess の実行

コマンドラインからの実行

Maven を使用して実行：

mvn compile exec:java

または、パッケージ化してから実行：

mvn package
java -jar target/fess-15.3.x.jar

IDE からの実行

Eclipse の場合

org.codelibs.fess.FessBoot クラスを右クリック
Run As > Java Application を選択

または、作成した実行構成を使用：

ツールバーの実行ボタンのドロップダウンをクリック
Fess Boot を選択

IntelliJ IDEA の場合

org.codelibs.fess.FessBoot クラスを右クリック
Run 'FessBoot.main()' を選択

または、作成した実行構成を使用：

ツールバーの実行ボタンのドロップダウンをクリック
Fess Boot を選択

VS Code の場合

src/main/java/org/codelibs/fess/FessBoot.java を開く
Run メニューから Run Without Debugging を選択

起動の確認

Fess の起動には 1〜2 分かかります。コンソールに以下のようなログが表示されれば起動完了です：

[INFO] Boot Thread: Boot process completed successfully.

ブラウザーで以下にアクセスして動作を確認：

検索画面: http://localhost:8080/
管理画面: http://localhost:8080/admin/
- デフォルトユーザー: admin
- デフォルトパスワード: admin

ポート番号の変更

デフォルトのポート 8080 が使用中の場合、以下のファイルで変更できます：

src/main/resources/fess_config.properties

# ポート番号を変更
server.port=8080

デバッグ実行

IDE でのデバッグ実行

Eclipse の場合

org.codelibs.fess.FessBoot クラスを右クリック
Debug As > Java Application を選択
ブレークポイントを設定して、コードの動作を追跡

IntelliJ IDEA の場合

org.codelibs.fess.FessBoot クラスを右クリック
Debug 'FessBoot.main()' を選択
ブレークポイントを設定して、コードの動作を追跡

VS Code の場合

src/main/java/org/codelibs/fess/FessBoot.java を開く
Run メニューから Start Debugging を選択

リモートデバッグ

コマンドラインから起動した Fess にデバッガーを接続することもできます。

Fess をデバッグモードで起動：

mvn compile exec:java -Dexec.args="-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005"

IDE からリモートデバッグ接続：

Eclipse:

Run > Debug Configurations... を選択
Remote Java Application を右クリックして New Configuration を選択
Port: 5005 を設定
Debug をクリック

IntelliJ IDEA:

Run > Edit Configurations... を選択
+ > Remote JVM Debug を選択
Port: 5005 を設定
OK をクリックして Debug を実行

開発に役立つ設定

ログレベルの変更

デバッグ時にログレベルを変更すると、詳細な情報を確認できます。

src/main/resources/log4j2.xml を編集：

<Configuration status="INFO">
    <Loggers>
        <Logger name="org.codelibs.fess" level="DEBUG"/>
        <Root level="INFO">
            <AppenderRef ref="console"/>
        </Root>
    </Loggers>
</Configuration>

ホットデプロイの有効化

LastaFlute は、一部の変更について再起動なしで反映できます。

src/main/resources/fess_config.properties で以下を設定：

# ホットデプロイを有効化
development.here=true

ただし、以下の変更は再起動が必要です：

クラス構造の変更（メソッドの追加・削除など）
設定ファイルの変更
依存ライブラリの変更

組み込み OpenSearch の操作

開発環境では、組み込みの OpenSearch が使用されます。

OpenSearch の配置場所：

target/fess/es/

OpenSearch API への直接アクセス：

# インデックスの一覧
curl -X GET http://localhost:9201/_cat/indices?v

# ドキュメントの検索
curl -X GET http://localhost:9201/fess.search/_search?pretty

# マッピングの確認
curl -X GET http://localhost:9201/fess.search/_mapping?pretty

外部 OpenSearch の使用

外部の OpenSearch サーバーを使用する場合は、 src/main/resources/fess_config.properties を編集：

# 組み込み OpenSearch を無効化
opensearch.cluster.name=fess
opensearch.http.url=http://localhost:9200

DBFlute によるコード生成

Fess は、DBFlute を使用して OpenSearch のスキーマから Java コードを自動生成しています。

スキーマが変更された場合の再生成

OpenSearch のマッピングを変更した場合、以下のコマンドで対応する Java コードを再生成します：

rm -rf mydbflute
mvn antrun:run
mvn dbflute:freegen
mvn license:format

各コマンドの説明：

rm -rf mydbflute: 既存の DBFlute 作業ディレクトリを削除
mvn antrun:run: OpenSearch プラグインをダウンロード
mvn dbflute:freegen: スキーマから Java コードを生成
mvn license:format: ライセンスヘッダーを追加

トラブルシューティング

ビルドエラー

エラー: Java バージョンが古い

[ERROR] Failed to execute goal ... requires at least Java 21

解決方法：Java 21 以降をインストールし、JAVA_HOME を適切に設定してください。

エラー: 依存ライブラリのダウンロード失敗

[ERROR] Failed to collect dependencies

解決方法：ネットワーク接続を確認し、Maven のローカルリポジトリをクリアしてから再試行：

rm -rf ~/.m2/repository
mvn clean compile

実行エラー

エラー: ポート 8080 がすでに使用されている

Address already in use

解決方法：

ポート 8080 を使用しているプロセスを終了
または、fess_config.properties でポート番号を変更

エラー: OpenSearch が起動しない

ログファイル target/fess/es/logs/ を確認してください。

よくある原因：

メモリ不足：JVM ヒープサイズを増やす
ポート 9201 が使用中：ポート番号を変更
ディスク容量不足：ディスク容量を確保

IDE でプロジェクトが認識されない

Maven プロジェクトの更新

Eclipse: プロジェクトを右クリック > Maven > Update Project
IntelliJ IDEA: Maven ツールウィンドウで Reload All Maven Projects をクリック
VS Code: コマンドパレットから Java: Clean Java Language Server Workspace を実行

次のステップ

開発環境のセットアップが完了したら、以下のドキュメントを参照してください：

アーキテクチャとコード構造 - コード構造の理解
開発ワークフロー - 開発ワークフローの学習
ビルドとテスト - ビルドとテストの方法
コントリビューションガイド - プルリクエストの作成

メニュー

開発環境のセットアップ

Eclipse Temurin のインストール（推奨）

インストール確認

環境変数の設定

ダウンロードとインストール

環境変数の設定

インストール確認

Eclipse のインストール

推奨プラグイン

プロジェクトのインポート

実行構成の設定

IntelliJ IDEA のインストール

プロジェクトのインポート

実行構成の設定

VS Code のインストール

必要な拡張機能のインストール

プロジェクトを開く

Eclipse の場合

IntelliJ IDEA の場合

VS Code の場合

Eclipse の場合

IntelliJ IDEA の場合

VS Code の場合