Red Hat build of OptaPlanner を使用したソルバーの開発

手順

1. コマンドターミナルで以下のコマンドを入力し、Maven が JDK 11 を使用していること、そして Maven のバージョンが 3.8 以上であることを確認します。

   mvn --version

   Copy to Clipboard Toggle word wrap
2. 上記のコマンドで JDK 11 が返されない場合は、JDK 11 へのパスを PATH 環境変数に追加し、上記のコマンドを再度入力します。

3. Quarkus OptaPlanner クイックスタートプロジェクトを生成するには、以下のコマンドを入力します。ここで、redhat-0000x は Quarkus BOM ファイルの現在のバージョンに置き換えます。

   mvn com.redhat.quarkus.platform:quarkus-maven-plugin:2.13.8.SP1-redhat-0000x:create \
       -DprojectGroupId=com.example \
       -DprojectArtifactId=optaplanner-quickstart  \
       -DplatformGroupId=com.redhat.quarkus.platform
       -DplatformArtifactId=quarkus-bom
       -DplatformVersion=2.13.8.SP1-redhat-0000x \
       -DnoExamples
       -Dextensions="resteasy,resteasy-jackson,optaplanner-quarkus,optaplanner-quarkus-jackson" \

   Copy to Clipboard Toggle word wrap

   このコマンドは、./optaplanner-quickstart ディレクトリーで以下の要素を作成します。

   • Maven の構造
   • src/main/docker の Dockerfile ファイルの例

   • アプリケーションの設定ファイル

     Expand

     表5.1 mvn io.quarkus:quarkus-maven-plugin:2.13.8.SP1-redhat-0000x:create コマンドで使用されるプロパティー

     プロパティー	説明
     projectGroupId	プロジェクトのグループ ID。
     projectArtifactId	プロジェクトのアーティファクト ID。
     extensions	このプロジェクトで使用する Quarkus 拡張のコンマ区切りリスト。Quarkus 拡張の全一覧については、特定のコマンドラインで mvn quarkus:list-extensions を入力します。
     noExamples	テストまたはクラスを使用せずに、プロジェクト構造でプロジェクトを作成します。

     Show more

     projectGroupID および projectArtifactID プロパティーの値を使用して、プロジェクトバージョンを生成します。デフォルトのプロジェクトバージョンは 1.0.0-SNAPSHOT です。

4. OptaPlanner プロジェクトを表示するには、OptaPlanner Quickstarts ディレクトリーに移動します。

   cd optaplanner-quickstart

   Copy to Clipboard Toggle word wrap

