浅谈前端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)