JavaScript代碼整潔之道

liaorio 發(fā)布于2019-08-23 16:29 / 3045人閱讀

摘要：代碼整潔之道整潔的代碼不僅僅是讓人看起來舒服，更重要的是遵循一些規(guī)范能夠讓你的代碼更容易維護(hù)，同時(shí)降低幾率。另外這不是強(qiáng)制的代碼規(guī)范，就像原文中說的，。里式替換原則父類和子類應(yīng)該可以被交換使用而不會(huì)出錯(cuò)。注釋好的代碼是自解釋的。

JavaScript代碼整潔之道

整潔的代碼不僅僅是讓人看起來舒服，更重要的是遵循一些規(guī)范能夠讓你的代碼更容易維護(hù)，同時(shí)降低bug幾率。

原文clean-code-javascript，這里總結(jié)摘錄出個(gè)人覺得有幫助的地方，也加入了一些自己的理解（有些文字我感覺保留原文更好，所以直接copy了），其他還有很多點(diǎn)沒有列出來，感興趣可以去看原文。另外這不是強(qiáng)制的代碼規(guī)范，就像原文中說的，These are guidelines and nothing more。

1. 用命名的變量代替數(shù)組下標(biāo)

// bad
const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,]+[,s]+(.+?)s*(d{5})?$/;
saveCityZipCode(
  // 下標(biāo)1,2不易于理解
  address.match(cityZipCodeRegex)[1],
  address.match(cityZipCodeRegex)[2]
);

// good
const address = "One Infinite Loop, Cupertino 95014";
const cityZipCodeRegex = /^[^,]+[,s]+(.+?)s*(d{5})?$/;
// 使用數(shù)組解構(gòu)更好的命名變量
const [, city, zipCode] = address.match(cityZipCodeRegex) || [];
saveCityZipCode(city, zipCode);

2. 函數(shù)的參數(shù)最好<=2個(gè)，盡量避免3個(gè)。

如果有很多參數(shù)就利用object傳遞，并使用解構(gòu)。

注意object array這些引用類型的值是mutable的。

3. 一個(gè)函數(shù)只做一件事。

好處在于compose, test, and reason about。

4. 不要自行擴(kuò)展原型

如果想擴(kuò)展原型，可以先繼承再添加方法，防止污染。

// bad
Array.prototype.diff = function diff(comparisonArray) {
  const hash = new Set(comparisonArray);
  return this.filter(elem => !hash.has(elem));
};

// good
class SuperArray extends Array {
  diff(comparisonArray) {
    const hash = new Set(comparisonArray);
    return this.filter(elem => !hash.has(elem));
  }
}

5. 用多態(tài)來代替條件語句

// bad
if (type === "text") {
    // do something
} else if (type === "select") {
    // do something else
}

我個(gè)人寫這種代碼的一種常用方式是：

const control = {
    text: {
        mapper() {},
        restore(){},
        name: "this is a text field",
    },
    select: {
        mapper() {},
        restore(){},
        name: "this is a select field",
    }
}

control[type].mapper();

實(shí)際上就是多態(tài)（polymorphism），也可以考慮用class的方式，大概這樣：

class Field {
    ...
}

class TextField extends Field {
    mapper(){}
    restore(){}
    name = "this is a text field";
}

class SelectField extends Field {
    mapper(){}
    restore(){}
    name = "this is a select field";
}

6. 使用getter和setter函數(shù)。

// bad
function makeBankAccount() {
  // ...

  return {
    balance: 0
    // ...
  };
}

const account = makeBankAccount();
account.balance = 100;

// good
function makeBankAccount() {
  // this one is private
  let balance = 0;

  // a "getter", made public via the returned object below
  function getBalance() {
    return balance;
  }

  // a "setter", made public via the returned object below
  function setBalance(amount) {
    // ... validate before updating the balance
    balance = amount;
  }

  return {
    // ...
    getBalance,
    setBalance
  };
}

const account = makeBankAccount();
account.setBalance(100);

你可以在getter和setter里面做很多事情而不需要修改每一個(gè).balance的地方。

