2009年4月18日 评论数：21条 标签： 编程 ,编程.C

C/C++ 中一个简单的 enum 手法（idiom）

★引子


　　今天写程序的时候，又用到这个 idiom 了，于是顺便贴出来。这个 idiom 蛮简单的，估计很多人都用过。今天主要是贴出来给新手参考（老手们就甭费时看此帖了）。
　　为了说明这个手法具体该咋用，咱举一个简单的例子来说事儿。比方说要开发一个网络程序，其中需要统计各种网络协议的数据包数量。

★版本1


　　假设一开始只需要处理 HTTP 和 FTP 两种协议。有些同学不假思索，立即会声明如下两个整数用于统计：
int nCntHttp = 0;
int nCntFtp = 0;

　　猛一看，似乎没啥问题。但是，如果需求发生变更，又要增加两种协议：SMTP 和 SSH。然后，该同学会继续扩展上述代码，变为如下：
int nCntHttp = 0;
int nCntFtp = 0;
int nCntSmtp = 0;
int nCntSsh = 0;

　　这时候，问题开始显露出来了。比方说要打印上述4统计值，就得写4个 printf 语句；再假如要用断言确保所有统计值大于零，也得写4个 assert 断言。这都是挺烦人的事儿。（当然啦，有些同学会把4个变量的打印写在一个 printf 中，但还是一样烦人）

★版本2


　　这可咋办捏？有点小聪明的程序猿就灵机一动，把上述代码修改为数组形式，上述的4个统计值【依次】放入数组中。具体如下：
int nCntProto[4];
/* 第0个是HTTP，第1个是FTP，第2个是SMTP，第3个是SSH */

　　这样一来，无论是打印还是断言，用一个 for 循环就搞定，貌似挺方便滴。
　　但这么一来，引入了另一个问题：假设我在程序中要用到 SMTP 的统计数字，就得这么写代码：
nCntProto[2]

　　这就造成了很不雅观的“Magic Number”！要知道，Magic Number 可是代码的臭味之一啊（其弊端在“这篇博文”中曾经介绍过）。万一将来，数组中的存放顺序发生变化，那就完蛋了：好多用到 Magic Number 的代码都得跟着改。一旦漏改某处，引出 Bug 无数！

★版本3


　　为了消除 Magic Number，增加代码可读性和可维护性，有些同学开始打起 enum 的主意。在代码中增加了一组 enum，具体如下：
enum PROTO
{
    PROTO_HTTP,
    PROTO_FTP,
    PROTO_SMTP,
    PROTO_SSH,
};

int nCntProto[4];

　　这样，如果我需要用到 SMTP 的统计数字，我就不用写
nCntProto[2]
而是写
nCntProto[PROTO_SMTP]
　　显然，可读性明显好多了。即使将来数组中的存放顺序发生变化，也没关系：只需稍微调整 enum 中常量的顺序即可，其它代码不用动。

★版本4


　　但是，还是有一个不爽的地方。定义数组的语句用到了“4”这个 Magic Number。万一将来需求继续变更，继续增加协议，那这个数字还得不断调整。还是有点不爽！
　　咋办捏？这时候，终极版本隆重登场。请看如下代码：
enum PROTO
{
    PROTO_HTTP,
    PROTO_FTP,
    PROTO_SMTP,
    PROTO_SSH,

    PROTO_NUM  /* 表示协议数量 */
};

int nCntProto[PROTO_NUM];

　　这种写法的好处在于，【没有任何一个】Magic Number 出现在代码中。不管是引用某个统计值还是循环遍历数组，都使用的是定义好的常量。
　　就算未来发生需求变更，要增加新的协议，只要往 enum 中增加相应的 enum 常量即可（但要记得保证 PROTO_NUM 位于 enum 定义的末尾）。由于 PROTO_NUM 会自动跟着增长，所以其它的代码几乎不会受到影响。

★C++ 的补充说明


　　上述代码同时适用于 C 和 C++。不过捏，某些 C++ 程序员或许看不惯原始数组，觉得 STL 的容器类看起来比较顺眼。那也没啥大关系：只要把上述代码中声明数组的那句修改为如下，其它的代码基本照旧。
std::vector<int> vctCntProto(PROTO_NUM);
版权声明
本博客所有的原创文章，作者皆保留版权。转载必须包含本声明，保持本文完整，并以超链接形式注明作者编程随想和本文原始地址：
https://program-think.blogspot.com/2009/04/c-cxx-enum-idiom.html