成为C++高手之提高可维护性

思路

当前的poker工程还能进一步改进：把只与扑克相关的各种声明和定义单独拿出来，放到单独的文件中；把只与玩家相关的东西拿出来，放到单独的文件中，而main函数里只是使用这些定义或声明，于是变成了三个文件：poker.c、player.c,main.c。这样带来什么好处呢？一是要查看或修改poker相关的功能，我们只需打开poker.c。现在由于程序小，感觉不出分开的优势，但当写一个程序要处理几十上百种结构时，如果不分开，面对一个上万行代码的main文件，相信一般人都会头晕。二是当别人要写一个poker游戏时，发现我们的poker.c中已经把操作一副牌的功能都实现了，于是他们只需把poker.c文件复制到自己的工程中用就ok了。通过分散到多个文件中，我们提高了代码的可维护性和可重用性。

下面我们就来研究一下代码中的东西该归各处：

card结构，表示一张牌，肯定要放到poker.c中。 定义一副牌数量的宏card_count只与扑克有关，放到poker.c中。 定义poker花色的枚举，与宏card_count一样，放到poker.c中。 比较函数，只与扑克相关，放到poker.c中。 比较函数类型定义，跟着比较函数走，放到poker.c中。 构造一副牌的函数initonepack，放到poker.c中。 洗牌函数shuffle，只操作card结构，放到poker.c中。 排序函数，只排扑克的序，放到poker.c中。 获取牌名字的函数，只操作扑克，放到poker.c中。 结构player，肯定放到player.c中。 存放原始一副牌的数组pokers，放到poker.c中。 分牌函数，操做了player和card两个结构，放在main.c中可以， 是从人思维角度讲，是人发牌，所以把它放到 player.c中也没问题。这个随意吧，但是我个人的话感觉放到player.c文件中比较好，所以我放到player.c中。 函数声明们跟着函数定义走。

现在是不是可以在main.c里include这两个文件然后就能编译出结果呢?有个问题先说明一下：c文件也是可以被include的，因为include的实质就是将被include的文件的内容复制到include行的位置。但include之后会产生一大堆错误，编译是不会成功的。这些错误的描述大都是说类型或标志符重复定义。这些错误是怎么造成的，后面再说，先说怎么解决。解决方法很简单：将poker.c和player.c从编译中排除，即不再编译poker.c和player.c。它们的内容会被插入main.c中，形成完整的main.c，此时poker.c和player.c不需要编译了。如果编译的话，就会产生重复定义，其原因后面的“编译过程详解”（请期待）一节有解释。所以要把这两个文件从工程中删掉，但不能删除实际的文件哦，只是从工程中删除对它们的引用，如果删掉了实际的文件，include就是找不到文件了。

删除一个文件的引用，在qtcreator中是这样的，如图，不要选中check按钮：

现在三个文件是这样的：

poker.c

