JavaScript 与设计模式

JavaScript与设计模式

作为一名有追求的 JavaScript 开发者,你努力编写整洁、健康且可维护的代码。当你解决一些有趣并且特定的挑战时,也许会发现经常对完全不同的问题编写非常类似的代码。也许你还没有意识到,但其实你已经在使用设计模式了。设计模式是软件设计领域对常见问题可复用解决方案

对于任何编程语言,很多可复用的解决方案通常都是被该语言相关社区的开发者们发明并经过大量测试的。由于设计模式是集成了大量开发者经验的解决方案,通常都非常实用并且能帮助我们以更优的方式编码并解决问题。

使用设计模式主要有如下益处

  • 经得起推敲:我们可以肯定设计模式是有用的,因为已经被业界大量的开发者使用了。而且,你几乎可以确信设计模式已经被修订及优化过无数次了。
  • 可复用设计模式与具体的问题没有关系,它是对某类特定问题的成熟的解决方案。
  • 富有表现力设计模式可以优雅的表述解决方案。
  • 便于交流:当开发者们对设计模式都熟悉时,他们可以很容易地对具体问题的潜在解决方案进行交流。
  • 避免后续重构代码:如果应用程序被特意使用设计模式编写了,通常你都不需要后续再对代码进行重构,因为对具体问题采用的合理的设计模式往往都是最优的解决方案。
  • 减少代码量设计模式往往优雅且是最优方案,通常比其他方案要求更少的代码量。

JavaScript 闪亮登场

截止到今天,JavaScript 在 Web 开发领域仍是最流行的编程语言。该语言起初是作为“胶水语言”,在早期的浏览器中配合 HTML 元素使用,也被叫做客户端脚本语言。在那个浏览器仅能展示静态 HTML 元素的年代,JavaScript 的登场无疑是划时代的。和你想的一样,客户端脚本语言的诞生加剧了当时包括微软、网景等大玩家在浏览器开发领域的“浏览器大战”。

当时,每个大玩家都想推动自家实现的脚本语言,比如网景(更具体些,Brendan Eich)创造了 JavaScript,微软创造了 JScript,诸如此类。和你想的一样,这些不同的脚本语言的差别很大,开发者们不得不针对每种浏览器单独进行开发。很快大家都意识到这样下去不可持续,需要制定一套标准及跨浏览器的解决方案以统一及简化 Web 开发过程。这套标准也就是 ECMAScript

ECMAScript 是所有现代浏览器都尽力支持的标准化的脚本语言规范说明,并且有对 ECMAScript 的不同实现(JavaScript 是其中一种比较流行的实现)。自从诞生之日起,ECMAScript 标准化了很多重要的特性,并且随着 ECMAScript 的不断迭代,有了许多不同的版本。浏览器对于 ES6(包括更高版本)的支持尚不完整,所以通常需要转化为 ES5。

JavaScript 有哪些特性?

如果有人问你“什么是 JavaScript?”,你也许会类似这样回答:

JavaScript 是一个高级的、轻量的、解释型的、基于原型式面向对象的多范式编程语言,函数作为其一等公民,其具有动态类型,支持事件驱动、函数式和指令式的编程风格,因作为网站的脚本语言而闻名。

上述定义主要说明 JavaScript 代码具有低内存占用,容易学习与使用,具有类似 C++ 或 Java 的语法风格。作为脚本语言,JavaScript 是解释型的而非编译型的,并且支持包括过程式(属于指令式编程风格的一种)、面向对象与函数式的编程风格。对于开发者来说是一门很灵活的编程语言。

以上,我们了解了所有听起来类似其他语言的特性,下面让我们具体看看一些值得特别关注地区分于其他语言的 JavaScript 特有的特性。

JavaScript 的函数是一等公民

对于很多来自 C/C++ 背景的开发者,刚开始使用 JavaScript 时,函数作为一等公民这个特性可能会有些难以掌握。JavaScript 将函数视为一等公民,意味着你可以像普通变量一样将函数A作为参数传入函数B。

// 将函数作为变量 cb,performOperation 函数执行时会执行传入的函数 cb
const performOperation = (a, b, cb) => {
    const c = a + b;
    cb(c);
}

performOperation(2, 3, result => {
    // 输出 5
    console.log(`The result of the operation is ${result}`);
})

JavaScript 的面向对象是基于原型的

与其他面向对象(OOP)语言一样,JavaScript 支持对象,对于对象我们通常最先想到的术语是类和继承。但不同于其他基于(class-based)的面向对象语言,JavaScript 本身没有类的概念(尽管 ES6 可以使用 class 关键字声明类,但本质是个语法糖),其通过基于原型(prototype-based)的方式达到面向对象的目的。

基于原型的编程是一种面向对象的编程风格,其行为重用(也称为继承)是通过重用已存在对象的原型来达到目的的。后面我们讨论设计模式时会继续深入探讨,此特性在许多 JavaScript 设计模式中都有用到。

JavaScript 的事件循环

你如果有使用过 JavaScript 的经历的话,一定熟悉回调函数这个术语。回调函数其实就是函数A可以作为另一个函数B的参数(记住,JavaScript 将函数视为一等公民),并且函数A会在某个事件发生后执行。回调函数往往被用作订阅类似鼠标点击或者键盘输入等事件。

JS EventLoop

每次事件(会被有关监听者绑定)触发时,相关消息会被发送到一个以 FIFO 的方式同步处理的消息队列中。这就是 JavaScript 的事件循环(Event Loop)机制。更多有关 JavaScript 事件循环机制的细节可参考:《JavaScript中的TaskQueue,Macrotask 与 Microtask》

