如何不让代码演进成互相缠绕的意大利面条?

如何处理好封装,

不让代码演进成互相缠绕的意大利面条?

对使用C语言且有过开发经历的人,在编写C代码的时候,

最头疼的事情莫过于决定哪些信息要暴露给外界,哪些隐藏在模块自身。

接下来,我们通过举一个具体的实际例子来说明

比如说我们要在一个ring buffer的基础上实现一个queue,我们可以提供queue.h作为头文件来暴露该模块的API接口,而在queue.c中进行具体实现,最基本的想法必然是:

queue.h

typedef struct {

ring_buffer_t *ring;

...

uint64_t counters[MAX_COUNTERS];

} queue_t;

int enqueue(queue_t *q, buf_t *buf);

buf_t *dequeue(queue_t *q);

然后在queue.c里面具体实现enqueue/dequeue

这样做的坏处是,queue实现的细节被暴露给了调用者,只要调用者拿到了queuepointer,就可以操作里面的ringcounters等等。如果queue模块本身没有提供充分的api,比如获取某个counter的信息,那么调用者可能就会图省事,自行做类似q->counters[COUNTER_A]这样的事情,从而完全破坏了模块的内聚。

更好的做法是使用typedef对类型做延迟定义。如下所示:

queue.h

typedef struct queue_s queue_t;

int enqueue(queue_t *q, buf_t *buf);

buf_t *dequeue(queue_t *q);

然后在queue.c里,真正去定义struct queue_s

#include "queue.h"

struct queue_s {

ring_buffer_t *ring;

...

uint64_t counters[MAX_COUNTERS];

}

这样,当你在该模块外的地方即使拿到了queuepointer,也无法进行q->counters[COUNTER_A]这样的操作,编译器会报错:

error: dereferencing pointer to incomplete type

一开始使用这种方法定义数据结构会让自己或者别人写代码的时候很不舒服,因为拿到了一个pointer,却无法访问其内部的数据,是一种「很不C」的做法。这样会逼迫你写更多的代码,在需求不断变化(增加)的时候封装出来更多的api。而更多的api意味着更多的重构,以及更通盘地考虑设计上的优化。最终,模块的内聚大大加强,任何外部代码只能通过模块提供的api进行受限的操作,无法再像之前那样随心所欲了。这也正是面向对象的编程的基本思想。

有的人说,

“C语言是面向过程编程的语言,C++是面向对象编程的语言。”

其实,这种说法并不贴切。通过上面的例子大家可以看到,通过库的封装和相应的编程方法,C语言一样可以实现相应的函数封装,达到面向对象的设计模式。

说到底,各种各样的编程语言到头来只是一种工具,并没有明显的根本区别。作为一个好的程序员,关键还是要培养自己的编程思想、丰富软件设计模式,这样才能更淡定地面对未来日新月异的软件技术发展潮流。

另外,在上文中还提及到了API的设计模式。在现在的软件工程中,API接口及标准化可以说是非常重要的一个部分,在接下来的文章里我将会继续对API设计及架构进行更多的解读与分享,敬请期待。

接下来的文章里我将会继续对API设计及架构进行更多的解读与分享,敬请期待

继续阅读更多实力技术干货

文章内容为睿江云睿普云博士原创,欢迎转载请注明出处

http://mp.weixin.qq.com/s/GA5tLxNWtuL6PBRnOcpinQ

持续关注我们的微信公众号“睿普Eflypro”和技术博客!

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

推荐阅读更多精彩内容