淺談前端JavaScript編程風格

前言

多家公司和組織已經公開了它們的風格規範，詳細可參閱jscs.info，如下的內容主要參考了Airbnb的JavaScript風格規範。固然還有google的編程建議等編程風格
本章探討怎樣使用ES6的新語法。與傳統的JavaScript語法結合在一塊兒。寫出合理的、易於閱讀和維護的代碼。

編程風格

塊級做用域

（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，因爲變量聲明提高到代碼塊的頭部。這違反了變量先聲明後使用的原則。
（2）全局常量和線程安全
const優於let有幾個緣由。

一個是const可以提醒閱讀程序的人，這個變量不該該改變；還有一個是const比較符合函數式編程思想，運算不改變值。僅僅是新建值。而且這樣也有利於未來的分佈式運算；最後一個緣由是 JavaScript 編譯器會對const進行優化，因此多使用const，有利於提供程序的執行效率，也就是說let和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表示的變量，僅僅應出現在單線程執行的代碼中。不能是多線程共享的，這樣有利於保證線程安全。

字符串

靜態字符串一概使用單引號或反引號，不使用雙引號。動態字符串使用反引號。

// 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';

解構賦值

使用數組成員對變量賦值時，優先使用解構賦值。

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);

對象

單行定義的對象。最後一個成員不以逗號結尾。

多行定義的對象，最後一個成員以逗號結尾。

// good
const a = { k1: v1, k2: v2 };
const b = {
  k1: v1,
  k2: v2,
};

對象儘可能靜態化。一旦定義，就不得任意加入新的屬性。假設加入屬性不可避免，要使用Object.assign方法。

// if reshape unavoidable
const a = {};
Object.assign(a, { x: 3 });

// good
const a = { x: null };
a.x = 3;

假設對象的屬性名是動態的。可以在創造對象的時候。使用屬性表達式定義。

// good
const obj = {
  id: 5,
  name: 'San Francisco',
  [getKey('enabled')]: true,
};

數組

使用擴展運算符（…）拷貝數組。

// 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);

函數

立刻執行函數可以寫成箭頭函數的形式。

(() => { 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 = {}) {
  // ...
}

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]);
}

Module模塊

Module語法是JavaScript模塊的標準寫法。堅持使用這樣的寫法。

使用import代替require。一般的寫法例如如下：

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）。

import myObject from './importModule';

假設模塊默認輸出一個函數，函數名的首字母應該小寫。

這也是駝峯命名的代碼風格。

function makeStyleGuide() {}
export default makeStyleGuide;

假設模塊默認輸出一個對象。對象名的首字母應該大寫。

const StyleGuide = {
  es6: {
  }
};
export default StyleGuide;

ESLint

ESLint是一個語法規則和代碼風格的檢查工具。可以用來保證寫出語法正確、風格統一的代碼。和lint的使用幾乎相同
首先。安裝ESLint。

npm i -g eslint

而後，安裝Airbnb語法規則。

npm i -g eslint-config-airbnb

最後。在項目的根文件夾下新建一個.eslintrc文件，配置ESLint。

{
  "extends": "eslint-config-airbnb" }

比方：

var unusued = 'I have no purpose!';

function greet() {
    var message = 'Hello, World!';
    alert(message);
}

greet();

而後咱們使用命令。就可以檢查語法的問題，並給出相關建議。

eslint index.js

$ eslint index.js
index.js
  1:5  error  unusued is defined but never used                 no-unused-vars
  4:5  error  Expected indentation of 2 characters but found 4  indent
  5:5  error  Expected indentation of 2 characters but found 4  indent

x 3 problems (3 errors, 0 warnings)