Optaplanner

　　上一篇我们成功以把Opotaplanner规划引擎下载回来，并把它的示例运行起来，简单解析了一下它的Cloud balance示例。这一篇我们这些示例的源代码导入到Eclipse中，看看它在后台是怎么运行的。 

一、推荐使用Maven

　　在上一篇，我们已经从Optaplanner的官网下载了它的压缩包，它里面几乎包含了Optaplanner的所有东西，基本上有了这个包，我们离线都可以做一个应用Optaplanner规划引擎程序出来了。但是如果我们直接使用里面的核心包来做Java Project是很不明智的；因为：1.这些包有很多在特殊的场景才会用到，并不是每个项目都会用到，引入太多浪费空间。2. 如果Optaplanner引擎有版本更新了，你又想使用的话，那只能重新下载、配置。所以，现在Optaplanner官网通常都是推荐通过Maven的方式来建议项目。关于Maven的用法，大家可以去看一下相关的文章，其实也不复杂的，就是有一些公共的库帮你管理好了这些你用到的包，你只需要在你的项目里配置好你需要使用的包，剩下的就是Maven自己把需要的包括下载到你本地，并自动匹配版本了，当有Optaplanner有版本更新的时候，你所使用的包也可以更新为最新版本，而无需人工下载。所以，在这里，我们都是以Maven项目的方式来建立Optaplanner的示例源码，在以后的Optaplanner相关的演示中（稍后会有一篇文章会编写一个最基本的Hello world程序，也会通过Maven项目实现）. 

二、Optaplanner的Hello word

　　这一篇里面我们就从Optaplanner所有示例程序中的“Hello word”开始，因为Optaplanner面对的是规则问题，所以并没办法像学习一门新语言的入门教程一下，以打印一个Hello world信息出来作为第一个程序，毕竟它是个规划引擎，是用来对一系列对像进行规划的。所以我们就从它的说明文档里最简单的一个示例Cloud Banacing开始。关于这个示例的说明，在上一篇文章里，我们把它的所有示例程序跑起来的时候，重点讲解过它，这里就概述一下，让大家对这个示例有个大概的了解。大家可以打开《OptaPlanner - 把example运行起来（运行并浅析Cloud balancing）》这篇文里看它在程序里的具体呈现方式。简而言之，Cloud banacing就是模拟在云端有很多任务，需要根据CPU, 内存及带宽的要求，分配到不同的计算机上去执行，在满足了每个任务的基础上，还需要实现最省计算机资源的原则。这就是典型的资源规则问题了，大家可以扩展到供应链各个环节中的场景，例如APS（Advanced Planning and Scheduling, 高级计划与排程）中，如何将任务按一定的要求分配到指定的车间、产线甚至机台、工位上，并实现成本最低，或效率最高，或资源平衡等要求。 

三、导入示例源码并试运行

　　接下来我们就一步步把源代码都导进Eclipse里慢慢分析一下，如果要实现一个规则程序，至少需要用到Optaplanner哪里功能，需要建议哪些对象和规则。在一上篇里，我们已经下载了Optaplanner的发布包了，它里面包含了Optaplanner引擎的所有东西，包括可以直接使用的字节码程序，源代码，用户手册（包括所有API的Java Doc）,所有示例程序和所有示例程序的源代码.这里，我们就以Mavin Project为基础，把这个发布包里的示例程序的源代码导进来，然后再从这些源代码里去看看它的基本运行步骤和所需的对象和规则。

1. 创建workspace

　　创建一个文件夹作为这些试验的workspace.接下来我们的所有示例源码都放在这个文件中进行导入、运行、调度并修改。

                               

2. 解压示例源码

　　把示例源代码解压到workspace文件夹中，以便下一步把它作为maven项目导入，注意，需要将optaplanner-distribution-7.6.0.Finalexamplessources整个文件夹解压到workspace文件夹中去，因为这个文件夹里包含了示例源代码，用于运行示例用的数据文件,还有一些资源文件。source文件夹下面有个pom,xml文件，表示它是一个maven项目。

             

3. 导入示例源代码

