升级至OptaPlanner 8/Drools时newKieSession返回null问题咨询

根因说明 #

OptaPlanner 8绑定Drools 8.x版本，默认启用可执行规则模型，类路径加载Kie模块时出现配置错误、依赖冲突时不会抛出明确异常，会直接在调用newKieSession()时返回null，你修改kmodule命名空间的操作是正确的，问题通常出在依赖对齐、配置属性缺失、类加载冲突这三类场景。

排查步骤 #

• 第一步：先校验KieContainer实际加载的模块列表，不要直接调用newKieSession
  插入以下调试代码，确认kmodule是否被正确解析：

  KieServices ks = KieServices.Factory.get();
  KieContainer kContainer = ks.getKieClasspathContainer();
  // 输出所有已加载的KieBase名称
  System.out.println("已加载KieBase列表：" + kContainer.getKieBaseNames());
  // 输出每个KieBase下注册的KieSession名称
  for (String kbaseName : kContainer.getKieBaseNames()) {
      System.out.printf("KieBase[%s]下的会话列表：%s%n", kbaseName, kContainer.getKieSessionNamesInKieBase(kbaseName));
  }
  

  如果输出内容里没有ksession-rules，说明kmodule.xml未被正确解析，优先检查文件位置和依赖；如果存在该会话名但new出来为null，说明KieBase初始化失败，检查规则文件和配置属性。

• 第二步：对齐所有Drools/KIE依赖版本
  OptaPlanner 8要求所有Drools、KIE相关依赖的版本号必须和OptaPlanner内置的Drools版本完全一致，禁止版本混装。必须显式引入以下依赖（不要依赖传递依赖自动引入）：

  • drools-compiler
  • drools-model-compiler
  • kie-api
  • kie-internal
    可以通过mvn dependency:tree（Maven）或./gradlew dependencies（Gradle）排查所有带drools、kie前缀的依赖，确保版本号完全统一，版本混装是该问题的最高发原因。

• 第三步：修正kmodule.xml配置
  Drools 8.x下kmodule的节点必须显式声明必填属性，你原来的配置缺失了关键属性，修正后配置如下：

  <?xml version="1.0" encoding="UTF-8"?>
  <kmodule xmlns="http://www.drools.org/xsd/kmodule">
      <kbase 
          name="drl.eval" 
          packages="drl.eval" 
          default="false"
          eventProcessingMode="cloud"
          equalsBehavior="identity">
          <ksession name="ksession-rules" default="false" type="stateful"/>
      </kbase>
  </kmodule>
  

  注意packages属性值大小写敏感，必须和你所有drl规则文件顶部声明的package值完全一致，规则包路径不匹配会导致KieBase初始化失败。同时确认kmodule.xml的存放路径为src/main/resources/META-INF/kmodule.xml，放在其他位置不会被类路径扫描识别。

• 第四步：排查容器类加载冲突
  如果你的项目是Spring Boot环境，且引入了optaplanner-spring-boot-starter，框架会自动在容器中初始化KieContainer实例，不要手动通过KieServices.Factory.get()重复创建KieContainer，直接注入容器中已有的KieContainer实例获取KieSession即可，重复创建会因为类加载器隔离导致无法读取kmodule配置。

内容的提问来源于stack exchange，提问作者Mischa Stone