7. Prefer composition over inheritance

盡量用組合來代替繼承，什么情況下用繼承：

Your inheritance represents an "is-a" relationship and not a "has-a" relationship (Human->Animal vs. User->UserDetails).

You can reuse code from the base classes (Humans can move like all animals).

You want to make global changes to derived classes by changing a base class. (Change the caloric expenditure of all animals when they move).

8. SOLID Single Responsibility Principle 單一職責(zé)原則

There should never be more than one reason for a class to change，一個(gè)類被改變的原因數(shù)量應(yīng)該盡可能降低。如果一個(gè)類中功能太多，當(dāng)你修改其中一點(diǎn)時(shí)會(huì)無法估量任何引用該類的模塊所受到的影響。

Open/Closed Principle 開放封閉原則

用戶可以在不修改內(nèi)部實(shí)現(xiàn)的前提下自行擴(kuò)展功能。例如有一個(gè)Http模塊，內(nèi)部會(huì)根據(jù)環(huán)境判斷用哪個(gè)adaptor。如果用戶要添加adaptor就必須修改Http模塊。

// bad
class AjaxAdapter extends Adapter {
  constructor() {
    super();
    this.name = "ajaxAdapter";
  }
}

class NodeAdapter extends Adapter {
  constructor() {
    super();
    this.name = "nodeAdapter";
  }
}

class HttpRequester {
  constructor(adapter) {
    this.adapter = adapter;
  }

  fetch(url) {
    if (this.adapter.name === "ajaxAdapter") {
      return makeAjaxCall(url).then(response => {
        // transform response and return
      });
    } else if (this.adapter.name === "nodeAdapter") {
      return makeHttpCall(url).then(response => {
        // transform response and return
      });
    }
  }
}

function makeAjaxCall(url) {
  // request and return promise
}

function makeHttpCall(url) {
  // request and return promise
}

// good
class AjaxAdapter extends Adapter {
  constructor() {
    super();
    this.name = "ajaxAdapter";
  }

  request(url) {
    // request and return promise
  }
}

class NodeAdapter extends Adapter {
  constructor() {
    super();
    this.name = "nodeAdapter";
  }

  request(url) {
    // request and return promise
  }
}

class HttpRequester {
  constructor(adapter) {
    this.adapter = adapter;
  }

  fetch(url) {
    return this.adapter.request(url).then(response => {
      // transform response and return
    });
  }
}

Liskov Substitution Principle 里式替換原則

父類和子類應(yīng)該可以被交換使用而不會(huì)出錯(cuò)。

// bad
class Rectangle {
  constructor() {
    this.width = 0;
    this.height = 0;
  }

  setColor(color) {
    // ...
  }

  render(area) {
    // ...
  }

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

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

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

class Square extends Rectangle {
  setWidth(width) {
    this.width = width;
    this.height = width;
  }

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

function renderLargeRectangles(rectangles) {
  rectangles.forEach(rectangle => {
    rectangle.setWidth(4);
    rectangle.setHeight(5);
    const area = rectangle.getArea(); // BAD: Returns 25 for Square. Should be 20.
    rectangle.render(area);
  });
}

const rectangles = [new Rectangle(), new Rectangle(), new Square()];
renderLargeRectangles(rectangles);

上面的Rectangle不能直接替換Square，因?yàn)闀?huì)導(dǎo)致計(jì)算面積錯(cuò)誤，考慮將計(jì)算面積的方法抽象出來：

class Shape {
  setColor(color) {
    // ...
  }

  render(area) {
    // ...
  }
}

class Rectangle extends Shape {
  constructor(width, height) {
    super();
    this.width = width;
    this.height = height;
  }

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

class Square extends Shape {
  constructor(length) {
    super();
    this.length = length;
  }

