美文网首页
ES6 编程风格

ES6 编程风格

作者: 了凡和纤风 | 来源:发表于2019-10-24 21:11 被阅读0次

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

    具体风格规范可参阅 jscs.info,下面的内容主要参考了 Airbnb 的JavaScript风格规范

    一、块级作用域

    1.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 命令存在变量提升效用,let命令没有这个问题。

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

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

    1.2、全局常量和线程安全

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

    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)
    

    四、对象

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

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

    // bad
    const a = {}
    a.x = 3
    
    // if reshape unavoidable
    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('enable')] = 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
      }
    }
    

    五、数组

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

    // bad
    const len = items.length
    const itemsCopy = []
    let i 
    for (i = 0; i < len; i++) {
      itemCopy[[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)
      const args.join('')
    }
    
    //  good
    function concatenateAll(...args) {
      return args.join('')
    }
    

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

    // bad
    function handleThings(opts) {
      opts = opts || []
    }
    
    // good
    function handleThings(opts = []) {
      // ...
    }
    

    七、Map 结构

    注意区分 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])
    }
    

    八、Class

    总是用 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
      }
    }
    

    使用 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]
      }
    }
    

    九、模块

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

    使用 import 取代 require 的代码如下

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

    使用 export 取代 module.exports

    // commonJS 的写法
    var React = require('react')
    
    var Breadcrumds = 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 './importModule'
    
    // good
    import myObject from './importModule'
    

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

    function makeStyleGuide() {
    
    }
    export default makeStyleGuide
    

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

    const StyleGuide = {
      es6: {
      }
    }
    
    export default StyleGuide
    

    10、ESLint 的使用

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

    首先,安装ESLint

    $ npm i -g eslint
    

    然后,安装 Airbnb 语法规则

    $ npm i -g eslint-config-airbnb
    

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

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

    现在就可以检查当前项目的代码是否符合预设的规范
    index.js文件的代码如下

    var unusued = 'i have no purpose!';
    
    function greet() {
      var message = 'Hello , World!'
    }
    
    greet()
    

    使用 ESLint 检查这个文件

    $ eslint ./index.js
    
    1:1   error  Unexpected var, use let or const instead         no-var
    1:5   error  'unusued' is assigned a value but never used     no-unused-vars
    4:5   error  Unexpected var, use let or const instead         no-var
    ...
    

    运行如上就会出现一些错误,如上面的 不能用var 声明 和 变量声明后未使用等情况

    相关文章

      网友评论

          本文标题:ES6 编程风格

          本文链接:https://www.haomeiwen.com/subject/kgvdvctx.html