//// 根据一项或多项贡献者许可协议，获得Apache软件基金会（ASF）的许可。有关版权归属的更多信息，请参阅随本作品分发的NOTICE文件。ASF根据Apache许可证第2.0版（“许可证”）向您授予本文件的使用许可；除非符合该许可证的规定，否则不得使用本文件。您可以在以下地址获取许可证副本：

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或以书面形式达成一致，否则根据本许可证分发的软件以“按原样”基础提供，不附带任何类型的保证或条件，无论是明示的还是默示的。有关特定语言的权限和限制，请参阅本许可证。 ////

:projectKey: org.optaplanner:optaplanner :sonarBadge: image:https://sonarcloud.io/api/project_badges/measure?project={projectKey} :sonarLink: link="https://sonarcloud.io/dashboard?id={projectKey}"

:branch: main

:jenkinsUrl: https://eng-jenkins-csb-business-automation.apps.ocp-c1.prod.psi.redhat.com/job/KIE/job/optaplanner :branchJenkinsUrl: {jenkinsUrl}/job/{branch} :toolsFolderJenkinsUrl: {branchJenkinsUrl}/job/tools :releaseFolderJenkinsUrl: {branchJenkinsUrl}/job/release

image::optaplanner-docs/src/modules/ROOT/images/shared/optaPlannerLogo.png[link="https://www.optaplanner.org/",OptaPlanner,150,150,align="center"]

image:https://img.shields.io/maven-central/v/org.optaplanner/optaplanner-bom?logo=apache-maven&style=for-the-badge["Maven artifact", link="https://ossindex.sonatype.org/component/pkg:maven/org.optaplanner/optaplanner-bom"] image:https://img.shields.io/badge/stackoverflow-ask_question-orange.svg?logo=stackoverflow&style=for-the-badge["Stackoverflow", link="https://stackoverflow.com/questions/tagged/optaplanner"] image:https://img.shields.io/badge/zulip-join_chat-brightgreen.svg?logo=zulip&style=for-the-badge[ "Join Zulip Chat", link="https://kie.zulipchat.com/#narrow/stream/232679-optaplanner"] image:https://img.shields.io/github/commit-activity/m/kiegroup/optaplanner?label=commits&style=for-the-badge["Commit Activity", link="https://github.com/kiegroup/optaplanner/pulse"] image:https://img.shields.io/github/license/kiegroup/optaplanner?style=for-the-badge&logo=apache["Livense", link="https://www.apache.org/licenses/LICENSE-2.0"] image:https://img.shields.io/badge/JVM-11--17-brightgreen.svg?style=for-the-badge["JVM support", link="https://github.com/kiegroup/optaplanner/actions/workflows/pull_request.yml"] image:https://img.shields.io/badge/Maven-3.x-blue?style=for-the-badge["Maven",link="https://maven.apache.org/install.html"] image:https://img.shields.io/github/languages/code-size/kiegroup/optaplanner?style=for-the-badge["Code size", link="https://github.com/kiegroup/optaplanner/actions/workflows/pull_request.yml"]

{sonarBadge}&style=for-the-badge&metric=reliability_rating["Reliability Rating", {sonarLink}] {sonarBadge}&metric=security_rating["Security Rating", {sonarLink}] {sonarBadge}&metric=sqale_rating["Maintainability Rating", {sonarLink}] {sonarBadge}&metric=coverage["Coverage", {sonarLink}]

一款快速、易用、开源的人工智能约束求解器，专为软件开发者设计。

== 正在寻找快速入门指南吗？

OptaPlanner 的快速入门指南位于 https://github.com/kiegroup/optaplanner-quickstarts[optaplanner-quickstarts 仓库]中。

== 快速开发开始

从源代码构建并运行：

---

$ mvn clean install -Dquickly $ cd optaplanner-examples $ mvn exec:java

若使用 IntelliJ IDEA、Eclipse 或 VSCode 进行开发，可将根目录下的 pom.xml 文件作为新项目打开，并配置如下 运行/调试配置：

• 类型：应用程序
• 主类：org.optaplanner.examples.app.OptaPlannerExamplesApp
• VM选项：-Xmx2G -server（仅在使用示例中的大型数据集时需要更多内存）
• 程序参数：（无）
• 工作目录：$MODULE_DIR$（必须解析为 optaplanner-examples 目录）
• 使用模块类路径：optaplanner-examples

== 参与 OptaPlanner 社区

这是一个开源项目，我们非常欢迎您的参与 :heart:!

• 如果您刚刚接触 OptaPlanner 并希望做出贡献，请查看我们的 https://issues.redhat.com/issues/?jql=project%20%3D%20PLANNER%20AND%20status%20in%20(Open%2C%20Reopened)%20AND%20labels%20%3D%20starter%20ORDER%20BY%20priority%20DESC[初学者问题]。这些问题特别挑选出来，适合首次贡献者。

• 如果您想贡献代码或发起有建设性的讨论，可以加入我们的 https://groups.google.com/g/optaplanner-dev[讨论组]，或者直接发送邮件至 optaplanner-dev@googlegroups.com。

