虽然C++一直在强调尽量少用宏,但是宏确实是个好东西,会使代码很简洁,使人欲罢不能。
近期出现一个无法理解的异常,找了很长时间,结果发现是调用的别人的宏导致的,差点吐血。
实际工作中,日志是定位程序错误的常用手段之一。不同等级的日志输出,代表不同的错误级别,有一些仅仅是警告,对程序运行无任何影响,则只需要打印出来即可;但有一些是严重的错误,会对后续程序的运行影响很大,除了打印信息外,最好还能直接断言,提示开发人员。
程序实际运行时,一般错误日志都是写到日志文件中;而开发环境下,直接打印到控制台更方便查看。想要实现这个功能,用宏来控制再方便不过。
开发环境visual studio 2013, 代码如下:
#include <iostream>
#include <assert.h>
#ifdef _DEBUG
#define LOG_I(x) std::cout << "警告:" << x << std::endl
#define LOG_E(x) std::cout << "错误:" << x << std::endl; assert(false)
#else
//有关文件的操作省略
#endif
int _tmain(int argc, _TCHAR* argv[])
{
LOG_I("有瑕疵");
LOG_E("有错误");
system("pause");
return 0;
}
这里很简单,如果定义了_DEBUG宏,即开发调试环境,则将日志打印到控制台;否则,将日志写到对应文件中(简单起见,此处省略)。注意,宏定义最后面是没有分号的。
编译运行,结果如下:
LOG_E宏除了打印错误日志外,还会触发断言,这里这样使用没任何问题。
但是,日志的打印,一般都会有条件判断,即某错误条件成立后,才打印日志。代码调整如下:
#include <iostream>
#include <assert.h>
#ifdef _DEBUG
#define LOG_I(x) std::cout << "警告:" << x << std::endl
#define LOG_E(x) std::cout << "错误:" << x << std::endl; assert(false)
#else
//有关文件的操作省略
#endif
int _tmain(int argc, _TCHAR* argv[])
{
int iValue;
std::cout << "请输入一个偶数:";
std::cin >> iValue;
if (iValue % 2 == 0)
LOG_I("数据正确");
else
LOG_E("数据错误");
system("pause");
return 0;
}
运行,输入1,结果如下:
和预想的一致,似乎没什么问题。但是如果输入的2,什么情况呢?
纳尼?发生了什么?
仔细看代码,用具体代码替换掉宏,if语句的代码就是如下:
问题就出在LOG_E宏上,里面有多条语句。展开后,只有第一条语句在else作用域内,第二条则一定会指定。
想要解决该怎么办?有两种方式:
1、在条件判断语句后面加上{}
调整后的代码如下:
#include <iostream>
#include <assert.h>
#ifdef _DEBUG
#define LOG_I(x) std::cout << "警告:" << x << std::endl
#define LOG_E(x) std::cout << "错误:" << x << std::endl; assert(false)
#else
//有关文件的操作省略
#endif
int _tmain(int argc, _TCHAR* argv[])
{
int iValue;
std::cout << "请输入一个偶数:";
std::cin >> iValue;
if (iValue % 2 == 0)
{
LOG_I("数据正确");
}
else
{
LOG_E("数据错误");
}
system("pause");
return 0;
}
运行后结果如下:
结果正确!
但如果你是宏的设计者,则需要为你设计的宏负责,用下面的方式更合适。
2、多条语句的宏,用{}将多条语句括起来
修改代码如下:
#include <iostream>
#include <assert.h>
#ifdef _DEBUG
#define LOG_I(x) std::cout << "警告:" << x << std::endl
#define LOG_E(x) { std::cout << "错误:" << x << std::endl; assert(false); }
#else
//有关文件的操作省略
#endif
int _tmain(int argc, _TCHAR* argv[])
{
int iValue;
std::cout << "请输入一个偶数:";
std::cin >> iValue;
if (iValue % 2 == 0)
LOG_I("数据正确");
else
LOG_E("数据错误");
system("pause");
return 0;
}
执行结果如下:
没问题!
有关宏的使用,一定要谨慎,特别是和条件判断语句搭配使用。
宏后面是否有";"也需要注意,和条件语句一起,也可能产生意想不到的问题。