美文网首页
25.编程风格

25.编程风格

作者: 如果俞天阳会飞 | 来源:发表于2019-05-21 11:53 被阅读0次

    来源:http://es6.ruanyifeng.com/?search=keys&x=0&y=0#docs/style

    1. 块级作用域
    2. 字符串
    3. 解构赋值
    4. 对象
    5. 数组
    6. 函数
    7. Map 结构
    8. Class
    9. 模块
    10. ESLint 的使用

    1.块级作用域

    let 取代var

    es6提出了两个新的声明变量的命名 let 和 const ,其中let完全取代了var 应为两者语义相同,而且let 没有副作用

    if (true) {
      let x = 'hello';
    }
    
    for (let i = 0; i < 10; i++) {
      console.log(i);
    }
    

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

    if(true){
    console.log(x) // refrence Error
    let x = 'hello';
    }
    

    上面代码如果使用var替代let,console.log那一行就不会报错,而是会输出undefined,因为变量声明提升到代码块的头部。这违反了变量先声明后使用的原则。
    所以,建议不再使用var命令,而是使用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];
    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(user){
    const {firstName, lastName} = user;
    }
    // best
    function getFullName({ firstName, lastName }) {
    }
    

    如果函数返回多个值,优先使用对象的解构赋值,而不是数组的解构赋值
    这样便于以后添加返回值,以及更改返回值的顺序

    //bed
    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, };
    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('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
    const len = items.length;
    const itemsCopy = [];
    let i;
    
    for (i = 0; i < len; i++) {
      itemsCopy[i] = items[i];
    }
    
    // good
    const itemsCopy = [...items];
    [...items] 浅拷贝 和上面 for循环是一样的,,只是简化了
    

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

    const foo = document.querySelectorAll('.foo');
    const nodes = Array.from(foo);
    

    6.函数

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

    (() => {
      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 } = {}) {
    }
    

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

    // 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]);
    }
    

    8.Class

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

    function Queue(contents = []){
     this._queue = [...contents];
    }
    Queue.prototype.pop = function() {
      const value = this._queue[0];
      this._queue.splice(0, 1);
      return value;
    }
     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];
    }
    }
    

    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。

    $ npm i -g eslint
    

    然后,安装 Airbnb 语法规则,以及 import、a11y、react 插件。

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

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

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

    现在就可以检查,当前项目的代码是否符合预设的规则。

    index.js文件的代码如下。

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

    使用 ESLint 检查这个文件,就会报出错误。

    $ eslint index.js
    index.js
      1:1  error  Unexpected var, use let or const instead          no-var
      1:5  error  unusued 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)
    

    上面代码说明,原文件有五个错误,其中两个是不应该使用var命令,而要使用let或const;一个是定义了变量,却没有使用;另外两个是行首缩进为 4 个空格,而不是规定的 2 个空格。

    相关文章

      网友评论

          本文标题:25.编程风格

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