多家公司和组织已经公开了它们的风格规范,具体可参阅,下面的内容主要参考了的 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 = {}) {
- // ...
- }
只有模拟现实世界的实体对象时,才使用 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 语法是 JavaScript 模块的标准写法,坚持使用这种写法。使用 import 取代 require。通常的写法如下:
- import {
- func1,
- func2
- }
- from'moduleA';
使用 export 取代 module.exports
- // commonJS的写法
- var React = require('react');
- var Breadcrumbs = React.createClass({
- render() {
- return;
- }
- });
- module.exports = Breadcrumbs;
- // ES6的写法
- import React from'react';
- const Breadcrumbs = React.createClass({
- render() {
- return;
- }
- });
- 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 是一个语法规则和代码风格的检查工具,可以用来保证写出语法正确、风格统一的代码。和 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)
来源: