前端 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 pide(a, b, option = false ) {
}

// good
function pide(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 &#39;react&#39;;

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)

 以上就是前端 JavaScript 编程风格浅析 的内容，更多相关内容请关注PHP中文网（www.php.cn）！