编程修养（二）

6、if 语句对出错的处理

———————————

我看见你说了，这有什么好说的。还是先看一段程序代码吧。

if ( ch >= '0' && ch <= '9' ){

/* 正常处理代码 */

}else{

/* 输出错误信息 */

printf("error ....../n");

return ( FALSE );

}

这种结构很不好，特别是如果“正常处理代码”很长时，对于这种情况，最好不要用else

。先判断错误，如：

if ( ch < '0' || ch > '9' ){

/* 输出错误信息 */

printf("error ....../n");

return ( FALSE );

}

/* 正常处理代码 */

......

这样的结构，不是很清楚吗？突出了错误的条件，让别人在使用你的函数的时候，第一眼

就能看到不合法的条件，于是就会更下意识的避免。

7、头文件中的#ifndef

——————————

千万不要忽略了头件的中的#ifndef，这是一个很关键的东西。比如你有两个C文件，这两

个C文件都include了同一个头文件。而编译时，这两个C文件要一同编译成一个可运行文件

，于是问题来了，大量的声明冲突。

还是把头文件的内容都放在#ifndef和#endif中吧。不管你的头文件会不会被多个文件引用

管你的头文件会不会被多个文件引用

，你都要加上这个。一般格式是这样的：

#ifndef <标识>

#define <标识>

......

......

#endif

<标识>在理论上来说可以是自由命名的，但每个头文件的这个“标识”都应该是唯一的。

标识的命名规则一般是头文件名全大写，前后加下划线，并把文件名中的“.”也变成下划

线，如：stdio.h

#ifndef _STDIO_H_

#define _STDIO_H_

......

#endif

（BTW：预编译有多很有用的功能。你会用预编译吗？）

（BTW：预编译有多很有用的功能。你会用预编译吗？）

8、在堆上分配内存

—————————

可能许多人对内存分配上的“栈 stack”和“堆 heap”还不是很明白。包括一些科班出身

的人也不明白这两个概念。我不想过多的说这两个东西。简单的来讲，stack上分配的内存

系统自动释放，heap上分配的内存，系统不释放，哪怕程序退出，那一块内存还是在那里

。stack一般是静态分配内存，heap上一般是动态分配内存。

由malloc系统函数分配的内存就是从堆上分配内存。从堆上分配的内存一定要自己释放。

用free释放，不然就是术语——“内存泄露”（或是“内存漏洞”）—— Memory Leak。

于是，系统的可分配内存会随malloc越来越少，直到系统崩溃。还是来看看“栈内存”和

“堆内存”的差别吧。

栈内存分配

—————

char*

AllocStrFromStack()

{

char pstr[100];

return pstr;

}

堆内存分配

—————

char*

AllocStrFromHeap(int len)

{

char *pstr;

if ( len <= 0 ) return NULL;

return ( char* ) malloc( len );

}

对于第一个函数，那块pstr的内存在函数返回时就被系统释放了。于是所返回的char*什么

也没有。而对于第二个函数，是从堆上分配内存，所以哪怕是程序退出时，也不释放，所

以第二个函数的返回的内存没有问题，可以被使用。但一定要调用free释放，不然就是Mem

ory Leak！

在堆上分配内存很容易造成内存泄漏，这是C/C++的最大的“克星”，如果你的程序要稳定

，那么就不要出现Memory Leak。所以，我还是要在这里千叮咛万嘱付，在使用malloc系统

蛑龈叮谑褂胢alloc系统

函数（包括calloc，realloc）时千万要小心。

记得有一个UNIX上的服务应用程序，大约有几百的C文件编译而成，运行测试良好，等使用

时，每隔三个月系统就是down一次，搞得许多人焦头烂额，查不出问题所在。只好，每隔

两个月人工手动重启系统一次。出现这种问题就是Memery Leak在做怪了，在C/C++中这种

问题总是会发生，所以你一定要小心。一个Rational的检测工作——Purify，可以帮你测

试你的程序有没有内存泄漏。

我保证，做过许多C/C++的工程的程序员，都会对malloc或是new有些感冒。当你什么时候

在使用malloc和new时，有一种轻度的紧张和惶恐的感觉时，你就具备了这方面的修养了。

对于malloc和free的操作有以下规则：

1) 配对使用，有一个malloc，就应该有一个free。（C++中对应为new和delete）

2) 尽量在同一层上使用，不要像上面那种，malloc在函数中，而free在函数外。最好在同

