BT12：从xml创建加载行为树的过程分析

大家好，欢迎大家关注我的知乎专栏慢慢悠悠小马车

本文主要分析BehaviorTree.CPP/src/xml_parsing.cpp的内容，因为函数代码都很长，就省略了代码，大家可以与源文件对照理解。搞清楚行为树的解析、加载、构建过程，有利于对其设计思路有更深刻的理解，但是对行为树的使用影响不大，可以跳过。

我认为行为树的精华在于blackboard的设计，实现了节点间、树间的数据共享，但代码层次较深，理解花费时间较多，待以后补充，大家可以期待一下。

---

1、BehaviorTreeFactory::createTreeFromText()

树的加载和创建由createTreeFromText() 实现，该函数的第2个参数具有默认参数，即初创建的blackboard，是一个局部变量，但是由智能指针指向它。因此，只要引用计数大于0，该变量仍然不会释放，可以访问得到。

Tree createTreeFromText(const std::string& text,
                        Blackboard::Ptr blackboard = Blackboard::create());

Tree BehaviorTreeFactory::createTreeFromText(const std::string& text,
                                             Blackboard::Ptr blackboard) {
  XMLParser parser(*this);
  // 加载和解析文本，检查各项元素是否符合BT的概念要求。
  parser.loadFromText(text);
  // 创建树和所有节点的实例，构造好树之间、节点之间的父子关系，port的映射关系等。
  auto tree = parser.instantiateTree(blackboard);
  // 将树的节点信息绑定给树实例变量
  tree.manifests = this->manifests();
  return tree;
}

createTreeFromText() 主要有3部分。其中的manifests包含了树的所有节点类型信息，其实节点的builder和manifest在树建立之前已经通过register函数传给factory变量了。

template 
void registerNodeType(const std::string& ID, PortsList ports) {
  ...
  registerBuilder(CreateManifest(ID, ports), CreateBuilder());
}

void BehaviorTreeFactory::registerBuilder(const TreeNodeManifest& manifest,
                                          const NodeBuilder& builder) {
  auto it = builders_.find(manifest.registration_ID);
  if (it != builders_.end()) {
    throw BehaviorTreeException("ID [", manifest.registration_ID,
                                "] already registered");
  }
  builders_.insert({manifest.registration_ID, builder});
  manifests_.insert({manifest.registration_ID, manifest});
}

2、XMLParser::loadFromText()

具体由XMLParser::Pimpl::loadDocImpl()执行，主要有如下几个步骤。

1. 第1个for循环，递归加载本xml中所include的子树xml文件，先加载子树，再加载外层树，相当于深度优先搜索。
2. 第2个for循环，遍历本xml文件中的树的名称或ID（相当于树的根节点），保存在类XMLParser::Pimpl的成员变量tree_roots中。
3. 第3、4个for循环，将构造树之前就注册的所有节点，和2中读取的树的根节点，都存入局部变量std::set registered_nodes; 然后将其传入VerifyXML()。
4. VerifyXML()负责检查树的设计要求是否满足。检查项有：
   1. TreeNodesModel标签是否合法，主要用于Groot可视化。
   2. 各种node的子节点数量是否合法，是否有ID。比如ControlNode至少有1个子节点，DecoratorNode只有1个子节点，Subtree没有子节点。
   3. 是否有未注册的不认识的节点。
   4. 针对非subtree节点进行递归检查。
   5. 是否指定main_tree_to_execute 标签。如果有多个BehaviorTree，则必须指定main_tree_to_execute，如果只有1个BehaviorTree，就不需要指定。

3、XMLParser::instantiateTree()

分为2个部分。

1. 构造了行为树的实例——局部变量output_tree，将传入的blackboard（即上文创建的智能指针指向的blackboard）保存入 output_tree.blackboard_stack。
2. 调用recursivelyCreateTree()，传入主树（最外层树）的ID、tree局部变量、blackboard（还是刚才同一个智能指针）、TreeNode指针（空指针nullptr，作为根节点）。

Tree XMLParser::instantiateTree(const Blackboard::Ptr& root_blackboard) {
  Tree output_tree;
  ...
  // first blackboard
  output_tree.blackboard_stack.push_back(root_blackboard);
  _p->recursivelyCreateTree(main_tree_ID, output_tree, root_blackboard,
                            TreeNode::Ptr());
  return output_tree;
}

接下来对recursivelyCreateTree()展开分析。

4、XMLParser::Pimpl::recursivelyCreateTree()

函数内递归执行recursiveStep()，注意第1个参数是父节点。

void BT::XMLParser::Pimpl::recursivelyCreateTree(
    const std::string& tree_ID, Tree& output_tree, Blackboard::Ptr blackboard,
    const TreeNode::Ptr& root_parent) {
  std::function recursiveStep;
  recursiveStep = [&](const TreeNode::Ptr& parent, const XMLElement* element) {
    ...
  };
  auto root_element = tree_roots[tree_ID]->FirstChildElement();
  // start recursion
  recursiveStep(root_parent, root_element);
}

recursiveStep()分为3部分。

1. 调用XMLParser::Pimpl::createNodeFromXML()创建节点实例，将该实例保存在树的std::vector nodes 成员变量中。
2. 如果该节点是SUBTREE类型的，细分SubtreeNode和SubtreePlusNode来处理。

   1. 如果是SubtreeNode，就根据__shared_blackboard的值来创建blackboard，并添加映射信息，然后递归调用recursivelyCreateTree()来创建子树。

   2. 如果是SubtreePlusNode，就根据__autoremap的值来创建blackboard的port的映射，然后递归调用recursivelyCreateTree()来创建子树。

3. 如果该节点不是SUBTREE类型的，递归调用recursiveStep()，并把该节点作为接下来待创建节点的父节点。如果该节点没有其他包含的元素了，就不再递归了，从recursiveStep()返回，进而从recursivelyCreateTree()返回，进而从instantiateTree() 返回。

5、createNodeFromXML()

1. 对非subtree的节点，将port映射的key和value保存入局部变量PortsRemapping port_remap。
2. 对于有remap的节点，在blackboard中通过Blackboard::setPortInfo() 添加port映射信息， 并在父树的blackboard的相同key也保存相同port信息。基于此，实现了父子树之间的blackboard对相同key的同一性关联。
3. 使用manifest中保存的信息，初始化NodeConfiguration。即在NodeConfiguration的input_ports和output_ports集合中添加存在外部映射的port。
4. 对于不存在外部映射的port，对其中的InputPort赋默认值，并存入NodeConfiguration的input_ports集合中。
5. config构造完成，调用 instantiateTreeNode() 来实例化子节点。
6. 若传入的父节点有效，根据父节点的类型，为其添加子节点。