5. pom.xml ファイルを確認します。コンテンツの例を以下に示します。

   <?xml version="1.0"?>
   <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.example</groupId>
     <artifactId>optaplanner-quickstart</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <properties>
       <compiler-plugin.version>3.8.1</compiler-plugin.version>
       <maven.compiler.release>11</maven.compiler.release>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
       <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
       <quarkus.platform.group-id>com.redhat.quarkus.platform</quarkus.platform.group-id>
       <quarkus.platform.version>2.13.8.SP1-redhat-0000x</quarkus.platform.version>
       <skipITs>true</skipITs>
       <surefire-plugin.version>3.0.0-M7</surefire-plugin.version>
     </properties>
     <dependencyManagement>
       <dependencies>
         <dependency>
           <groupId>${quarkus.platform.group-id}</groupId>
           <artifactId>${quarkus.platform.artifact-id}</artifactId>
           <version>${quarkus.platform.version}</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>
         <dependency>
           <groupId>${quarkus.platform.group-id}</groupId>
           <artifactId>quarkus-optaplanner-bom</artifactId>
           <version>${quarkus.platform.version}</version>
           <type>pom</type>
           <scope>import</scope>
         </dependency>
       </dependencies>
     </dependencyManagement>
     <dependencies>
       <dependency>
         <groupId>org.optaplanner</groupId>
         <artifactId>optaplanner-quarkus</artifactId>
       </dependency>
       <dependency>
         <groupId>org.optaplanner</groupId>
         <artifactId>optaplanner-quarkus-jackson</artifactId>
       </dependency>
       <dependency>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-resteasy-jackson</artifactId>
       </dependency>
       <dependency>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-resteasy</artifactId>
       </dependency>
       <dependency>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-arc</artifactId>
       </dependency>
       <dependency>
         <groupId>io.quarkus</groupId>
         <artifactId>quarkus-junit5</artifactId>
         <scope>test</scope>
       </dependency>
       <dependency>
         <groupId>io.rest-assured</groupId>
         <artifactId>rest-assured</artifactId>
         <scope>test</scope>
       </dependency>
     </dependencies>
     <repositories>
       <repository>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
         <id>redhat</id>
         <url>https://maven.repository.redhat.com/ga</url>
       </repository>
     </repositories>
     <pluginRepositories>
       <pluginRepository>
         <releases>
           <enabled>true</enabled>
         </releases>
         <snapshots>
           <enabled>false</enabled>
         </snapshots>
         <id>redhat</id>
         <url>https://maven.repository.redhat.com/ga</url>
       </pluginRepository>
     </pluginRepositories>
     <build>
       <plugins>
         <plugin>
           <groupId>${quarkus.platform.group-id}</groupId>
           <artifactId>quarkus-maven-plugin</artifactId>
           <version>${quarkus.platform.version}</version>
           <extensions>true</extensions>
           <executions>
             <execution>
               <goals>
                 <goal>build</goal>
                 <goal>generate-code</goal>
                 <goal>generate-code-tests</goal>
               </goals>
             </execution>
           </executions>
         </plugin>
         <plugin>
           <artifactId>maven-compiler-plugin</artifactId>
           <version>${compiler-plugin.version}</version>
           <configuration>
             <compilerArgs>
               <arg>-parameters</arg>
             </compilerArgs>
           </configuration>
         </plugin>
         <plugin>
           <artifactId>maven-surefire-plugin</artifactId>
           <version>${surefire-plugin.version}</version>
           <configuration>
             <systemPropertyVariables>
               <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
               <maven.home>${maven.home}</maven.home>
             </systemPropertyVariables>
           </configuration>
         </plugin>
         <plugin>
           <artifactId>maven-failsafe-plugin</artifactId>
           <version>${surefire-plugin.version}</version>
           <executions>
             <execution>
               <goals>
                 <goal>integration-test</goal>
                 <goal>verify</goal>
               </goals>
               <configuration>
                 <systemPropertyVariables>
                   <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                   <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                   <maven.home>${maven.home}</maven.home>
                 </systemPropertyVariables>
               </configuration>
             </execution>
           </executions>
         </plugin>
       </plugins>
     </build>
     <profiles>
       <profile>
         <id>native</id>
         <activation>
           <property>
             <name>native</name>
           </property>
         </activation>
         <properties>
           <skipITs>false</skipITs>
           <quarkus.package.type>native</quarkus.package.type>
         </properties>
       </profile>
     </profiles>
   </project>

   Copy to Clipboard Toggle word wrap

手順

1. Web ブラウザーで https://code.quarkus.redhat.com を開きます。
2. プロジェクトの詳細を指定します。
3. プロジェクトのグループ名を入力します。名前の形式は、Java パッケージ命名規則に従います (例: com.example)。
4. プロジェクトから生成された Maven アーティファクトに使用する名前を入力します (例: code-with-quarkus)。

5. Build Tool > Maven を選択して、作成するプロジェクトが Maven プロジェクトであることを指定します。選択するビルドツールにより、以下の項目が決定されます。

   • 生成されたプロジェクトのディレクトリー構造。
   • 生成されたプロジェクトで使用される設定ファイルの形式。

   • アプリケーションのコンパイルおよび起動用のカスタムビルドスクリプトおよびコマンド (プロジェクトの生成後に code.quarkus.redhat.com が表示)。

     注記

     Red Hat は、code.quarkus.redhat.com を使用した OptaPlanner Maven プロジェクトの作成だけをサポートします。Red Hat では、Gradle プロジェクトの生成はサポートしていません。

6. プロジェクトから生成されたアーティファクトで使用するバージョンを入力します。このフィールドのデフォルト値は 1.0.0-SNAPSHOT です。semantic versioning の使用が推奨されますが、必要に応じて、別のタイプのバージョンを使用できます。

7. プロジェクトをパッケージ化する時に、ビルドツールが生成するアーティファクトのパッケージ名を入力します。

   パッケージ名は、Java パッケージの命名規則に従い、プロジェクトに使用するグループ名と一致するはずですが、別の名前を指定することもできます。

