ES6编程风格

前端开发
2018年10月28日
451

本文探讨如何将ES6的新语法运用到编码实践中,与传统的JavaScript语法结合在一起,写出合理的、易于阅读和维护的代码。有多家公司和组织已经公开其风格规范,具体可参阅jscs.info,下面的内部主要参考了Airbnbhttps://github.com/airbnb/javascript)的JavaScript风格规范。

块级作用域

let取代var

ES6提出了两个新的声明变量命令:letconst。其中,let完全可以取代var,因为两者语义相同,而且let没有副作用。

js
"use strict"; if (true) { let x = 'hello'; } for (let i = 0; i < 10; i++) { console.log(i); }

上面的代码如果使用var替代let,实际上就声明了一个全局变量,这显然不是本意。变量应该只在其声明的代码块内有效,var命令做不到这一点。

var命令存在变量提升,let命令没有这个问题。

js
"use strict"; if (true) { console.log(x); // ReferenceError let x = 'hello'; }

上面的代码如果使用var替代let,那么console.log那一行不会报错,而是输出undefined,因为变量声明会提升到代码块的头部。这违反了变量先声明后使用的原则

所以,建议不再使用var命令,而是使用let命令取代。

全局常量和线程安全

letconst之间,建议优先使用const,尤其是在全局环境,不应该设置变量,只应设置常量。这符合函数式编程思想,有利于将来的分布式运算。

js
// 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声明常量还有两处好处,一是阅读代码的人立刻会意识到不应该修改这个值,二是防止了无意间修改变量值导致错误。

所有函数都应该设置为常量。

let表示的变量只应出现在单线程运行的代码中,不能是多线程共享的,这样有利于保证线程安全。

严格模式

V8引擎只在严格模式下支持letconst。结合前两点,这实际上意味着将来所有的编程都是针对严格模式的。

字符串

静态字符串一律使用单引号或反引号,不使用双引号。动态字符串使用反引号。

js
// 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`;

解构赋值

使用数组成员对变量赋值,优先使用解构赋值。

js
const arr = [1, 2, 3, 4]; // bad const first = arr[0]; const second = arr[1]; // good const [first, second] = arr;

函数的参数如果是对象的成员,优先使用解构赋值。

js
// 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}) { }

如果函数返回多个值,优先使用对象的解构赋值,而不是数组的解构赋值。这样便于以后添加返回值,以及更改返回值的顺序。

js
// bad function processInput (input) { return [left, right, top, bottom]; } // good function processInput (input) { return { left, right, top, bottom }; } const { left, right } = processInput(input);

对象

单行定义的对象,最后一个成员不以逗号结尾。多行定义的对象,最后一个成员以逗号结尾。

js
// 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方法

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

如果对象的属性名是动态的,可以在创造对象时使用属性表达式定义。

js
// 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时就将该属性与其他属性定义在一起。这样一来,所有属性就在一个地方定义了。

另外,对象的属性和方法尽量采用简洁表达法,这样易于描述和书写。

js
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; }, }

数组

使用扩展运算符(...)复制数组。

js
// 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方法将类似数组的对象转为数组。

js
const foo = document.querySelectorAll('.foo'); const nodes = Array.from(foo);

函数

立即执行函数可以写成箭头函数的形式:

js
(() => { console.log('Welcome to the Internet.'); })();

那些需要使用函数表达式的场合,尽量使用箭头函数代替。因为这样更简洁,而且绑定了this

js
// bad [1, 2, 3].map(function (x) { return x * x; }); // good [1, 2, 3].map(x => x * x);

箭头函数取代Function.prototype.bind,不就再用self/_this/that绑定this

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

简单的、单行的、不会复用的函数,建议采用箭头函数。如果函数体较为复杂,行数转多,还是应该采用传统的函数写法。

所有配置项都应该集中在一个对象,放在最后一个参数,布尔值不可以直接作为参数。

js
// bad function divide (a, b, option = false) { } // good function divide (a, b, { option = false } = {}) { }

不要在函数体内使用arguments变量,使用rest运算符(...)代替。因为rest运算符显式表明你想要获取参数,而且arguments是一个类似数组的对象,而rest运算符可以提供一个真正的数组。

js
// bad function concatenateAll () { const args = Array.prototype.slice.call(arguments); return args.join(''); } // good function concatenateAll (...args) { return args.join(''); }

使用默认值语法设置函数参数的默认值。

js
// bad function handleThings (opts) { opts = opts || {}; } // good function handleThings (opts = {}) { // ... }

Map结构

注意区分ObjectMap,只有模拟实体对象时才使用Object。如果只是需要key-value的数据结构,则使用Map。因为Map有内建的遍历机制。

js
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 [key, value] of map.entries()) { console.log(key, value); }

Class

总是使用Class取代需要prototype的操作。因为Class的写法更简洁,更易于理解。

js
// 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运算的危险。

js
// 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]; } }

模块

Module语法是JavaScript模块的标准写法,要坚持使用这种写法。使用import取代require

js
// bad const moduleA = require('moduleA'); const func1 = moduleA.func1; const func2 = moduleA.func2; // good import { func1, func2 } from 'moduleA';

使用export取代module.exports

js
// 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,不要exprot default与普通的export同时使用。

不要在模块输入中使用通配符。因为这样可以确保模块中有一个默认输出(export default)。

js
// bad import * as myObject from './importModule'; // good import myObject from './importModule';

如果模块默认输出一个函数,函数名的首字母应该小写。

如果模块默认输出一个对象,对象名的首字母应该大写。

ESLint的使用

ESLint是一个语法规则和代码风格的检查工具,可用于保证写出语法正确、风格统一的代码。

首先,安装ESLint。

shell
$ npm i - g eslint

然后,安装Airbnb语法规则

shell
npm i -g eslint-config-airbnb

最后,在项目的根目录下新建.eslintrc文件,配置ESLint

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

现在就可以检查当前项目的代码是否符合预设的规则。

index.js文件的代码如下。

js
var unused = 'I have no purpose!'; function greet () { var message = 'Hello, World'; alert(message); } greet();

使用ESLint检查这个文件。

shell
$ eslint index.js index.js 1:5 error unused 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 × 3 problems (3 errors, 0 warnings)

上面的代码说明,原文件有3个错误:一个是定义了变量,却没有使用;另外两个是行首缩进为4个空格,而不是规定的2个空格。

以上,摘抄自阮一峰老师的《ES6标准入门》