優雅的程式碼：符合規範，程式碼合理、易於閱讀和維護。

一、備註

1.文件註釋：

簡單描述當前js檔案作用。是頁面js邏輯處理，還是公共的方法等。

2.變數註釋：

註明變數是用來做什麼的。

3.函式註釋：

引數註釋，返回引數註釋。

// utils.js
// 公共方法js
/**
 * @func
 * @desc 陣列求和
 * @param {array} arr - 數字陣列
 * @return {number} 返回數組合
 */
const arraySum = (arr) =>{
 return arr.reduce(function(prev,cur,index,array){
  
 
return prev + cur
 });
}
...
export default {arraySum}

二、塊級作用域

1. let 取代 var

let var 語義相同，let 可以取代var，而且let沒有副作用。

if (true) {
  let x = 'hello';
}

上面程式碼如果用var替代let，實際上就聲明瞭x全域性變數，這顯然不是本意。變數應該只在其宣告的程式碼塊內有效，var命令做不到這一點。

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

上面程式碼如果使用var替代let，console.log那一行就不會報錯，而是會輸出undefined，因為變數宣告提升到程式碼塊的頭部。這違反了變數先聲明後使用的原則。

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 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('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;
  },
};

六、陣列

使用擴充套件運算子（...）拷貝陣列。

// 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 和 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 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';

如果模組預設輸出一個函式，函式名的首字母應該小寫。

const StyleGuide = {
  es6: {
  }
};

export default StyleGuide;

十一、變數相關

語義化命名

// bad
let fName = 'jackie'; // 雖然用了駝峰，但是簡寫嚴重。無法直觀看出變數的含義
let lName = 'willen'; // 這個問題和上面的一樣
// good
 let firstName = 'jackie'; // 語義化命名，不能過於縮寫
 let lastName = 'willen';

不使用的變數及時刪除掉

// bad
let kpi = 4;  // 定義好了之後再也沒用過
function example() {
    var a = 1;
    var b = 2;
    var c = a+b;
    var d = c+1;
    var e = d+a;
    return e;
}
// good 
let kpi = 4;  // 不使用的變數及時刪除掉
function example() { // 資料只使用一次或不使用就無需裝到變數中
    var a = 1;
    var b = 2;
    return 2*a+b+1;
}

特定的變數

// bad
if (value.length < 8) { // 8 是啥。不易閱讀理解，除非有明確的註釋
    ....
}
// good
const MAX_INPUT_LENGTH = 8;
if (value.length < MAX_INPUT_LENGTH) { // 一目瞭然，不能超過最大輸入長度
    ....
}

避免使用太多的全域性變數

// bad
name.js
window.name = 'a';
hello.js
window.name = 'b';
time.js
window.name = 'c'; // 容易汙染全域性環境，多人協作開發，可能會衝突

// good 名稱空間少用或使用替代方案 你可以選擇只用區域性變數。通過(){}的方法。
// 如果你確實用很多的全域性變數需要共享，你可以使用vuex,redux或者你自己參考flux模式寫一個也行。

變數的賦值 兜底

// bad
const MIN_NAME_LENGTH = 8;
let lastName = fullName[1];
if(lastName.length > MIN_NAME_LENGTH) { // 這樣你就給你的程式碼成功的埋了一個坑，你有考慮過如果fullName = ['jackie']這樣的情況嗎？這樣程式一跑起來就爆炸。要不你試試。
    ....
}
// good
const MIN_NAME_LENGTH = 8;
let lastName = fullName[1] || ''; // 做好兜底，fullName[1]中取不到的時候，不至於賦值個undefined,至少還有個空字元，從根本上講，lastName的變數型別還是String，String原型鏈上的特性都能使用，不會報錯。不會變成undefined。
if(lastName.length > MIN_NAME_LENGTH) {
    ....
}
// 其實在專案中有很多求值變數，對於每個求值變數都需要做好兜底。
let propertyValue = Object.attr || 0; // 因為Object.attr有可能為空，所以需要兜底。
// 但是，賦值變數就不需要兜底了。
let a = 2; // 因為有底了，所以不要兜著。
let myName = 'Tiny'; // 因為有底了，所以不要兜著。

