ES6 编程风格规范(重要)
一 基本的一些规范
1. 块级作用域与常量变量(const与let)
(1)let 取代 var
var命令存在变量提升效用,let命令没有这个问题。
if (true) {
console.log(x); // ReferenceError
let x = 'hello';
}
如使用var替代let,console.log那一行就不会报错,而会输出undefined,因为变量声明提升到代码块的头部。违反了变量先声明后使用的原则。
(2)全局常量和线程安全
let和const,优先使用const,尤其是全局环境,不应设置变量,只应设置常量const
const优于let有几个原因:
- const可提醒阅读程序的人,这个变量不应改变,也防止了无意间修改变量值所导致的错误;
- const比较符合函数式编程思想,运算不改变值,只是新建值,这样也有利于将来的分布式运算;
- Js 编译器会对const进行优化,所以多用const,有利于提高程序的运行效率,let和const的本质区别,其实是编译器内部的处理不同。
// bad
var a = 1, b = 2;
// good
const a = 1;
const b = 2;
// best
const [a, b] = [1, 2];
所有的函数都应该设置为常量。
长远看,Js 可能会有多线程的实现,这时let表示的变量,只应出现在单线程运行的代码中,不能是多线程共享的,这样有利于保证线程安全。
2. 解构赋值
使用数组成员对变量赋值,优先使用解构赋值。
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;
}
// best
function getFullName({ firstName, lastName }) {
// 里边可以直接使用firstName, lastName
}
如果函数返回多个值,优先使用对象的解构赋值,而不是数组的解构赋值。便于以后添加返回值,以及更改返回值顺序。
3. 对象
(1)对象尽量静态化,一旦定义,不得随意添加新的属性。如果添加属性不可避免,使用Object.assign
// bad
const a = {};
a.x = 3;
// 如果添加属性不可避免,用Object.assign()
const a = {};
Object.assign(a, { x: 3 });
// good
const a = { x: null };
a.x = 3;
(2)如对象的属性名是动态的,可在创造对象时,使用属性表达式
// 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时,将该属性与其他属性定义在一起。这样所有属性就在一个地方定义了。
4. 数组
(1)使用扩展运算符(...)拷贝数组
// bad
const len = items.length;
const itemsCopy = [];
let i;
for (i = 0; i < len; i++) {
itemsCopy[i] = items[i];
}
// good
const itemsCopy = [...items];
(2)使用 Array.from 方法,将类似数组的对象转为数组
const foo = document.querySelectorAll('.foo');
const nodes = Array.from(foo);
5. 函数
(1)立即执行函数可写成箭头函数的形式
(() => {
console.log('Welcome');
})();
(2)需使用函数表达式的场合,尽量用箭头函数代替。因为这样更简洁,而且绑定了 this
// bad
[1, 2, 3].map(function (x) {
return x * x;
});
// good
[1, 2, 3].map((x) => {
return x * x;
});
(3)箭头函数取代Function.prototype.bind,不应再用 self/_this/that 绑定 this
// bad
const self = this;
const boundMethod = function(...params) {
return method.apply(self, params);
}
// best
const boundMethod = (...params) => method.apply(this, params);
(4)简单的、单行的、不会复用的函数,建议采用箭头函数。如函数体较复杂,行数较多,还应采用传统函数写法
(5)所有配置项都应该集中在一个对象,放在最后一个参数,布尔值不可以直接作为参数
// bad function divide(a, b, option = false ) { }
// good function divide(a, b, { option = false } = {}) { }
(6)不要在函数体内使用 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('');
}
(7)使用默认值语法设置函数参数的默认值(在参数位置设置默认值而非在函数体内)
// bad
function handleThings(opts) {
opts = opts || {};
}
// good
function handleThings(opts = {}) {
// ...
}
6 Map
(1)区分 Object 和 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]);
}
7 Class
(1)用 Class,取代需要 prototype 的操作。因为 Class 写法更简洁,更易理解
// 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;
}
}
(2)使用extends实现继承,这样更简单,不会有破坏instanceof运算的危险
// 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];
}
}
8 模块
Module 语法是 Js 模块的标准写法,坚持使用这种写法。
(1)使用import取代commonjs的 require,使用export取代commonjs的module.exports。
(2)模块只有一个输出值,就使用export default,如有多个输出值,不使用export default,export default与普通的export不要同时使用
(3)不要在模块输入中使用通配符*。这样可确保模块中,有一个默认输出(export default)。
// bad
import * as myObject from './importModule';
// good
import myObject from './importModule';
(4)如模块默认输出一个函数,函数名的首字母应该小写;如果模块默认输出一个对象,对象名的首字母应该大写
function makeStyleGuide() {
}
export default makeStyleGuide;
const StyleGuide = {
es6: {
}
};
export default StyleGuide;
9 ESLint
参考:
本书笔记:ESLint
另外 ESLint的规则也可以详细阅读下,弄清楚为什么要这样写,对养成良好的js编程风格和加深js理解很有帮助。
二 具体参考
Airbnb 公司的 JavaScript 风格规范 https://github.com/airbnb/javascript
es6入门-阮一峰 http://es6.ruanyifeng.com/#docs/style