8. 以下の拡張を選択して、依存関係として組み込みます。

   • RESTEasy JAX-RS (quarkus-resteasy)
   • RESTEasy Jackson (quarkus-resteasy-jackson)
   • OptaPlanner AI 制約ソルバー (optaplanner-quarkus)

   • OptaPlanner Jackson (optaplanner-quarkus-jackson)

     Red Hat は、一覧にある個別の拡張に対してさまざまなレベルのサポートを提供します。レベルは、各拡張名の横にあるラベルで示されています。

     • SUPPORTED 拡張: Red Hat は、実稼働環境のエンタープライズアプリケーションでの使用を完全にサポートします。
     • TECH-PREVIEW 拡張: Red Hat は、テクノロジープレビュー機能のサポート範囲 に基づき、限定的に、実稼働環境でのサポートを提供します。
     • DEV-SUPPORT 拡張: Red Hat は、実稼働環境での使用をサポートしていません。ただし、新規アプリケーションの開発での使用に対しては、Red Hat 開発者がこれらのコア機能をサポートしています。

     • DEPRECATED 拡張: 同じ機能を提供する新しいテクノロジーまたは実装に置き換える予定です。

       Red Hat では、ラベル付けされていない拡張の実稼働環境での使用はサポートしていません。

9. Generate your application を選択して選択内容を確認し、生成されたプロジェクトを含むアーカイブのダウンロードリンクのオーバーレイ画面を表示します。オーバーレイ画面には、アプリケーションのコンパイルおよび起動に使用できるカスタムコマンドも表示されます。
10. Download the ZIP を選択して、生成されたプロジェクトファイルを含むアーカイブをマシンに保存します。
11. アーカイブの内容を展開します。

12. 展開したプロジェクトファイルが含まれるディレクトリーに移動します。

    cd <directory_name>

    Copy to Clipboard Toggle word wrap

13. 開発モードでアプリケーションをコンパイルして起動します。

    ./mvnw compile quarkus:dev

    Copy to Clipboard Toggle word wrap

手順

1. Quarkus アプリケーションを作成します。

   quarkus create app -P io.quarkus:quarkus-bom:2.13.8.SP1-redhat-0000x

   Copy to Clipboard Toggle word wrap

2. 利用可能な拡張機能を表示するには、以下のコマンドを入力します。

   quarkus ext -i

   Copy to Clipboard Toggle word wrap

   このコマンドは、以下の拡張機能を返します。

   optaplanner-quarkus
   optaplanner-quarkus-benchmark
   optaplanner-quarkus-jackson
   optaplanner-quarkus-jsonb

   Copy to Clipboard Toggle word wrap

3. 以下のコマンドを入力して、エクステンションをプロジェクトの pom.xml ファイルに追加します。

   quarkus ext add resteasy-jackson
   quarkus ext add optaplanner-quarkus
   quarkus ext add optaplanner-quarkus-jackson

   Copy to Clipboard Toggle word wrap

