代码重构之解耦合

最近在对业务代码进行重构,遇到了一些比较典型的“散发着难闻味道”的代码,可以用又臭又长来形容。

这部分的业务是发布动态,包括以下步骤:

  • 敏感词过滤
  • 话题提取
  • 动态数据入库
  • 敏感词记录
  • 话题及话题动态关联关系入库

之所以说重构前的代码“又臭又长”,首先最直观的一点,方法的行数超过了200行,其次上面四个步骤的逻辑全都写在了一起,没有按功能模块拆分,这也是方法过长的原因。

如果按功能划分,发布动态包含三个模块:

  • 敏感词模块
  • 动态模块
  • 话题模块

其中的敏感词模块话题模块都是为动态模块服务的。一个动态可以有敏感词,也可以没有敏感词,比如用户分享一个链接,这就不需要做敏感词过滤与记录了,所以敏感词模块与动态模块应该是“松耦合”的。同样,一个动态可以包含话题,也可能不包含,所以话题模块与动态模块也应该是松耦合的。

既然敏感词模块与话题模块都是为动态模块服务的,动态模块就有必要与这两个服务模块建立一个服务约定

  • 我需要什么样的服务
  • 我们之间如何建立耦合关系

我需要什么样的服务

在编程的世界里,约定可以抽象成接口

interface PublishContract
{
    // Call this method before publishing
    public function beforePublish();
    
    // Call this method after publishing
    public function afterPublish();
}

对于敏感词模块和话题模块,只需要实现该接口,动态模块就可以根据约定调用它们提供的服务。

class SensitiveWords implements PublishContract
{
    public function beforePublish()
    {
        // 
    }
    
    public function afterPublish()
    {
        //
    }
}
class TopicObserver implements PublishContract
{
    public function beforePublish()
    {
        // 
    }
    
    public function afterPublish()
    {
        //
    }
}

这样动态模块就知道,在动态入库前调用服务模块的beforePublish服务,入库后调用服务模块的afterPublish服务。

我们如何建立耦合

耦合关系的建立应该由动态发布的调用方决定,动态模块需提供相应的接口,

class Feeds
{
    // PublishContract[]
    protected $serviceModules = [];
    
    public function addServiceModule(PublishContract $service)
    {
        $this->serviceModules[get_class($service)] = $service;
    }
    
    public function removeServiceModule($serviceClassName)
    {
        unset($this->serviceModules[$serviceClassName]);
    }
    
    public function publish()
    {
        foreach ($this->serviceModules as $service) {
            $service->beforePublish();
        }
        
        // do something about publishment
        
        foreach ($this->serviceModules as $service) {
            $service->afterPublish();
        }
    
    }
}

这样,动态发布的调用方可以通过addServiceModule/removeServiceModule动态地添加/删除服务模块。

UML图

[from processon.com](https://www.processon.com/i/5429053c0cf2e6eabf125bb8 "")

重构带来的好处

松耦合

服务模块与核心模块是独立的,通过接口建立松耦合的关系;可动态添加/删除服务模块。

易于维护

服务模块的修改不会直接影响核心模块。

易于扩展

如果需要添加其它服务模块,只需实现服务约定的接口,并将新的服务模块动态添加到核心模块即可。

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

推荐阅读更多精彩内容