16.7. OptaWeb 配送経路の開発ガイド
このセクションでは、開発モードでバックエンドモジュールおよびフロントエンドモジュールを設定して実行する方法を説明します。
16.7.1. OptaWeb 配送経路プロジェクトの構造
OptaWeb 配送経路プロジェクトは、マルチモジュールの Maven プロジェクトです。
図16.1 モジュール依存関係ツリーの図
バックエンドとフロントエンドモジュールは、モジュールツリーの一番下にあります。これらのモジュールには、アプリケーションのソースコードが含まれます。
スタンドアロンモジュールは、バックエンドとフロントエンドを 1 つの実行可能な JAR ファイルに統合するアセンブリーモジュールです。
ディストリビューションモジュールは、最終的なアセンブリーの手順を表します。このモジュールは、スタンドアロンアプリケーションと、ドキュメントを受けとり、配信しやすいようにアーカイブとしてラッピングします。
バックエンドとフロントエンドは、別にビルドとデプロイが可能な、別個のプロジェクトです。実際には、全く異なる言語で記述され、異なるツールでビルドされています。どちらのプロジェクトでも、コードの変更からアプリケーションの実行までの対応時間を短くし、最新の開発体験ができるようにするツールが含まれています。
次のセクションでは、バックエンドとフロントエンドのプロジェクトを開発モードで実行する方法を説明します。
16.7.2. OptaWeb 配送経路のバックエンドモジュール
バックエンドモジュールには、Red Hat build of OptaPlanner を使用して配送経路を最適化するサーバー側のアプリケーションが含まれています。最適化は CPU を集中的に使用する計算であり、最大限に能力を発揮するには I/O 操作を回避する必要があります。移動コスト (時間または距離) を最小限に抑えることが主な目的の 1 つであるため、OptaWeb 配送経路では RAM メモリーに移動コストの情報を保持します。OptaPlanner は、解を出す時に、ユーザーが入力した全場所間の移動コストを把握しておく必要があります。この情報は、距離行列 と呼ばれる構造に保存されます。
新しい場所を入力すると、OptaWeb 配送経路は新しい場所と、それ以外でこれまでに入力されたすべての場所との間の移動コストを計算して、距離行列にその移動コストを保存します。移動コストの計算は、GraphHopper の経路エンジンで実行されます。
バックエンドモジュールは、以下のような機能を追加で実装します。
- 永続性
- フロントエンドの WebSocket 接続
- データセットの読み込み、エクスポート、およびインポート
バックエンドコードのアーキテクチャーの詳細は、「OptaWeb 配送経路のバックエンドアーキテクチャー」 を参照してください。
次のセクションでは、開発モードでバックエンドを設定して実行する方法を説明します。
16.7.2.1. OptaWeb 配送経路のバックエンドモジュールの実行
バックエンドモジュールは、Quarkus 開発モードで実行できます。
前提条件
- OptaWeb 配送経路が 「OptaWeb 配送経路の手動での設定および実行」 の説明どおりに設定されている。
手順
-
rhpam-7.13.4-kogito-and-optaplanner-quickstarts/optaweb-8.13.0.Final-redhat-00013/optaweb-vehicle-routing/optaweb-vehicle-routing-backend
ディレクトリーに移動します。 開発モードでバックエンドを実行するには、次のコマンドを入力します。
mvn compile quarkus:dev
16.7.2.2. IntelliJ IDEA Ultimate からの OptaWeb 配送経路バックエンドモジュールの実行
IntelliJ IDEA Ultimate を使用して OptaWeb 配送経路バックエンドモジュールを実行し、プロジェクトの開発を簡素化できます。IntelliJ IDEA Ultimate には、Quarkus プラグインが同梱されており、Quarkus フレームワークを使用するモジュールの実行設定を自動的に作成します。
手順
optaweb-vehicle-routing-backend の設定を使用して、バックエンドを実行します。
関連情報
詳細は、Quarkus アプリケーションのビルド を参照してください。
16.7.2.3. Quarkus 開発モード
開発モードでは、バックエンドのソースコードまたは設定が変更された場合に、フロントエンドが実行されるブラウザータブを更新すると、バックエンドが自動的に再起動します。
Quarkus 開発モード の詳細を確認してください。
16.7.2.4. OptaWeb 配送経路バックエンドモジュールのシステムプロパティーの値の変更
OptaWeb 配送経路バックエンドモジュールのデフォルトのシステムプロパティー値を一時的または永続的に上書きできます。
OptaWeb 配送経路バックエンドモジュールのプロパティーは /src/main/resources/application.properties
ファイルに保存されます。このファイルはバージョン管理されます。このファイルを使用してデフォルトの設定プロパティーの値を永続的に保存し、Quarkus プロファイルを定義します。
前提条件
- OptaWeb 配送経路のスターターアプリケーションをダウンロードしてデプロイメントしている。詳細は、「OptaWeb 配送経路デプロイメントファイルのダウンロードおよびビルド」 を参照してください。
手順
デフォルトのシステムプロパティー値を一時的に上書きするには、
mvn
またはjava
コマンドの実行時に、-D<PROPERTY>=<VALUE>
引数を追加します。<PROPERTY>
は変更するプロパティーの名前、<VALUE>
はそのプロパティーに一時的に割り当てる値に置き換えます。以下の例は、Maven を使用してdev
モードで Quarkus プロジェクトをコンパイルした場合に、quarkus.http.port
システムプロパティーの値を8181
に一時的に変更する方法を示しています。mvn compile quarkus:dev -Dquarkus.http.port=8181
これを実行すると、
/src/main/resources/application.properties
ファイルに保存されているプロパティーの値が一時的に変更されます。開発環境に固有の設定を保存する場合など設定値を永続的に変更するには、
env-example
ファイルの内容をoptaweb-vehicle-routing-backend/.env
ファイルにコピーします。このファイルはバージョン管理には含まれないので、リポジトリーのクローン時には存在しません。Git の作業ツリーに影響を与えずに、
.env
ファイルで変更を加えることができます。
関連情報
OptaWeb 配送経路の設定プロパティーに関する完全リストは、「OptaWeb 配送経路のバックエンド設定プロパティー」 を参照してください。
16.7.2.5. OptaWeb 配送経路のバックエンドログ
OptaWeb 配送経路は、SLF4J API と Logback をロギングフレームワークとして使用します。詳細は、Quarkus のロギングの設定 を参照してください。
16.7.3. OptaWeb 配送経路のフロントエンドモジュールの操作
フロントエンドのプロジェクトは、Create React App でブートストラップされました。Create React App には、開発や、実稼働環境でアプリケーションをビルドしやすくするためのスクリプトや依存関係が多数含まれています。
前提条件
- OptaWeb 配送経路のスターターアプリケーションをダウンロードしてデプロイメントしている。詳細は、「OptaWeb 配送経路デプロイメントファイルのダウンロードおよびビルド」 を参照してください。
手順
Fedora で、次のコマンドを入力して開発環境を設定します。
sudo dnf install npm
npm のインストールの詳細は、Downloading and installing Node.js and npm を参照してください。
-
rhpam-7.13.4-kogito-and-optaplanner-quickstarts/optaweb-8.13.0.Final-redhat-00013/optaweb-vehicle-routing/optaweb-vehicle-routing-frontend
ディレクトリーに移動します。 npm
の依存関係をインストールします。npm install
Maven とは違い、
npm
パッケージマネージャーは、npm install
を実行した場合にのみ、プロジェクトディレクトリーのnode_modules
に依存関係をインストールします。package.json
にリストされている依存関係が変更されると、master ブランチに変更をプルした時点で、npm install
を実行してから開発サーバーを実行する必要があります。以下のコマンドを入力して、開発サーバーを実行します。
npm start
自動的に表示されない場合には、Web ブラウザーで
http://localhost:3000/
を開きます。デフォルトでは
npm start
コマンドは、デフォルトのブラウザーでこの URL を開こうとします。注記npm start
コマンドで、実行するたびに新規ブラウザーのタブを開かないようにするには、BROWSER=none
環境変数をエクスポートします。.env.local
ファイルを使用して、この設定を永続化します。これには、以下のコマンドを実行します。echo BROWSER=none >> .env.local
ブラウザーは、フロントエンドのソースコードを変更するたびにページを更新します。端末で実行する開発サーバーのプロセスは、これらの変更を取得し、コンパイルエラーと lint エラーをコンソールに出力します。
以下のコマンドを入力して、テストを実行します。
npm test
REACT_APP_BACKEND_URL
環境変数の値を変更して、npm start
、npm run build
などの実行時に、npm
が使用するバックエンドプロジェクトの場所を指定します。REACT_APP_BACKEND_URL=http://10.0.0.123:8081
注記環境変数は、
npm
のビルドプロセス中は JavaScript バンドル内でハードコード化されるため、バックエンドの場所を指定してから、フロントエンドをビルドしてデプロイする必要があります。React 環境変数の詳細は、Adding Custom Environment Variables を参照してください。
フロントエンドをビルドするには、以下のコマンドのいずれか 1 つを実行します。
./mvnw install
mvn install