一调用层上使用这两个函数。

3) malloc分配的内存一定要初始化。free后的指针一定要设置为NULL。

注：虽然现在的操作系统（如：UNIX和Win2k/NT）都有进程内存跟踪机制，也就是如果你

有没有释放的内存，操作系统会帮你释放。但操作系统依然不会释放你程序中所有产生了M

emory Leak的内存，所以，最好还是你自己来做这个工作。（有的时候不知不觉就出现Mem

ory Leak了，而且在几百万行的代码中找无异于海底捞针，Rational有一个工具叫Purify

蛐械拇胫姓椅抟煊诤５桌陶耄琑ational有一个工具叫Purify

，可能很好的帮你检查程序中的Memory Leak）

9、变量的初始化

————————

接上一条，变量一定要被初始化再使用。C/C++编译器在这个方面不会像JAVA一样帮你初始

化，这一切都需要你自己来，如果你使用了没有初始化的变量，结果未知。好的程序员从

来都会在使用变量前初始化变量的。如：

1) 对malloc分配的内存进行memset清零操作。（可以使用calloc分配一块全零的内存

）

2) 对一些栈上分配的struct或数组进行初始化。（最好也是清零）

不过话又说回来了，初始化也会造成系统运行时间有一定的开销，所以，也不要对所有的

变量做初始化，这个也没有意义。好的程序员知道哪些变量需要初始化，哪些则不需要。

如：以下这种情况，则不需要。

char *pstr; /* 一个字符串 */

pstr = ( char* ) malloc( 50 );

if ( pstr == NULL ) exit(0);

strcpy( pstr, "Hello Wrold" );

strcpy( pstr, "Hello Wrold" );

但如果是下面一种情况，最好进行内存初始化。（指针是一个危险的东西，一定要初始化

）

char **pstr; /* 一个字符串数组 */

pstr = ( char** ) malloc( 50 );

if ( pstr == NULL ) exit(0);

/* 让数组中的指针都指向NULL */

memset( pstr, 0, 50*sizeof(char*) );

而对于全局变量，和静态变量，一定要声明时就初始化。因为你不知道它第一次会在哪里

被使用。所以使用前初始这些变量是比较不现实的，一定要在声明时就初始化它们。如：

Links *plnk = NULL; /* 对于全局变量plnk初始化为NULL */

10、h和c文件的使用

—————————

—————————

H文件和C文件怎么用呢？一般来说，H文件中是declare（声明），C文件中是define（定义

）。因为C文件要编译成库文件（Windows下是.obj/.lib，UNIX下是.o/.a），如果别人要

使用你的函数，那么就要引用你的H文件，所以，H文件中一般是变量、宏定义、枚举、结

构和函数接口的声明，就像一个接口说明文件一样。而C文件则是实现细节。

H文件和C文件最大的用处就是声明和实现分开。这个特性应该是公认的了，但我仍然看到

有些人喜欢把函数写在H文件中，这种习惯很不好。（如果是C++话，对于其模板函数，在V

C中只有把实现和声明都写在一个文件中，因为VC不支持export关键字）。而且，如果在H

文件中写上函数的实现，你还得在makefile中把头文件的依赖关系也加上去，这个就会让

你的makefile很不规范。

最后，有一个最需要注意的地方就是：带初始化的全局变量不要放在H文件中！

例如有一个处理错误信息的结构：

char* errmsg[] = {

/* 0 */ "No error",

/* 1 */ "Open file error",

/* 2 */ "Failed in sending/receiving a message",

/* 3 */ "Bad arguments",

/* 4 */ "Memeroy is not enough",

/* 5 */ "Service is down; try later",

/* 6 */ "Unknow information",

/* 7 */ "A socket operation has failed",

/* 8 */ "Permission denied",

/* 9 */ "Bad configuration file format",

/* 10 */ "Communication time out",

......

......

};

请不要把这个东西放在头文件中，因为如果你的这个头文件被5个函数库（.lib或是.a）所

用到，于是他就被链接在这5个.lib或.a中，而如果你的一个程序用到了这5个函数库中的

函数，并且这些函数都用到了这个出错信息数组。那么这份信息将有5个副本存在于你的执

行文件中。如果你的这个errmsg很大的话，而且你用到的函数库更多的话，你的执行文件

也会变得很大。

正确的写法应该把它写到C文件中，然后在各个需要用到errmsg的C文件头上加上 extern