设计模式分类

如本文开头所描述,设计模式是软件设计领域对常见问题的可复用的解决方案。设计模式有多种归类方式,最流行的分类如下:

  • 创建型设计模式(Creational)
  • 结构型设计模式(Structural)
  • 行为型设计模式(Behavioral)
  • 并发型设计模式(Concurrency)
  • 架构型设计模式(Architectural)

需要注意的是在很多主流分类中,架构型设计模式并不属于设计模式讨论的范畴,而是另外的架构模式。

创建型设计模式

此类设计模式主要处理对象的创建机制,对于特定问题,相较于基础的创建对象的方式能优化对象的创建,基础创建对象的方式可能导致设计问题或增加系统设计的复杂度。创建型设计模式通过某种形式控制对象的创建以解决特定问题,这类设计模式主要有:

  • 工厂方法模式(Factory method)
  • 抽象工厂模式(Abstract factor)
  • 建造者模式(Builder)
  • 原型模式(Prototype)
  • 单例模式(Singleton)

结构型设计模式

此类设计模式主要处理对象间的关系,能保证系统的某部分发生变更后不会影响到系统整体。常见的有:

  • 适配器模式(Adapter)
  • 桥接模式(Bridge)
  • 组合模式(Composite)
  • 装饰器模式(Decorator)
  • 外观模式(Facade)
  • 享元模式(Flyweight)
  • 代理模式(Proxy)

行为型设计模式

此类设计模式关注于系统中不同对象间的高效通信与职责委派。主要有:

  • 责任链模式(Chain Of Responsibility)
  • 命令模式(Command)
  • 迭代器模式(Iterator)
  • 中介者模式(Mediator)
  • 备忘录模式(Memento)
  • 观察者模式(Observer)
  • 状态模式(State)
  • 策略模式(Strategy)
  • 访问者模式(Visitor)
  • 模板方法模式(Template Method)

并发型设计模式

此类设计模式主要涉及处理多线程编程范式。常见的有:

  • 主动对象模式(Active Object)
  • 试探模式(Balking)
  • 屏障模式(Barrier)
  • 双重检查锁定模式(Double-checked Locking)
  • 守护挂起模式(Guarded Suspension)
  • 领导者/追随者模式(Leaders/Followers)
  • 监视器对象模式(Monitor Object)
  • 反应器模式(Reactor)
  • 读写锁模式(Read-Write Lock)
  • 调度者模式(Scheduler)
  • 线程池模式(Thread Pool)
  • 线程本地存储模式(Thread-Local Storage)

架构型设计模式

此类设计模式主要用于代码架构意图。较著名的有:

  • MVC(Model-View-Controller)
  • MVP(Model-View-Presenter)
  • MVVM(Model-View-ViewModel)

JavaScript 常见设计模式

每种设计模式都代表特定类型问题的特定解决方案,并没有所谓全宇宙通用的设计模式来很好地适应各种问题。因此需要我们学习在什么情况下某种设计模式能派上用场并发挥其实际价值,当我们熟悉了设计模式及它们所适用的场景后,就能更容易地确定某种设计模式是否能应用于所要解决的问题。

记住,对问题使用错误的设计模式很可能会导致不期望的效果,比如不必要的代码复杂度、不必要的性能开销等。

以上是我们在应用某个设计模式时需要考虑的问题。接下来我们来探讨一些比较常用并且大多数 JavaScript 开发者需要熟悉的设计模式。

构造器模式(Constructor)

对于典型的面向对象语言,构造器是类中特殊的函数,主要用于初始化对象(对属性赋予默认或者传入的值)。

在 JavaScript 中,创建一个对象通常有以下方式:

// 我们可以使用如下方式创建对象
const instance = {};
// 或
const instance = Object.create(Object.prototype);
// 或
const instance = new Object();

创建对象后,可以使用下列方式对创建的对象添加属性:

// 从 ES3 开始支持
// 点符号
instance.key = "A key's value";

// 中括号
instance["key"] = "A key's value";

// 从 ES5 开始支持
// 使用 Object.defineProperty 设置单个属性
Object.defineProperty(instance, "key", {
    value: "A key's value",
    writable: true,
    enumerable: true,
    configurable: true
});

// 使用 Object.defineProperties 同时设置多个属性
Object.defineProperties(instance, {
    "firstKey": {
        value: "First key's value",
        writable: true
    },
    "secondKey": {
        value: "Second key's value",
        writable: false
    }
});

前面我们提到过 JavaScript 没有从语言层面原生性的支持类(ES6 class 只是语法糖),但通过对函数使用“new”关键字的形式,JavaScript 支持构造器。通过这种方式,我们可以将某个函数作为构造函数来初始化对象的属性,就像使用类中的构造器一样。

// 声明 Person 对象的构造器(函数)
const Person = (name, age, isDeveloper) => {
    this.name = name;
    this.age = age;
    this.isDeveloper = isDeveloper || false;

    this.writesCode = function() {
      console.log(this.isDeveloper? "This person does write code" : "This person does not write code");
    }
}

// 创建对象 Bob
const person1 = new Person("Bob", 38, true);
// 创建对象 Alice
const person2 = new Person("Alice", 32);

// 输出: This person does write code
person1.writesCode();
// 输出: this person does not write code
person2.writesCode();

然而,上述代码还有改进的空间。如果你还记得的话,我们前面有提到过 JavaScript 是基于原型的继承。上述代码的问题出在在 Person 构造器中每次创建对象实例时都会重复定义 writesCode 方法。我们可以通过将 wirtesCode 方法设置为 Person 的原型方法来避免这个问题。