十二、函式相關

語義化 功能性命名

返回布林值函式應以should/is/can/has開頭

function shouldShowFriendsList() {...}
function isEmpty() {...}
function canCreateDocuments() {...}
function hasLicense() {...}

動作函式要以動詞開頭

function sendEmailToUser(user) {
    ....
}
function geUserInfo(user) {
    ....
}
function setUserInfo(user) {
    ....
}

功能函式最好為純函式

// bad 不要讓功能函式的輸出變化無常。
function plusAbc(a, b, c) {  
        var c = fetch('../api');
        return a+b+c;
}
// 這個函式的輸出將變化無常，因為api返回的值一旦改變，同樣輸入函式的a，b,c的值，但函式返回的結果卻不一定相同。

// good
function plusAbc(a, b, c) {  // 同樣輸入函式的a，b,c的值，但函式返回的結果永遠相同。
        return a+b+c;
}

傳參無說明

// bad
page.getSVG(api, true, false); // true和false啥意思，一目不了然
// good
page.getSVG({
    imageApi: api,
    includePageBackground: true, // 一目瞭然，知道這些true和false是啥意思
    compress: false,
})

一個函式完成一個獨立的功能，不要一個函式混雜多個功能

這是軟體工程中最重要的一條規則，當函式需要做更多的事情時，它們將會更難進行編寫、測試、理解和組合。當你能將一個函式抽離出只完成一個動作，他們將能夠很容易的進行重構並且你的程式碼將會更容易閱讀。如果你嚴格遵守本條規則，你將會領先於許多開發者。

// bad 函式功能混亂，一個函式包含多個功能。最後就像能以一當百的老師傅一樣，被亂拳打死（亂拳（功能複雜函式）打死老師傅（老程式設計師））
function sendEmailToClients(clients) {
  clients.forEach(client => {
    const clientRecord = database.lookup(client)
    if (clientRecord.isActive()) {
      email(client)
    }
  })
}
// good
function sendEmailToActiveClients(clients) {  //各個擊破，易於維護和複用
  clients.filter(isActiveClient).forEach(email)
}

function isActiveClient(client) {
  const clientRecord = database.lookup(client)
  return clientRecord.isActive()
}

優先使用函數語言程式設計

// bad
for(i = 1; i <= 10; i++) { // 一看到for迴圈讓人頓生不想看的情愫
   a[i] = a[i] +1;
}
// good
let b = a.map(item => ++item)
// 怎麼樣，是不是很好理解，就是把a的值每項加一賦值給b就可以了。現在在javascript中幾乎所有的for迴圈都可以被map,filter,find,some,any,forEach等函數語言程式設計取代。

函式中過多的採用if else ..

// bad
if (a === 1) {
    ...
} else if (a ===2) {
    ...
} else if (a === 3) {
    ...
} else {
   ...
}
// good
switch(a) {
   case 1:
        ....
   case 2:
        ....
   case 3:
        ....
  default:
    ....
}

let handler = {
    1: () => {....},
    2: () => {....}.
    3: () => {....},
    default: () => {....}
}

十三、資料互動封裝

統一處理後端返回的 code 狀態及loading。不需要在每次介面請求後，判斷 code 狀態。資料互動時只有在 200 成功的時候，執行成功回撥。非成功狀態，統一提示錯誤資訊，如果傳遞了失敗的回撥，則執行失敗的回撥函式。
元件庫 element-ui axios 封裝的資料互動

import {Message, Loading } from 'element-ui'
import axios from 'axios' // axios 中文說明 https://www.kancloud.cn/yunye/axios/234845
import store from '@/store'
import router from '@/router'


let loading = null; // 請求 loading

// token 過期 清除 vuex 使用者資訊 清除本地快取
let invalidToken = () => {
  Message({
    message:"登入過期，請重新登入",
    type:'error',
    duration:3000,
    showClose: true,
  })

  //清空 token 和 使用者資訊
  store.dispatch('setUserInfo', {})

  // 清空所有快取
  window.localStorage.clear();

  // 跳轉登入頁面
  router.push({
    name: 'login'
  })
}