char* errmsg[]; 的外部声明，让编译器在链接时才去管他，这样一来，就只会有一个err

msg存在于执行文件中，而且，这样做很利于封装。

我曾遇到过的最疯狂的事，就是在我的目标文件中，这个errmsg一共有112个副本，执行文

件有8M左右。当我把errmsg放到C文件中，并为一千多个C文件加上了extern的声明后，所

有的函数库文件尺寸都下降了20%左右，而我的执行文件只有5M了。一下子少了3M啊。

［ 备注 ］

—————

有朋友对我说，这个只是一个特例，因为，如果errmsg在执行文件中存在多个副本时，可

以加快程序运行速度，理由是errmsg的多个复本会让系统的内存换页降低，达到效率提升

。像我们这里所说的errmsg只有一份，当某函数要用errmsg时，如果内存隔得比较远，会

产生换页，反而效率不高。

生副本导致执行文件尺寸变大，不仅增加了系统装载时间，也会让一个程序在内存中占更

多的页面。而对于errmsg这样数据，一般来说，在系统运行时不会经常用到，所以还是产

生的内存换页也就不算频繁。权衡之下，还是只有一份errmsg的效率高。即便是像logmsg

这样频繁使用的的数据，操作系统的内存调度算法会让这样的频繁使用的页面常驻于内存

，所以也就不会出现内存换页问题了。

11、出错信息的处理

—————————

你会处理出错信息吗？哦，它并不是简单的输出。看下面的示例：

if ( p == NULL ){

printf ( "ERR: The pointer is NULL/n" );

}

告别学生时代的编程吧。这种编程很不利于维护和管理，出错信息或是提示信息，应该统

一处理，而不是像上面这样，写成一个“硬编码”。第10条对这方面的处理做了一部分说

明。如果要管理错误信息，那就要有以下的处理：

/* 声明出错代码 */

#define ERR_NO_ERROR 0 /* No error */

#define ERR_OPEN_FILE 1 /* Open file error */

#define ERR_SEND_MESG 2 /* sending a message error */

#define ERR_BAD_ARGS 3 /* Bad arguments */

#define ERR_MEM_NONE 4 /* Memeroy is not enough */

#define ERR_SERV_DOWN 5 /* Service down try later */

#define ERR_UNKNOW_INFO 6 /* Unknow information */

#define ERR_SOCKET_ERR 7 /* Socket operation failed */

#define ERR_PERMISSION 8 /* Permission denied */

#define ERR_BAD_FORMAT 9 /* Bad configuration file */

#define ERR_TIME_OUT 10 /* Communication time out */

/* 声明出错信息 */

char* errmsg[] = {

/* 0 */ "No error",

/* 1 */ "Open file error",

/* 2 */ "Failed in sending/receiving a message",

/* 3 */ "Bad arguments",

/* 4 */ "Memeroy is not enough",

/* 5 */ "Service is down; try later",

/* 6 */ "Unknow information",

/* 7 */ "A socket operation has failed",

/* 8 */ "Permission denied",

/* 9 */ "Bad configuration file format",

/* 10 */ "Communication time out",

/* 10 */ "Communication time out",

};

/* 声明错误代码全局变量 */

long errno = 0;

/* 打印出错信息函数 */

void perror( char* info)

{

if ( info ){

printf("%s: %s/n", info, errmsg[errno] );

return;

}

printf("Error: %s/n", errmsg[errno] );

}

这个基本上是ANSI的错误处理实现细节了，于是当你程序中有错误时你就可以这样处理：

bool CheckPermission( char* userName )

{

if ( strcpy(userName, "root") != 0 ){

errno = ERR_PERMISSION_DENIED;

return (FALSE);

}

...

}

main()

{

...

if (! CheckPermission( username ) ){

perror("main()");

}

...

}

一个即有共性，也有个性的错误信息处理，这样做有利同种错误出一样的信息，统一用户

界面，而不会因为文件打开失败，A程序员出一个信息，B程序员又出一个信息。而且这样

做，非常容易维护。代码也易读。

当然，物极必反，也没有必要把所有的输出都放到errmsg中，抽取比较重要的出错信息或

是提示信息是其关键，但即使这样，这也包括了大多数的信息。

12、常用函数和循环语句中的被计算量

—————————————————

看一下下面这个例子：

for( i=0; i<1000; i++ ){

GetLocalHostName( hostname );

...

}

