<<测试驱动开发与设计模式>> 开发实例三 rs_driver

1 简介

rs_driver是RoboSense雷达的基本驱动。

这次的工作是对rs_driver v1.3.2的重构，重构后的代码是v1.5.7。

2 做了哪些变更？

2.1 从大类中拆分出小类

classes_from_decoder.png

• 从Decoder中分拆出一系列小类。这些类方便作单元测试。
• Decoder计算三角函数值时，使用查表方式，以便减少计算量。Trigon类包装了这部分逻辑。
• 对于机械式式雷达，Decoder计算每个通道的时间和角度时，需要先计算MSOP Packet中每个Block的时间偏移和角度偏移。BlockDiff定义了这个接口，SingleReturnBlockDiff、DualReturnBlockDiff分别实现了单回波模式、双回波模式下的时间角度偏移的计算方式。
• Decoder需要将连续的MSOP包中的点分帧。SplitStrategy定义了这个接口，SplitStrategyByAngle和SplitStrategyByNum分别实现了两种分帧模式，也就是机械式雷达按角度分帧和按照MSOP包数量分帧。SplitStrategySeq则实现了MEMS雷达按MSOP包序列号分帧。
• 对于机械式雷达，Decoder需要加载和保存垂直角和水平角标定数据。ChanAngles类包装了这部分逻辑。
• 对于机械式雷达，AzmuthSection对点的角度作校验。DistanceSection分别对点的距离作校验。虽然这两部分逻辑比较简单，但把它们独立出来，也会让Decoder更容易理解。

2.2 将一个大类拆分成一组基类+派生类

classes_input.png

• Input类是一个庞大的类，解析PCAP文件的逻辑与从Socket接收的逻辑混在一起。将它拆分成一个基类+派生类的组合，是合适的。
• 新的Input类定义数据源的接口。InputSock类实现从Socket接收的逻辑，InputPcap实现从PCAP解析的逻辑，新增的InputRaw从用户调用得到数据并解析。
• InputFactory用于创建Input类的实例。

2.3 改变库的接口设计 - 有没有更平滑的实现方式？

packet_replay.png

• 原来MSOP/DIFOP Packet的录制与回放的设计，回放有单独的函数接口和实现。实际上这个实现与Socket和PCAP数据源的后端处理是一样的，所以把它当做一个新的数据源InputRaw，也是顺理成章的。

2.4 将代码转移到更合适的位置上

decoder_get_const_param.png

• 机械式雷达有很多公共的逻辑，如从DIFOP包解析参数，分帧策略等，所以从Decoder创建一个公共的派生类DecoderMech。
• 计算每个通道的时间和角度偏移所依赖的发射时序，是特定于雷达的，将这个计算放到单独的函数getConstParam()中。
• 同样地，判断当前回波模式的代码，也放到单独的函数getEchoMode()中。

2.5 让类之间的依赖关系变得更简单

decoder_get_timestamp.png

• 原来的设计，使用了函数指针等比较复杂的方式，来确定"使用雷达时间还是主机时间作为点云的时间"。这其实搞得有点复杂了，改成简单的if/else逻辑，还更容易理解。

2.6 考虑限制条件，去掉不必要的考虑，简化代码

inline void InputSock::recvPacket()
{
 ...
 std::shared_ptr pkt = cb_get_(MAX_PKT_LEN);
 ssize_t ret = recvfrom(fds_[0], pkt->buf(), pkt->bufSize(), 0, NULL, NULL);
 ...
}

• 以太网包的长度是有限制的，为它分配1400个字节，还是1500个字节，其实对内存占用的影响并不大，不值得为了长度保存一个变量并把它计算得精确。就用一个够用的估计值15xx就好，可以让代码简单很多。

2.7 删除不需要的功能 - 有更简单的替代方法吗？

template 
inline void LidarDriverImpl::initPointCloudTransFunc()
{
  if (driver_param_.saved_by_rows)
  {
    point_cloud_transform_func_ = [](const typename PointCloudMsg::PointCloudPtr input_ptr,
                                     const size_t& height) -> typename PointCloudMsg::PointCloudPtr
    {
      typename PointCloudMsg::PointCloudPtr row_major_ptr =
          std::make_shared::PointCloud>();
      row_major_ptr->resize(input_ptr->size());
      size_t width = input_ptr->size() / height;
      for (int i = 0; i < static_cast(height); i++)
      {
        for (int j = 0; j < static_cast(width); j++)
        {
          row_major_ptr->at(i * width + j) = input_ptr->at(j * height + i);
        }
      }
      return row_major_ptr;
    };
  }
}

• 点云中的点，默认是按照扫描顺序保存的，也就是按列保存。其实按行保存的目的，无非是按行访问。由于列的点数是一定的，所以按列保存的点云，按行访问也是方便的，跳过列的点数访问就可以了。
• 按行保存的实现，实际上将点云复制了一遍，这个对CPU占用影响较大，是客户不希望的。所以不如干脆去除这个特性。

3 重构的设计原则

• 费脑子的计算工作，让单元测试帮忙做
• 不在同一维度的逻辑，切分成不同小块
• 去除代码的坏气味（比如不好理解的逻辑），让它有层次、有条理。
• 让生活轻松一点，再轻松一点。

相关链接

测试驱动开发与设计模式 - 为什么使用测试驱动开发
测试驱动开发与设计模式 - 从入门到精通
测试驱动开发与设计模式 - C++书籍及网站
测试驱动开发与设计模式 - 适应并改进软件设计过程
测试驱动开发与设计模式 - 让“理想结构”与“快速变更”并行
测试驱动开发与设计模式 - 提速 — 在纸上做细节设计
测试驱动开发与设计模式 - 开发实例一 DVR-POS库
测试驱动开发与设计模式 - 开发实例二 JSON过滤库
测试驱动开发与设计模式 - 开发实例三 DVR-POS库