// 声明 Person 对象的构造器
const Person = (name, age, isDeveloper) => {
    this.name = name;
    this.age = age;
    this.isDeveloper = isDeveloper || false;
}

// 扩展函数的原型
Person.prototype.writesCode = function() {
    console.log(this.isDeveloper? "This person does write code" : "This person does not write code");
}

现在,每个 Person 实例都能共享同一个 writesCode 方法。

模块模式(Module)

就独特性而言,JavaScript 永远不会停止让你感到惊讶。JavaScript 另一个独特之处(对于面向对象语言来说)就是其不支持访问修饰符(access modifiers)。而其他典型的面向对象语言,用户是可以在声明一个类时确定其成员的访问权限。为此,JavaScript 开发人员鼓捣出来模仿这些行为的方式。

在我们正式进入 JavaScript 的模块模式前,先讨论下其闭包(closure)的概念。闭包是指一个能访问其父级作用域的函数(即使在其父级函数结束运行后),可以帮助我们通过作用域来模仿访问修饰符的行为。举个例子:

// 我们使用一个立即执行函数来声明 counter 这个私有变量
const counterIncrementer = (
  () => {
    let counter = 0;

    return () => {
        return ++counter;
    };
    }
)();

// 输出 1
console.log(counterIncrementer());
// 输出 2
console.log(counterIncrementer());
// 输出 3
console.log(counterIncrementer());

如上面的例子,通过使用立即执行函数(IIFE),我们将 counter 变量绑定到一个已经执行完闭的函数中,而且仍然可以通过其返回的子函数将 counter 变量递增。以上我们已通过操作作用域的方式将 counter 私有化了,无法通过外部直接访问到 counter 变量。

使用闭包,我们在创建对象时就可以为其定义私有及公有的部分。这其实就是模块,当我们需要隐藏对象的某些细节并且仅展示特定对外接口时,这会非常实用。如下面的例子:

// 通过使用闭包我们暴露了一个对象作为对外接口
// 可以管理私有成员 objects 数组
const collection = (() => {
    // 私有成员
    const objects = [];

    // 公有成员
    return {
        addObject: (object) => {
            objects.push(object);
        },
        removeObject: (object) => {
            const index = objects.indexOf(object);
            if (index >= 0) {
                objects.splice(index, 1);
            }
        },
        getObjects: () => {
            return JSON.parse(JSON.stringify(objects));
        }
    };
})();

collection.addObject("Bob");
collection.addObject("Alice");
collection.addObject("Franck");
// 输出 ["Bob", "Alice", "Franck"]
console.log(collection.getObjects());
collection.removeObject("Alice");
// 输出 ["Bob", "Franck"]
console.log(collection.getObjects());

模块模式很好地将对象私有和公有的部分清晰地分离开来。然而,当你希望改变成员的可见性时,由于访问公有部分及私有部分的性质不同,你需要修改所有用到这些成员的代码。另外,在对象创建添加的方法是无法访问到对象的私有成员的。

揭示模块模式(Revealing Module)

此模式是上述模块模式的增强版本,主要的不同是我们将所有对象的逻辑放到了模块的私有部分,然后通过返回匿名对象的方式暴露出公有的部分。我们可以在将私有成员映射到公有成员时改变他们的命名。

// 我们将所有对象的逻辑都放到私有成员中,然后暴露出一个映射了私有成员的匿名对象
const namesCollection = (() => {
    // 私有成员
    const objects = [];

    const addObject = (object) => {
        objects.push(object);
    }

    const removeObject = (object) => {
        var index = objects.indexOf(object);
        if (index >= 0) {
            objects.splice(index, 1);
        }
    }

    const getObjects = () => {
        return JSON.parse(JSON.stringify(objects));
    }

    // 公有成员
    return {
        addName: addObject,
        removeName: removeObject,
        getNames: getObjects
    };
})();

namesCollection.addName("Bob");
namesCollection.addName("Alice");
namesCollection.addName("Franck");
// 输出 ["Bob", "Alice", "Franck"]
console.log(namesCollection.getNames());
namesCollection.removeName("Alice");
// 输出 ["Bob", "Franck"]
console.log(namesCollection.getNames());

揭示模块模式与其他模块模式不同点主要在于公有成员是如何引用的,其更容易使用与修改。然后揭示模块模式在某些特殊场景也会比较脆弱,比如使用该模式创建的对象作为继承链上的原型时,会有如下问题:

  • 如果私有函数被公有函数引用了,我们不能重写这个公有函数,这是因为私有函数会继续指向之前的函数实现,并可能导致系统出 bug。
  • 如果公有成员指向了私有变量,当我们尝试从模块外重写这个公有成员时,其他函数仍会引用该私有变量值,这可能会导致系统出 bug。

单例模式(Singleton)

该模式的应用场景是我们仅需要类的一个实例时,比如我们需要一个包含某类配置信息的对象。在这类场景中,我们需要在代码中不同部分用到这些配置时都单独创建一个对象。

const singleton = (() => {
    // 仅被初始化一次的私有值
    let config;

    const initializeConfiguration = (values) => {
        this.randomNumber = Math.random();
        values = values || {};
        this.number = values.number || 5;
        this.size = values.size || 10;
    }

    // 暴露用于获取单例值的统一处理函数
    return {
        getConfig: (values) => {
            // 确保仅被初始化一次
            if (config === undefined) {
                config = new initializeConfiguration(values);
            }

            return config;
        }
    };
})();

