编程风格

本章探讨如何将 ES6 的新语法，运用到编码实践之中，与传统的 JavaScript 语法结合在一起，写出合理的、易于阅读和维护的代码。

多家公司和组织已经公开了它们的风格规范，下面的内容主要参考了 Airbnb (opens new window) 公司的 JavaScript 风格规范。

1. 块级作用域

（1）使用 let 取代 var

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

'use strict';

if (true) {
  let x = 'hello'; // 在块级作用域中声明变量 x
}

for (let i = 0; i < 10; i++) { // 在 for 循环中使用 let 声明变量 i
  console.log(i); // 输出 0 到 9
}

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

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

'use strict';

if (true) {
  console.log(x); // ReferenceError: x is not defined
  let x = 'hello'; // 变量 x 声明在此处
}

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

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

（2）全局常量和线程安全

在 let 和 const 之间，建议优先使用 const，尤其是在全局环境，不应该设置变量，只应设置常量。

const 优于 let 有几个原因。一个是 const 可以提醒阅读程序的人，这个变量不应该改变；另一个是 const 比较符合函数式编程思想，运算不改变值，只是新建值，而且这样也有利于将来的分布式运算；最后一个原因是 JavaScript 编译器会对 const 进行优化，所以多使用 const，有利于提高程序的运行效率，也就是说 let 和 const 的本质区别，其实是编译器内部的处理不同。

// bad: 使用 var 声明多个变量
var a = 1, b = 2, c = 3;

// good: 使用 const 分别声明变量
const a = 1;
const b = 2;
const c = 3;

// best: 使用解构赋值声明变量
const [a, b, c] = [1, 2, 3];

const 声明常量还有两个好处，一是阅读代码的人立刻会意识到不应该修改这个值，二是防止了无意间修改变量值所导致的错误。

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

长远来看，JavaScript 可能会有多线程的实现（比如 Intel 公司的 River Trail 那一类的项目），这时 let 表示的变量，只应出现在单线程运行的代码中，不能是多线程共享的，这样有利于保证线程安全。

2. 字符串

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

// bad: 使用双引号定义字符串
const a = "foobar";
const b = 'foo' + a + 'bar';

// acceptable: 使用反引号定义静态字符串
const c = `foobar`;

// good: 使用单引号和反引号
const a = 'foobar';
const b = `foo${a}bar`; // 使用模板字符串拼接

3. 解构赋值

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

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); // 使用对象解构赋值提取返回值

4. 对象

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

// bad: 单行定义的对象，最后一个成员以逗号结尾
const a = { k1: v1, k2: v2, };

// bad: 多行定义的对象，最后一个成员不以逗号结尾
const b = {
  k1: v1,
  k2: v2
};

// good: 单行定义的对象，最后一个成员不以逗号结尾
const a = { k1: v1, k2: v2 };

// good: 多行定义的对象，最后一个成员以逗号结尾
const b = {
  k1: v1,
  k2: v2,
};

对象尽量静态化，一旦定义，就不得随意添加新的属性。如果添加属性不可避免，要使用Object.assign方法。

// bad: 动态添加属性
const a = {};
a.x = 3;

// if reshape unavoidable: 如果不可避免地需要重新定义对象，可以使用 Object.assign 方法
const a = {};
Object.assign(a, { x: 3 });

// good: 预先定义所有需要的属性
const a = { x: null };
a.x = 3;

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

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

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

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

5. 数组

使用扩展运算符（...）拷贝数组。

// bad: 使用传统的 for 循环拷贝数组
const len = items.length;
const itemsCopy = [];
let i;

for (i = 0; i < len; i++) {
  itemsCopy[i] = items[i];
}

// good: 使用扩展运算符拷贝数组
const itemsCopy = [...items];

使用 Array.from 方法，将类似数组的对象转为数组。

// bad: 没有示例

// good: 使用 Array.from 将 NodeList 转为数组
const foo = document.querySelectorAll('.foo'); // 返回一个 NodeList
const nodes = Array.from(foo); // 将 NodeList 转换为数组

6. 函数

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

// 传统的立即执行函数表达式 (IIFE)
(function () {
  console.log('Welcome to the Internet.');
})();