4. テキストエディターで pom.xml ファイルを開きます。ファイルの内容は以下の例のようになります。

   <?xml version="1.0"?>
   <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
   	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.acme</groupId>
     <artifactId>code-with-quarkus-optaplanner</artifactId>
     <version>1.0.0-SNAPSHOT</version>
     <properties>
   	<compiler-plugin.version>3.8.1</compiler-plugin.version>
   	<maven.compiler.parameters>true</maven.compiler.parameters>
   	<maven.compiler.source>11</maven.compiler.source>
   	<maven.compiler.target>11</maven.compiler.target>
   	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   	<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   	<quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
   	<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
   	<quarkus.platform.version>2.13.8.SP1-redhat-0000x</quarkus.platform.version>
   	<surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
     </properties>
     <dependencyManagement>
   	<dependencies>
     	<dependency>
       	<groupId>${quarkus.platform.group-id}</groupId>
       	<artifactId>${quarkus.platform.artifact-id}</artifactId>
       	<version>${quarkus.platform.version}</version>
       	<type>pom</type>
       	<scope>import</scope>
     	</dependency>
     	<dependency>
       	<groupId>io.quarkus.platform</groupId>
       	<artifactId>optaplanner-quarkus</artifactId>
       	<version>2.2.2.Final</version>
       	<type>pom</type>
       	<scope>import</scope>
     	</dependency>
   	</dependencies>
     </dependencyManagement>
     <dependencies>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-arc</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-resteasy</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>org.optaplanner</groupId>
     	<artifactId>optaplanner-quarkus</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>org.optaplanner</groupId>
     	<artifactId>optaplanner-quarkus-jackson</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-resteasy-jackson</artifactId>
   	</dependency>
   	<dependency>
     	<groupId>io.quarkus</groupId>
     	<artifactId>quarkus-junit5</artifactId>
     	<scope>test</scope>
   	</dependency>
   	<dependency>
     	<groupId>io.rest-assured</groupId>
     	<artifactId>rest-assured</artifactId>
     	<scope>test</scope>
   	</dependency>
     </dependencies>
     <build>
   	<plugins>
     	<plugin>
       	<groupId>${quarkus.platform.group-id}</groupId>
       	<artifactId>quarkus-maven-plugin</artifactId>
       	<version>${quarkus.platform.version}</version>
       	<extensions>true</extensions>
       	<executions>
         	<execution>
           	<goals>
             	<goal>build</goal>
             	<goal>generate-code</goal>
             	<goal>generate-code-tests</goal>
           	</goals>
         	</execution>
       	</executions>
     	</plugin>
     	<plugin>
       	<artifactId>maven-compiler-plugin</artifactId>
       	<version>${compiler-plugin.version}</version>
       	<configuration>
         	<parameters>${maven.compiler.parameters}</parameters>
       	</configuration>
     	</plugin>
     	<plugin>
       	<artifactId>maven-surefire-plugin</artifactId>
       	<version>${surefire-plugin.version}</version>
       	<configuration>
         	<systemPropertyVariables>
           	<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
           	<maven.home>${maven.home}</maven.home>
         	</systemPropertyVariables>
       	</configuration>
     	</plugin>
   	</plugins>
     </build>
     <profiles>
   	<profile>
     	<id>native</id>
     	<activation>
       	<property>
         	<name>native</name>
       	</property>
     	</activation>
     	<build>
       	<plugins>
         	<plugin>
           	<artifactId>maven-failsafe-plugin</artifactId>
           	<version>${surefire-plugin.version}</version>
           	<executions>
             	<execution>
               	<goals>
                 	<goal>integration-test</goal>
                 	<goal>verify</goal>
               	</goals>
               	<configuration>
                 	<systemPropertyVariables>
                   	<native.image.path>${project.build.directory}/${project.build.finalName}-run</native.image.path>
                   	<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                   	<maven.home>${maven.home}</maven.home>
                 	</systemPropertyVariables>
               	</configuration>
             	</execution>
           	</executions>
         	</plugin>
       	</plugins>
     	</build>
     	<properties>
       	<quarkus.package.type>native</quarkus.package.type>
     	</properties>
   	</profile>
     </profiles>
   </project>

   Copy to Clipboard Toggle word wrap

手順

1. SolverFactory で Solver インスタンスをビルドします。

2. Solver 設定の XML ファイルを設定します。

   1. モデルを定義します。
   2. スコア機能を定義します。

   3. 必要に応じて、最適化アルゴリズムを設定します。

      以下の例は、NQueens 問題に対するソルバー XML ファイルです。

      <?xml version="1.0" encoding="UTF-8"?>
      <solver xmlns="https://www.optaplanner.org/xsd/solver" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="https://www.optaplanner.org/xsd/solver https://www.optaplanner.org/xsd/solver/solver.xsd">
        <!-- Define the model -->
        <solutionClass>org.optaplanner.examples.nqueens.domain.NQueens</solutionClass>
        <entityClass>org.optaplanner.examples.nqueens.domain.Queen</entityClass>
      
        <!-- Define the score function -->
        <scoreDirectorFactory>
          <scoreDrl>org/optaplanner/examples/nqueens/optional/nQueensConstraints.drl</scoreDrl>
        </scoreDirectorFactory>
      
        <!-- Configure the optimization algorithms (optional) -->
        <termination>
          ...
        </termination>
        <constructionHeuristic>
          ...
        </constructionHeuristic>
        <localSearch>
          ...
        </localSearch>
      </solver>

      Copy to Clipboard Toggle word wrap
      注記

      一部の環境では、OSGi や JBoss モジュールなどの一部の環境では、JAR ファイルのソルバー設定、スコア DRL、ドメインクラスなどのクラスパスリソースが optaplanner-core JAR ファイルのデフォルトの ClassLoader で利用できない場合もあります。このような場合は、クラスの ClassLoader をパラメーターとして提供します。

             SolverFactory<NQueens> solverFactory = SolverFactory.createFromXmlResource(
                     ".../nqueensSolverConfig.xml", getClass().getClassLoader());

      Copy to Clipboard Toggle word wrap

3. ClassLoader.getResource() で定義されているクラスパスリソースとして提供されるソルバー設定 XML ファイルを使用して SolverFactory を設定します。

          SolverFasctory<NQueens> solverFactory = SolverFactory.createFromXmlResource(
                  "org/optaplanner/examples/nqueens/optional/nqueensSolverConfig.xml");
          Solver<NQueens> solver = solverFactory.buildSolver();

   Copy to Clipboard Toggle word wrap