const configObject = singleton.getConfig({ "size": 8 });
// 输出 number: 5, size: 8, randomNumber: 某个随机值
console.log(configObject);
const configObject1 = singleton.getConfig({ "number": 8 });
// 输出 number: 5, size: 8, randomNumber: 和上面相同
console.log(configObject1);

需要注意的是,在每次获取实例时都需要确保其有且仅有同一个实例。

观察者模式(Observer)

当我们需要优化系统中不同部分的通信时,观察者模式将是个非常有用的工具,能很好地降低对象间的耦合性。

观察者模式有很多不同版本,其最基础的形式是拥有两个主要部分,分别为 SubjectObserver

Subject 处理有关 Observers 订阅的某个主题的所有操作。这些操包括:为 Observer 订阅特定主题,为 Observer 取消订阅特定主题,通知所有 Observers 关于某个特定主题的事件发布。

观察者模式演化出发布者/订阅者模式(publisher/subscriber),后面有代码示例。相对于典型的观察者模式发布者/订阅者模式主要的不同在于其更进一步地降低耦合性。在观察者模式中,Subject 持有所有 Observers 的引用并且直接通过 Subject 对象本身直接调用 Observer 的方法进行通知。而在发布者/订阅者模式中,发布者订阅者之间是通过频道(或者说经纪人,从数据结构角度看通常是个消息队列)建立通信渠道的,也就是发布者和订阅者间互不认识(完全解耦)。发布者在成功发布了某个事件到频道中就可以进行后续的业务逻辑,而无需关心订阅者

const publisherSubscriber = {};

// container对象处理订阅及发布
((container) => {
    // id代表某个主题的唯一订阅ID
    const id = 0;

    // 订阅特定主题并传入主题触发后的处理函数
    container.subscribe = (topic, f) => {
        if (!(topic in container)) {
          container[topic] = [];
        }

        container[topic].push({
            "id": ++id,
            "callback": f
        });

        return id;
    }

    // 针对主题每个订阅都有其独一无二的ID,我们可以用于取消订阅
    container.unsubscribe = (topic, id) => {
        const subscribers = [];
        for (const subscriber of container[topic]) {
            if (subscriber.id !== id) {
                subscribers.push(subscriber);
            }
        }
        container[topic] = subscribers;
    }

    container.publish = (topic, data) => {
        for (const subscriber of container[topic]) {
            // 执行订阅时传入的处理函数时
            subscriber.callback(data);
        }
    }

})(publisherSubscriber);

const subscriptionID1 = publisherSubscriber.subscribe("mouseClicked", (data) => {
    console.log("I am Bob's callback function for a mouse clicked event and this is my event data: " + JSON.stringify(data));
});

const subscriptionID2 = publisherSubscriber.subscribe("mouseHovered", (data) => {
    console.log("I am Bob's callback function for a hovered mouse event and this is my event data: " + JSON.stringify(data));
});

const subscriptionID3 = publisherSubscriber.subscribe("mouseClicked", (data) => {
    console.log("I am Alice's callback function for a mouse clicked event and this is my event data: " + JSON.stringify(data));
});

// 执行3次 console.log
publisherSubscriber.publish("mouseClicked", {"data": "data1"});
publisherSubscriber.publish("mouseHovered", {"data": "data2"});

// 取消订阅
publisherSubscriber.unsubscribe("mouseClicked", subscriptionID3);

// 执行2次 console.log
publisherSubscriber.publish("mouseClicked", {"data": "data1"});
publisherSubscriber.publish("mouseHovered", {"data": "data2"});

使用这个模式的缺点是其加大了测试系统不同部分的难度,比如没有优雅的方式可以测试订阅者部分是否符合预期。

中介者模式(Mediator)

当谈到将系统解耦时,中介者模式或许也是个非常有用的工具。

中介者是一个对象,它作为中介者被用作系统不同部分间的通信并处理它们间的工作流(workflow)。这里特别强调了处理工作流,为什么呢?

因为中介者模式与上面谈到的发布者/订阅者模式有很多的相同点,你也许会问自己:“嗯......这两种设计模式都用于实现对象间更好的通信.......那他们有何不同呢?🤔”

主要不同在于中介者模式同时处理了工作流,而发布者/订阅者模式使用“即发即弃(fire and forget)”的方式处理通信。发布者/订阅者模式可以认为是个简单的事件(消息)聚合器,它只关心为发布者发送特定事件并确保对应的订阅者知道该事件被触发了,并不关心事件触发后的处理逻辑。

中介者模式的一个不错的例子是作为向导类型的接口。假设你开发的系统有较复杂的注册流程,并且需要用户填写大量的信息时,通常将这些流程拆解为一系列的步骤是个不错的实践。通过这种方式,代码会更简洁(更易维护),并且对于用户来说更友好(不需要仅为了完成注册而填写大量的信息)。此时中介者作为处理注册步骤的对象,对于不同用户潜在的不同的注册过程,需要考虑各种可能的工作流(注册流)。

这种模式的缺点是我们在系统中引入了一个潜在的错误点,假如中介者挂了,整个系统可能会停止工作。

原型模式(Prototype)

和本文前面谈到的一样,JavaScript 底子里不支持类,其通过基于原型的编程方式进行对象继承的。这使我们能够为对象创建其原型对象,如下面的例子:

const personPrototype = {
    sayHi: function (){
        console.log("Hello, my name is " + this.name + ", and I am " + this.age);
    },
    sayBye: function () {
        console.log("Bye Bye!");
    }
};