#include 
//一副牌的数量
#define card_count 54
//定义扑克的花色
enum suit{
    heart,
    spade,
    diamond,
    club,
    joker1,
    joker2
};
//定义扑克
typedef struct card{
    int value;//牌的点数从1开始
    enum suit suit;//花色
}card;
//定义比较函数的类型
typedef int (*compare)(card* ,card*);
//原始一副牌所在的数组
card pokers[card_count];
//构造一副牌
void initonepack(){
    int i=0;
    //前52张
    for(;ivalue > b->value){
        return 1;
    }else if(a->value < b->value){
        return 0;
    }else{
        if(a->suit > b->suit)
            return 1;
        else
            return 0;
    }
}
//比较函数，先比较点数再比较花色
int compare2(card* a,card* b){
    if(a->value > b->value){
        return 0;
    }else if(a->value < b->value){
        return 1;
    }else{
        if(a->suit > b->suit)
            return 0;
        else
            return 1;
    }
}
//获取牌的名字
//返回牌的名字字符串，调用者用完后需要free()之。
char* getcardname(const card* card){
    //存放花色名字
    char suitstr[16]={0};//0=='\0'
    switch (card->suit) {
    case heart:
        strcpy(suitstr,"红桃");
        break;
    case spade:
        strcpy(suitstr,"黑桃");
        break;
    case diamond:
        strcpy(suitstr,"方块");
        break;
    case club:
        strcpy(suitstr,"梅花");
        break;
    }
    //存放点数名字
    char valuestr[16];
    switch(card->value){
    case 1:
        strcpy(valuestr,"a");
        break;
    case 11:
        strcpy(valuestr,"j");
        break;
    case 12:
        strcpy(valuestr,"q");
        break;
    case 13:
        strcpy(valuestr,"k");
        break;
    case 14:
        strcpy(valuestr,"小王");
        break;
    case 15:
        strcpy(valuestr,"大王");
        break;
    default:
        sprintf(valuestr,"%d",card->value);
        break;
    }
    //动态分配足够的空间
    char * ret = malloc(16);
    //将两个名字合并到ret中
    sprintf(ret,"%s%s",suitstr,valuestr);
    return ret;
}

player.c:

//定义玩家
typedef struct player{
    char name[64];//玩家的名字
    card ** cards;//玩家分到的牌。每项是一个指针，指向原始一副牌数组中的一项，这样可以节省空间
    int cardscount;//玩家分到的牌的数量
}player;
//发牌
//players是玩家数组
//playercount是玩家数量
//shuffledcards是洗完后的一副牌
void dispatchcards(player** players,int playercount,const card** shuffledcards){
    //计算每个玩家手中牌的数组的容量，如果每个玩家手中的牌不一样，
    //最多就差一张，加1是为了保证数组分配的空间足够容纳分到的牌。
    int numbercards = card_count/playercount+1;
    //为每个玩家的牌数组分配空间
    int i;
    for(i=0;icards = cards;
    }
    //轮流向每个玩家发牌
    for(i=0;icards[curplayer->cardscount] = shuffledcards[i];
        //玩家手中实际的牌数增加
        curplayer->cardscount++;
    }
};i++){>

main.c:

#include 
#include 
#include 
#include "poker.c"
#include "player.c"
//函数声明们
//char* getcardname(const card*);
//card** shuffle(const card*);
//void dispatchcards(player** ,int ,const card** );
//void sort(card**,int,compare);
//int compare1(card* ,card*);
//int compare2(card* ,card*);
//void initonepack();
//原始一副牌所在的数组
card pokers[card_count];
//入口函数
int main(void)
{
    //初始化一副牌
    initonepack();
    //洗牌，shuffledpokers保存洗后的牌们
    card** shuffledpokers = shuffle(pokers);
    //构建三个玩家
    player player1;
    strcpy(player1.name,"隔壁老王");
    player1.cards=null;
    player1.cardscount=0;
    player player2;
    strcpy(player2.name,"小明");
    player2.cards=null;
    player2.cardscount=0;
    player player3;
    strcpy(player3.name,"田中龟孙");
    player3.cards=null;
    player3.cardscount=0;
    //把三放到一个数组中，以传入发牌函数中
    player* players[]={&player1,&player2,&player3};
    //发牌
    dispatchcards(players,sizeof(players)/sizeof(player*),shuffledpokers);
    //洗后的牌用完了，释放之
    free(shuffledpokers);
    int i;
    //打印出每个玩家手中的牌
    for(i=0;iname);
        //需要对玩家手中的牌排序
        sort(players[i]->cards,players[i]->cardscount,compare1);
        //打印玩家手中所有的牌
        int j;
        for(j=0;jcardscount;j++){
            char * name = getcardname(players[i]->cards[j]);
            printf("%s ",name);
            free(name);
        }
        //每个玩家都需要换一次行
        printf("\n");
    }
    //释放玩家手中牌的数组
    for(i=0;icards);
    }
    return 0;
}[i]->