　　在eclipse中，选择菜单File -> Import, 在弹出的Import对话框中，选择"Existing Maven Projects",(可以在Select an import wizard下面的文档框中输入maven来快速定位你们导入的项目，输入maven，就会过滤出maven相关的项目），选择“Existing Maven Projects”，点击"Next", 在"Import Maven Projects"对话框中，通过"Browser"按钮定位到刚才解压的sources文件夹去，Root Directory即会显示该位置，并在下面的Projects列表中，显示该文件夹下的pom.xml文件，选中该pom.xml文件，并选中“add projects(s) to working set”，点击Finish。eclipse即会把程序导入,并在sources文件夹(即与pom.xml文件同一个地方)中生成.project文件。即表示项目导入成功。

                             

                                                                                                                                                                                                    

4. 更新依赖包。

　　项目导入后，通常eclipse会自己检测项目中依赖的包是否都存在，若不存在会自己下载。如果eclipse没有自动下载（通常几秒钟后会检查到并下载），就点选一下菜单File -> Refresh 刷新一下。你们的电脑如果是第一次导入Optaplanner的项目，将会有一个比较长的下载依赖包过程，视下载速率而定。通常会显示更新进度。完成依赖包下载后，eclipse还会原始的项目信息，为源创建好各种包。即恢复原来的包信息.

　　　　　　　　
                              

　　　　　　

  5.试运行

　　我们先试一下，看看我们的导入的源代码是否都已经正确，所需的依赖包是否都已经完成下载并更新。找到整个示例的入口类 - OptaPlannerExamplesApp.java. 右击它，在弹出菜单中，选择Run As -> 2 Java Application. 稍等片刻，程序就会跑起来了，效果跟上一篇我们直接通过批处理文件运行起来的效果一样，那么就表示我们已经成功把Optaplanner的所有示例成功导进eclipse了。

                               

四、分析Hello world源码

　　下面，我们着重分析一下它的Cloud Balancing示例，它的，在包org.optaplanner.examples.cloudbalancing.app下，有一个CloudBalancingHelloWorld.java类。这个就是Optaplanner最基本的入门示例了。我们直接看它的代码，可以看到要使用Optaplanner需要最基本的三个步骤，分别是创建Solver对象, 创建被规划的对象，启动solve()方法，solver方法的返回值就是一个已经规划好的方案了.代码如下： 

  public static void main(String[] args) {
        // Build the Solver
        SolverFactory<CloudBalance> solverFactory = SolverFactory.createFromXmlResource(
                "org/optaplanner/examples/cloudbalancing/solver/cloudBalancingSolverConfig.xml");
        Solver<CloudBalance> solver = solverFactory.buildSolver();

        // Load a problem with 400 computers and 1200 processes
        CloudBalance unsolvedCloudBalance = new CloudBalancingGenerator().createCloudBalance(400, 1200);

        // Solve the problem
        CloudBalance solvedCloudBalance = solver.solve(unsolvedCloudBalance);

        // Display the result
        System.out.println("
Solved cloudBalance with 400 computers and 1200 processes:
"
                + toDisplayString(solvedCloudBalance));
    }

　　第一步：生成Solver对象，代码的第3行创建一个SolverFactory<CloudBanace>对象，其实也就是它使用了工厂模式，并使用了泛型了。其中CloudBalance是一个由我们定义的Planning Problem对象，被规则的对象都会作为Planning Problem对象的属性列表而传进引擎中，它是Opaplanner的几大基本对象之一，在这个示例中，第8行就是创建了一个Planning Problem对象，大家可以导航进去看到，创建它的时候，是否为它的两个列表(Computer和Process列表)初始化了一些对象。在关于这些基本对象的文章中，将会有详细的说明.在这一步主要是创建一个Solver对象出来，这个对象是指Optaplanner引擎将会使用什么算法,以什么参数，引用哪些规则对Planning Problem进行规划运算的，在规划运算过程中，基于什么原则进行退出等等设置。而这些设置全部可以写进一个XML文件中，也就是上面代码中的cloudBalancingSolverConfig.xml了。

　　第二步：创建将要被规划的对象，就是上面提到的Planning Problem对象了，在代码中的第8行实现。

第三步：通过Solver对象的solve方法，对上面创建的Planning Problem进行规划。这个过程有可能需要一个很长的时间，也有可能是实时规划的，也可能7 * 24小时都在包（实时规划）。而对于前一种（非实进规划），当规划运算完成后（通常在cloudBalancingSolverConfig.xml文件中会设置规划的完成条件），会返回一个已经完成了规划的Planning Problem对象，读取这个对象里的规划实体列表（例如本例中的规划实体就是Process对象），就得到规划好的方案了。

  以下是这个示例在规划过程中的Log输出，它清楚以显示了每一个规划步骤，引擎对规划实体进行了什么操作。

20:00:47.447 [main        ] DEBUG     LS step (20378), time spent (14822), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/2), picked move (CloudProcess-21 {CloudComputer-182 -> CloudComputer-74}).
20:00:47.447 [main        ] DEBUG     LS step (20379), time spent (14822), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/1), picked move (CloudProcess-1191 {CloudComputer-164} <-> CloudProcess-674 {CloudComputer-375}).
20:00:47.447 [main        ] DEBUG     LS step (20380), time spent (14822), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/3), picked move (CloudProcess-696 {CloudComputer-360} <-> CloudProcess-945 {CloudComputer-286}).
20:00:47.447 [main        ] DEBUG     LS step (20381), time spent (14822), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/1), picked move (CloudProcess-490 {CloudComputer-298} <-> CloudProcess-1196 {CloudComputer-258}).
20:00:47.447 [main        ] DEBUG     LS step (20382), time spent (14822), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/10), picked move (CloudProcess-204 {CloudComputer-375 -> CloudComputer-159}).
20:00:47.448 [main        ] DEBUG     LS step (20383), time spent (14823), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/1), picked move (CloudProcess-465 {CloudComputer-136} <-> CloudProcess-621 {CloudComputer-0}).
20:00:47.448 [main        ] DEBUG     LS step (20384), time spent (14823), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/1), picked move (CloudProcess-860 {CloudComputer-393} <-> CloudProcess-29 {CloudComputer-216}).
20:00:47.449 [main        ] DEBUG     LS step (20385), time spent (14824), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/5), picked move (CloudProcess-57 {CloudComputer-323} <-> CloudProcess-768 {CloudComputer-36}).
20:00:47.449 [main        ] DEBUG     LS step (20386), time spent (14824), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/3), picked move (CloudProcess-934 {CloudComputer-324 -> CloudComputer-246}).
20:00:47.449 [main        ] DEBUG     LS step (20387), time spent (14824), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/2), picked move (CloudProcess-812 {CloudComputer-198} <-> CloudProcess-1085 {CloudComputer-112}).
20:00:47.449 [main        ] DEBUG     LS step (20388), time spent (14824), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/1), picked move (CloudProcess-883 {CloudComputer-41} <-> CloudProcess-1180 {CloudComputer-237}).
20:00:47.450 [main        ] DEBUG     LS step (20389), time spent (14825), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/6), picked move (CloudProcess-477 {CloudComputer-376} <-> CloudProcess-713 {CloudComputer-197}).
20:00:47.450 [main        ] DEBUG     LS step (20390), time spent (14825), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/3), picked move (CloudProcess-693 {CloudComputer-311 -> CloudComputer-342}).
20:00:47.450 [main        ] DEBUG     LS step (20391), time spent (14825), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/3), picked move (CloudProcess-328 {CloudComputer-186} <-> CloudProcess-520 {CloudComputer-59}).
20:00:47.453 [main        ] DEBUG     LS step (20392), time spent (14828), score (0hard/-519420soft),     best score (0hard/-518110soft), accepted/selected move count (1/3), picked move (CloudProcess-203 {CloudComputer-103} <-> CloudProcess-745 {CloudComputer-112}).