const Person = (name, age) => {
    name = name || "John Doe";
    age = age || 26;

    function constructorFunction(name, age) {
        this.name = name;
        this.age = age;
    };

    constructorFunction.prototype = personPrototype;

    const instance = new constructorFunction(name, age);
    return instance;
}

const person1 = Person();
const person2 = Person("Bob", 38);

// 输出: Hello, my name is John Doe, and I am 26
person1.sayHi();
// 输出: Hello, my name is Bob, and I am 38
person2.sayHi();

需要注意到,基于原型的继承是可以提升性能的。因为创建的对象会保留对原型对象的引用,而无需对每个对象都进行重复声明。

命令模式(Command)

当我们需要通过从某个集中的对象触发命令的方式来降低对象间的耦合时,命令模式会很有帮助。比如,应用中使用了大量的 API 服务的调用,当我们的 API 服务发生变更时,可能要根据已变更的 API 改动很多地方。这种情况下我们需要实现一个抽象层,将 API 服务的调用从直接使用的对象中抽离出来。这样我们可以避免在 API 服务发生变更时需要同时修改多个地方,因为实际请求 API 服务只存在于一个地方。

和其他任何模式一样,我们需要确切的知道在什么情况下才真的需要使用这个模式。我们需要实际问题做出取舍,因为增加了抽象层可能会降低性能,但却可能提高代码的清晰度及更易维护。

// 实际执行命令的对象
const invoker = {
    add: (x, y) => x + y,
    subtract: (x, y) => x - y,
}

// 执行命令的抽象层,对于调用者来说是 invoker 对象的接口
const manager = {
    execute: (name, ...args) => {
        if (name in invoker) {
            return invoker[name](...args);
        }
        return false;
    }
}

// 输出 8
console.log(manager.execute("add", 3, 5));
// 输出 2
console.log(manager.execute("subtract", 5, 3));

外观模式(Facade)

外观模式用于隐藏系统的复杂性,在内部实现及客户端间建立抽象层,并向客户端提供了一个可以访问系统的接口。

典型的例子是前端曾经一度流行的 JQuery 库中的 selector 选择器,其对外隐藏了对 DOM 的相关操作。

jQuery(".parent .child div.span")

其大大简化了选择 DOM 元素的过程,尽管表面上看起来很简单,但其内部是做了大量的复杂逻辑。

总结

任何中高级 JavaScript 开发者都需要意识到设计模式是非常有用的工具,熟悉有关设计模式的细节会非常有用,能让我们在项目的生命周期中节省大量宝贵时间,尤其是在维护阶段。

由于篇幅所限,本文只列举了部分常见的 JavaScript 设计模式。我们日常开发过程中也要下意识的去应用设计模式并不断积累这类经验,多学、多思、多运用,相信你一定能成为更好的开发者。

SOLID 原则浅析

SOLID原则

相关术语

在正式进入 SOLID 的探讨之前,我们最好先了解如下几个术语:

最少知识原则强调的是每个代码单元(包括但不限于类、函数、对象、模块)都应该对其他代码单元有尽可能少的知识,这能帮助提升代码的可重用性及可维护性。

耦合也称块间联系。指软件系统结构中各模块间相互联系紧密程度的一种度量。模块之间联系越紧密,其耦合性就越强,模块的独立性则越差。

内聚标志一个模块内各个元素彼此结合的紧密程度,它是信息隐蔽和局部化概念的自然扩展。内聚是从功能角度来度量模块内的联系,一个好的内聚模块应当恰好做一件事。它描述的是模块内的功能联系。

我们的软件由大量的类或对象单元组成,它们将数据及其相关的方法封装在一起。对象间应该是低耦合的,并且尽可能减少彼此间的依赖,每个对象尽可能对其他对象有更少的了解。特性(feature)与模块也应如此。S.O.L.I.D 就是用于帮助我们达成这些目的一些原则。

什么是 SOLID 原则?

SOLID 原则首先由著名的计算机科学家 Robert C·Martin (著名的Bob大叔)由 2000 年在他的论文中提出。但是 SOLID 缩略词是稍晚由 Michael Feathers 先使用的。Bob大叔也是畅销书《代码整洁之道》和《架构整洁之道》的作者,也是 "Agile Alliance" 的成员。

SOLID 指的是一组软件设计原则,可以指导我们构建我们的方法和类,以提升可靠性、可维护性和可适应性。

如果你过去编写的代码无法满足当前新的需求,更改这些代码以满足这些需求可能会很昂贵。我们需要记录下那些地方需要修改,不断地去完善,这个过程中不应该增加更多的缺陷或使其变得更难扩展。

SOLID 其实是多个英文首字母的组合,每个字母代表:

  • S: Single Responsiblity Principle(SRP,单一职责/功能原则)
  • O: Open-Closed Principle(开闭原则)
  • L: Liskov-Substitution Principle(里氏替换原则)
  • I: Interface Segregation Principle(接口隔离原则)
  • D: Dependency Inversion Principle(依赖反转原则)

单一职责原则

每个类或函数应该只有一个变化的原因,并且只做好一件事情。需要注意如下几点:

  • 不要将函数放在会因各种各样原因而改变的类中
  • 基于使用它的用户考虑其职责(变化的原因)
  • 类应该是低耦合且高内聚的

举个实际的例子,比如我们开发的企业应用需要计算技术部、财务部等不同部门的薪水及工时并将记录存储至数据库中。我们最好能将不同部门的不同计算逻辑分离(抽象)开来。

