do...while(0)的妙用（转）

在C++中，有三种类型的循环语句：for, while, 和do...while， 但是在一般应用中作循环时， 我们可能用for和while要多一些，do...while相对不受重视。
    但是，最近在读我们项目的代码时，却发现了do...while的一些十分聪明的用法，不是用来做循环，而是用作其他来提高代码的健壮性。

1. do...while(0)消除goto语句。
通常，如果在一个函数中开始要分配一些资源，然后在中途执行过程中如果遇到错误则退出函数，当然，退出前先释放资源，我们的代码可能是这样：
version 1

bool  Execute  ()
{
     //  分配资源
     int  *  p  =  new  int  ;
    bool bOk(  true  );

     //  执行并进行错误处理
    bOk  =  func1();
     if  (!bOk) 
    {
       delete p;   
       p  =  NULL  ;
       return  false  ;
    }

    bOk  =  func2();
     if  (!bOk) 
    {
       delete p;   
       p  =  NULL  ;
       return  false  ;
    }

    bOk  =  func3();
     if  (!bOk) 
    {
       delete p;   
       p  =  NULL  ;
       return  false  ;
    }

     //     .

     //  执行成功，释放资源并返回
     delete p;   
     p  =  NULL  ;
     return  true  ;
   
}

这里一个最大的问题就是代码的冗余，而且我每增加一个操作，就需要做相应的错误处理，非常不灵活。于是我们想到了goto:
version 2

bool  Execute  ()
{
     //  分配资源
     int  *  p  =  new  int  ;
    bool bOk(  true  );

     //  执行并进行错误处理
    bOk  =  func1();
     if  (!bOk)  goto  errorhandle;

    bOk  =  func2();
     if  (!bOk)  goto  errorhandle;

    bOk  =  func3();
     if  (!bOk)  goto  errorhandle;

     //     .

     //  执行成功，释放资源并返回
     delete p;   
     p  =  NULL  ;
     return  true  ;

errorhandle:
     delete p;   
     p  =  NULL  ;
     return  false  ;
   
}

代码冗余是消除了，但是我们引入了C++中身份比较微妙的goto语句，虽然正确的使用goto可以大大提高程序的灵活性与简洁性，但太灵活的东西往往是很危险的，它会让我们的程序捉摸不定，那么怎么才能避免使用goto语句，又能消除代码冗余呢，请看do...while(0)循环：
version3

bool  Execute  ()
{
     //  分配资源
     int  *  p  =  new  int  ;

    bool bOk(  true  );
     do 
    {
        //  执行并进行错误处理
       bOk  =  func1();
        if  (!bOk) break;

       bOk  =  func2();
        if  (!bOk) break;

       bOk  =  func3();
        if  (!bOk) break;

        //     .

    }  while  (  0  );

      //  释放资源
     delete p;   
     p  =  NULL  ;
     return bOk;
   
}

“漂亮！”， 看代码就行了，啥都不用说了...

2 宏定义中的do...while(0)
如果你是C++程序员，我有理由相信你用过，或者接触过，至少听说过MFC, 在MFC的afx.h文件里面， 你会发现很多宏定义都是用了do...while(0)或do...while(false)， 比如说：

#define  AFXASSUME(cond)        do { bool __afx_condVal=!!(cond); ASSERT(__afx_condVal); __analysis_assume(__afx_condVal); } while(0)

粗看我们就会觉得很奇怪，既然循环里面只执行了一次，我要这个看似多余的do...while(0)有什么意义呢？ 
当然有！
为了看起来更清晰，这里用一个简单点的宏来演示：

#define  SAFE_DELETE(p) do{ delete p; p = NULL} while(0)

假设这里去掉do...while(0),

#define  SAFE_DELETE(p) delete p; p = NULL;

那么以下代码：

if  (NULL  !=  p) SAFE_DELETE(p)
else       do  sth

就有两个问题，
1) 因为if分支后有两个语句，else分支没有对应的if，编译失败
2) 假设没有else, SAFE_DELETE中的第二个语句无论if测试是否通过，会永远执行。
你可能发现，为了避免这两个问题，我不一定要用这个令人费解的do...while, 我直接用{}括起来就可以了

#define  SAFE_DELETE(p) { delete p; p = NULL;}