• 如果您想提交一个问题，请访问 https://issues.redhat.com/projects/PLANNER/issues[OptaPlanner Jira 项目]。

=== 是时候做出改变了吗？

所有更改都必须通过 GitHub 拉取请求（PR）提交。OptaPlanner 使用持续集成（CI）。在您提交 PR 后，OptaPlanner 的 CI 会针对您的分支运行检查，以确保您的 PR 不会引入错误。如果 CI 发现潜在问题，我们的友好维护人员会帮助您解决。

=== 如何贡献

. 克隆仓库（https://github.com/kiegroup/optaplanner）。 . 创建您的功能分支：(git checkout -b feature)。 . 提交更改并添加注释：(git commit -am 'Add some feature')。 . 推送到 GitHub 的分支：(git push origin feature)。 . 创建一个新的拉取请求。

=== 代码规范

每次 Maven 构建时，您的代码都会自动按照“导入和代码风格”约定进行格式化。CI 检查也会强制执行这些约定，因此在创建 PR 之前，请务必使用 Maven 构建您的项目：

mvn clean install

有关如何设置代码风格检查的信息，请参阅 https://github.com/kiegroup/optaplanner/blob/main/build/optaplanner-ide-config/ide-configuration.adoc[IDE 设置说明]。

=== 构建您的 OptaPlanner 项目

您可以使用以下方法之一来构建您的 OptaPlanner 项目：

• :rocket: 快速构建：mvn clean install -Dquickly 跳过所有检查和代码分析 (~1 分钟)

• :hammer: 正常构建：mvn clean install 运行测试、检查代码风格，但跳过文档生成 (~17 分钟)

• :receipt: 文档构建：mvn clean install 在 optaplanner/optaplanner-docs 中创建 asciidoctor 文档 target/optaplanner-docs-*/html_single/index.html (~2 分钟)

• :mechanical_arm: 全面构建：mvn clean install -Dfull 运行所有检查，并生成文档和分发文件 (~20 分钟)

== OptaPlanner CI 状态

您可以通过 https://kiegroup.github.io/optaplanner/[链状态网页]查看 OptaPlanner 仓库的 CI 状态。

=== Jenkins CI 任务（需 VPN 访问） ===

所有 Jenkins 任务都可以在 OptaPlanner 文件夹下找到：{jenkinsUrl}

有趣的 Jenkins CI 任务（需 VPN 访问）：

• {toolsFolderJenkinsUrl}/job/update-quarkus-all/[更新 Quarkus 版本]
• {toolsFolderJenkinsUrl}/job/update-drools-optaplanner/[更新 Drools 版本]
• {releasefolderjenkinsurl}/job/optaplanner-release[发布流水线]（仅在发布分支上可用）
• {releasefolderjenkinsurl}/job/optaplanner-post-release[发布后流水线]（仅在发布分支上可用）

OptaPlanner 快速上手指南

OptaPlanner 是一个快速、易用且开源的 AI 约束求解器，专为软件开发人员设计，用于解决复杂的规划问题（如车辆路径、员工排班、任务调度等）。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• JDK: 支持 Java 11 至 Java 17。
• 构建工具: Apache Maven 3.x 或更高版本。
• 操作系统: Linux, macOS 或 Windows。
• 内存建议: 运行示例项目时，建议分配至少 2GB 内存。

提示：国内开发者建议在 Maven 的 settings.xml 中配置阿里云镜像源以加速依赖下载：

<mirror>
  <id>aliyunmaven</id>
  <mirrorOf>*</mirrorOf>
  <name>Aliyun Public</name>
  <url>https://maven.aliyun.com/repository/public</url>
</mirror>

2. 安装与构建

您可以直接从源码构建并运行 OptaPlanner。打开终端执行以下命令：

# 清理并快速安装（跳过部分检查以加快速度）
mvn clean install -Dquickly

# 进入示例项目目录
cd optaplanner-examples

# 运行示例应用程序
mvn exec:java

构建完成后，您将看到 OptaPlanner 的示例界面，其中包含了多种预设的规划场景供测试和学习。

3. 基本使用 (IDE 开发)

若要在 IntelliJ IDEA、Eclipse 或 VSCode 中进行开发，请按以下步骤配置项目：

1. 导入项目：将根目录下的 pom.xml 作为新项目打开。
2. 配置运行/调试 (Run/Debug Configuration)：
   • Type (类型): Application
   • Main class (主类): org.optaplanner.examples.app.OptaPlannerExamplesApp
   • VM options (虚拟机参数): -Xmx2G -server

     注：仅在运行包含大数据集的示例时需要此内存设置。

   • Program arguments (程序参数): (留空)
   • Working directory (工作目录): $MODULE_DIR$

     注：必须解析为 optaplanner-examples 目录。

   • Use classpath of module (使用模块类路径): optaplanner-examples

配置完成后，即可在 IDE 中直接启动示例应用或开始编写您自己的约束求解逻辑。

---

更多入门示例代码请访问官方快速开始仓库：optaplanner-quickstarts