---
title: 编程惯例
---

OceanBase seekdb 编程惯例

OceanBase seekdb 是一个基于发展了十几年的、包含几百万行C++代码的巨型工程 OceanBase 演化而来，它已经有了很多自己特有的编程习惯，这里介绍一些首次接触seekdb源码同学一些需要注意的事项，也可以让大家更方便的阅读seekdb源码。更详细的内容可以参考[OceanBase seekdb C++编程规范](coding-standard.md)。

# 命名习惯
## 文件命名
seekdb中代码文件名都以`ob_`开头。但也有一些陈旧的例外文件。

## 类命名
类都以`Ob`开头，也有一些陈旧类的意外。

## 成员变量命名
成员变量都以`_`作为后缀。

# 函数编程习惯
## 禁止使用STL容器
由于seekdb支持多租户资源隔离，为了方便控制内存，seekdb禁止使用STL、boost等容器。同时，seekdb提供了自己实现的容器，比如 `ObSEArray` 等。

## 单入口单出口
强制要求所有函数在末尾返回，禁止中途调用return、goto、exit等全局跳转指令。这一条也是所有首次接触seekdb代码的人最迷惑的地方。
为了实现这一要求，代码中会出现很多 `if/else if` ，并且在 `for` 循环中存在 `OB_SUCC(ret)` 等多个不那么直观的条件判断。同时为了减少嵌套，会使用宏 `FALSE_IT` 执行某些语句。比如

```cpp
int ObMPStmtReset::process()
{
  int ret = OB_SUCCESS;
  ...
  if (OB_ISNULL(req_)) {
    ret = OB_INVALID_ARGUMENT;
    LOG_WARN("invalid packet", K(ret), KP(req_));
  } else if (OB_INVALID_STMT_ID == stmt_id_) {
    ret = OB_INVALID_ARGUMENT;
    LOG_WARN("stmt_id is invalid", K(ret));
  } else if (OB_FAIL(get_session(session))) {
    LOG_WARN("get session failed");
  } else if (OB_ISNULL(session)) {
    ret = OB_ERR_UNEXPECTED;
    LOG_WARN("session is NULL or invalid", K(ret), K(session));
  } else if (OB_FAIL(process_kill_client_session(*session))) {
    LOG_WARN("client session has been killed", K(ret));
  } else if (OB_FAIL(process_extra_info(*session, pkt, need_response_error))) {
    LOG_WARN("fail get process extra info", K(ret));
  } else if (FALSE_IT(need_disconnect = false)) {
  } else if (OB_FAIL(update_transmission_checksum_flag(*session))) {
    LOG_WARN("update transmisson checksum flag failed", K(ret));
  } else {
    // ...
  }
  return ret;
}
```

代码中使用了大量的 `if/else if` ，并且使用了FALSE_IF宏尽量减少if的嵌套。

值得一提的是，类似的函数中都会在函数开头写 `int ret = OB_SUCCESS;`，将ret作为函数返回值，并且很多宏，也会默认ret的存在。

## 函数返回错误码
对于绝大多数函数，都要求函数具备int返回值，返回值可以使用错误码 `ob_errno.h` 解释。
这里说的绝大多数函数，包含一些获取值的函数，比如 ObSEArray的at函数 
```cpp
int at(int64_t idx, T &obj);
```

哪些函数不需要返回int值？
比较简单的返回类属性的函数，比如 ObSEArray 的函数：
```cpp
int64_t get_capacity();
```
将直接返回值，而不带int错误码。
或者类似的简单判断的函数不需要返回int错误码。

## 需要判断所有函数值与函数参数有效性
seekdb 要求只要函数有返回值，就必须对返回值做检测，做到“能检就检”。对于函数参数，特别是指针，在使用前都必须检查其有效性。
比如：
```cpp
int ObDDLServerClient::abort_redef_table(const obrpc::ObAbortRedefTableArg &arg, sql::ObSQLSessionInfo *session)
{
  int ret = OB_SUCCESS;
  ...
  obrpc::ObCommonRpcProxy *common_rpc_proxy = GCTX.rs_rpc_proxy_;
  if (OB_UNLIKELY(!arg.is_valid())) { // 这里对传入的参数做有效性检查
    ret = OB_INVALID_ARGUMENT;
    LOG_WARN("invalid arg", K(ret), K(arg));
  } else if (OB_ISNULL(common_rpc_proxy)) { // 在使用指针之前，也要做检查
    ret = OB_ERR_UNEXPECTED;
    LOG_WARN("common rpc proxy is null", K(ret));
  } else {
  ...
  }
  return ret;
}
```

# 一些约定函数接口
## init/destroy
seekdb 要求在构造函数中，仅实现一些非常轻量级的数据初始化工作，比如变量初始化为0，指针初始化为nullptr等。因为构造函数中，不太容易处理一些复杂的异常场景，并且无法给出返回值。seekdb绝大多数的类都有 init 函数，通常在构造函数之后执行，并且拥有int错误码作为返回值。这里做一些比较复杂的初始化工作。相对应的，通常也会提供destroy函数做资源销毁工作。

## reuse/reset
内存缓存是提高性能非常有效的手段。seekdb 很多类都会有reuse/reset接口，以方便某个对象后续重用。reuse 通常表示轻量级的清理工作，而reset会做更多的资源清理工作。但是需要看具体实现类，不能一概而论。
## 操作符重载
C++ 提供了非常方便编写程序的运算符重载功能，但是这些重载往往会带来很多负担，使得代码难以阅读、功能误用。比如运算符重载可能会导致程序员不知情的情况下出现类型隐式转换、或者看起来一个简单的操作却有比较高的开销。
另外，要尽量避免使用 `operator=` ，尽量以`deep_copy`、`shallow_copy`的方式实现对象的复制。

# 常用宏
OB_SUCC

判断某个语句是否返回成功，等价于OB_SUCCESS == (ret = func())
```cpp
ret = OB_SUCCESS;
if (OB_SUCC(func())) {
  // do something
}
```
OB_FAIL

类似OB_SUCC，只是判断某个语句是否执行失败：
```cpp
ret = OB_SUCCESS;
if (OB_FAIL(func())) {
  // do something
}
```
OB_ISNULL

判断指针是否为空，等价于nullptr == ptr，
```cpp
if (OB_ISNULL(ptr)) {
  // do something
}
```
OB_NOT_NULL

判断指针是否非空，等价于nullptr != ptr，
```cpp
if (OB_NOT_NULL(ptr)) {
  // do something
}
```

K

通常用在输出日志中，用法 K(obj)，其中obj可以是普通类型变量，也可以是类对象(必须实现to_string)，会被展开会 `"obj", obj`，最终在日志中会输出 "obj=123"。比如：
```cpp
LOG_WARN("fail to exec func, ", K(ret));
```

DISALLOW_COPY_AND_ASSIGN

用在类的声明中，表示此类禁止复制赋值等操作。