class Employee {
  public calculateSalary (): number { ...some code }
  public hoursWorked (): number { ...some code }
  public storeToDB (): any { ...some code }
} // 没有将不同部门的不同计算逻辑分离,违背了SRP原则:

上述代码中对不同部门的所有业务逻辑都写到一块了,因其中一个部门的代码改动会同时影响到其他部门(或者说我们尝试在同一个类中处理,会导致代码中出现各种嵌套的 if-else/switch 语句,不利于代码维护)。

abstract class Employee {
  abstract calculateSalary (): number;
  abstract hoursWorked (): number;
  protected storeToDB ():any { ...some code }
}

// 迫使开发者根据抽象类为不同的部门实现对应的类,便于维护并且减少了潜在的代码提交发生冲突的可能
class Technical extends Employee {
  calculateSalary (): number { ...some code }
  hoursWorked (): number {...some code }
}

class Finance extends Employee {
  calculateSalary (): number {...some code}
  hoursWorked (): number {...some code}
}

仍然对如何组织一个类有困惑?建议从类的使用者(用户/角色)的角度去考虑,并结合实际业务逻辑。

开闭原则

代码中的实体(类、模块、函数等)应该对扩展开放对修改关闭。这个原则想要表达的是:我们应该能在不动已经存在代码的前提下添加新的功能。这是因为当我们修改存在的代码时,我们就面临着创建潜在 bug 的风险。因此,如果可能,应该避免碰通过测试的(大部分时候)可靠的生产环境的代码。

违背该规则的代码的味道:代码中存在大量 if/switch 语句。为何我们要尽量避免大量的 if/switch 语句?因为多种执行流更容易导致 bug 的产生。

里氏替换原则

里氏替换原则描述的是子类应该能替换为它的基类。意思是,给定 class B 是 class A 的子类,在预期传入 class A 的对象的任何方法传入 class B 的对象,方法都不应该有异常。这是一个预期的行为,因为继承假定子类继承了父类的一切。子类可以扩展行为但不会收窄

来看个例子:

Class Rectangle { // 长方形
  constructor(width, height) {
    this.width = width;
    this.height = height;
  }

  setWidth(width) {
    this.width = width;
  }

  setHeight(height) {
    this.height = height;
  }

  area ( ) {
    return this.width * this.height;
  }
}

Class Square extends Rectangle { // 正方形
  setWidth(width) {
    this.width = width
    this.height = width;
  }

  setHeight(height) {
    this.height = height;
    this.width = height;
  }
}

const rectangle = new Rectangle(10, 2)
const square = new Square(5, 5)

function increaseRectangleWidth(rectangle) {
    rectangle.setWidth(rectangle.width +1)
}
increaseRectangleWidth(rectangle) // 新的面积为:11 * 2 = 22
increaseRectangleWidth(square) // 新的面积为:6 * 6 = 36

嘿,问题来了:上述代码中的正方形作为长方形的子类,他们符合里氏替换原则吗?

🤔......

答案是否定的!原因是正方形在设置宽度时同时设置了高度(将父类的行为收窄了)。

解决方案:可以将正方形与长方形的共同点进一步剥离出来,基于此创建一个共同的父类(如 Shape),使父类更为通用。

Class Shape {
  constructor(width, height) {
    this.width = width;
    this.height = height;
  }

    area(): void {
    return this.width * this.height;
  }
}

接口隔离原则

该原则旨在通过将大型接口拆解为更小的部分以减少大型接口带来的负面影响,很多客户端特定的接口优于一个多用途接口,理念上有些类似单一职责原则。客户端不应该强制实现他们不需要的函数。

/**
 * 正面例子
 */
export class SummaryPageComponent implements OnInit {
    // 实现 OnInit 接口
}

export interface OnInit { // 小而特定的接口
    ngOnInit(): void; // 只有一个方法
}

/**
 * 反面例子
 */
export class SummaryPageComponent implements LifeCycles {
    // 尽管有些方法不需要,但仍然要实现它
}

export interface LifeCycles {
  // 太多方法
  ngOnInit(): void;
  ngOnChanges(changes: SimpleChanges): void;
  ngDoCheck(): void;
  ngOnDestroy(): void;
  ...
}

依赖反转原则

依赖倒置原则描述的是我们的 class 应该依赖接口和抽象类而不是具体的类和函数。

举个支付相关的例子:

class GooglePayService {
  constructor (googlePayInstance) {
    this.gps = googlePayInstance;
  }
  pay (to, amount ) {
    ...some code
  }
}

10个月后,你的上级告诉你需要将支付服务修改为 PhonePay 而不是 GooglePay(或两者都需要支持),你的代码需要支持这种扩展:

type PaymentTransaction = 'Success' | 'Failure' | 'Bounced'

interface IPaymentTransactionResult {
  result: PaymentTransaction;
  message?: string;
}

interface IPaymentService {
    pay(to: string, amount: number): Promise<IPaymentTransactionResult>
}

class GooglePayService implements IPaymentService {
  pay(to: string, amount: number): Promise<IPaymentTransactionResult> {
    ...some code
  }
}

class PhonePayService implements IPaymentService {
  pay(to: string, amount: number): Promise<IPaymentTransactionResult> {
    ...some code
  }
}

然后我们可以将以上两个类“依赖注入”到需要使用的类中,通过引用接口而不是具体的实现的方式。

class CreateUserController extends BaseController {
  constructor (paymentService: IPaymentService) {
    this.paymentService = paymentService;
  }