GetLocalHostName的意思是取得当前计算机名，在循环体中，它会被调用1000次啊。这是

多么的没有效率的事啊。应该把这个函数拿到循环体外，这样只调用一次，效率得到了很

大的提高。虽然，我们的编译器会进行优化，会把循环体内的不变的东西拿到循环外面，

但是，你相信所有编译器会知道哪些是不变的吗？我觉得编译器不可靠。最好还是自己动

手吧。

同样，对于常用函数中的不变量，如：

GetLocalHostName(char* name)

{

{

char funcName[] = "GetLocalHostName";

sys_log( "%s begin......", funcName );

...

sys_log( "%s end......", funcName );

}

如果这是一个经常调用的函数，每次调用时都要对funcName进行分配内存，这个开销很大

啊。把这个变量声明成static吧，当函数再次被调用时，就会省去了分配内存的开销，执

行效率也很好。

13、函数名和变量名的命名

————————————

我看到许多程序对变量名和函数名的取名很草率，特别是变量名，什么a,b,c,aa,bb,cc，

还有什么flag1,flag2, cnt1, cnt2，这同样是一种没有“修养”的行为。即便加上好的注

释。好的变量名或是函数名，我认为应该有以下的规则：

1) 直观并且可以拼读，可望文知意，不必“解码”。

2) 名字的长度应该即要最短的长度，也要能最大限度的表达其含义。

3) 不要全部大写，也不要全部小写，应该大小写都有，如：GetLocalHostName 或是

UserAccount。

4) 可以简写，但简写得要让人明白，如：ErrorCode -> ErrCode,

ServerListener -> ServLisner，UserAccount -> UsrAcct 等。

5) 为了避免全局函数和变量名字冲突，可以加上一些前缀，一般以模块简称做为前缀

。

6) 全局变量统一加一个前缀或是后缀，让人一看到这个变量就知道是全局的。

7) 用匈牙利命名法命名函数参数，局部变量。但还是要坚持“望文生意”的原则。

8) 与标准库（如：STL）或开发库（如：MFC）的命名风格保持一致。

14、函数的传值和传指针

————————————

向函数传参数时，一般而言，传入非const的指针时，就表示，在函数中要修改这个指针把

指内存中的数据。如果是传值，那么无论在函数内部怎么修改这个值，也影响不到传过来

的值，因为传值是只内存拷贝。

什么？你说这个特性你明白了，好吧，让我们看看下面的这个例程：

void

void

GetVersion(char* pStr)

{

pStr = malloc(10);

strcpy ( pStr, "2.0" );

}

main()

{

char* ver = NULL;

GetVersion ( ver );

...

...

free ( ver );

}

我保证，类似这样的问题是一个新手最容易犯的错误。程序中妄图通过函数GetVersion给

指针ver分配空间，但这种方法根本没有什么作用，原因就是——这是传值，不是传指针。

你或许会和我争论，我分明传的时指针啊？再仔细看看，其实，你传的是指针其实是在传

值。

15、修改别人程序的修养

———————————

当你维护别人的程序时，请不要非常主观臆断的把已有的程序删除或是修改。我经常看到

有的程序员直接在别人的程序上修改表达式或是语句。修改别人的程序时，请不要删除别

人的程序，如果你觉得别人的程序有所不妥，请注释掉，然后添加自己的处理程序，必竟

，你不可能100%的知道别人的意图，所以为了可以恢复，请不依赖于CVS或是SourceSafe这

种版本控制软件，还是要在源码上给别人看到你修改程序的意图和步骤。这是程序维护时

，一个有修养的程序员所应该做的。

如下所示，这就是一种比较好的修改方法：

/*

* ----- commented by haoel 2003/04/12 ------

*

* char* p = ( char* ) malloc( 10 );

* memset( p, 0, 10 );

*/

/* ------ Added by haoel 2003/04/12 ----- */

char* p = ( char* )calloc( 10, sizeof char );

/* ---------------------------------------- */

* char* p = 开始使劲) malloc( 10 );

* memset( p, 0, 10 );

*/

/* ------ Added by haoel 2003/04/12 ----- */

char* p = ( char* )calloc( 10, sizeof char );

/* ---------------------------------------- */

...

当然，这种方法是在软件维护时使用的，这样的方法，可以让再维护的人很容易知道以前

的代码更改的动作和意图，而且这也是对原作者的一种尊敬。

以“注释 — 添加”方式修改别人的程序，要好于直接删除别人的程序。