• js设计模式


    学习设计模式js中的设计原则

    js中的设计原则

    设计原则是一系列指导性的原则和准则,用于指导软件和系统的设计过程。这些原则旨在提供一种通用的方法,帮助开发人员在设计和实现过程中做出合理的决策,以创建出高质量、可维护和可扩展的解决方案。

    实际上,前端开发是软件开发的一个重要领域,并且在现代Web应用程序中扮演着越来越重要的角色。前端开发人员需要掌握和应用许多软件开发的基础知识和概念,例如设计模式、代码架构、测试和调试等,才能开发出高质量、可维护、可扩展的Web应用程序。

    设计原则不仅限于特定的编程语言或技术,可以应用于任何类型的软件开发,包括前端开发。

    

    设计原则的作用

    设计原则的作用

    提供指导方针

    -

    设计原则提供了一些通用的指导方针,帮助开发人员在设计和实现过程中做出决策。这些原则可以帮助他们避免一些常见的设计陷阱,提高设计的质量

    促进可维护性和可扩展性

    -

    设计原则强调代码的可维护性和可扩展性。通过遵循这些原则,可以创建出结构清晰、易于理解和修改的代码,使得软件系统更加易于维护和扩展。

    提高代码质量

    -

    设计原则鼓励采用良好的设计实践,包括模块化、单一职责、高内聚低耦合等原则。这些原则可以提高代码的可读性、可测试性和可靠性,从而提高代码的质量。

    降低复杂性

    -

    设计原则通过提供抽象和结构化的方法来降低系统的复杂性。这可以使开发人员更好地理解和处理复杂的问题,减少错误和不必要的复杂性

    促进重用性

    -

    设计原则鼓励重用已有的代码和组件,减少重复编写和维护相似的代码。这可以提高开发效率,减少代码冗余,并提供一致性和标准化的解决方案

    改善用户体验

    -

    一些设计原则也关注用户体验方面,例如简单性原则和可访问性原则。通过设计简单直观的用户界面和考虑用户的需求和能力,可以提供更好的用户体验

    

    软件设计中的常用设计原则

    单一职责原则

    一个类或模块(函数、对象)应该只有一个引起它变化的原因,换句话说,一个类应该只有一个责任(通俗点说比如:一个函数只做一件事)。如果一个对象具有多个职责,职责之间相互耦合,那么如果一个职责的逻辑需要修改,势必会影响到其他职责的代码。

    代码示例(违反原则)

    1. // 不符合单一职责原则的示例
    2. 
    3. function calculateAreaAndPerimeter(rectangle) {
    4. const area = rectangle.width * rectangle.height;
    5. const perimeter = 2 * (rectangle.width + rectangle.height);
    6. console.log(`周长: ${perimeter}`);
    7. }

    在上面的示例中,展示了一个不符合单一职责原则的函数calculateAreaAndPerimeter。该函数负责计算矩形的面积和周长,并直接将结果打印到控制台。这违反了单一职责原则,因为函数承担了多个计算和打印多个不同的责任。

    代码重构(符合原则)

    1. // 符合单一职责原则的示例
    2. function calculateArea(rectangle) {
    3. return rectangle.width * rectangle.height;
    4. }
    5. 
    6. function calculatePerimeter(rectangle) {
    7. return 2 * (rectangle.width + rectangle.height);
    8. }
    9. 
    10. function printPerimeter(perimeter) {
    11. console.log(`周长: ${perimeter}`);
    12. }
    13. 
    14. // 使用示例
    15. const rectangle = { width: 10, height: 5 };
    16. 
    17. const area = calculateArea(rectangle);
    18. const perimeter = calculatePerimeter(rectangle);
    19. printPerimeter(perimeter);

    我们将计算面积和周长的功能分别提取到两个独立的函数calculateAreacalculatePerimeter中。这样,每个函数都只负责一个具体的计算任务,符合单一职责原则。

    为了打印结果,我们也创建了独立的函数printPerimeter。这样,计算和打印的责任得到了清晰的分离。

    通过这种重构,我们使得代码更加清晰、可维护,并且每个函数都遵循了单一职责原则

    

    开放封闭原则

    软件实体(类、模块、函数等)应该对扩展开放,对修改关闭。当需要增加功能需求的时候,则尽量通过扩展新代码的方式,而不是修改已有代码。因为修改已有代码,则会给依赖原有代码的模块带来隐患,增加测试成本。

    代码示例(违反原则)

    1. // 不符合开放封闭原则的示例
    2. 
    3. function calculateTotalPrice(cartItems) {
    4. let totalPrice = 0;
    5. for (const item of cartItems) {
    6. if (item.type === 'book') {
    7. totalPrice += item.price * 0.9; // 10% 折扣
    8. } else if (item.type === 'clothing') {
    9. totalPrice += item.price * 1.2; // 20% 涨价
    10. } else if (item.type === 'electronic') {
    11. totalPrice += item.price * 1.5; // 50% 涨价
    12. }
    13. }
    14. return totalPrice;
    15. }
    16. 
    17. const totalPrice = calculateTotalPrice(cartItems)

    在上面的示例中,首先展示了一个不符合开放封闭原则的函数calculateTotalPrice。该函数根据不同商品的类型进行不同的计算逻辑,这意味着每次添加新的商品类型时,都需要修改该函数。这违反了开放封闭原则,因为函数不是对扩展开放的,而是对修改开放的。为了符合开放封闭原则,我们对代码进行了重构。

    代码重构(符合原则)

    1. // 符合开放封闭原则的重构后的代码
    2. const discountList = {
    3. book: 0.9, // 书籍 10% 折扣
    4. clothing: 1.2, // 服装 20% 涨价
    5. electronic: 1.5, // 电子产品 50% 涨价
    6. }
    7. 
    8. function calculateTotalPrice(cartItems, discount = discountList) {
    9. let totalPrice = 0;
    10. for (const item of cartItems) {
    11. if (discount[item.type]) totalPrice += item.price * discount[item.type]
    12. }
    13. return totalPrice;
    14. }
    15. 
    16. const totalPrice = calculateTotalPrice(cartItems)
    17. 
    18. // 新增鞋子类型,打8折
    19. // discountList.shoe = 0.8
    20. 
    21. const discountListNew = {
    22. ...discountList,
    23. shoe: 0.8
    24. }
    25. 
    26. calculateTotalPrice(cartItems, discountListNew)

    我们将商品的类型、对应商品类型的折扣优惠,提取到一个公共对象discountList中,商品type类型作为key值,对应的折扣优惠为value值,重构了calculateTotalPrice方法中关于totalPrice的计算逻辑,商品的折扣优惠根据商品的type类型作为key从discountList对象中,取出对应的value值(折扣优惠)。这样每次添加新的商品时,无需再次更改calculateTotalPrice方法,只需要给discountList新增属性即可。或者,传入一个新的 discountListNew 对象

    

    依赖倒置原则

    它是关于模块之间相互依赖(引用、使用)关系的一个约束,高层模块不应该依赖于低层模块的具体实现(实例对象),它应该依赖于低层模块的抽象

    代码示例(违反原则)

    1. // 不符合依赖倒置原则的示例
    2. 
    3. class EmailSender {
    4. sendEmail(email, message) {
    5. // 发送电子邮件的具体实现
    6. }
    7. }
    8. 
    9. class NotificationService {
    10. constructor() {
    11. this.emailSender = new EmailSender();
    12. }
    13. 
    14. sendNotification(user, message) {
    15. const email = user.getEmail();
    16. this.emailSender.sendEmail(email, message);
    17. }
    18. }

    在上面的示例中,首先展示了一个不符合依赖倒置原则的类设计。NotificationService类内部创建了一个具体的EmailSender对象,并依赖于该对象来发送通知。这种设计限制了NotificationService类的灵活性,使其与具体的EmailSender实现紧密耦合在一起。

    代码重构(符合原则)

    1. // 符合依赖倒置原则的示例
    2. 
    3. class EmailSender {
    4. sendEmail(email, message) {
    5. // 发送电子邮件的具体实现
    6. }
    7. }
    8. 
    9. class NotificationService {
    10. constructor(sender) {
    11. // 接收一个实现了EmailSender的对象
    12. this.sender = sender;
    13. }
    14. 
    15. sendNotification(user, message) {
    16. const email = user.getEmail();
    17. this.sender.sendEmail(email, message);
    18. }
    19. }
    20. 
    21. // 使用示例
    22. const emailSender = new EmailSender();
    23. const notificationService = new NotificationService(emailSender);

    为了符合依赖倒置原则,我们对代码进行了重构。首先,我们定义了一个EmailSender类,用于发送电子邮件。然后,NotificationService类的构造函数接受一个实现了EmailSender类的对象,而不是直接创建EmailSender对象。

    这样,NotificationService类不再依赖于具体的EmailSender实现,而是依赖于抽象。这符合依赖倒置原则,高层模块(NotificationService)依赖于抽象,而不依赖于具体的实现细节

    在使用示例中,我们首先创建了一个具体的EmailSender对象。然后,我们通过将EmailSender对象传递给NotificationService的构造函数来创建NotificationService对象。这样,NotificationService类可以与任何实现了EmailSender接口的对象进行协作。

    通过这种依赖倒置的设计,我们降低了类之间的耦合性,提高了代码的灵活性和可维护性。任何实现了EmailSender类的对象都可以被传递给NotificationService类,实现了依赖的反转

    如何理解所谓 ”依赖的反转倒置"?

    在传统的依赖关系中,高层模块(或类、函数)依赖于低层模块的具体实现。这意味着高层模块需要直接引用和依赖于低层模块。如:

    1. // 一个类直接依赖另一个类的实例对象
    2. // DataFetcher 紧耦合了 MySQLDatabase 这个数据库类
    3. class DataFetcher {
    4. fetchData(){
    5. const dataBase = new MySQLDatabase()
    6. return dataBase.getData()
    7. }
    8. }
    9. 
    10. // 一个函数直接依赖一个第三方函数
    11. // calcFunc 方法紧耦合了 lodash.multiply 方法
    12. const calcFunc = function(width, height){
    13. //...一些逻辑
    14. const lodash = require('lodash');
    15. return lodash.multiply(width, height)
    16. }

    而在依赖倒置中,我们将这个依赖关系进行反转。高层模块不再直接依赖于低层模块的具体实现,而是依赖于一个抽象或者说”约定”。根据依赖倒置原则重构代码如下:

    1. class DataFetcher {
    2. constructor(database) {
    3. this.database = database;
    4. }
    5. fetchData(){
    6. return this.database.getData()
    7. }
    8. }
    9. const SQLDataBase = new MySQLDatabase()
    10. const SQLDataFetcher = new DataFetcher(SQLDataBase);
    11. SQLDataFetcher.fetchData()
    12. 
    13. const OracleDataBase = new OracleDatabase()
    14. const OracleDataFetcher = new DataFetcher(OracleDataBase);
    15. OracleDataFetcher.fetchData()

    // 将DataFetcher和具体的数据库类解耦,DataFetcher赖于抽象接口 database,

    // 而不依赖于具体类或实例对象。这样,无论是使用 MySQLDatabase 还是 OracleDatabase,

    // 都可以通过依赖注入的方式传递给 DataFetcher,实现对不同数据库的数据获取操作

    

    1. 
    2. const lodash = require('lodash');
    3. const calcFunc = function(width, height, func = lodash.multiply){
    4. //...一些逻辑
    5. return func(width, height)
    6. }
    7. calcFunc(width, height)
    8. calcFunc(width, height, lodash.add)

    

    // 将 calcFunc 方法与lodash.multiply 解耦,不再依赖于具体的函数,而是依赖一个抽象'func'

    简单来说依赖倒置原则的两个核心

    • 高层模块应依赖于一个抽象或者说“约定”,而不是直接依赖于具体实现。

    • 具体的低层模块应实现了这个抽象或者说'约定',从而能够满足高层模块的需求。

    

    里式替换原则

    它是关于父类、子类继承关系的一个约束。该原则的定义是:如果S是T的子类型,那么在任何程序中,所有使用T类型的地方都可以用S类型的对象替换而不会导致程序的任何错误

    换句话说,子类应该能够完全替代父类并在不破坏程序正确性的前提下扩展或修改其行为。

    代码示例:

    1. class Animal {
    2. makeSound() {
    3. console.log("动物在发出声音");
    4. }
    5. }
    6. 
    7. class Cat extends Animal {
    8. makeSound() {
    9. console.log("猫在喵喵喵");
    10. }
    11. }
    12. 
    13. class Dog extends Animal {
    14. makeSound() {
    15. console.log("狗在汪汪汪");
    16. }
    17. }
    18. 
    19. function animalMakeSound(animal) {
    20. animal.makeSound();
    21. }
    22. 
    23. const animal = new Animal();
    24. const cat = new Cat();
    25. const dog = new Dog();
    26. 
    27. animalMakeSound(animal); // 输出: "动物在发出声音"
    28. animalMakeSound(cat); // 输出: "猫在喵喵喵"
    29. animalMakeSound(dog); // 输出: "狗在汪汪汪"

    在上述代码示例中,我们定义了一个Animal类作为父类,以及Cat和Dog作为子类。这些子类继承了父类的makeSound方法,并根据自身特性进行了具体实现。

    在animalMakeSound函数中,我们接收一个Animal类型的参数,然后调用其makeSound方法。根据里式替换原则,我们可以将Cat和Dog实例作为参数传递给animalMakeSound函数,而不会导致逻辑错误或异常。

    这个示例展示了符合里式替换原则的代码。子类能够替换父类,并且在使用父类类型的地方,我们可以使用子类类型进行替代,而不会破坏程序的正确性

    里式替换原则之子类重写父类方法时,应遵循:

    • 子类的方法参数类型应该与父类的方法参数类型相同或更宽松

    • 子类的方法返回类型应该与父类的方法返回类型相同或更严格

    • 子类的方法不应该抛出比父类方法更多或更宽泛的异常

    • 子类的方法不应该改变父类方法的预置条件 (即方法的前置条件)

    • 子类的方法不应该改变父类方法的后置条件(即方法的后置条件)

    如果子类重写父类的方法时遵循了上述原则,那么它就符合里氏替换原则。

    

    接口隔离原则

    客户端(接口使用端)不应该强迫依赖于它们不使用的接口。简而言之,这意味着一个类不应该被迫实现它不需要的接口方法或属性,接口应该被分离成更小的、更具体的部分,以使得每个类只需要实现与其相关的接口。接口隔离原则强调将大型、臃肿的接口拆分成更小、更具体的接口,以便每个客户端(接口使用端)只需关注其所需的接口方法,确保接口的精简和高内聚,减少代码耦合。

    代码示例(违反原则)

    1. // 不符合接口隔离原则的示例
    2. 
    3. class Vehicle {
    4. constructor() {
    5. this.speed = 0;
    6. }
    7. 
    8. start() {
    9. console.log('启动')
    10. }
    11. 
    12. stop() {
    13. console.log('停止')
    14. }
    15. 
    16. accelerate() {
    17. console.log('加速')
    18. }
    19. 
    20. brake() {
    21. console.log('刹车')
    22. }
    23. 
    24. refuel() {
    25. console.log('加油')
    26. }
    27. }
    28. 
    29. class Car extends Vehicle {
    30. constructor() {
    31. super();
    32. // 具体汽车的特性和实现
    33. }
    34. }
    35. 
    36. class Bicycle extends Vehicle {
    37. constructor() {
    38. super();
    39. // 具体自行车的特性和实现
    40. }
    41. }
    42. 
    43. const bicycle = new Bicycle()
    44. bicycle.refuel() // 自行车不需要加油,它的实例却可以使用 refuel方法

    代码重构(符合原则)

    1. // 符合接口隔离原则的示例
    2. class Vehicle {
    3. constructor() {
    4. this.speed = 0;
    5. }
    6. 
    7. start() {
    8. console.log('启动')
    9. }
    10. 
    11. stop() {
    12. console.log('停止')
    13. }
    14. 
    15. accelerate() {
    16. console.log('加速')
    17. }
    18. 
    19. brake() {
    20. console.log('刹车')
    21. }
    22. 
    23. }
    24. 
    25. class Motor {
    26. refuel() {
    27. console.log('加油')
    28. }
    29. }
    30. 
    31. 
    32. // mixinClass函数支持实现多重继承
    33. class Car extends mixinClass(Vehicle, Motor) {
    34. constructor() {
    35. super();
    36. // 具体汽车的特性和实现
    37. }
    38. }
    39. 
    40. class Bicycle extends Vehicle {
    41. constructor() {
    42. super();
    43. // 具体自行车的特性和实现
    44. }
    45. }
    46. 
    47. 
    48. // 使用示例
    49. const car = new Car();
    50. car.start();
    51. car.refuel()
    52. 
    53. const bicycle = new Bicycle()
    54. bicycle.start();

    接口隔离原则中的“接口”概念

    前端开发中,通常提到的接口(API)指的是前端应用程序与后端服务器之间的通信接口,用于请求和响应数据。这些接口定义了前端应用程序可以向服务器发送哪些请求以及服务器将返回哪些数据。然而,在接口隔离原则中,"接口"的含义有所不同。接口在这里指的是面向对象编程中的接口,它描述了一个类或对象所提供的方法和行为。它是一种契约或协议,定义了类或对象与其使用者之间的约定

    在前端开发中,我们可以应用接口隔离原则来设计前端组件、模块或类的接口,以确保它们的设计合理、可维护和可扩展。

    

    迪米特法则

    也被称为最少知识原则,它提出:一个对象应该对其他对象保持最小的了解。换句话说,一个对象应该只与它直接相关的对象进行通信,而不应该了解其他对象的内部细节。迪米特法则的核心思想是减少对象之间的依赖关系(降低耦合度),使得对象的设计更加独立和可复用。对象只应该与其直接的朋友进行通信,而不需要与朋友的朋友进行直接通信

    直接的朋友是指与当前对象有紧密关联的对象:

    • 当前对象本身

    • 当前对象的成员变量

    • 当前对象所创建的对象

    • 以参数形式传入到当前对象的方法中的对象

    两个核心:

    • 对象之间的通信限制:迪米特法则要求一个对象只与直接的朋友进行通信,不要和陌生的对象直接通信。

    • 限制对象对其他对象的了解程度:迪米特法则要求一个对象对其他对象的了解应该越少越好。一个对象只需知道它需要与之交互的对象的接口,不需要深入了解对象的内部实现细节。

    代码示例(违反原则)

    1. class Customer {
    2. constructor(name) {
    3. this.name = name;
    4. this.cart = new ShoppingCart();
    5. }
    6. 
    7. addToCart(item) {
    8. this.cart.addItem(item);
    9. }
    10. 
    11. checkout() {
    12. const totalPrice = this.cart.calculateTotalPrice();
    13. // 执行支付逻辑
    14. console.log(`顾客 ${this.name} 已结账。总价: ${totalPrice}`);
    15. }
    16. }
    17. 
    18. class ShoppingCart {
    19. constructor() {
    20. this.goods = [];
    21. }
    22. 
    23. addItem(item) {
    24. this.goods.push(item);
    25. }
    26. 
    27. calculateTotalPrice() {
    28. let totalPrice = 0;
    29. for (const item of this.goods) {
    30. totalPrice += item.price;
    31. }
    32. return totalPrice;
    33. }
    34. }
    35. 
    36. class Goods {
    37. constructor(name, price) {
    38. this.name = name;
    39. this.price = price;
    40. }
    41. }
    42. 
    43. // 使用示例
    44. const customer = new Customer("张三");
    45. 
    46. const goods1 = new Goods("product 1", 10);
    47. const goods2 = new Goods("product 2", 20);
    48. 
    49. customer.addToCart(goods1);
    50. customer.addToCart(goods2);
    51. 
    52. customer.checkout();

    在上述示例中,Customer 类直接依赖于 ShoppingCart 类的内部实现细节。Customer类知道ShoppingCart类具有addItem和calculateTotalPrice方法,并且直接调用这些方法来添加商品和计算总价格。

    这违反了迪米特法则,因为Customer类过度了解ShoppingCart类的内部实现细节。按照迪米特法则,Customer类应该只与ShoppingCart类的公共接口进行交互,而不需要了解其具体实现。

    代码重构(符合原则)

    1. class Customer {
    2. constructor(name) {
    3. this.name = name;
    4. }
    5. // 与传入的参数对象通信,通过它提供的合适的接口(不暴露过多内部实现细节)访问到必要的信息
    6. checkout(cart) {
    7. const totalPrice = cart.getTotalPrice();
    8. // 执行支付逻辑
    9. console.log(`顾客 ${this.name} 已结账。总价: ${totalPrice}`);
    10. }
    11. }
    12. 
    13. class ShoppingCart {
    14. constructor() {
    15. this.goods = [];
    16. }
    17. 
    18. addGoods(item) {
    19. this.goods.push(item);
    20. }
    21. 
    22. calculateTotalPrice() {
    23. let totalPrice = 0;
    24. for (const item of this.goods) {
    25. totalPrice += item.price;
    26. }
    27. return totalPrice;
    28. }
    29. 
    30. getTotalPrice() {
    31. return this.calculateTotalPrice()
    32. }
    33. }
    34. 
    35. class Goods {
    36. constructor(name, price) {
    37. this.name = name;
    38. this.price = price;
    39. }
    40. }
    41. 
    42. // 使用示例
    43. const goods1 = new Goods("Product 1", 10);
    44. const goods2 = new Goods("Product 2", 20);
    45. 
    46. const cart = new ShoppingCart()
    47. cart.addGoods(goods1);
    48. cart.addGoods(goods2);
    49. 
    50. const customer = new Customer("张三");
    51. customer.checkout(cart);

    在实践中,可以通过以下方式来应用迪米特法则:

    1. 一个对象应该尽量减少对其他对象的直接依赖。一个对象不应该直接访问其他对象的内部属性和方法,而应该通过尽可能少的接口与其他对象进行通信。

    2. 对象之间的通信应该通过最少的层次进行,即避免出现"链式调用"的情况。因为这会增加对象之间的耦合性。如果需要多个对象进行协作,应该通过引入中间对象或通过事件/消息机制进行通信,以减少直接依赖和耦合。

    3. 通过封装和抽象来隐藏对象的内部实现细节。对象应该暴露合适的接口,让其他对象只能访问到必要的信息,从而降低对象之间的耦合性。

    4. 当对象需要与其他对象进行通信时,应该使用依赖注入或依赖反转等技术,而不是直接创建和管理对象的实例。

    所谓"依赖注入":通过外部传入的方式将依赖对象注入到对象中。在依赖注入中,依赖关系不是由对象自身创建或者获取,而是由外部的调用者或者容器负责创建和传递给对象。具体实现依赖注入的方式有多种,包括构造函数注入(new)、属性注入和接口注入(提供专门的注入接口)等。

    以上的几个原则,有些技术文章分享中把它们称为 “SOLID 原则” ,也有的叫“面向对象编程中的六大原则”。不管叫什么吧,我们在理解这些设计原则时,应该从一种更加广义的范围去理解这些设计原则背后的思想,做开发时尽量遵循这些设计原则的约定。

    

    高内聚低耦合原则

    模块内部的元素应该紧密相关(高内聚),而模块之间的依赖应该尽量减少(低耦合)。高内聚和低耦合可以提高代码的可读性、可维护性和可测试性

    

    最小意外原则

    软件的行为应该符合用户的预期,避免令人困惑或出乎意料的行为。最小意外原则要求开发人员设计和实现软件时尽量遵循常规的、符合用户认知和预期的方式,以提供一致性和易用性的用户体验。

    

    重用原则

    在设计软件时,应该鼓励和促进代码的重用。通过抽象、模块化和组件化的方式,可以使得代码更易于复用,并减少重复编写代码的工作量,提高开发效率。

    

    简单原则

    软件设计应该保持简单,避免不必要的复杂性和过度工程化。简单原则强调优先选择简单而有效的解决方案,避免过度设计和过度优化,以确保代码的可读性和可理解性

    

    思考:

    我们学习了这些设计原则,并不是要强调开发时一定要遵循什么原则,什么样的代码书写是符合原则的,什么样的代码是错误的。

    我们只是讨论和理解这些设计原则背后的思想、关键点是什么。比如我个人的一些理解:

    1.对于函数,单一职责是说 “一个函数只做一件事儿”。但在实际开发中,我们一个函数肯定有“综合性函数”,它做了很多件事,我们不能直接说这个函数是不对的,是不符合原则的,这样就片面了。而是说,理解了设计原则的思想,我们尽量把 “一大坨代码”进行逻辑归类、拆分出不同职责的几个函数,尽可能一个函数承担“一个责任”,这样做是好的。

    2.开放封闭原则,是说我们在书写代码的过程中,要考虑它的一个开放性和封闭性,尽可能实现对扩展开放,对修改封闭。个人体会,就是写函数时尽量 单一职责,尽量 函数内依赖一个“抽象”(依赖函数传入的参数),而不直接依赖一个“具体细节”。如果说在一个综合性函数中我们把一些实现的具体细节写的非常清楚,那么大概率是不符合开放封闭的,因为一旦有需求的变化,这些“具体实现的逻辑代码”就一定会要修改的。正确的做法是,我们把一些具体实现的细节放在另一个单一职责的函数中去,然后把这个函数通过参数,传入进来使用。

    3.对于我们前端来说,书写函数,最重要的两个原则一是 单一职责(一个函数只干一件事而)二是 依赖倒置(应依赖一个抽象,而不依赖于具体实现);只要能大概遵循,那我们的代码也大概率是低耦合的,能轻松实现开放封闭。

    

    综合举例:

    糟糕的实现1:

    存在3个函数A、B、C, 要求A函数执行完成,返回成功态,然后执行B函数,B函数判断A函数是成功态则执行,执行完成返回成功态,然后执行C函数,C函数执行完成,重置events,输出重置语句。

    1. let events = {}
    2. 
    3. function A(){
    4. // A函数的逻辑...
    5. console.log('A函数执行完成')
    6. events.A = true
    7. B()
    8. }
    9. function B() {
    10. if (!events.A) return
    11. // B函数的逻辑...
    12. console.log('B函数执行完成')
    13. events.B = true
    14. C()
    15. }
    16. function C(){
    17. if (!events.B) return
    18. // C函数的逻辑...
    19. console.log('C函数执行完成')
    20. events = {}
    21. console.log('A、B、C函数都执行完成,events被重置')
    22. }
    23. 
    24. // 执行A
    25. A()
    26. 
    27. export events

    第一次重构优化:

    1. const status = {
    2. success: 200,
    3. fail: 500,
    4. reset: 100,
    5. }
    6. // type Status = 'success' | 'fail' | 'reset'
    7. 
    8. function A(){
    9. // A函数的逻辑...
    10. console.log('A函数执行完成')
    11. return status.success
    12. 
    13. }
    14. function B() {
    15. 
    16. // B函数的逻辑...
    17. console.log('B函数执行完成')
    18. return status.success
    19. 
    20. }
    21. function C(){
    22. 
    23. // C函数的逻辑...
    24. console.log('C函数执行完成')
    25. return status.reset
    26. 
    27. }
    28. 
    29. let events = {}
    30. function execute() {
    31. events.A_status = A()
    32. if (events.A_status === status.success) events.B_status = B()
    33. if (events.B_status === status.success) events.C_status = C()
    34. if (events.C_status === status.reset) {
    35. events = {}
    36. console.log('A、B、C函数都执行完成,events被重置')
    37. }
    38. }
    39. 
    40. // 执行
    41. execute()
    42. 
    43. export events

    需求变更(无需改动原先的代码)

    我希望先执行B函数,B函数执行成功再执行A函数, 然后再执行C函数...

    1. function execute_B() {
    2. events.B_status = B()
    3. if (events.B_status === status.success) events.A_status = A()
    4. if (events.A_status === status.success) events.C_status = C()
    5. if (events.C_status === status.reset) {
    6. message = {}
    7. console.log('A、B、C函数都执行完成,events被重置')
    8. }
    9. }
    10. 
    11. execute_B()

    进一步抽象封装:

    // 我希望可以任意改变函数执行顺序,并且,可以重复执行某个函数,或者任意新增函数执行,只要能保证最后一个函数执行完,重置就可以了

    1. const status = {
    2. success: 200,
    3. fail: 500,
    4. reset: 100,
    5. }
    6. 
    7. function A(){
    8. // A函数的逻辑...
    9. console.log('A函数执行完成')
    10. }
    11. function B() {
    12. // B函数的逻辑...
    13. console.log('B函数执行完成')
    14. }
    15. function C(){
    16. // C函数的逻辑...
    17. console.log('C函数执行完成')
    18. }
    19. 
    20. // 新增加D函数
    21. function D() {
    22. // D函数的逻辑...
    23. console.log('D函数执行完成')
    24. return {msg: 'D函数执行完了'}
    25. }
    26. 
    27. const running = (func, returnStatus, fail) => (func(), returnStatus)
    28. 
    29. const getReturnStatus = (index, last, reset, success) => index === last ? reset : success
    30. 
    31. const handleReset = (e, reset) => e.currentStatus === reset ? (e = {}, console.log('所有函数都执行完成,events被重置'), e) : e
    32. 
    33. 
    34. // 重新定义新的执行
    35. function handleExecute(...args) {
    36. let events = {}
    37. args.forEach((func, i) => {
    38. if (!events.currentStatus || events.currentStatus === status.success) {
    39. events.currentStatus = running(func, getReturnStatus(i, args.length - 1, status.reset, status.success), status.fail)
    40. }
    41. })
    42. events = handleReset(events, status.reset)
    43. return events
    44. }
    45. 
    46. let events = handleExecute(A, B, C)
    47. 
    48. events = handleExecute(C, B, A)
    49. 
    50. events = handleExecute(C, B, C)
    51. 
    52. events = handleExecute(C, B, A, D)

    糟糕的实现2:

    一个按钮的文本色为黑色背景色为浅灰色,当光标 mouseover 的时候文本色为蓝色、背景色为绿色、尺寸变为 1.5 倍,当光标 mouseleave 的时候还原文本色、背景色、尺寸,在鼠标按下的时候文本色变为红色、背景色变为紫色、尺寸变为 0.5 倍,抬起后恢复原状。

    1. DOCTYPE html>
    2. <html lang="en">
    3. <head>
    4. <meta charset="UTF-8" />
    5. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    6. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. <title>Documenttitle>
    8. <style>
    9. #btn {
    10. width: 120px;
    11. height: 30px;
    12. color: black;
    13. background-color: lightgray;
    14. display: block;
    15. transition: 0.4s;
    16. margin-left: calc(50% - 120px / 2);
    17. margin-top: 100px;
    18. }
    19. style>
    20. head>
    21. 
    22. 
    23. <body>
    24. <button id="btn">点一下试试button>
    25. <script>
    26. var btn = document.getElementById("btn");
    27. 
    28. btn.addEventListener("mouseover", function () {
    29. btn.style.setProperty("color", "blue");
    30. btn.style.setProperty("background-color", "green");
    31. btn.style.setProperty("transform", "scale(1.5)");
    32. 
    33. });
    34. 
    35. btn.addEventListener("mouseleave", function () {
    36. btn.style.setProperty("color", "black");
    37. btn.style.setProperty("background-color", "lightgray");
    38. btn.style.setProperty("transform", "scale(1)");
    39. });
    40. 
    41. btn.addEventListener("mousedown", function () {
    42. btn.style.setProperty("color", "red");
    43. btn.style.setProperty("background-color", "purple");
    44. btn.style.setProperty("transform", "scale(.5)");
    45. });
    46. 
    47. btn.addEventListener("mouseup", function () {
    48. btn.style.setProperty("color", "black");
    49. btn.style.setProperty("background-color", "lightgray");
    50. btn.style.setProperty("transform", "scale(1)");
    51. });
    52. script>
    53. body>
    54. html>

    重构优化:

    1. DOCTYPE html>
    2. <html lang="en">
    3. <head>
    4. <meta charset="UTF-8" />
    5. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    6. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    7. <title>Documenttitle>
    8. <style>
    9. #btn {
    10. width: 120px;
    11. height: 30px;
    12. color: black;
    13. background-color: lightgray;
    14. display: block;
    15. transition: 0.4s;
    16. margin-left: calc(50% - 120px / 2);
    17. margin-top: 100px;
    18. }
    19. style>
    20. head>
    21. <body>
    22. <button id="btn">点一下试试button>
    23. <script>
    24. /* 批量设置dom style样式 */
    25. let setStyleProperty = (element, styleStr) => {
    26. if (element.setAttribute) {
    27. element.setAttribute("style", styleStr);
    28. } else {
    29. element.style.cssText = styleStr;
    30. }
    31. };
    32. 
    33. // 判断是否是dom元素
    34. const isNodeElement = n => n && n.nodeType === 1;
    35. const _getElement = (element, that) => {
    36. element = isNodeElement(element) ? element : that;
    37. if (element === window) throw Error("找不到Dom元素");
    38. return element;
    39. };
    40. 
    41. 
    42. // 检测样式属性名称是否可以使用
    43. const _checkPropertyName = function (propName) {
    44. if (!document.body.style.hasOwnProperty(propName)) {
    45. throw Error(`style名称 ${propName} 错误`);
    46. }
    47. return true
    48. };
    49. 
    50. 
    51. // 转换驼峰写法 到 中横线写法
    52. const propertyNameAdapter = name => {
    53. const capitalIndex = name.split("").findIndex((str) => /[A-Z]/.test(str)); // 大写字母存在且位置是什么
    54. if (capitalIndex >= 0) {
    55. const prefix = name.substring(0, capitalIndex); // substring(a,b) 得到从a开始到b结束(不包括b处)的子串
    56. const suffix = name.substr(capitalIndex).toLowerCase(); // substr(a,b) 将得到从 a 开始,长度为b 的子串,b可以省略,表示到字符串结尾;
    57. name = `${prefix}-${suffix}`;
    58. }
    59. return name;
    60. };
    61. 
    62. // 批量处理css样式
    63. const _handleCSS = styles => {
    64. let stylesStr = "";
    65. const propNameArr = Object.keys(styles);
    66. if (propNameArr.length) {
    67. propNameArr.forEach((propName) => {
    68. _checkPropertyName(propName);
    69. stylesStr += `${propertyNameAdapter(propName)}: ${styles[propName]}; `;
    70. });
    71. }
    72. return stylesStr;
    73. };
    74. 
    75. 
    76. // 缓存备忘
    77. const cache = new Map();
    78. // 设置dom元素样式
    79. let setElementStyle = (styles, element = null) => {
    80. return function () {
    81. element = _getElement(element, this); // 获得Dom
    82. const stylesStr = cache.get(styles) || cache.set(styles, _handleCSS(styles)).get(styles); // 获得样式
    83. if (stylesStr) setStyleProperty(element, stylesStr); // 设置
    84. };
    85. };
    86. 
    87. // 需求可以是:发送1个请求,从请求中拿到配置的参数信息
    88. const requestStyleConfig = () => {
    89. //... 请求...
    90. const hoverStyle = {
    91. color: "white",
    92. "background-color": "green",
    93. transform: "scale(1.5)",
    94. // fontSize: "18px",
    95. // textDecoration: "underline",
    96. // 'font-style': 'italic',
    97. };
    98. 
    99. const clickStyle = {
    100. color: "red",
    101. "background-color": "purple",
    102. transform: "scale(.8)",
    103. };
    104. 
    105. const defaultStyle = {
    106. color: "black",
    107. "background-color": "lightgray",
    108. "font-size": "12px",
    109. transform: "scale(1)",
    110. };
    111. return { hoverStyle, clickStyle, defaultStyle };
    112. };
    113. 
    114. 
    115. const { hoverStyle, clickStyle, defaultStyle } = requestStyleConfig();
    116. var btn = document.getElementById("btn");
    117. 
    118. btn.addEventListener("mouseover", setElementStyle(hoverStyle));
    119. btn.addEventListener("mouseleave", setElementStyle(defaultStyle));
    120. btn.addEventListener("mousedown", setElementStyle(clickStyle));
    121. btn.addEventListener("mouseup", setElementStyle(defaultStyle));
    122. script>
    123. body>
    124. html>

    提问:

    还可以优化吗?

    假如出现了第2个dom元素需要应用不同的逻辑, 你不得不这样写了:

    1. class="second">第二个dom
    2. ...
    3. ...
    4. 
    5. 
    6. const { hoverStyle, clickStyle, defaultStyle } = requestStyleConfig();
    7. var btn = document.getElementById("btn");
    8. 
    9. btn.addEventListener("mouseover", setElementStyle(hoverStyle));
    10. btn.addEventListener("mouseleave", setElementStyle(defaultStyle));
    11. btn.addEventListener("mousedown", setElementStyle(clickStyle));
    12. btn.addEventListener("mouseup", setElementStyle(defaultStyle));
    13. 
    14. var second = document.querySelector(".second");
    15. second.addEventListener("mouseover", setElementStyle(clickStyle));
    16. second.addEventListener("mouseleave", setElementStyle(defaultStyle));
    17. second.addEventListener("mousedown", setElementStyle(hoverStyle));
    18. second.addEventListener("mouseup", setElementStyle(defaultStyle));

    继续封装,再次解耦:

    // 上面dom 绑定这块可以被抽象和解耦吗?

    1. const btnStyle = {
    2. id:'btn',
    3. class: '',
    4. events : {
    5. mouseover: hoverStyle,
    6. mouseleave: defaultStyle,
    7. mousedown: clickStyle,
    8. mouseup: defaultStyle
    9. },
    10. handler: setElementStyle
    11. }
    12. 
    13. const secondStyle = {
    14. id:'',
    15. class: '.second',
    16. events: {
    17. mouseover: clickStyle,
    18. mouseleave: defaultStyle,
    19. mousedown: hoverStyle,
    20. mouseup: defaultStyle
    21. },
    22. handler: setElementStyle
    23. }
    24. 
    25. const bindEvents = (dom, events) => {
    26. Object.keys(events).forEach(key => dom.addEventListener(key, events[key]))
    27. }
    28. 
    29. const createEvents = (eventStyle, creatEventFunc) => {
    30. const events = {}
    31. Object.keys(eventStyle).forEach(key => {
    32. events[key] = creatEventFunc(eventStyle[key])
    33. })
    34. return events
    35. }
    36. 
    37. const domBindStyle = (domStyle) => {
    38. const id = domStyle.id
    39. const className = domStyle.class
    40. const dom = id ? document.getElementById(id) : document.querySelector(className)
    41. if (!isNodeElement(dom)) throw Error("找不到Dom元素");
    42. bindEvents(dom, createEvents(domStyle.events, domStyle.handler))
    43. }
    44. 
    45. domBindStyle(btnStyle)
    46. domBindStyle(secondStyle)

    设计原则在 Vue开发中的应用

    单一职责原则:每个组件职责单一

    1. 
    2. <script setup>
    3. import { ref } from "vue";
    4. 
    5. const products = ref([])
    6. const categories = ref([])
    7. const selectedProduct = ref(null)
    8. 
    9. const handleProductSelected = (product) => {
    10. selectedProduct.value = product;
    11. };
    12. 
    13. const handleCategorySelected = (category) => {
    14. // Filter products by category
    15. };
    16. script>

    正如你所看到的,这里有三个不同的组件,每个组件有自己的单一职责:ProductListProductFilterProductDetail

    • ProductList 组件负责显示产品列表,并在选择某个产品时发出 product-selected 事件。

    • ProductFilter 组件负责显示类别列表,并在选择某个类别时发出 category-selected 事件。

    • ProductDetail ‍组件负责显示所选产品的详细信息。

    将职责分离到不同的组件中,使得代码更容易理解、维护和测试。每个组件都可以单独进行测试,对一个组件的更改不会影响到其他组件。

    开放封闭原则:扩展组件的功能

    List.vue 组件,添加排序功能

    1. 
    2. <script setup>
    3. defineProps({
    4. items: Array
    5. })
    6. script>

    扩展1个composable(useSorting.js):

    1. import { ref, watchEffect } from 'vue'
    2. 
    3. export default function useSorting (items) {
    4. const sortOrder = ref('ascending')
    5. const sortedItems = ref([])
    6. 
    7. function toggleSortOrder () {
    8. sortOrder.value = sortOrder.value === 'ascending' ? 'descending' : 'ascending'
    9. }
    10. 
    11. watchEffect(() => {
    12. sortedItems.value = items.value.sort((a, b) => {
    13. if (sortOrder.value === 'ascending') {
    14. return a.text.localeCompare(b.text)
    15. } else {
    16. return b.text.localeCompare(a.text)
    17. }
    18. })
    19. })
    20. 
    21. return {sortOrder, sortedItems, toggleSortOrder}
    22. }

    使用 list 组件并通过 useSorting composable 为其添加排序功能的 App 组件:

    1. 
    2. <script setup>
    3. import { ref } from 'vue'
    4. import useSorting from './useSorting.js'
    5. 
    6. const { sortedItems, toggleSortOrder } = useSorting(items)
    7. 
    8. const items = ref([
    9. { id: 1, text: 'Item 1' },
    10. { id: 2, text: 'Item 2' },
    11. { id: 3, text: 'Item 3' }
    12. ])
    13. script>

    里氏替换原则:插槽

    Form.vue组件

    1. 
    2. <script setup>
    3. function submit() {
    4. console.log('Form submitted!')
    5. }
    6. script>

    扩展Form.vue组件并添加两个文本字段:

    1. 
    2. <script setup>
    3. const username = ref('')
    4. const password = ref('')
    5. script>

    通过这种方式 UI 的开发变得更加灵活和可扩展。里氏替换原则也是已经集成到 Vue 架构中的东西,我们在使用它时并不关心它实际上叫什么名字。

    接口隔离原则:避免复杂功能的“庞大组件”

    1. 
    2. <script setup>
    3. import { reactive, toRefs } from 'vue'
    4. 
    5. const state = reactive({
    6. items: [...], // an array of items
    7. filter: '',
    8. selectedItem: null
    9. })
    10. 
    11. const filteredItems = computed(() => {
    12. return state.items.filter(item => item.name.includes(state.filter))
    13. })
    14. 
    15. function setFilter(filter) {
    16. state.filter = filter
    17. }
    18. 
    19. function selectItem(item) {
    20. state.selectedItem = item
    21. }
    22. 
    23. function deselectItem() {
    24. state.selectedItem = null
    25. }
    26. 
    27. const { items, filter, selectedItem } = toRefs(state)
    28. script>

    它要求我们将复杂结构分解成具有更简单行为和单一职责的较小组件.

    

    依赖倒置原则:组件通信props

    A组件依赖于B组件的数据,并没有直接去使用B组件数据,而是"约定好"使用抽象props来传递数据。

    

    迪米特法则:组件通信$eventBus ($emit 、$on)

    组件之间通过共同约定好的“接口”、”信号”进行通信,不关心各自内部的实现。

    举个“不友好”的例子(实际业务开发场景):

    有一个form.vue表单组件,嵌套多个input.vue等子组件,每个子组件都有1个 validate()方法,用来校验用户输入是否正确,返回检验值,现在,form组件点击 提交submit,需要首先执行所有子组件的validate()完成校验通过,才可以提交成功。
     

    1. <script>
    2. export default {
    3. methods: {
    4. validate(){
    5. return [this.$refs.mobile.validate(), this.$refs.username.validate()].every(v => v)
    6. },
    7. async submit(){
    8. // 检验不通过
    9. if(!this.validate()) return
    10. //...提交成功
    11. }
    12. }
    13. }
    14. script>

  • 相关阅读:
    第二次数据库作业
    算法通关村第七关-黄金挑战二叉树迭代遍历
    c++取出文件路径中的文件名
    到广阔的边缘市场去,浪潮信息首次发布全栈边缘计算软硬件新品
    深入理解JVM----垃圾回收算法
    QML QTP0001 not set 警告
    天堂2服务器基本设置
    2022年更新宠物 鼠 鱼 十二生肖 宠物养殖系统区块源码
    windows ,C ,thread、
    ICPC2023合肥站:D. Balanced Array
  • 原文地址:https://blog.csdn.net/qq_38111015/article/details/131597538