JS 如何书写优雅的代码
优雅的代码：符合规范，代码合理、易于阅读和维护。
一、备注
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;
});
十四、其他&&技巧
遍历对象少用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 代码缩进换行要规范。
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
君不见，高堂明镜悲白发，朝如青丝暮成雪
