Apollo Cyber RT自定义组件
文件结构
头文件
源文件
BUILD编译文件
DAG
Launch
运行
参考资料

写在前面。网上关于Cyber RT中自定义组件的有很多，其中大部分直接翻译apollo官方github教程——如何使用 Cyber RT 来创建一个新的组件，并未对其中的个个语句给出详细的解释。在次前提下，整理网上资料和翻阅源代码，自学整理，记录在此。2019.11.10
文件结构

程序头文件
程序源文件
BUILD bazel编译所需
DAG 依赖文件
Launch文件

头文件
/*common_component_example.h*/
// std
#include <memory>
// cyber
#include "cyber/class_loader/class_loader.h"
#include "cyber/component/component.h"
#include "cyber/examples/proto/examples.pb.h"

using apollo::cyber::examples::proto::Driver;
using apollo::cyber::Component;
using apollo::cyber::ComponentBase;
/*需要继承Component类，并实现Init和Proc成员函数
  若继承自Component<>，则CommonComponentSample中没有继承Proc函数，无需实现*/
class CommonComponentSample : public Component<Driver, Driver> {
 public:
  bool Init() override;
  bool Proc(const std::shared_ptr<Driver>& msg0,
            const std::shared_ptr<Driver>& msg1) override;
};
/*使用CYBER_REGISTER_COMPONENT宏定义把组件类注册成全局可用*/
CYBER_REGISTER_COMPONENT(CommonComponentSample)

源文件
/*common_component_example.cc*/
#include "cyber/examples/common_component_example/common_component_example.h"
#include "cyber/class_loader/class_loader.h"
#include "cyber/component/component.h"

bool CommonComponentSample::Init() {
  /*apollo采用google::LogMessage记录日志文件，并保存在apollo/data/log/mainborad.INFO文件中*/
  AINFO << "Commontest component init";
  return true;
}

bool CommonComponentSample::Proc(const std::shared_ptr<Driver>& msg0,
                               const std::shared_ptr<Driver>& msg1) {
  AINFO << "Start common component Proc [" << msg0->msg_id() << "] ["
        << msg1->msg_id() << "]";
  return true;
}

BUILD编译文件
# 从apollo/tools/cpplint.bzl文件中加载cpplint
load("//tools:cpplint.bzl", "cpplint")

# default_visibility指定了这个包的默认可见规则。可见的情况下才能被其他package调用。
package(default_visibility = ["//visibility:public"])

# 构建二进制文件
cc_binary(
    # 构建二进制文件的名字
    name = "libcommon_component_example.so",
    # 
    linkopts = ["-shared"],
    # 
    linkstatic = False,
    # 引用当前包中的目标
    deps = [":common_component_example_lib"],
)

# 构建库
cc_library(
    # 构建库的名字
    name = "common_component_example_lib",
    # 源文件
    srcs = [
        "common_component_example.cc",
    ],
    # 头文件
    hdrs = [
        "common_component_example.h",
    ],
    # 依赖包
    # //表示根目录，格式//相对路径/包名:目标名
    # 若不指定目标名则目标名与报名相同
    deps = [
        "//cyber",
        "//cyber/examples/proto:examples_cc_proto",
    ],
)

# apollo自定义的方法，必须添加到末尾
# 原型为cpplint(data=None, extra_srcs=None)
# 可以传入额外的配置（data）和源文件（extra_srcs）
# 参见：/apollo/apollo/tools/cpplint.bzl 53行
cpplint()

DAG
# Define all coms in DAG streaming.
# 与官方教程（component_config）不同此处为：module_config
# 参见：/apollo/cyber/mainboard/module_controller.cc 129行
module_config {
    # 模块路径
    module_library : "/apollo/bazel-bin/cyber/examples/common_component_example/libcommon_component_example.so"
    # 组件
    components {
        # 类名
        class_name : "CommonComponentSample"
        # 配置
        config {
            # 组件的名字
            name : "common"
            # 接收消息的通道，因为在头文件中自定义的类继承自Component<Driver, Driver>，
            # 模板中含有两个量，因此此处*必须*要有两个readers
            # 参见源码：/apollo/apollo/cyber/component/component.h 237行
            readers {
                channel: "/apollo/prediction"
            }
            # 接收消息的通道
            readers {
                channel: "/apollo/test"
            }
        }
    }
}

Launch
<cyber>
    <module>
        <name>common</name>
        <dag_conf>/apollo/cyber/examples/common_component_example/common.dag</dag_conf>
        <process_name>common</process_name>
    </module>
</cyber>

##　编译
# 如果已经完成apollo的编译，建议使用第二条
# 仅编译所有文件夹中的内容
bash /apollo/apollo.sh build
# 仅编译cyber文件夹中的内容
bash /apollo/apollo.sh build_cyber

运行
cyber_launch start /apollo/cyber/examples/common_component_example/common.launch

参考资料
如何使用 Cyber RT 来创建一个新的组件

Bazel学习笔记

1. IAR中，函数指针参数如果为void，那么定义函数指针和函数实体时也要写上void，否则编译会报错。

2.对多个源文件，如果a文件要访问b文件的函数指针而调用b文件中的函数，前提是b文件的这个函数指针在b调用之前，要在a中定义和声明，否则会出现系统卡死的问题，因为调用一个未初始化的函数指针，系统不知道掉到哪里去了。也有个办法就是调用的时候判断是否为NULL。

      还有就是在定义结构体时，全局结构体初始化这个函数指针为NULL，其他文件使用时判断是否为null，或者全局结构体中初始化这个函数指针其他文件不管多早运行，都可以使用这个函数指针，因为已经在全局结构体成员初始化时初始化过了，即编译阶段就初始化了。并不是运行的时候构造的。

3. 如果a.h中定义一个结构体的某个成员类型为b.h中定义的结构体类型，即使a.h包含了b.h，编译也不会通过，因为头文件展开只会在.c源文件中进行，不会在.h文件中进行。两个方法解决：

（1）把a.h定义的这个结构体放在a.c中定义，然后a.c中包含b.h，这样这个结构体的那个成员的类型就可以使用b.h中定义的类型了。

（2）在a.h定义的结构体时，要使用另外.h文件结构体类型的成员定义为void *类型，这样在c文件中初始化时把这个void*指针指向b.h中结构体类型的实体，这样也能编译通过，也能实现目的。任何类型指针可以赋值给void*，但是void*类型要赋值给其他类型指针就需要强制转换为其他类型才能赋值。

4. 定义一个二维数组，要想某个指针指向这个数组，可以定义一个二维数组指针：

int a[5][6]

int(*p)[6]; //p是指向长度为6的数组的指针

然后p=a，这样访问p就相当于访问a了。

4. 关于结构内存占用字节对齐--两个原则

（1）结构体每个成员相对于结构体首地址的偏移量必须是成员本身占用内存的整数倍。

（2）结构体占用总内存大小为结构体最宽基本类型成员大小的整数倍。