C++编程好习惯

本文来自于朋友LJT的日常编程心得。

1.不要在构造函数中做初始化操作
要求类（尤其是对外接口类）提供Init()函数，在该函数中进行相关初始化操作，初始化失败能够返回错误码。
可以规避问题：
构造函数中难以返回错误码，外部调用者无从判断初始化结果。
当该类作为全局变量使用时，构造函数调用发生在main()函数执行之前，出现问题难以追踪。

2.所有函数返回值都要判断

可以规避问题：
及时发现错误环节，终止处理流程，避免后续发生难以预料的错误。

3.关于函数返回值：
除了逻辑判断函数外，函数返回值都为整型，且该返回值只能用来表示函数执行情况（是否正确执行及错误码）。禁止采用bool类型作为返回值来表示函数执行情况。
避免void作为返回类型
返回值不能用来传递结果，结果数据可以采用引用类型的出参来实现。
返回值为整数时，其代表的含义统一规范为：小于0时表示执行错误；等于0时表示执行正确。

4.函数调用与错误日志
任何函数调用失败，必须记录日志。
避免无效的日志：日志中需要明确记录错误码（返回值）。除此之外，日志中还需要记录尽量多的上下文信息，包括全部的入参信息，具有相关性的成员变量信息、全局变量信息等。

5.尽量不使用全局变量。考虑采用成员变量或者main()中的局部变量代替。
如果采用全局变量，需要给出合适的解释。
可以规避问题：
各种奇葩问题

6.全局变量注意事项（如果一定要使用）
如果只在一个CPP文件中使用，那么请使用静态（static）全局变量。例如static int a = 0;
如果需要跨CPP使用，那么请使用较长且有区分度的名字来命名全局变量。例如。int _g_model_section_object;(解决linux上全局符号表识别错误问题)
确定该全局变量类的构造函数中没有进行复杂的初始化工作、是否依赖其他类。
清楚：c++标准没有规定不同编译单元(cpp文件)中的全局对象的构造顺序，只规定了同一编译单元中的全局对象按照其定义的顺序构造并倒序析构。
清楚：全局变量初始化发生在main函数执行前，且没有办法捕获到全局对象初始化抛出的异常。

7.使用数组前要先判空。
未判空的情况下，使用下标0或者front()或者back()函数访问数组元素都是危险的。

8.函数入参检查与出参复归
防御性编程：函数开始位置应对所有入参合法性、有效性进行检测；
函数开始位置应该对所有出参进行清理和复归工作；

9.字符串拷贝函数
字符串相关操作导致了太多问题。注意解决长度越界问题。

10.结构体与构造函数
结构体中如果使用了char[]数组，必须在构造函数中给char[]数组赋初值。
例如：

struct Test
{
    Test( )
    {
        *name=0;
    };
    char name[32];
};

慎用memset给结构体初始化，因为结构中可能有非连续变量类型，如string等。
错误示例：

struct Test
{
    char name[32];
    std::string name2;
};
Test test;
memset( &test, 0, sizeof( Test ) );

11.函数入参
复杂对象（如vector）应采用引用方式作为入参，而不是值传递。
对于“引用入参”应该采用const修饰符。尤其注意字符串入参应采用const char 类型，而不要采用char 。

12.”%s”与字符串
注意printf等函数中”%s”与字符串的对应关系，规避输出崩溃问题。代码review时，应着重检查该类问题。

13.使用stdint.h定义的变量类型
建议采用stdint.h中定义的数据类型如int32_t、int64_t、uint32_t、uint64_t等，避免不同平台数据长度问题。

14.命名规则
源码文件名、动态库名、执行程序名采用小写字母+下划线的组合方式。规避操作系统对大小写字母敏感导致的各类问题。

15.减少重复代码，优化结构设计
败絮其中，难以金玉在外。要努力避免流水账代码、机械地拷贝、粘贴、无设计的堆砌。相似代码、相似功能尽量抽取出来，封装为一个内部公共函数。

16.动态库中的结构体要定义在命名空间中
动态库中所定义的结构体，要定义在专有的命名空间中。规避问题：避免动态库与可执行程序之间结构体重名导致的各种问题。

17.switch-case语句中必须要有default语句，且default语句中应打印相关日志信息。

18.多线程
非线程安全的C函数。如struct tm *localtime(const time_t *timep);还有strtok、asctime、ctime、gmtime等等，使用时需要特别注意。
多线程共享的资源，使用前要先上线程锁。STL模板库是非线程安全的，例如多线程共享同一个vector，那么有关vector的任何操作前都需要使用锁保护，即使调用的仅仅是size()函数。
关于线程的退出。不要试图从外部强制杀掉某个线程，这样做存在极大的内存泄漏风险。

19.配置文件采用INI格式
除非INI格式不能满足配置要求，否则应一律采用INI格式。

20.函数提前结束，做好资源释放工作
若在某个程序分支中提前退出函数，请不要忘记释放内存、数据库句柄、文件句柄等资源，否则会导致内存泄漏，资源耗尽。
举例：

int Test( int a )
{
    char * b = new char[100];
    //...
    if ( a > 1000 )
    {
        delete b;//在这种情况下，切记不要忘记释放b
        return -1;
    }
    ...//其他操作   
}

21.消缺与维护
克服侥幸心理，问题只要出现一次就肯定会出现第二次第三次….;
不要放过小问题，小问题可能迁出大问题；
不应通过“试”来解决问题，应寻找问题的根本原因；
修复BUG需谨慎，全盘考虑，避免引入新BUG。