手順

1. カスタムプロパティーを追加します。

   たとえば、Easy ScoreCalculator にキャッシュされる大きな計算があり、1 つのベンチマークでキャッシュサイズを増やす場合は、myCacheSize プロパティーを追加します。

     <scoreDirectorFactory>
       <easyScoreCalculatorClass>...MyEasyScoreCalculator</easyScoreCalculatorClass>
       <easyScoreCalculatorCustomProperties>
         <property name="myCacheSize" value="1000"/><!-- Override value -->
       </easyScoreCalculatorCustomProperties>
     </scoreDirectorFactory>

   Copy to Clipboard Toggle word wrap

2. カスタムプロパティーごとにパブリックセッターを追加します。これは、ソルバーの ビルド時に呼び出されます。

   public class MyEasyScoreCalculator extends EasyScoreCalculator<MySolution, SimpleScore> {
   
           private int myCacheSize = 500; // Default value
   
           @SuppressWarnings("unused")
           public void setMyCacheSize(int myCacheSize) {
               this.myCacheSize = myCacheSize;
           }
   
       ...
   }

   Copy to Clipboard Toggle word wrap

   boolean 、 int 、 double 、 BigDecimal 、 String 、 enums など、ほとんどの値型がサポートされています。

手順

1. 次の Maven 依存関係を OptaPlanner プロジェクトの pom.xml ファイルに追加します。

   注記

   ブリッジの依存関係を追加する必要はありません。

       <dependency>
         <groupId>ch.qos.logback</groupId>
         <artifactId>logback-classic</artifactId>
         <version>1.x</version>
       </dependency>

   Copy to Clipboard Toggle word wrap

2. 次の例に示すように、 logback.xml ファイルの org.optaplanner パッケージのログレベルを設定します。ここで、<LEVEL> はにリストされているログレベルです。「Logback を使用して OptaPlanner ソルバーアクティビティーをログに記録する」 。

   <configuration>
   
     <logger name="org.optaplanner" level="<LEVEL>"/>
   
     ...
   
   </configuration>

   Copy to Clipboard Toggle word wrap

3. オプション: 複数の ソルバー インスタンスが同時に実行されている可能性があるマルチテナントアプリケーションがある場合は、各インスタンスのログを別々のファイルに分割します。

   1. solve() 呼び出しをマップされた診断コンテキスト (MDC) で囲みます。

              MDC.put("tenant.name",tenantName);
              MySolution bestSolution = solver.solve(problem);
              MDC.remove("tenant.name");

      Copy to Clipboard Toggle word wrap

   2. ${tenant.name} ごとに異なるファイルを使用するようにロガーを設定します。たとえば、 logback.xml ファイルで SiftingAppender を使用します。

        <appender name="fileAppender" class="ch.qos.logback.classic.sift.SiftingAppender">
          <discriminator>
            <key>tenant.name</key>
            <defaultValue>unknown</defaultValue>
          </discriminator>
          <sift>
            <appender name="fileAppender.${tenant.name}" class="...FileAppender">
              <file>local/log/optaplanner-${tenant.name}.log</file>
              ...
            </appender>
          </sift>
        </appender>

      Copy to Clipboard Toggle word wrap
      注記

      複数のソルバーまたは 1 つのマルチスレッドソルバーを実行する場合、コンソールを含むほとんどのアペンダーは、デバッグ および トレース ログで輻輳を引き起こします。この問題を回避するには、非同期アペンダーに切り替えるか、デバッグ ログをオフにします。

4. OptaPlanner が新しいレベルを認識しない場合は、一時的にシステムプロパティー -Dlogback.LEVEL=true を追加してトラブルシューティングします。

手順

1. ブリッジの依存関係をプロジェクトの pom.xml ファイルに追加します。

       <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-log4j12</artifactId>
         <version>1.x</version>
       </dependency>

   Copy to Clipboard Toggle word wrap

2. 次の例に示すように、 log4j.xml ファイルのパッケージ org.optaplanner でログレベルを設定します。ここで、<LEVEL> はにリストされているログレベルです。「Logback を使用して OptaPlanner ソルバーアクティビティーをログに記録する」 。

   <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
   
     <category name="org.optaplanner">
       <priority value="<LEVEL>" />
     </category>
   
     ...
   
   </log4j:configuration>

   Copy to Clipboard Toggle word wrap