// 使用箭头函数的 IIFE
(() => {
  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: 使用 self 绑定 this
const self = this;
const boundMethod = function(...params) {
  return method.apply(self, params);
}

// acceptable: 使用 Function.prototype.bind 绑定 this
const boundMethod = method.bind(this);

// best: 使用箭头函数绑定 this
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: 使用 arguments 变量
function concatenateAll() {
  const args = Array.prototype.slice.call(arguments);
  return args.join('');
}

// good: 使用 rest 运算符
function concatenateAll(...args) {
  return args.join('');
}

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

// bad: 使用或运算符设置默认值
function handleThings(opts) {
  opts = opts || {};
}

// good: 使用默认值语法
function handleThings(opts = {}) {
  // ...
}

7. Map 结构

注意区分Object和Map，只有模拟现实世界的实体对象时，才使用Object。如果只是需要key: value的数据结构，使用Map结构。因为Map有内建的遍历机制。

// 使用 Map 结构存储 key-value 数据
let map = new Map(arr);

// 遍历 Map 的 keys
for (let key of map.keys()) {
  console.log(key);
}

// 遍历 Map 的 values
for (let value of map.values()) {
  console.log(value);
}

// 遍历 Map 的 entries
for (let [key, value] of map.entries()) {
  console.log(key, value);
}

上面的代码示例展示了如何使用Map结构来存储和遍历key-value数据，相比Object更加方便和直观。

8. Class

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

// bad
function Queue(contents = []) {
  // 使用构造函数初始化队列
  this._queue = [...contents];
}
Queue.prototype.pop = function() {
  // 定义 pop 方法，删除并返回队列中的第一个元素
  const value = this._queue[0];
  this._queue.splice(0, 1); // 删除第一个元素
  return value;
}

// good
class Queue {
  constructor(contents = []) {
    // 使用 class 初始化队列
    this._queue = [...contents];
  }
  pop() {
    // 定义 pop 方法，删除并返回队列中的第一个元素
    const value = this._queue[0];
    this._queue.splice(0, 1); // 删除第一个元素
    return value;
  }
}

使用extends实现继承，因为这样更简单，不会有破坏instanceof运算的危险。

// bad
const inherits = require('inherits');
function PeekableQueue(contents) {
  // 使用构造函数继承 Queue
  Queue.apply(this, contents);
}
inherits(PeekableQueue, Queue);
PeekableQueue.prototype.peek = function() {
  // 定义 peek 方法，返回队列中的第一个元素
  return this._queue[0];
}

// good
class PeekableQueue extends Queue {
  // 使用 class 继承 Queue
  peek() {
    // 定义 peek 方法，返回队列中的第一个元素
    return this._queue[0];
  }
}

9. 模块

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

// bad
const moduleA = require('moduleA');
const func1 = moduleA.func1;
const func2 = moduleA.func2;

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

class Breadcrumbs extends React.Component {
  render() {
    return <nav />;
  }
};

export default Breadcrumbs;

如果模块只有一个输出值，就使用export default，如果模块有多个输出值，就不使用export default，export default与普通的export不要同时使用。

不要在模块输入中使用通配符。因为这样可以确保你的模块之中，有一个默认输出（export default）。

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

// good
import myObject from './importModule';

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

// 定义并导出一个默认函数，函数名首字母小写
function makeStyleGuide() {
}

export default makeStyleGuide;

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

// 定义并导出一个默认对象，对象名首字母大写
const StyleGuide = {
  es6: {
  }
};

export default StyleGuide;

10. ESLint 的使用

ESLint 是一个语法规则和代码风格的检查工具，可以用来保证写出语法正确、风格统一的代码。以下是使用 ESLint 的详细步骤。

安装 ESLint

首先，使用 npm 全局安装 ESLint。

$ npm install -g eslint

安装 Airbnb 语法规则及插件

接下来，安装 Airbnb 的 ESLint 规则，以及 import、a11y、react 插件。

$ npm install -g eslint-config-airbnb
$ npm install -g eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

配置 ESLint

在项目的根目录下，新建一个 .eslintrc 文件，用来配置 ESLint。可以使用以下配置，这个配置扩展了 Airbnb 的规则。

{
  "extends": "airbnb"
}

检查代码

现在就可以使用 ESLint 检查项目中的代码是否符合预设的规则。下面是 index.js 文件的代码示例。

// 定义了一个没有被使用的变量
var unused = 'I have no purpose!';

// 定义了一个函数，用于显示问候消息
function greet() {
    var message = 'Hello, World!';
    alert(message); // 显示消息
}

// 调用 greet 函数
greet();

使用 ESLint 检查这个文件，可以看到报出的错误信息。

$ eslint index.js
index.js
  1:1  error  Unexpected var, use let or const instead          no-var
  1:5  error  unused is defined but never used                  no-unused-vars
  4:5  error  Expected indentation of 2 characters but found 4  indent
  4:5  error  Unexpected var, use let or const instead          no-var
  5:5  error  Expected indentation of 2 characters but found 4  indent

✖ 5 problems (5 errors, 0 warnings)

上面代码说明，原文件有五个错误：

1. 使用了 var 命令，建议使用 let 或 const 代替。
2. 定义了变量 unused，但是没有使用。
3. 行首缩进为 4 个空格，而不是规定的 2 个空格。

修改后的代码示例

根据 ESLint 的提示，修改后的 index.js 文件如下：

// 定义了一个没有被使用的变量，用 const 声明
const unused = 'I have no purpose!';

// 定义了一个函数，用于显示问候消息
function greet() {
  // 使用 let 声明变量，并修正缩进
  let message = 'Hello, World!';
  alert(message); // 显示消息
}

// 调用 greet 函数
greet();

此时，再次使用 ESLint 检查修改后的文件，应该不会再报错。

$ eslint index.js

上面没有任何输出，表示代码已经符合 ESLint 的规定。

通过 ESLint 和合适的规则配置，可以帮助你在编写代码时保持一致的编码风格，并避免常见的错误。