JS设计原则 —— 开闭原则

扩展性是衡量代码质量最重要的标准之一,代码的扩展性好了,出bug的几率就小很多。在经典的设计模式中,大部分设计模式都是为了解决代码的扩展性而存在的,主要遵从的原则就是开闭原则,所以理解开闭原则并能灵活应用很重要。

如何理解开闭原则

英文全称:Open Closed Principle(OCP)。开闭原则是对什么开放又是对什么关闭呢?是对扩展开放,对修改关闭。详细描述一下就是:添加一个新的功能时,应该在已有代码的基础上扩展代码(新增模块、类、方法等),而非修改已有代码(修改模块、类、方法等)。

这条原则的意义是什么呢?对扩展开放是为了应对需求变化,对修改关闭是为了保证原有代码的稳定性。在识别出代码可变部分和不可变部分之后,要将可变部分封装起来,隔离变化,提供抽象化的不可变接口,给上层使用。

我们来看一个栗子,理解一下这个原则。

我们在登陆一个系统的时候,都会输入用户名和密码然后点击登陆。在正式登陆之前,都会对输入的用户名和密码做校验,看是否符合规则,比如:

function checkLogin() {
    const username = document.querySelector('#username').value;
    if (!username) {
        // ...
    } else {
        // ...
    }
    
    const pwd = document.querySelector('#pwd').value;
    if (!pwd){
        // ...
    } else {
        // ...
    }
    
}

我们只提取了主要的业务逻辑check函数,里面对两个字段做了规则校验。

现在我们需要增加一个在登陆前输入验证码的功能。该如何改动代码呢?在这里就是在checkLogin函数中再增加一段对验证码做校验的代码。

function checkLogin() {
    const username = document.querySelector('#username').value;
    if (!username) {
        // ...
    } else {
        // ...
    }
    
    const pwd = document.querySelector('#pwd').value;
    if (!pwd){
        // ...
    } else {
        // ...
    }
    
    const captcha = document.querySelector('#captcha').value;
    if (!captcha) {
        // ...
    } else {
        // ...
    }
    
}

这样实现的问题是什么呢?一方面,如果验证规则很多,那这段代码就会很长很复杂,降低了可读性和可维护性。再者,如果有对应的单元测试,那每次修改单元测试也要修改。

上面的代码是基于“修改”的方式来实现新功能的,因为新功能的实现是在原有的方法中进行了修改,而非新增模块、类、方法等。那如何通过扩展的方式实现上面的功能呢?

class Verification {
    private verifiedHandlers: VerifiedHandler[] = [];

    public addVerifiedHandler(handler: VerifiedHandler) {
        this.verifiedHandlers.push(handler)
    }

    public checkAll() {
        for (let i = 0; i < this.verifiedHandlers.length; i++) {
            this.verifiedHandlers[i].check();
        }
    }
}

interface VerifiedHandler {
    check(): void;
}
class UsernameVerifiedHandler implements VerifiedHandler {
    public check() {
        console.log('username');
    }
}
class PwdVerifiedHandler implements VerifiedHandler {
    public check() {
        console.log('pwd');
        
    }
}
class CaptchaVerifiedHandler implements VerifiedHandler {
    public check() {
        console.log('captcha');
        
    }
}

在上面的实现中,定义接口VerifiedHandler,里面包含一个check方法,将对各个字段的校验移到每个handler中,并实现接口VerifiedHandler。

定义Verification类,暴露出addVerifiedHandler方法,以便添加不同的handler,并定义checkAll方法,调用所有handler的check方法。

各个handler已经定义好了,具体该如何使用呢?

class ApplyVerification {
    private verification: Verification = new Verification();
    private static instance: ApplyVerification;

    private constructor() {
        this.init();
    }
    public init() {
        this.verification.addVerifiedHandler(new UsernameVerifiedHandler());
        this.verification.addVerifiedHandler(new PwdVerifiedHandler());
        this.verification.addVerifiedHandler(new CaptchaVerifiedHandler());
    }

    public getVerification() {
        return this.verification;
    }

    public static getInstance() {
        if (!ApplyVerification.instance) {
            ApplyVerification.instance = new ApplyVerification();
        }
        return ApplyVerification.instance;
    }
}

function checkLogin() {
    ApplyVerification.getInstance().getVerification().checkAll();
}

ApplyVerification是一个单例类,创建Verification并添加不同的handler。

现在的代码再想添加新的校验逻辑只需要创建新的handler即可,最容易变化的部分是基于扩展的方式添加新功能而非修改原有代码。

如果觉得上述实现方式太过复杂,把不同的校验逻辑封装到不同的方法中也是可以的。

有时候,代码的可扩展性跟可读性不能两者兼顾,要做一些权衡和取舍。在if判断不是很多的时候,写在一起也没有太大问题,当if判断很多很复杂的时候,自然要选用可扩展性更好的方式。

如何做到“对扩展开放、对修改关闭”

最常用来提高代码扩展性的方法有:多态、基于接口而非实现编程、依赖注入,以及大部分设计模式(比如:装饰、策略、模板、职责链、状态等)。

最重要的是要时刻具备扩展意识、抽象意识、封装意识。写代码的时候多向前思考,可能会有哪些需求变更。不过也经常会有考虑不全的情况,只能通过不断重构来保持代码的可扩展性。

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

推荐阅读更多精彩内容

  • 对扩展开放、修改关闭 1 如何理解“对扩展开放、修改关闭”? 开闭原则的英文全称是 Open Closed Pri...
    凯玲之恋阅读 490评论 0 1
  • 在忙新书《间隔年在新西兰》插图时,翻阅着一张张图片,感觉时间静止了,满脸洋溢着回忆的微笑。 2013年12月...
    小强环球阅读 736评论 0 1
  • 我去旅行,是因为我决定了要去,并不是因为对风景的兴趣。 ——《霍乱时期的爱情》 真正的...
    罗锦书阅读 4,876评论 12 50
  • 人总是回忆往昔,是因过往一去不返。还有往昔丢失的美感,在如今是找不回来了,无意中很希望如今的生活能给予我们从...
    关音阅读 264评论 0 0
  • 我是一个杀手,我喜欢杀人,喜欢嗜血的快乐,我喜欢杀那种愚蠢的人,因为和她们说话有时候会让你有很大的无力感,他们...
    大好人666阅读 280评论 0 0