　　至此，我们已把Optaplanner的示例程序全部导入到eclipse并跑起来了，也简单地介绍过一下它的hello world示例，可能大家还是会有些疑问，到底它是怎么执行得的，它做了些什么，要理解这些问题，就真的需要从需求开始，再理解一下Optaplanner的规划模型，最后结合一些示例才能说得清楚了。在接下来的文章中，我将会以自己想出来的简单示例，逐步对上述的问题进行讲述。过程不再一次过写太长的内容了，会在每篇文章里介绍几个相关的概念。好让大家更容易理解，更容易上手。

PS: 其实在导入并试运行过程中，使用7.6.0.Final版本的代码会出现一个异常的，刚好今天发现有7.7.0.Final发布了（好快喔），就下了最新的源码，那个异常消失了。大家可以注意一下，下载7.6.0.Final的示例源码不一定能跑成功喔，

原创不易，如果觉得文章对你有帮助，欢迎点赞、评论。文章有疏漏之处，欢迎批评指正。

---

本系列文章在公众号不定时连载，请关注公众号（让APS成为可能）及时接收,二维码：

如需了解更多关于Optaplanner的应用，请发电邮致：kentbill@gmail.com
或到讨论组发表你的意见：https://groups.google.com/forum/#!forum/optaplanner-cn
若有需要可添加本人微信（13631823503）或QQ(12977379)实时沟通，但因本人日常工作繁忙，通过微信,QQ等工具可能无法深入沟通，较复杂的问题，建议以邮件或讨论组方式提出。(讨论组属于google邮件列表，国内网络可能较难访问，需自行解决)