// 動態配置 axios  baseURL  根據當前url地址,配置 api 介面。 生產或測試
let baseURL = window.location.href.indexOf('生產環境域名') !== -1 ? '生產api地址' : '測試地址';

// 建立例項
const service = axios.create({
  baseURL: baseURL, // 請求api地址
  timeout: 30000, // 超時時間 毫秒
  withCredentials: true // 表示跨域請求時是否需要使用憑證
})
// 新增請求攔截器
service.interceptors.request.use(
  config => {
    // loading open
    loading = Loading.service({
      lock: true,
      text: '努力載入中...',
      background: 'rgba(0,0,0,0.7)',
      target: document.querySelector('.loading-area') // 設定載入動畫區域
    });
    // vuex 使用者資訊  token
    let token = store.state.common.userInfo.token;

    // 新增請求頭
    if (token) {
      config.headers.Authorization = token;
    }

    return config
  },
  error => {
    loading.close();
    Message({
      message:'請求超時',
      type:'error',
      duration:3000,
      showClose: true,
    })
    return Promise.reject(error)
  }
)

//新增響應攔截器
service.interceptors.response.use(
  response => {
    // loading close
    loading.close();
    return response
  },
  error => {
    // loading close
    loading.close();
    Message({
      message:error.message,
      type:'error',
      duration:3000,
      showClose: true,
    })
    return Promise.reject(error)
  }
)

/* 
  @func
  @desc 後端返回資料 統一處理返回狀態碼，不同的狀態碼 執行不同的操作。
  @param {object} a.data 後端返回的資料
  @param {object} a.msg  後端返回的訊息
  @param {object} a.code 後端返回的狀態碼
  @param {func} b Promise 成功回撥
  @param {func} c Promise 失敗回撥
*/
let responseCode = ({data, msg, code}, resolve ,reject) => {
  // data 返回引數 msg 返回訊息 code 返回狀態
  switch(code) {
    // 請求成功
    case 200:
      // 成功回撥
      resolve(data);
      break;
    // 請求被攔截 需要重新登入賬號
    case 403:
      invalidToken();
      break;
    // 其他狀態
    default:
    Message({
      message:msg,
      type:'error',
      duration:3000,
      showClose: true,
    })

    // 失敗回撥
    reject({
      data,
      msg,
      code,
    });
  }
}

export default {
  /* 
    @func
    @desc axios get 請求
    @param {string} a 介面地址
    @param {object} b = {} 請求引數
  */
  get(url, params = {}) {
    return new Promise((resolve, reject) => {
      service({
        method: 'get',
        url,
        params,
      }).then(({data}) => {
        responseCode(data, resolve, reject);
      }).catch(err => {
        reject(err);
        console.log(err, '異常')
      })
    })
  },
  /* 
    @func
    @desc axios post 請求
    @param {string} a 介面地址
    @param {object} b = {} 請求引數
  */
  post(url, data = {}) {
    return new Promise((resolve, reject) => {
      service({
        method: 'post',
        url,
        data,
      }).then(({data}) => {
        responseCode(data, resolve, reject);
      }).catch(err => {
        reject(err);
        console.log(err, '異常')
      })
    })
  }
}
// 使用
this.$axios.post('api',{
          ...params
        }).then((data) => {
          this.accessoriesTable = data;
          this.accessoriesKeywordShow = false;
        });

View Code

十四、其他&&技巧

遍歷物件少用for in,因為for in 會遍歷原型上所有能列舉的屬性

let obj2 = {
    name:'fei',
    age:20
}
Object.keys( obj2 ).forEach( ( key )=>{
    console.log( obj2[ key ] )
} )

物件深拷貝

let copyObj = JSON.parse(JSON.stringify(obj));

陣列去重

uniq = function(array){ return filter.call(array, function(item, idx){ return array.indexOf(item) == idx }) }

reduce的使用

//求下列陣列總和
var sumArr = [1,2,6,7,3,2,45,6,4]
var s = sumArr.reduce( ( pre, cur )=> pre + cur )
console.log( s )

