開発

開発者ガイド

• 対象読者
• 必要な前提知識
• 開発ガイドの構成
• クイックスタート
• 開発環境の選択肢
  • ローカル開発環境
  • Docker を使用した開発環境
• よくある質問
  • Q: 開発に必要な最小限のスペックは？
  • Q: どの IDE を使用すればよいですか？
  • Q: LastaFlute や DBFlute の知識は必須ですか？
  • Q: 初めてのコントリビューションは何から始めればよいですか？
• 関連リソース
  • 公式リソース
  • 技術ドキュメント
  • コミュニティ
• 次のステップ
  • オープンソース全文検索サーバー - Fess 開発概要
    • 概要
      • Fess の特徴
    • 技術スタック
      • 対象バージョン
      • 主要な技術とフレームワーク
        • Java 21
        • LastaFlute
        • DBFlute
        • OpenSearch
        • Maven
    • 開発ツール
      • 推奨される開発環境
        • Eclipse
        • IntelliJ IDEA
        • VS Code
        • バージョン管理
    • 必要な知識
      • 基礎知識
      • 学習リソース
        • 公式ドキュメント
        • コミュニティ
        • ソースコード
    • 開発の基本フロー
    • プロジェクト構造の概要
      • 主要なパッケージ
        • app
        • crawler
        • opensearch
        • helper
        • job
    • 開発環境のクイックスタート
      • 前提条件
      • 手順
    • 開発のヒント
      • デバッグ実行
      • ホットデプロイ
      • ログの確認
      • OpenSearch の操作
    • コミュニティとサポート
      • 質問や相談
      • 貢献方法
    • 次のステップ
    • 参考資料
      • 公式リソース
      • 技術ドキュメント
      • コミュニティ
  • 開発環境のセットアップ
    • システム要件
      • ハードウェア要件
      • ソフトウェア要件
    • 必須ソフトウェアのインストール
      • Java のインストール
        • Eclipse Temurin のインストール（推奨）
        • インストール確認
        • 環境変数の設定
      • Maven のインストール
        • ダウンロードとインストール
        • 環境変数の設定
        • インストール確認
      • Git のインストール
    • IDE のセットアップ
      • Eclipse の場合
        • Eclipse のインストール
        • 推奨プラグイン
        • プロジェクトのインポート
        • 実行構成の設定
      • IntelliJ IDEA の場合
        • IntelliJ IDEA のインストール
        • プロジェクトのインポート
        • 実行構成の設定
      • VS Code の場合
        • VS Code のインストール
        • 必要な拡張機能のインストール
        • プロジェクトを開く
    • ソースコードの取得
      • GitHub からのクローン
    • プロジェクトのビルド
      • OpenSearch プラグインのダウンロード
      • 初回ビルド
    • Fess の実行
      • コマンドラインからの実行
      • IDE からの実行
        • Eclipse の場合
        • IntelliJ IDEA の場合
        • VS Code の場合
      • 起動の確認
      • ポート番号の変更
    • デバッグ実行
      • IDE でのデバッグ実行
        • Eclipse の場合
        • IntelliJ IDEA の場合
        • VS Code の場合
      • リモートデバッグ
    • 開発に役立つ設定
      • ログレベルの変更
      • ホットデプロイの有効化
      • 組み込み OpenSearch の操作
      • 外部 OpenSearch の使用
    • DBFlute によるコード生成
      • スキーマが変更された場合の再生成
    • トラブルシューティング
      • ビルドエラー
      • 実行エラー
      • IDE でプロジェクトが認識されない
    • 次のステップ
    • リソース
  • アーキテクチャとコード構造
    • 全体アーキテクチャ
      • レイヤーの説明
        • ユーザーインターフェース層
        • Web アプリケーション層
        • ビジネスロジック層
        • データアクセス層
        • データストア層
    • プロジェクト構造
      • ディレクトリ構造
    • 主要パッケージの詳細
      • app パッケージ
        • app.web パッケージ
        • app.web.admin パッケージ
        • app.service パッケージ
      • crawler パッケージ
        • crawler パッケージ（fess-crawler ライブラリ）
        • crawler パッケージ（fess 本体）
      • opensearch パッケージ
        • opensearch.client パッケージ
        • opensearch.query パッケージ
      • helper パッケージ
      • job パッケージ
      • entity パッケージ
      • mylasta パッケージ
        • mylasta.action パッケージ
        • mylasta.direction パッケージ
    • デザインパターンと実装パターン
      • MVC パターン
      • DI パターン
      • Factory パターン
      • Strategy パターン
    • 設定管理
      • fess_config.properties
      • fess_config.xml
      • fess_message_*.properties
    • データフロー
      • 検索フロー
      • クロールフロー
    • 拡張ポイント
      • カスタムクローラーの追加
      • カスタムトランスフォーマーの追加
      • カスタムエクストラクターの追加
      • カスタムプラグインの追加
    • 参考資料
      • フレームワーク
      • 技術ドキュメント
    • 次のステップ
  • 開発ワークフロー
    • 開発の基本フロー
    • Step 1: Issue の確認・作成
      • 既存の Issue を確認
      • 新しい Issue の作成
        • Issue の記載例
    • Step 2: ブランチの作成
      • ブランチ命名規則
      • ブランチの作成手順
    • Step 3: コーディング
      • コーディング規約
        • 基本的なスタイル
        • 命名規則
        • コメント
        • null の扱い
        • 例外処理
        • ログ出力
      • 開発中のテスト
        • ローカル実行
        • デバッグ実行
        • 単体テストの実行
    • Step 4: ローカルテストの実行
      • 単体テストの実行
      • 統合テストの実行
      • コードフォーマットのチェック
      • すべてのチェックを実行
    • Step 5: コミット
      • コミットメッセージの規約
      • コミット手順
      • コミットの粒度
    • Step 6: プッシュ
    • Step 7: プルリクエストの作成
      • PR の作成手順
      • PR の記載例
      • PR の説明
    • Step 8: コードレビュー
      • レビューの観点
      • レビューコメントの例
    • Step 9: レビューフィードバックへの対応
      • フィードバックへの対応手順
      • コメントへの返信
    • Step 10: マージ
      • マージ後の対応
    • よくある開発シナリオ
      • 機能追加
      • バグ修正
      • リファクタリング
      • ドキュメント更新
    • 開発のヒント
      • 効率的な開発
      • 問題の解決
    • 次のステップ
    • 参考資料
  • ビルドとテスト
    • ビルドシステムの概要
      • pom.xml
    • 基本的なビルドコマンド
      • クリーンビルド
      • パッケージの作成
      • フルビルド
      • 依存関係のダウンロード
      • OpenSearch プラグインのダウンロード
    • テスト
      • 単体テストの実行
        • すべての単体テストを実行
        • 特定のテストクラスを実行
        • 特定のテストメソッドを実行
        • 複数のテストクラスを実行
      • テストのスキップ
      • 統合テストの実行
    • テストの書き方
      • 単体テストの作成
        • テストクラスの配置
        • テストクラスの基本構造
        • テストのライフサイクル
        • アサーション
      • テストカバレッジ
    • コードフォーマット
      • コードフォーマッター
      • ライセンスヘッダー
      • コミット前のチェック
    • 配布パッケージの作成
      • zip パッケージの作成
      • RPM パッケージの作成
      • DEB パッケージの作成
    • プロファイル
      • build（デフォルト）
      • integrationTests
    • CI/CD
      • GitHub Actions
      • ローカルでの CI チェック
    • トラブルシューティング
      • ビルドエラー
      • テストエラー
      • 依存関係の問題
    • ビルドのベストプラクティス
      • 定期的なクリーンビルド
      • テストの実行
      • コードフォーマットの実行
      • 依存関係の更新
      • ビルドキャッシュの活用
    • Maven コマンドリファレンス
      • よく使うコマンド
    • 次のステップ
    • 参考資料
  • コントリビューションガイド
    • はじめに
    • 貢献の方法
      • コードの貢献
      • ドキュメントの貢献
      • Issue の報告
      • コミュニティ活動
    • 初めての貢献
      • Step 1: プロジェクトを理解する
      • Step 2: Issue を探す
      • Step 3: 開発環境をセットアップ
      • Step 4: ブランチを作成して作業
      • Step 5: プルリクエストを作成
    • コーディング規約
      • Javaコーディングスタイル
        • 基本スタイル
        • 命名規則
        • コメント
        • クラスとメソッドの設計
        • 例外処理
        • null の扱い
        • テストの記述
    • コードレビューのガイドライン
      • プルリクエストのレビュープロセス
      • レビュー観点
      • レビューコメントへの対応
    • プルリクエストのベストプラクティス
      • PR の大きさ
      • PR のタイトル
      • PR の説明
      • コミットメッセージ
      • Draft PR の活用
    • コミュニティガイドライン
      • 行動規範
      • コミュニケーション
      • 感謝の表明
    • よくある質問
      • Q: 初心者でも貢献できますか？
      • Q: プルリクエストはどのくらいで レビューされますか？
      • Q: プルリクエストが却下された場合は？
      • Q: コーディング規約に違反している場合は？
      • Q: 大きな機能を追加したい場合は？
      • Q: 日本語で質問しても良いですか？
    • 貢献の種類別ガイド
      • ドキュメントの改善
      • バグ報告
      • 機能リクエスト
      • コードレビュー
    • ライセンス
    • 謝辞
    • 次のステップ
    • 参考資料
    • コミュニティリソース

GitHub

Docker

JavaDoc

XRef

I/F Doc

ロードマップ

• バージョン付けの方針
• 15.0

変更点

課題追跡