本章探讨如何将 ES6 的新文法, 運用到編碼實踐之中, 與傳統的 JavaScript 文法結合在一起, 寫出合理的、 易于閱讀和維護的代碼。
多家公司群組織已經公開了它們的風格規範, 具體可參閱 jscs.info, 下面的内容主要參考了 Airbnb 的 JavaScript 風格規範。
1 塊級作用域
(1)let 取代 var
ES6 提出了兩個新的聲明變量的指令: let和const。 其中, let完全可以取代var, 因為兩者語義相同, 而且let沒有副作用。
'use strict';
if (true) {
let x = 'hello';
}
for (let i = 0; i < 10; i++) {
console.log(i);
}
上面代碼如果用var替代let, 實際上就聲明了兩個全局變量, 這顯然不是本意。 變量應該隻在其聲明的代碼塊内有效, var指令做不到這一點。
var指令存在變量提升效用, let指令沒有這個問題。
'use strict';
if (true) {
console.log(x); // ReferenceError
let x = 'hello';
}
上面代碼如果使用var替代let, console.log那一行就不會報錯, 而是會輸出undefined, 因為變量聲明提升到代碼塊的頭部。 這違反了變量先聲明後使用的原則。
是以, 建議不再使用var指令, 而是使用let指令取代。
(2) 全局常量和線程安全
在let和const之間, 建議優先使用const, 尤其是在全局環境, 不應該設定變量, 隻應設定常量。 這符合函數式程式設計思想, 有利于将來的分布式運算。
// 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表示的變量, 隻應出現在單線程運作的代碼中, 不能是多線程共享的, 這樣有利于保證線程安全。
2 字元串
靜态字元串一律使用單引号或反引号, 不使用雙引号。 動态字元串使用反引号。
// bad
const a = "foobar";
const b = 'foo' + a + 'bar';
// acceptable
const c = `foobar`;
// good
const a = 'foobar';
const b = `foo${a}bar`;
const c = 'foobar';
3 解構指派
使用數組成員對變量指派時, 優先使用解構指派。
const arr = [1, 2, 3, 4];
// bad
const first = arr[0];
const second = arr[1];
// good
const [first, second] = arr;
函數的參數如果是對象的成員, 優先使用解構指派。
// 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
}) {}
如果函數傳回多個值, 優先使用對象的解構指派, 而不是數組的解構指派。 這樣便于以後添加傳回值, 以及更改傳回值的順序。
// bad
function processInput(input) {
return [left, right, top, bottom];
}
// good
function processInput(input) {
return {
left,
right,
top,
bottom
};
}
const {
left,
right
} = processInput(input);
4 對象
單行定義的對象, 最後一個成員不以逗号結尾。 多行定義的對象, 最後一個成員以逗号結尾。
// 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方法。
// bad
const a = {};
a.x = 3;
// if reshape unavoidable
const a = {};
Object.assign(a, {
x: 3
});
// good
const a = {
x: null
};
a.x = 3;
如果對象的屬性名是動态的, 可以在創造對象的時候, 使用屬性表達式定義。
// 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的時候, 将該屬性與其他屬性定義在一起。 這樣一來, 所有屬性就在一個地方定義了。
另外, 對象的屬性和方法, 盡量采用簡潔表達法, 這樣易于描述和書寫。
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;
},
};
5 數組
使用擴充運算符(...)拷貝數組。
// 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 方法, 将類似數組的對象轉為數組。
const foo = document.querySelectorAll('.foo');
const nodes = Array.from(foo);
6 函數
(() => {
console.log('Welcome to the Internet.');
})();
那些需要使用函數表達式的場合, 盡量用箭頭函數代替。 因為這樣更簡潔, 而且綁定了 this。
// 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。
// 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);
簡單的、 單行的、 不會複用的函數, 建議采用箭頭函數。 如果函數體較為複雜, 行數較多, 還是應該采用傳統的函數寫法。
所有配置項都應該集中在一個對象, 放在最後一個參數, 布爾值不可以直接作為參數。
// bad
function divide(a, b, option = false) {}
// good
function divide(a, b, {
option = false
} = {}) {}
不要在函數體内使用 arguments 變量, 使用 rest 運算符(...)代替。 因為 rest 運算符顯式表明你想要擷取參數, 而且 arguments 是一個類似數組的對象,而 rest 運算符可以提供一個真正的數組。
// bad
function concatenateAll() {
const args = Array.prototype.slice.call(arguments);
return args.join('');
}
// good
function concatenateAll(...args) {
return args.join('');
}
使用預設值文法設定函數參數的預設值。
// bad
function handleThings(opts) {
opts = opts || {};
}
// good
function handleThings(opts = {}) {
// ...
}
7 Map 結構
注意區分 Object 和 Map, 隻有模拟現實世界的實體對象時, 才使用 Object。 如果隻是需要key: value的資料結構, 使用 Map 結構。 因為 Map 有内建的周遊機制。
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]);
}
8 Class
總是用 Class, 取代需要 prototype 的操作。 因為 Class 的寫法更簡潔, 更易于了解。
// 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運算的危險。
// 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];
}
}
9 子產品
首先, Module 文法是 JavaScript 子產品的标準寫法, 堅持使用這種寫法。 使用import取代require。
// bad
const moduleA = require('moduleA');
const func1 = moduleA.func1;
const func2 = moduleA.func2;
// good
import {
func1,
func2
} from 'moduleA';
使用export取代module.exports。
// commonJS 的寫法
var React = require('react');
var Breadcrumbs = React.createClass({
render() {
return <nav / > ;
}
});
module.exports = Breadcrumbs;
// ES6 的寫法
import React from 'react';
const Breadcrumbs = React.createClass({
render() {
return <nav / > ;
}
});
export default Breadcrumbs
如果子產品隻有一個輸出值, 就使用export default, 如果子產品有多個輸出值, 就不使用export default, 不要export default與普通的export同時使用。
不要在子產品輸入中使用通配符。 因為這樣可以確定你的子產品之中, 有一個預設輸出(export default)。
// bad
import * as myObject './importModule';
// good
import myObject from './importModule';
如果子產品預設輸出一個函數, 函數名的首字母應該小寫。
function makeStyleGuide() {}
export default makeStyleGuide;
如果子產品預設輸出一個對象, 對象名的首字母應該大寫。
const StyleGuide = {
es6: {}
};
export default StyleGuide;