如何求陣列物件某個值得總和

//如下陣列想得出陣列物件的cpu使用總和
var addArr = [
    {id:1,cpu:2},
    {id:2,cpu:1},
    {id:3,cpu:5},
    {id:4,cpu:4}
]
//傳統的方式
function getCpuTotal(arr){
    var sum = 0;
    arr.forEach( (v)=>{
        sum += v.cpu
    } )
    return sum;
}
console.log( getCpuTotal(addArr))
//使用reduce
function getCpuTotal2(pre,cur){
    return pre + cur.cpu;
}
var t = addArr.reduce( getCpuTotal2, 0 )
console.log( t )

優雅的for迴圈

let arr = [1,2,3,4];
let i = arr.length;
while( i-- ){
    console.log( arr[ i ] )
}

日期格式轉化

/** 
* 對Date的擴充套件，將 Date 轉化為指定格式的String 
* 月(M)、日(d)、12小時(h)、24小時(H)、分(m)、秒(s)、周(E)、季度(q) 可以用 1-2 個佔位符 
* 年(y)可以用 1-4 個佔位符，毫秒(S)只能用 1 個佔位符(是 1-3 位的數字) 
* eg: 
* (new Date()).pattern("yyyy-MM-dd hh:mm:ss.S") ==> 2006-07-02 08:09:04.423 
* (new Date()).pattern("yyyy-MM-dd E HH:mm:ss") ==> 2009-03-10 二 20:09:04 
* (new Date()).pattern("yyyy-MM-dd EE hh:mm:ss") ==> 2009-03-10 週二 08:09:04 
* (new Date()).pattern("yyyy-MM-dd EEE hh:mm:ss") ==> 2009-03-10 星期二 08:09:04 
* (new Date()).pattern("yyyy-M-d h:m:s.S") ==> 2006-7-2 8:9:4.18 
*/ 
Date.prototype.pattern=function(fmt) { 
    var o = { 
        "M+" : this.getMonth()+1, //月份 
        "d+" : this.getDate(), //日 
        "h+" : this.getHours()%12 == 0 ? 12 : this.getHours()%12, //小時 
        "H+" : this.getHours(), //小時 
        "m+" : this.getMinutes(), //分 
        "s+" : this.getSeconds(), //秒 
        "q+" : Math.floor((this.getMonth()+3)/3), //季度 
        "S"  : this.getMilliseconds() //毫秒 
    }; 
    var week = { 
        "0" : "\u65e5", 
        "1" : "\u4e00", 
        "2" : "\u4e8c", 
        "3" : "\u4e09", 
        "4" : "\u56db", 
        "5" : "\u4e94", 
        "6" : "\u516d" 
    }; 
    if(/(y+)/.test(fmt)){ 
        fmt=fmt.replace(RegExp.$1, (this.getFullYear()+"").substr(4 - RegExp.$1.length)); 
    } 
    if(/(E+)/.test(fmt)){ 
        fmt=fmt.replace(RegExp.$1, ((RegExp.$1.length>1) ? (RegExp.$1.length>2 ? "\u661f\u671f" : "\u5468") : "")+week[this.getDay()+""]); 
    } 
    for(var k in o){ 
        if(new RegExp("("+ k +")").test(fmt)){ 
            fmt = fmt.replace(RegExp.$1, (RegExp.$1.length==1) ? (o[k]) : (("00"+ o[k]).substr((""+ o[k]).length))); 
        } 
    } 
    return fmt; 
}
var date = new Date(); 
console.log(date.pattern("yyyy-MM-dd EEE hh:mm:ss")); 

邏輯運算子

if (a == 1) {
    b()
}
//可以寫成
a == 1 && b()

三元運算子：

var a = b % 2 == 0 ? 'even' : 'odd'

HTML CSS JS 程式碼縮排換行要規範。

作者：一程式碼農1970
連結：https://www.jianshu.com/p/c8da47713f98 來源：簡書
著作權歸作者所有。商業轉載請聯絡作者獲得授權，非商業轉載請註明出處。