本章探讨如何将 ES6 的新语法,运用到编码实践之中,与传统的 JavaScript 语法结合在一起,写出合理的、易于阅读和维护的代码。
多家公司和组织已经公开了它们的风格规范,本文的内容主要参考了 Airbnb 公司github开源的 JavaScript 风格规范
1、块级作用域
(1)let 取代 var
ES6 提出了两个新的声明变量的命令:let
和const
。其中,let
完全可以取代var
,因为两者语义相同,而且let
没有副作用
1 'use strict'; 2 3 if (true) { 4 let x = 'hello'; 5 } 6 7 for (let i = 0; i < 10; i++) { 8 console.log(i); 9 }
上面代码如果用var
替代let
,实际上就声明了两个全局变量,这显然不是本意。变量应该只在其声明的代码块内有效,var
命令做不到这一点。
var
命令存在变量提升效用,let
命令没有这个问题。
1 'use strict'; 2 3 if (true) { 4 console.log(x); // ReferenceError 5 let x = 'hello'; 6 }
上面代码如果使用var
替代let
,console.log
那一行就不会报错,而是会输出undefined
,因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。
所以,建议不再使用var
命令,而是使用let
命令取代。
(2)全局常量和线程安全
在let
和const
之间,建议优先使用const
,尤其是在全局环境,不应该设置变量,只应设置常量。
const
优于let
有几个原因。一个是const
可以提醒阅读程序的人,这个变量不应该改变;另一个是const
比较符合函数式编程思想,运算不改变值,只是新建值,而且这样也有利于将来的分布式运算;最后一个原因是 JavaScript 编译器会对const
进行优化,所以多使用const
,有利于提高程序的运行效率,也就是说let
和const
的本质区别,其实是编译器内部的处理不同。
1 // bad 2 var a = 1, b = 2, c = 3; 3 4 // good 5 const a = 1; 6 const b = 2; 7 const c = 3; 8 9 // best 10 const [a, b, c] = [1, 2, 3];
const
声明常量还有两个好处,一是阅读代码的人立刻会意识到不应该修改这个值,二是防止了无意间修改变量值所导致的错误。
所有的函数都应该设置为常量。
长远来看,JavaScript 可能会有多线程的实现(比如 Intel 公司的 River Trail 那一类的项目),这时let
表示的变量,只应出现在单线程运行的代码中,不能是多线程共享的,这样有利于保证线程安全。
2、 字符串
静态字符串一律使用单引号或反引号,不使用双引号。动态字符串使用反引号。
1 // bad 2 const a = "foobar"; 3 const b = 'foo' + a + 'bar'; 4 5 // acceptable 6 const c = `foobar`; 7 8 // good 9 const a = 'foobar'; 10 const b = `foo${a}bar`; 11 const c = 'foobar';
3、解构赋值
使用数组成员对变量赋值时,优先使用解构赋值
1 const arr = [1, 2, 3, 4]; 2 3 // bad 4 const first = arr[0]; 5 const second = arr[1]; 6 7 // good 8 const [first, second] = arr;
函数的参数如果是对象的成员,优先使用解构赋值。
1 // bad 2 function getFullName(user) { 3 const firstName = user.firstName; 4 const lastName = user.lastName; 5 } 6 7 // good 8 function getFullName(obj) { 9 const { firstName, lastName } = obj; 10 } 11 12 // best 13 function getFullName({ firstName, lastName }) { 14 }
如果函数返回多个值,优先使用对象的解构赋值,而不是数组的解构赋值。这样便于以后添加返回值,以及更改返回值的顺序。
1 // bad 2 function processInput(input) { 3 return [left, right, top, bottom]; 4 } 5 6 // good 7 function processInput(input) { 8 return { left, right, top, bottom }; 9 } 10 11 const { left, right } = processInput(input);
4、 对象
单行定义的对象,最后一个成员不以逗号结尾。多行定义的对象,最后一个成员以逗号结尾。
1 // bad 2 const a = { k1: v1, k2: v2, }; 3 const b = { 4 k1: v1, 5 k2: v2 6 }; 7 8 // good 9 const a = { k1: v1, k2: v2 }; 10 const b = { 11 k1: v1, 12 k2: v2, 13 };
对象尽量静态化,一旦定义,就不得随意添加新的属性。如果添加属性不可避免,要使用Object.assign
方法。
1 // bad 2 const a = {}; 3 a.x = 3; 4 5 // if reshape unavoidable 6 const a = {}; 7 Object.assign(a, { x: 3 }); 8 9 // good 10 const a = { x: null }; 11 a.x = 3;
如果对象的属性名是动态的,可以在创造对象的时候,使用属性表达式定义。
1 // bad 2 const obj = { 3 id: 5, 4 name: 'San Francisco', 5 }; 6 obj[getKey('enabled')] = true; 7 8 // good 9 const obj = { 10 id: 5, 11 name: 'San Francisco', 12 [getKey('enabled')]: true, 13 };
上面代码中,对象obj
的最后一个属性名,需要计算得到。这时最好采用属性表达式,在新建obj
的时候,将该属性与其他属性定义在一起。这样一来,所有属性就在一个地方定义了。
另外,对象的属性和方法,尽量采用简洁表达法,这样易于描述和书写。
1 var ref = 'some value'; 2 3 // bad 4 const atom = { 5 ref: ref, 6 7 value: 1, 8 9 addValue: function (value) { 10 return atom.value + value; 11 }, 12 }; 13 14 // good 15 const atom = { 16 ref, 17 18 value: 1, 19 20 addValue(value) { 21 return atom.value + value; 22 }, 23 };
5、数组
使用扩展运算符(...)拷贝数组。
1 // bad 2 const len = items.length; 3 const itemsCopy = []; 4 let i; 5 6 for (i = 0; i < len; i++) { 7 itemsCopy[i] = items[i]; 8 } 9 10 // good 11 const itemsCopy = [...items];
使用 Array.from 方法,将类似数组的对象转为数组:
1 const foo = document.querySelectorAll('.foo'); 2 const nodes = Array.from(foo);
6、 函数
立即执行函数可以写成箭头函数的形式
1 (() => { 2 console.log('Welcome to the Internet.'); 3 })();
那些需要使用函数表达式的场合,尽量用箭头函数代替。因为这样更简洁,而且绑定了 this。
1 // bad 2 [1, 2, 3].map(function (x) { 3 return x * x; 4 }); 5 6 // good 7 [1, 2, 3].map((x) => { 8 return x * x; 9 }); 10 11 // best 12 [1, 2, 3].map(x => x * x);
箭头函数取代Function.prototype.bind
,不应再用 self/_this/that 绑定 this。
1 // bad 2 const self = this; 3 const boundMethod = function(...params) { 4 return method.apply(self, params); 5 } 6 7 // acceptable 8 const boundMethod = method.bind(this); 9 10 // best 11 const boundMethod = (...params) => method.apply(this, params);
简单的、单行的、不会复用的函数,建议采用箭头函数。如果函数体较为复杂,行数较多,还是应该采用传统的函数写法。
所有配置项都应该集中在一个对象,放在最后一个参数,布尔值不可以直接作为参数。
1 // bad 2 function divide(a, b, option = false ) { 3 } 4 5 // good 6 function divide(a, b, { option = false } = {}) { 7 }
不要在函数体内使用 arguments 变量,使用 rest 运算符(...)代替。因为 rest 运算符显式表明你想要获取参数,而且 arguments 是一个类似数组的对象,而 rest 运算符可以提供一个真正的数组。
1 // bad 2 function concatenateAll() { 3 const args = Array.prototype.slice.call(arguments); 4 return args.join(''); 5 } 6 7 // good 8 function concatenateAll(...args) { 9 return args.join(''); 10 }
使用默认值语法设置函数参数的默认值
1 // bad 2 function handleThings(opts) { 3 opts = opts || {}; 4 } 5 6 // good 7 function handleThings(opts = {}) { 8 // ... 9 }
7、Map 结构
1 let map = new Map(arr); 2 3 for (let key of map.keys()) { 4 console.log(key); 5 } 6 7 for (let value of map.values()) { 8 console.log(value); 9 } 10 11 for (let item of map.entries()) { 12 console.log(item[0], item[1]); 13 }
8、class 类
总是用 Class,取代需要 prototype 的操作。因为 Class 的写法更简洁,更易于理解。
1 // bad 2 function Queue(contents = []) { 3 this._queue = [...contents]; 4 } 5 Queue.prototype.pop = function() { 6 const value = this._queue[0]; 7 this._queue.splice(0, 1); 8 return value; 9 } 10 11 // good 12 class Queue { 13 constructor(contents = []) { 14 this._queue = [...contents]; 15 } 16 pop() { 17 const value = this._queue[0]; 18 this._queue.splice(0, 1); 19 return value; 20 } 21 }
使用extends
实现继承,因为这样更简单,不会有破坏instanceof
运算的危险
1 // bad 2 const inherits = require('inherits'); 3 function PeekableQueue(contents) { 4 Queue.apply(this, contents); 5 } 6 inherits(PeekableQueue, Queue); 7 PeekableQueue.prototype.peek = function() { 8 return this._queue[0]; 9 } 10 11 // good 12 class PeekableQueue extends Queue { 13 peek() { 14 return this._queue[0]; 15 } 16 }
9、 模块
首先,Module 语法是 JavaScript 模块的标准写法,坚持使用这种写法。使用import
取代require
。
1 // bad 2 const moduleA = require('moduleA'); 3 const func1 = moduleA.func1; 4 const func2 = moduleA.func2; 5 6 // good 7 import { func1, func2 } from 'moduleA';
使用export
取代module.exports
1 // commonJS的写法 2 var React = require('react'); 3 4 var Breadcrumbs = React.createClass({ 5 render() { 6 return <nav />; 7 } 8 }); 9 10 module.exports = Breadcrumbs; 11 12 // ES6的写法 13 import React from 'react'; 14 15 class Breadcrumbs extends React.Component { 16 render() { 17 return <nav />; 18 } 19 }; 20 21 export default Breadcrumbs;
如果模块只有一个输出值,就使用export default
,如果模块有多个输出值,就不使用export default
,export default
与普通的export
不要同时使用。
不要在模块输入中使用通配符。因为这样可以确保你的模块之中,有一个默认输出(export default)。
1 // bad 2 import * as myObject from './importModule'; 3 4 // good 5 import myObject from './importModule';
如果模块默认输出一个函数,函数名的首字母应该小写
1 function makeStyleGuide() { 2 } 3 4 export default makeStyleGuide;
如果模块默认输出一个对象,对象名的首字母应该大写
1 const StyleGuide = { 2 es6: { 3 } 4 }; 5 6 export default StyleGuide;
10、ESLint 的使用
ESLint 是一个语法规则和代码风格的检查工具,可以用来保证写出语法正确、风格统一的代码。
首先,安装 ESLint。
$ npm i -g eslint
然后,安装 Airbnb 语法规则,以及 import、a11y、react 插件。
$ npm i -g eslint-config-airbnb
$ npm i -g eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react
最后,在项目的根目录下新建一个.eslintrc
文件,配置 ESLint。
{ "extends": "eslint-config-airbnb" }
现在就可以检查,当前项目的代码是否符合预设的规则。
index.js
文件的代码如下
1 var unusued = 'I have no purpose!'; 2 3 function greet() { 4 var message = 'Hello, World!'; 5 alert(message); 6 } 7 8 greet();
使用 ESLint 检查这个文件,就会报出错误
1 $ eslint index.js 2 index.js 3 1:1 error Unexpected var, use let or const instead no-var 4 1:5 error unusued is defined but never used no-unused-vars 5 4:5 error Expected indentation of 2 characters but found 4 indent 6 4:5 error Unexpected var, use let or const instead no-var 7 5:5 error Expected indentation of 2 characters but found 4 indent 8 9 ✖ 5 problems (5 errors, 0 warnings)
上面代码说明,原文件有五个错误,其中两个是不应该使用var
命令,而要使用let
或const
;一个是定义了变量,却没有使用;另外两个是行首缩进为 4 个空格,而不是规定的 2 个空格。
-- 在代码规范方面,您有什么好的习惯,欢迎留言......