有始有终的编码原则

基本情况

在程序员的修炼之道之中,说到:

这个建议能简单地应用到大多数场合。简单说就是,分配资源的函
数或对象,对释放资源应负有责任。

这其实就是我们常说的谁分配的就谁负责释放,这也是内存释放的一个原则,这一个原则,可以推而广之,就是谁分配的资源,就谁分配释放;这真是非常常用的东西,比如数据库存连接的分配与释放。

我写一个简单的例子说明这种情况,这一个例子就是单纯为了实现价格读出后,然后价格更改,再写入:

void Market::readCustomer()
{
    fopen_s(&m_pf, "test.txt", "r+");

    if (m_pf != nullptr)
    {
        CUSTOMER p = {0};
        fscanf(m_pf, "%s %d", p.name, &p.price);
        printf("%s %d\n", p.name, p.price);
    }
}

void Market::writeCustomer()
{
    if (m_pf != nullptr)
    {
        CUSTOMER p = { "zhangsan", m_money };
        fprintf(m_pf, "%s %d\n", p.name, p.price);
        printf("%s %d\n", p.name, p.price);
        fclose(m_pf);
        m_pf = nullptr;
    }
}

void Market::updateCustomer(int money)
{

    this->readCustomer();
    m_money = money;
    this->writeCustomer();

}

为了清楚其见,写下头文件的部分代码:

typedef struct Customer
{
    char name[10];
    int price;

}CUSTOMER;

private:
     FILE* m_pf;
     int m_money;

上面代码updateCustomer,看着是没问题的,但发现其耦合了变量 m_pf,从函数角度来看,的确是耦合这一个变量,不是一个好事;

后来加了些需要,要求100元以上,才更改价格,程序员,可能更改成下面这个样子:

void Market::updateCustomer(int money)
{

    this->readCustomer();
    m_money = money;
    if(m_money > 100)
    {
        this->writeCustomer();
    }

}

运行代码,不一会,就提示打开的文件过多,原来,那些小于100的客户,只打开了文件的链接,没有关闭文件链接,与是可能更改如下:

void Market::updateCustomer(int money)
{

   this->readCustomer();
   m_money = money;
   if(m_money > 100)
   {
       this->writeCustomer();
   }
   else
   {
     fclose(m_pf);
   }

}

现在问题是解决了,但是出现一个变量的三处耦合,最严重的是文件的状态变得混乱。

程序员修炼这样描述这种问题:

这个问题已修复——如果不考虑新的平衡,文件现在的确关闭了。
但是,这个修复方案意味着,三个例程因为共享变量m_pf耦合
在了一起,而且对文件何时是打开状态、何时是关闭状态的跟踪开始变
得混乱。我们正掉入一个陷阱,如果继续走这条路,情况将开始迅速恶
化。这是不平衡的!

那么,如果用有始有终的原则,则更改如下:

void Market::readCustomer(FILE *pf)
{
    if (pf != nullptr)
    {
        CUSTOMER p = {0};
        fscanf(pf, "%s %d", p.name, &p.price);
        printf("%s %d\n", p.name, p.price);
    }
}

void Market::writeCustomer(FILE *pf)
{
    if (pf != nullptr)
    {
        CUSTOMER p = { "zhangsan", m_money };
        fprintf(pf, "%s %d\n", p.name, p.price);
        printf("%s %d\n", p.name, p.price);
    }
}

void Market::updateCustomer(int money)
{   
    FILE *pf;
    fopen_s(&pf, "test.txt", "r+");
    this->readCustomer(pf);
    m_money = money;
    this->writeCustomer(pf);
    fclose(pf);
    pf = nullptr;
}

这样代码就清晰了很多:

我们修改了代码,将文件引用通过参数传进去,而不是在内部持有
引用[5]。现在,关于该文件的所有职责都在 updateCustomer例程中。
它打开文件,再(有始有终地)在返回之前关闭它。例程保持了文件使
用的平衡:打开和关闭在同一个位置,而且非常明显的是,每次对文件
的打开操作都有一个对应的关闭操作。重构还删除了一个丑陋的共享变
量。

总结

代码中时时处处都在遵守这一原则,代码才能清晰,代码才能简单。


image.png
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,869评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,716评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 166,223评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,047评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,089评论 6 395
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,839评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,516评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,410评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,920评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,052评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,179评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,868评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,522评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,070评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,186评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,487评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,162评论 2 356

推荐阅读更多精彩内容