  protected proceedPayTransaction (): void {
    // api 处理逻辑...
    // 支付
    this.paymentService.pay(userId, amount);
  }
}

现在,可以使用任何需要的支付服务,或者添加其他支付服务。

const phonePayService = new PhonePayService();
const createUserController = new CreateUserController(phonePayService);
createUserController.proceedPayTransaction();

const googlePayService = new GooglePayService();
const createUserController = new CreateUserController(googlePayService);

总结

在代码中运用 SOLID 原则可以帮助我们提升代码的可复用性、可适应性、可读性、可维护性,并且更利于测试。

日常编码其实也是个不断优化代码的过程,随着业务需求的复杂度提升,代码“熵”增不可避免,我们能做的就是努力通过使用 SOLID 原则或相关设计模式让“熵”减少或减缓其增加的步伐。

Git flow —— 一种常用的 git 分支模型

git flow

背景

目前团队在 git 实践上还没有一套统一的规范,且存在以下影响开发效率的情况:

  • 不同团队成员对于 git 的使用未达成一致,导致在实际开发协助中需要花费更多额外的时间和精力解决各种意想不到的问题。
  • 不同项目间使用的 git 实践也不一致,导致在切换项目时存在一定的上下文损耗,且更容易出错。

因此,亟需一套大家达成一致的通用的 git 实践以解决上述问题,从而提升效率。

为什么使用 git flow ?

结合团队项目的实际情况以及各主流 git 分支模型的特点,推荐使用最为知名且经过大量项目验证的 git flow 模型。

什么是 git flow ?

Git flow是由 Vincent Driessen 于2010年提出的 git branching workflow,主要特点是基于两个 long-live 分支以及一些用于支援开发周期的 supporting 分支进行分支管理。

long-live 分支

主要包含 masterdevelop 这两个存在于整个研发周期的固定分支。

  • master 分支:对应的是已经在生产环境上的代码。
  • develop 分支:包含下次将要部署到 production 的变更。

当 develop 分支上的代码稳定且可以发版时,其中所有的变更应该通过某种形式(一般是从 develop 分支 checkout out 出对应的 release 分支进行进一步的验证)merge 到 master 分支上,之后再 tag 对应的版本号。

supporting 分支

除了上述 long-live 分支,我们还会使用一些 supporting 分支以支援日常的开发场景。不同于 long-live 分支,supporting 分支都是为了特定的目的而存在,因此这些分支的存活周期是有限的。

我们主要使用的 supporting 分支类型有:

  • Feature 分支:从 develop 分支 checkout 出来,用于新功能的开发。
  • Release 分支:从 develop 分支 checkout 出来,用于部署到 production 前的预发布及验证,另外可以解放 develop 分支以进行后续功能的迭代。
  • Hotfix分支:从 master 分支 checkout 出来,用于快速修复 production 环境发现的 bug。

Feature 分支

Feature branch

  • 只应存在于开发者个人的 repo,不应出现在 upstream repo
  • develop 分支 checkout,必须 merge 到 develop 分支
  • 命名规范:feat/[ticket-no]-[simple-description]

Release 分支

  • 需存在于 upstream repo
  • 仅可基于该分支进行 bug fix
  • develop 分支 checkout(时机为 develop 分支能反映出下次上 production 的状态),必须 merge 到 master 分支(当有在 release 分支进行 bug fix 时,也必须 merge 回 develop 分支)
  • 命名规范:release/[release-no]
  • 版本号:*.0.* -> *.1.01.*.* -> 2.0.0

Hotfix 分支

hotfix branch

  • 只应存在于开发者个人的 repo,不应出现在 upstream repo
  • master 分支 checkout,必须 merge 回 develop 分支与 master 分支(若此时存在 release 分支,则应将 hotfix 分支先 merge 到 release 分支,再将 release 分支 merge 回 develop 分支)
  • 命名规范:hotfix/[issue-no]-[simple-description]
  • 版本号:*.*.1 -> *.*.2

其他约定

  • master, develop, release 分支上的迭代必须通过提 PR 的方式进行,禁止直接修改这些分支。
  • 合并 PR 时使用 create a merge commit 的方式(因为其他方式会导致丢失被合并分支上的 commit 信息,后续若继续使用此原始分支提交 PR,会导致旧 PR 的改动仍然出现在新 PR 中的情况,详情请参考 github 官方文档)。

参考资料

JavaScript中的TaskQueue,Macrotask 与 Microtask

通常,JavaScript会通过使用事件机制或timer的方式以达到在特定事件或时间调度执行某段代码(块),这种类型的异步通常在JavaScript中称为Event loop(事件循环)机制。本文,我们将探讨事件循环机制的工作原理,并演示其任务队列的执行过程。

JavaScript中的Event Loop(事件循环)与Call Stack(调用栈)

由于是单线程的,JS使用事件循环的概念来创建异步运行多个任务(我们的JS代码只运行在一个线程中,而JS使用事件循环异步运行代码)。我们将listener(监听器)附加到事件上,因此无论何时触发事件,附加到该事件的回调代码都会被执行。在进一步深入之前,让我们先了解一下JavaScript引擎是如何工作的。

JavaScript引擎由Stack(栈),Heap(堆)及Task Queue(任务队列)组成。

  • Stack

Stack是一个类似数组的结构,用于跟踪当前正在执行的函数。

function m() {
    a()
    b()
}
m()

我们有一个m函数,该函数在函数体中调用了a函数和b函数。在开始执行时,内存中m函数的地址将被压入call stack(调用栈)。同样,JavaScript引擎在执行a函数和b函数前也会将它们的地址压入调用栈。