  getArea() {
    return this.length * this.length;
  }
}

function renderLargeShapes(shapes) {
  shapes.forEach(shape => {
    const area = shape.getArea();
    shape.render(area);
  });
}

const shapes = [new Rectangle(4, 5), new Rectangle(4, 5), new Square(5)];
renderLargeShapes(shapes);

Interface Segregation Principle 接口隔離原則

Clients should not be forced to depend upon interfaces that they do not use。舉例來說，一個(gè)功能模塊需要設(shè)計(jì)必須傳的參數(shù)和可選參數(shù)，不應(yīng)該強(qiáng)迫用戶使用可選參數(shù)。

Dependency Inversion Principle 依賴注入原則

原文：

High-level modules should not depend on low-level modules. Both should depend on abstractions.

Abstractions should not depend upon details. Details should depend on abstractions.

// bad
class InventoryRequester {
  constructor() {
    this.REQ_METHODS = ["HTTP"];
  }

  requestItem(item) {
    // ...
  }
}

class InventoryTracker {
  constructor(items) {
    this.items = items;

    // BAD: We have created a dependency on a specific request implementation.
    // We should just have requestItems depend on a request method: `request`
    this.requester = new InventoryRequester();
  }

  requestItems() {
    this.items.forEach(item => {
      this.requester.requestItem(item);
    });
  }
}

const inventoryTracker = new InventoryTracker(["apples", "bananas"]);
inventoryTracker.requestItems();

上面例子在于，InventoryTracker內(nèi)部實(shí)例化了InventoryRequester，也就意味著high-level的模塊需要知道low-level模塊的細(xì)節(jié)（比如實(shí)例化InventoryRequester需要知道它的構(gòu)造參數(shù)等，或者說需要import該模塊，造成耦合）。

// good
class InventoryTracker {
  constructor(items, requester) {
    this.items = items;
    this.requester = requester;
  }

  requestItems() {
    this.items.forEach(item => {
      this.requester.requestItem(item);
    });
  }
}

class InventoryRequesterV1 {
  constructor() {
    this.REQ_METHODS = ["HTTP"];
  }

  requestItem(item) {
    // ...
  }
}

class InventoryRequesterV2 {
  constructor() {
    this.REQ_METHODS = ["WS"];
  }

  requestItem(item) {
    // ...
  }
}

// By constructing our dependencies externally and injecting them, we can easily
// substitute our request module for a fancy new one that uses WebSockets.
const inventoryTracker = new InventoryTracker(
  ["apples", "bananas"],
  new InventoryRequesterV2()
);
inventoryTracker.requestItems();

直接傳入low-level的實(shí)例而不需要考慮它是如何被實(shí)例化的，high-level只需要依賴抽象的接口就可以完成對(duì)子模塊的調(diào)用。

9. 注釋

Comments are an apology, not a requirement. Good code mostly documents itself. 好的代碼是自解釋的。

參考：clean-code-javascript

云服務(wù)器 GPU云服務(wù)器代碼整潔 php 干凈整潔 javascript代碼維持整潔的 Git 提交記錄

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://m.hztianpu.com/yun/103083.html

發(fā)表評(píng)論

登陸后可評(píng)論

0條評(píng)論

liaorio

男|高級(jí)講師

我要關(guān)注我要私信

TA的文章

tensorflow鏡像

閱讀 1586·2023-04-25 15:40
遨游主機(jī)：16個(gè)機(jī)房，后臺(tái)自主換IP僅需10元，有韓國cn2/中國香港CN2/美國cn2/德國CN2

閱讀 3048·2021-08-11 11:15
重學(xué)前端學(xué)習(xí)筆記（十八）--JavaScript的閉包和執(zhí)行上下文

閱讀 2339·2019-08-26 13:48
javascript - RegExp類型 - String類型

閱讀 2903·2019-08-26 12:18
fetch使用，ajax替代方案

閱讀 2518·2019-08-23 18:23
你真的了解this指向嗎？

閱讀 2966·2019-08-23 17:01
JavaScript代碼整潔之道

閱讀 3046·2019-08-23 16:29
「前端面試題系列6」理解函數(shù)的柯里化

閱讀 1183·2019-08-23 15:15

成人无码视频,亚洲精品久久久久av无码,午夜精品久久久久久毛片,亚洲中文字幕日韩无码

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺(tái)、長期優(yōu)惠，快來選購！

JavaScript代碼整潔之道

相關(guān)文章