3. オプション: 複数の ソルバー インスタンスが同時に実行されている可能性があるマルチテナントアプリケーションがある場合は、各インスタンスのログを別々のファイルに分割します。

   1. solve() 呼び出しをマップされた診断コンテキスト (MDC) で囲みます。

              MDC.put("tenant.name",tenantName);
              MySolution bestSolution = solver.solve(problem);
              MDC.remove("tenant.name");

      Copy to Clipboard Toggle word wrap

   2. ${tenant.name} ごとに異なるファイルを使用するようにロガーを設定します。たとえば、 logback.xml ファイルで SiftingAppender を使用します。

        <appender name="fileAppender" class="ch.qos.logback.classic.sift.SiftingAppender">
          <discriminator>
            <key>tenant.name</key>
            <defaultValue>unknown</defaultValue>
          </discriminator>
          <sift>
            <appender name="fileAppender.${tenant.name}" class="...FileAppender">
              <file>local/log/optaplanner-${tenant.name}.log</file>
              ...
            </appender>
          </sift>
        </appender>

      Copy to Clipboard Toggle word wrap
      注記

      複数のソルバーまたは 1 つのマルチスレッドソルバーを実行する場合、コンソールを含むほとんどのアペンダーは、デバッグ および トレース ログで輻輳を引き起こします。この問題を回避するには、非同期アペンダーに切り替えるか、デバッグ ログをオフにします。

手順

1. オプション: ランダムインスタンスのランダムシードを変更するには、 randomSeed を指定します。

   <solver xmlns="https://www.optaplanner.org/xsd/solver" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="https://www.optaplanner.org/xsd/solver https://www.optaplanner.org/xsd/solver/solver.xsd">
     <randomSeed>0</randomSeed>
     ...
   </solver>

   Copy to Clipboard Toggle word wrap

2. オプション: 疑似乱数ジェネレーターの実装を変更するには、以下のソルバー設定ファイルにリストされている randomType プロパティーの値を指定します。ここで、<RANDOM_NUMBER_GENERATOR> は疑似乱数ジェネレーターです。

   <solver xmlns="https://www.optaplanner.org/xsd/solver" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="https://www.optaplanner.org/xsd/solver https://www.optaplanner.org/xsd/solver/solver.xsd">
     <randomType><RANDOM_NUMBER_GENERATOR></randomType>
     ...
   </solver>

   Copy to Clipboard Toggle word wrap

   次の疑似乱数ジェネレータがサポートされています。

   • JDK (デフォルト): 標準の乱数ジェネレーターの実装 (java.util.Random)
   • MERSENNE_TWISTER:コモンズ数学 によって乱数ジェネレータの実装
   • WELL512A, WELL1024A, WELL19937A, WELL19937C, WELL44497A と WELL44497B: Commons Mathによる乱数ジェネレータの実装

手順

1. 中間の最良のソリューションを処理するには、solveAndListen(…) を 使用します。

   public class TimeTableService {
   
       private SolverManager<TimeTable, Long> solverManager;
   
       // Returns immediately
       public void solveLive(Long timeTableId) {
           solverManager.solveAndListen(timeTableId,
                   // Called once, when solving starts
                   this::findById,
                   // Called multiple times, for every best solution change
                   this::save);
       }
   
       public TimeTable findById(Long timeTableId) {...}
   
       public void save(TimeTable timeTable) {...}
   
       public void stopSolving(Long timeTableId) {
           solverManager.terminateEarly(timeTableId);
       }
   
   }

   Copy to Clipboard Toggle word wrap

   この実装は、データベースを使用して、データベースをポーリングする UI と通信します。より高度な実装は、最適なソリューションを UI またはメッセージングキューに直接プッシュします。

2. ユーザーが中間の最良の解決策に満足し、より良い解決策をこれ以上待ちたくない場合は、 SolverManager.terminateEarly (problemId) を呼び出します。

手順

1. 制約の重みと他の制約パラメーターを保持する新しいクラス (ConferenceConstraintConfiguration など) を作成します。

2. このクラスに @ConstraintConfiguration のアノテーションを付けます。

   @ConstraintConfiguration
   public class ConferenceConstraintConfiguration {
       ...
   }

   Copy to Clipboard Toggle word wrap

3. 計画ソリューションに制約設定を追加し、そのフィールドまたはプロパティーに @ConstraintConfigurationProvider のアノテーションを付けます。

   @PlanningSolution
   public class ConferenceSolution {
   
       @ConstraintConfigurationProvider
       private ConferenceConstraintConfiguration constraintConfiguration;
   
       ...
   }

   Copy to Clipboard Toggle word wrap

