前端 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)
相關文章
- Javascript程式設計風格JavaScript程式設計
- JavaScript 程式設計風格指南JavaScript程式設計
- 前端程式碼規範 — JavaScript 風格指南前端JavaScript
- 編寫可維護的JavaScript-程式設計風格JavaScript程式設計
- 糟糕程式設計師的程式設計風格程式設計師
- 淺析面向協議程式設計協議程式設計
- 物件導向程式設計風格 VS 基於物件程式設計風格(boost::bind/function)物件程式設計Function
- JavaScript 程式碼風格指南JavaScript
- Google Java 程式設計風格指南GoJava程式設計
- Python程式設計風格和設計模式Python程式設計設計模式
- 優秀Java程式設計師的程式設計風格Java程式設計師
- Vue 前端程式碼風格指南Vue前端
- Google JavaScript 程式碼風格指南GoJavaScript
- 各種流行的程式設計風格程式設計
- Google Python 程式設計風格指南GoPython程式設計
- 你需要懂點程式設計風格程式設計
- Google C++程式設計風格指南GoC++程式設計
- REST設計風格REST
- java程式設計規約----程式碼風格(一)Java程式設計
- 如何培養良好的程式設計風格程式設計
- Google C++ 程式設計風格指南:類GoC++程式設計
- Google C++ 程式設計風格指南:格式GoC++程式設計
- java中須遵守的程式設計風格Java程式設計
- 好程式設計師web前端教程之詳解JavaScript嚴格模式程式設計師Web前端JavaScript模式
- JavaScript風格指南JavaScript
- 淺析iOS-MAS&鏈式程式設計思想iOS程式設計
- 淺析微前端沙箱前端
- 前端模組化淺析前端
- 淺析專網通訊領域的前端架構設計前端架構
- 淺析遊戲內的古建築風格及其背後的含義遊戲
- 淺析JavaScript非同步JavaScript非同步
- JavaScript之淺析PromiseJavaScriptPromise
- 前端- JavaScript非同步程式設計Promise前端JavaScript非同步程式設計Promise
- Google C++ 程式設計風格指南:作用域GoC++程式設計
- Google C++ 程式設計風格指南:註釋GoC++程式設計
- 關於程式設計風格的討論 (轉)程式設計
- Google C++程式設計風格指南(七):格式GoC++程式設計
- Spring MVC 中使用 RESTFul 程式設計風格SpringMVCREST程式設計