的确，这样的话上面的问题是不存在了，但是我想对于C++程序员来讲，在每个语句后面加分号是一种约定俗成的习惯，这样的话，以下代码:

if  (NULL  !=  p) SAFE_DELETE(p);
else       do  sth

其else分支就无法通过编译了（原因同上），所以采用do...while(0)是做好的选择了。

也许你会说，我们代码的习惯是在每个判断后面加上{}, 就不会有这种问题了，也就不需要do...while了，如：

if  ( ) 
{
}
else 
{
}

诚然，这是一个好的，应该提倡的编程习惯，但一般这样的宏都是作为library的一部分出现的，而对于一个library的作者，他所要做的就是让其库具有通用性，强壮性，因此他不能有任何对库的使用者的假设，如其编码规范，技术水平等。

posted on 2007-07-03 22:49  SmartPtr 阅读(1110)  评论(16)  编辑  收藏  引用 所属分类:  06. 程序语言

FeedBack:

#  re: do...while(0)的妙用

2007-07-03 23:29 |  czxskell 

不错 
恍然大悟   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-03 23:59 |  罗宾李 

原来是这样，不错！   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 02:47 |  天津大学计算机学院 常兴龙 

哦,不错不错！还悬念一下,紧张死偶了.   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 08:58 |  yzy 

有点意思   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 10:34 |  沐枫 

do{}while(0)
在于宏定义上的使用是无疑的。我在设计库的时候，是常用的。

但是对于第一点，用于消除goto，举的例子很不恰当。
而且，代码中常常有一些循环语句。此时，从内循环是无法用break跳出到外循环，仍然得用goto，这样,do while(0)就变得多余了。

用auto_ptr等自动守护(guard)机制是更好的选择：
bool Execute()
{
// 分配资源
auto_ptr<int> p = new int;

// 执行并进行错误处理
if(!func1())
return false;
if(!func2())
return false;
if(!func3())
return false;

//...
return true; 
}   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 10:36 |  力为 

不错~   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 11:02 |  SmartPtr 

to 沐枫 
欢迎参与讨论。 

的确，对于用do-while-break消除goto语句，的确不是一个很完美的例子，用auto_ptr是一个很好的选择， 而且这样也达到了异常安全的目的。但是auto_ptr只能处理指针这种资源， 我们可能还有处理其他资源，比如文件， 数据库链接，网络连接等等。 这样，在没有类似auto_ptr的机制处理这些资源的时候， 用do-while-break会是一个比较简单但不算太差的选择。 
另外， 对于你提到的多层循环的问题， 我想你可能被“do-while是用来做循环“这个定式限制了，这里do-while(0)的作用是在执行遇到错误时能break，正确的释放资源, 也就是说这么设计着去用的， 你想想， 是不是不会出现你想的那种情况？   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 11:07 |  沐枫 

比如文件， 数据库链接，网络连接等等这些都可以设计一个资源维护的guard来保护。
比如MFC的CFile就有这个功能。   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 11:18 |  anders06 

恭喜恭喜   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 13:35 |  chaosim 

do...while是个循环，但是如楼主这般使用，要让程序的阅读者(也就是维护者，审阅者,.......)大费周章猜测程序作者的本意。还不如用goto语句。 
错误处理和资源释放等任务自有其它更好的方式完成，何况如作者这般做法，也并未解决问题。误导。   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 14:47 |  Darkblue 

@chaosim 

也不能说是误导吧 
只不过是给大家提供另一种思路和看问题的另一种方式而已 

“错误处理和资源释放等任务自有其它更好的方式完成”，不知道可否共享出来让大家学习一下呢？   回复    更多评论
  

#  re: do...while(0)的妙用

2007-07-04 15:34 |  dfl 

看了大家的讨论，真是长了见识^_^   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-04 16:32 |  CloudStrifePeng 

条条大路通罗马，多条路子总是好的～   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-05 10:27 |  SuperPlayeR 

第二种用法我是从Linux内核分析中看到的，博主说了MFC中也有，才恍然大悟。唉~~自己也用了这么久VC了，还没真地去好好读过这些源码，惭愧惭愧~~   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-06 22:52 |  pass86 

赞一个。   回复    更多评论 
  

#  re: do...while(0)的妙用

2007-07-08 21:13 |  小学生 

涨见识了！   回复    更多评论