4. 制約設定クラスで、各制約の @ConstraintWeight プロパティーを追加し、それらの重みにデフォルト値を与えます。

   @ConstraintConfiguration(constraintPackage = "...conferencescheduling.score")
   public class ConferenceConstraintConfiguration {
   
       @ConstraintWeight("Speaker conflict")
       private HardMediumSoftScore speakerConflict = HardMediumSoftScore.ofHard(10);
   
       @ConstraintWeight("Theme track conflict")
       private HardMediumSoftScore themeTrackConflict = HardMediumSoftScore.ofSoft(10);
       @ConstraintWeight("Content conflict")
       private HardMediumSoftScore contentConflict = HardMediumSoftScore.ofSoft(100);
   
       ...
   }

   Copy to Clipboard Toggle word wrap

   @ConstraintConfigurationProvider アノテーションは、制約設定を問題の事実として自動的に公開します。@ProblemFactProperty アノテーションを追加する必要はありません。制約の重みを null にすることはできません。

5. ビジネスユーザーが値を調整できるように、制約の重みを UI に公開します。前述の例では、ofHard()、ofMedium()、および ofSoft() メソッドを使用してこれを行います。コンテンツの競合 制約が テーマトラックの競合 制約よりも 10 倍重要であるとデフォルトで設定されていることに注目してください。通常、制約の重みでは 1 つのスコアレベルのみが使用されますが、(わずかなパフォーマンスコストで) 複数のスコアレベルを使用することも可能です。

手順

1. src/main/java/com/example/domain/Timeslot.java クラスを作成します。

   package com.example.domain;
   
   import java.time.DayOfWeek;
   import java.time.LocalTime;
   
   public class Timeslot {
   
       private DayOfWeek dayOfWeek;
       private LocalTime startTime;
       private LocalTime endTime;
   
       private Timeslot() {
       }
   
       public Timeslot(DayOfWeek dayOfWeek, LocalTime startTime, LocalTime endTime) {
           this.dayOfWeek = dayOfWeek;
           this.startTime = startTime;
           this.endTime = endTime;
       }
   
       @Override
       public String toString() {
           return dayOfWeek + " " + startTime.toString();
       }
   
       // ********************************
       // Getters and setters
       // ********************************
   
       public DayOfWeek getDayOfWeek() {
           return dayOfWeek;
       }
   
       public LocalTime getStartTime() {
           return startTime;
       }
   
       public LocalTime getEndTime() {
           return endTime;
       }
   
   }

   Copy to Clipboard Toggle word wrap

   後述しているように、toString() メソッドで出力を短くするため、OptaPlanner の DEBUG ログまたは TRACE ログの読み取りが簡単になっています。

2. src/main/java/com/example/domain/Room.java クラスを作成します。

   package com.example.domain;
   
   public class Room {
   
       private String name;
   
       private Room() {
       }
   
       public Room(String name) {
           this.name = name;
       }
   
       @Override
       public String toString() {
           return name;
       }
   
       // ********************************
       // Getters and setters
       // ********************************
   
       public String getName() {
           return name;
       }
   
   }

   Copy to Clipboard Toggle word wrap

3. src/main/java/com/example/domain/Lesson.java クラスを作成します。

   package com.example.domain;
   
   import org.optaplanner.core.api.domain.entity.PlanningEntity;
   import org.optaplanner.core.api.domain.variable.PlanningVariable;
   
   @PlanningEntity
   public class Lesson {
   
       private Long id;
   
       private String subject;
       private String teacher;
       private String studentGroup;
   
       @PlanningVariable(valueRangeProviderRefs = "timeslotRange")
       private Timeslot timeslot;
   
       @PlanningVariable(valueRangeProviderRefs = "roomRange")
       private Room room;
   
       private Lesson() {
       }
   
       public Lesson(Long id, String subject, String teacher, String studentGroup) {
           this.id = id;
           this.subject = subject;
           this.teacher = teacher;
           this.studentGroup = studentGroup;
       }
   
       @Override
       public String toString() {
           return subject + "(" + id + ")";
       }
   
       // ********************************
       // Getters and setters
       // ********************************
   
       public Long getId() {
           return id;
       }
   
       public String getSubject() {
           return subject;
       }
   
       public String getTeacher() {
           return teacher;
       }
   
       public String getStudentGroup() {
           return studentGroup;
       }
   
       public Timeslot getTimeslot() {
           return timeslot;
       }
   
       public void setTimeslot(Timeslot timeslot) {
           this.timeslot = timeslot;
       }
   
       public Room getRoom() {
           return room;
       }
   
       public void setRoom(Room room) {
           this.room = room;
       }
   
   }

   Copy to Clipboard Toggle word wrap

   Lesson クラスには @PlanningEntity アノテーションが含まれており、その中にプランニング変数が 1 つ以上含まれているため、OptaPlanner はこのクラスが解決時に変化することを認識します。

   timeslot フィールドには @PlanningVariable アノテーションがあるため、OptaPlanner は、このフィールドの値が変化することを認識しています。このフィールドに割り当てることのできる Timeslot インスタンスを見つけ出すために、OptaPlanner は valueRangeProviderRefs プロパティーを使用して値の範囲プロバイダーと連携し、List<Timeslot> を提供して選択できるようにします。値の範囲プロバイダーに関する詳細は、「プランニングソリューションでのドメインオブジェクトの収集」 を参照してください。

   room フィールドにも、同じ理由で @PlanningVariable アノテーションが含まれます。