先等等,你是否会有这样的疑问:为什么JavaScript引擎要存储函数地址及其参数到调用栈呢?

在底层(以x86汇编语言为例),CPU会利用EAX,EBX,ECX,ESP,EIPregisters(寄存器)来临时存储变量并运行我们的程序(前提是已经加载到内存中)。其中EAXEBX用于计算,ECX用于counter job(计数器作业,如存储for循环的次数)。ESP(堆栈指针)保存堆栈的当前地址,EIP(指令指针)保存要执行的程序的当前地址。

RAM                 EIP = 10
0 |     |           ESP = 21
1 |a(){}|
2 |     |             Call Stack
3 |b(){}|             14|   |
4 |     |             15|   |
5 |     |             16|   |
6 |m(){ |             17|   |
7 | a() |             18|   |
8 | b() |             19|   |
9 |}    |             20|   |
10|m()  |             21|   | 

以上是我们的程序运行时在内存中表示的草图,我们看到程序被加载,然后是调用堆栈、ESP和EIP。程序的入口是m(),这就是为什么EIP是10(语句在内存中的位置)。在执行期间,CPU通过查看EIP来知道从哪里开始执行。

每当调用函数时,执行都会跳转到内存中的函数并从那里执行。 然后,在函数运行完成时,必须从其跳转的位置继续上一个函数,因此返回地址必须保存,调用栈就是用于解决这个问题的。 在每个函数调用中,EIP中的当前值都被推送到调用堆栈中。 在我们的示例中,当调用a()时,我们的调用堆栈如下所示:

RAM                   EIP = 1
  0 |     |           ESP = 19
➥ 1 |a(){}|
  2 |     |             Call Stack
  3 |b(){}|             14|   |
  4 |     |             15|   |
  5 |     |             16|   |
  6 |m(){ |             17|   |
  7 | a() |             18|   |
  8 | b() |             19|   |
  9 |}    |             20| 7 |
  10|m()  |             21| 10| 

a()执行完成后,调用栈会将栈顶的7弹出并赋值给EIP,来达到告知CPU继续执行内存地址为7之后的指令。

为什么函数执行参数也要推入调用栈?其实在执行带参数的函数时,该函数使用EBP寄存器从堆栈中获取值,这些值就是它的参数。因此,在调用方函数调用一个函数之前,它必须首先推送被调用方函数要访问的参数,然后推送EIP和ESP地址。

  • Heap

通常在new一个Objects(对象)时,会将新创建的对象分配到堆中。

const apple = new Fruit('apple', 'very_tasty');

上述代码将在堆上创建一个Fruit对象,并将地址返回给apple变量。由于堆本质上不是有序的,因此操作系统必须找到一种方法来实现内存管理,以防止内存泄漏。

  • Task Queue

后续由JavaScript引擎处理的任务会进入任务队列。事件循环机制会不断检查调用栈是否为空,为空的话会继续执行任务队列中排队的所有回调。

Microtask(微任务)与Macrotask(宏任务)

上面我们探讨了JavaScript引擎的工作方式以及任务队列的基本作用。当我们进一步探讨任务队列时,发现 任务进一步被细分为微任务宏任务

事件循环的每次循环:

while (eventLoop.waitForTask()) {
  eventLoop.processNextTask()
}

每次循环中只处理一个宏任务(任务队列是宏任务队列), 完成此操作后,将在同一循环内处理微任务队列中入队的所有微任务。 这些微任务可以入队其他微任务,这些微任务将一直运行直到微任务队列为空。

while (eventLoop.waitForTask()) {
  const taskQueue = eventLoop.selectTaskQueue()
  if (taskQueue.hasNextTask()) {
    taskQueue.processNextTask()
  }

  const microtaskQueue = eventLoop.microTaskQueue
  while (microtaskQueue.hasNextMicrotask()) {
    microtaskQueue.processNextMicrotask()
  }
}

举个实际栗子以更好帮助我们了解微任务及宏任务的处理机制:

// example.js
console.log('script start');

setTimeout(function() {
  console.log('setTimeout');
}, 0);

Promise.resolve().then(function() {
  console.log('promise1');
}).then(function() {
  console.log('promise2');
});

console.log('script end');

当我们运行上述代码时,将会得到下述结果:

script start
script end
promise1
promise2
setTimeout

PS:宏任务可通过setTimeoutsetIntervalsetImmediateevent等方式入队;微任务通过process.nextTickPromisesMutationObserver等方式入队。

上面提到每次事件循环都会先处理一个宏任务,之后再处理微任务队列中的所有微任务。因此你也许会觉得setTimeout应该先于promise1与promise2打印,毕竟似乎没有其他宏任务先于setTimeout产生的宏任务入队?

JavaScript是事件驱动的,因此除非产生了事件,没有代码会在JavaScript引擎中运行。其实在执行任何JS文件前,JavaScript引擎都会将其中的内容包装进一个函数,并且将该函数绑定了startlaunch事件。然后JavaScript引擎会主动触发start事件,该事件的回调函数(其实就是包装代码的函数)将会被加入到宏任务队列中。

总结

  • 任务从任务队列中获取
  • 从任务队列中获取的任务是宏任务,而不是微任务
  • 微任务在当前任务结束时进行处理,在下一个宏任务处理前会处理完微任务队列中所以微任务。
  • 微任务可以入队其他微任务,但微任务队列中所有的微任务都会在下一轮宏任务开始前执行完。
  • UI渲染运行在所有微任务执行完成后。

参考资料