編程風格 · ECMAScript 6 入門

# 編程風格本章探討如何將 ES6 的新語法，運用到編碼實踐之中，與傳統的 JavaScript 語法結合在一起，寫出合理的、易于閱讀和維護的代碼。多家公司和組織已經公開了它們的風格規范，下面的內容主要參考了 [Airbnb](https://github.com/airbnb/javascript) 公司的 JavaScript 風格規范。 ## 塊級作用域 **（1）let 取代 var** ES6 提出了兩個新的聲明變量的命令：`let`和`const`。其中，`let`完全可以取代`var`，因為兩者語義相同，而且`let`沒有副作用。 ```javascript 'use strict'; if (true) { let x = 'hello'; } for (let i = 0; i < 10; i++) { console.log(i); } ``` 上面代碼如果用`var`替代`let`，實際上就聲明了兩個全局變量，這顯然不是本意。變量應該只在其聲明的代碼塊內有效，`var`命令做不到這一點。 `var`命令存在變量提升效用，`let`命令沒有這個問題。 ```javascript 'use strict'; if (true) { console.log(x); // ReferenceError let x = 'hello'; } ``` 上面代碼如果使用`var`替代`let`，`console.log`那一行就不會報錯，而是會輸出`undefined`，因為變量聲明提升到代碼塊的頭部。這違反了變量先聲明后使用的原則。所以，建議不再使用`var`命令，而是使用`let`命令取代。 **（2）全局常量和線程安全** 在`let`和`const`之間，建議優先使用`const`，尤其是在全局環境，不應該設置變量，只應設置常量。 `const`優于`let`有幾個原因。一個是`const`可以提醒閱讀程序的人，這個變量不應該改變；另一個是`const`比較符合函數式編程思想，運算不改變值，只是新建值，而且這樣也有利于將來的分布式運算；最后一個原因是 JavaScript 編譯器會對`const`進行優化，所以多使用`const`，有利于提高程序的運行效率，也就是說`let`和`const`的本質區別，其實是編譯器內部的處理不同。 ```javascript // bad var a = 1, b = 2, c = 3; // good const a = 1; const b = 2; const c = 3; // best const [a, b, c] = [1, 2, 3]; ``` `const`聲明常量還有兩個好處，一是閱讀代碼的人立刻會意識到不應該修改這個值，二是防止了無意間修改變量值所導致的錯誤。所有的函數都應該設置為常量。長遠來看，JavaScript 可能會有多線程的實現（比如 Intel 公司的 River Trail 那一類的項目），這時`let`表示的變量，只應出現在單線程運行的代碼中，不能是多線程共享的，這樣有利于保證線程安全。 ## 字符串靜態字符串一律使用單引號或反引號，不使用雙引號。動態字符串使用反引號。 ```javascript // bad const a = "foobar"; const b = 'foo' + a + 'bar'; // acceptable const c = `foobar`; // good const a = 'foobar'; const b = `foo${a}bar`; ``` ## 解構賦值使用數組成員對變量賦值時，優先使用解構賦值。 ```javascript const arr = [1, 2, 3, 4]; // bad const first = arr[0]; const second = arr[1]; // good const [first, second] = arr; ``` 函數的參數如果是對象的成員，優先使用解構賦值。 ```javascript // bad function getFullName(user) { const firstName = user.firstName; const lastName = user.lastName; } // good function getFullName(obj) { const { firstName, lastName } = obj; } // best function getFullName({ firstName, lastName }) { } ``` 如果函數返回多個值，優先使用對象的解構賦值，而不是數組的解構賦值。這樣便于以后添加返回值，以及更改返回值的順序。 ```javascript // bad function processInput(input) { return [left, right, top, bottom]; } // good function processInput(input) { return { left, right, top, bottom }; } const { left, right } = processInput(input); ``` ## 對象單行定義的對象，最后一個成員不以逗號結尾。多行定義的對象，最后一個成員以逗號結尾。 ```javascript // bad const a = { k1: v1, k2: v2, }; const b = { k1: v1, k2: v2 }; // good const a = { k1: v1, k2: v2 }; const b = { k1: v1, k2: v2, }; ``` 對象盡量靜態化，一旦定義，就不得隨意添加新的屬性。如果添加屬性不可避免，要使用`Object.assign`方法。 ```javascript // bad const a = {}; a.x = 3; // if reshape unavoidable const a = {}; Object.assign(a, { x: 3 }); // good const a = { x: null }; a.x = 3; ``` 如果對象的屬性名是動態的，可以在創造對象的時候，使用屬性表達式定義。 ```javascript // bad const obj = { id: 5, name: 'San Francisco', }; obj[getKey('enabled')] = true; // good const obj = { id: 5, name: 'San Francisco', [getKey('enabled')]: true, }; ``` 上面代碼中，對象`obj`的最后一個屬性名，需要計算得到。這時最好采用屬性表達式，在新建`obj`的時候，將該屬性與其他屬性定義在一起。這樣一來，所有屬性就在一個地方定義了。另外，對象的屬性和方法，盡量采用簡潔表達法，這樣易于描述和書寫。 ```javascript var ref = 'some value'; // bad const atom = { ref: ref, value: 1, addValue: function (value) { return atom.value + value; }, }; // good const atom = { ref, value: 1, addValue(value) { return atom.value + value; }, }; ``` ## 數組使用擴展運算符（...）拷貝數組。 ```javascript // bad const len = items.length; const itemsCopy = []; let i; for (i = 0; i < len; i++) { itemsCopy[i] = items[i]; } // good const itemsCopy = [...items]; ``` 使用 Array.from 方法，將類似數組的對象轉為數組。 ```javascript const foo = document.querySelectorAll('.foo'); const nodes = Array.from(foo); ``` ## 函數立即執行函數可以寫成箭頭函數的形式。 ```javascript (() => { console.log('Welcome to the Internet.'); })(); ``` 那些使用匿名函數當作參數的場合，盡量用箭頭函數代替。因為這樣更簡潔，而且綁定了 this。 ```javascript // bad [1, 2, 3].map(function (x) { return x * x; }); // good [1, 2, 3].map((x) => { return x * x; }); // best [1, 2, 3].map(x => x * x); ``` 箭頭函數取代`Function.prototype.bind`，不應再用 self/\_this/that 綁定 this。 ```javascript // bad const self = this; const boundMethod = function(...params) { return method.apply(self, params); } // acceptable const boundMethod = method.bind(this); // best const boundMethod = (...params) => method.apply(this, params); ``` 簡單的、單行的、不會復用的函數，建議采用箭頭函數。如果函數體較為復雜，行數較多，還是應該采用傳統的函數寫法。所有配置項都應該集中在一個對象，放在最后一個參數，布爾值不可以直接作為參數。 ```javascript // bad function divide(a, b, option = false ) { } // good function divide(a, b, { option = false } = {}) { } ``` 不要在函數體內使用 arguments 變量，使用 rest 運算符（...）代替。因為 rest 運算符顯式表明你想要獲取參數，而且 arguments 是一個類似數組的對象，而 rest 運算符可以提供一個真正的數組。 ```javascript // bad function concatenateAll() { const args = Array.prototype.slice.call(arguments); return args.join(''); } // good function concatenateAll(...args) { return args.join(''); } ``` 使用默認值語法設置函數參數的默認值。 ```javascript // bad function handleThings(opts) { opts = opts || {}; } // good function handleThings(opts = {}) { // ... } ``` ## Map 結構注意區分 Object 和 Map，只有模擬現實世界的實體對象時，才使用 Object。如果只是需要`key: value`的數據結構，使用 Map 結構。因為 Map 有內建的遍歷機制。 ```javascript let map = new Map(arr); for (let key of map.keys()) { console.log(key); } for (let value of map.values()) { console.log(value); } for (let item of map.entries()) { console.log(item[0], item[1]); } ``` ## Class 總是用 Class，取代需要 prototype 的操作。因為 Class 的寫法更簡潔，更易于理解。 ```javascript // bad function Queue(contents = []) { this._queue = [...contents]; } Queue.prototype.pop = function() { const value = this._queue[0]; this._queue.splice(0, 1); return value; } // good class Queue { constructor(contents = []) { this._queue = [...contents]; } pop() { const value = this._queue[0]; this._queue.splice(0, 1); return value; } } ``` 使用`extends`實現繼承，因為這樣更簡單，不會有破壞`instanceof`運算的危險。 ```javascript // bad const inherits = require('inherits'); function PeekableQueue(contents) { Queue.apply(this, contents); } inherits(PeekableQueue, Queue); PeekableQueue.prototype.peek = function() { return this._queue[0]; } // good class PeekableQueue extends Queue { peek() { return this._queue[0]; } } ``` ## 模塊首先，Module 語法是 JavaScript 模塊的標準寫法，堅持使用這種寫法。使用`import`取代`require`。 ```javascript // bad const moduleA = require('moduleA'); const func1 = moduleA.func1; const func2 = moduleA.func2; // good import { func1, func2 } from 'moduleA'; ``` 使用`export`取代`module.exports`。 ```javascript // commonJS的寫法 var React = require('react'); var Breadcrumbs = React.createClass({ render() { return <nav />; } }); module.exports = Breadcrumbs; // ES6的寫法 import React from 'react'; class Breadcrumbs extends React.Component { render() { return <nav />; } }; export default Breadcrumbs; ``` 如果模塊只有一個輸出值，就使用`export default`，如果模塊有多個輸出值，就不使用`export default`，`export default`與普通的`export`不要同時使用。不要在模塊輸入中使用通配符。因為這樣可以確保你的模塊之中，有一個默認輸出（export default）。 ```javascript // bad import * as myObject from './importModule'; // good import myObject from './importModule'; ``` 如果模塊默認輸出一個函數，函數名的首字母應該小寫。 ```javascript function makeStyleGuide() { } export default makeStyleGuide; ``` 如果模塊默認輸出一個對象，對象名的首字母應該大寫。 ```javascript const StyleGuide = { es6: { } }; export default StyleGuide; ``` ## ESLint 的使用 ESLint 是一個語法規則和代碼風格的檢查工具，可以用來保證寫出語法正確、風格統一的代碼。首先，在項目的根目錄安裝 ESLint。 ```bash $ npm install --save-dev eslint ``` 然后，安裝 Airbnb 語法規則，以及 import、a11y、react 插件。 ```bash $ npm install --save-dev eslint-config-airbnb $ npm install --save-dev eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react ``` 最后，在項目的根目錄下新建一個`.eslintrc`文件，配置 ESLint。 ```javascript { "extends": "eslint-config-airbnb" } ``` 現在就可以檢查，當前項目的代碼是否符合預設的規則。 `index.js`文件的代碼如下。 ```javascript var unused = 'I have no purpose!'; function greet() { var message = 'Hello, World!'; console.log(message); } greet(); ``` 使用 ESLint 檢查這個文件，就會報出錯誤。 ```bash $ npx eslint index.js index.js 1:1 error Unexpected var, use let or const instead no-var 1:5 error unused is defined but never used no-unused-vars 4:5 error Expected indentation of 2 characters but found 4 indent 4:5 error Unexpected var, use let or const instead no-var 5:5 error Expected indentation of 2 characters but found 4 indent ? 5 problems (5 errors, 0 warnings) ``` 上面代碼說明，原文件有五個錯誤，其中兩個是不應該使用`var`命令，而要使用`let`或`const`；一個是定義了變量，卻沒有使用；另外兩個是行首縮進為 4 個空格，而不是規定的 2 個空格。