手順

1. 開発モードでアプリケーションをコンパイルするには、プロジェクトディレクトリーから以下のコマンドを入力します。

   ./mvnw compile quarkus:dev

   Copy to Clipboard Toggle word wrap

2. REST サービスをテストします。任意の REST クライアントを使用できます。この例では Linux curl コマンドを使用して POST 要求を送信します。

   $ curl -i -X POST http://localhost:8080/timeTable/solve -H "Content-Type:application/json" -d '{"timeslotList":[{"dayOfWeek":"MONDAY","startTime":"08:30:00","endTime":"09:30:00"},{"dayOfWeek":"MONDAY","startTime":"09:30:00","endTime":"10:30:00"}],"roomList":[{"name":"Room A"},{"name":"Room B"}],"lessonList":[{"id":1,"subject":"Math","teacher":"A. Turing","studentGroup":"9th grade"},{"id":2,"subject":"Chemistry","teacher":"M. Curie","studentGroup":"9th grade"},{"id":3,"subject":"French","teacher":"M. Curie","studentGroup":"10th grade"},{"id":4,"subject":"History","teacher":"I. Jones","studentGroup":"10th grade"}]}'

   Copy to Clipboard Toggle word wrap

   application.properties ファイルで定義した 終了時間 で指定した期間後に、サービスにより、以下の例のような出力が返されます。

   HTTP/1.1 200
   Content-Type: application/json
   ...
   
   {"timeslotList":...,"roomList":...,"lessonList":[{"id":1,"subject":"Math","teacher":"A. Turing","studentGroup":"9th grade","timeslot":{"dayOfWeek":"MONDAY","startTime":"08:30:00","endTime":"09:30:00"},"room":{"name":"Room A"}},{"id":2,"subject":"Chemistry","teacher":"M. Curie","studentGroup":"9th grade","timeslot":{"dayOfWeek":"MONDAY","startTime":"09:30:00","endTime":"10:30:00"},"room":{"name":"Room A"}},{"id":3,"subject":"French","teacher":"M. Curie","studentGroup":"10th grade","timeslot":{"dayOfWeek":"MONDAY","startTime":"08:30:00","endTime":"09:30:00"},"room":{"name":"Room B"}},{"id":4,"subject":"History","teacher":"I. Jones","studentGroup":"10th grade","timeslot":{"dayOfWeek":"MONDAY","startTime":"09:30:00","endTime":"10:30:00"},"room":{"name":"Room B"}}],"score":"0hard/0soft"}

   Copy to Clipboard Toggle word wrap

   アプリケーションにより、4 つの授業がすべて 2 つの時間枠、そして 2 つある部屋のうちの 1 つに割り当てられている点に注目してください。また、すべてのハード制約に準拠することに注意してください。たとえば、M. Curie の 2 つの授業は異なる時間スロットにあります。

3. 解決時間の OptaPlanner の実行内容を確認するには、サーバー側で情報ログを確認します。以下は、情報ログ出力の例です。

   ... Solving started: time spent (33), best score (-8init/0hard/0soft), environment mode (REPRODUCIBLE), random (JDK with seed 0).
   ... Construction Heuristic phase (0) ended: time spent (73), best score (0hard/0soft), score calculation speed (459/sec), step total (4).
   ... Local Search phase (1) ended: time spent (5000), best score (0hard/0soft), score calculation speed (28949/sec), step total (28398).
   ... Solving ended: time spent (5000), best score (0hard/0soft), score calculation speed (28524/sec), phase total (2), environment mode (REPRODUCIBLE).

   Copy to Clipboard Toggle word wrap