Javascript 常用代码优化和重构的方法

简介

主要介绍以下几点：

提炼函数
合并重复的条件片段
把条件分支语句提炼成函数
合理使用循环
提前让函数退出代替嵌套条件分支
传递对象参数代替过长的参数列表
少用三目运算符
合理使用链式调用
分解大型类
活用位操作符
纯函数

本文会不断更新，不足之处欢迎评论区补充。

1. 提炼函数

好处：

避免出现超大函数。
独立出来的函数有助于代码复用。
独立出来的函数更容易被覆写。
独立出来的函数如果拥有一个良好的命名，它本身就起到了注释的作用。
语义化将多段分离的逻辑放在不同的函数中实现，可以使代码逻辑清晰，清楚的看到每一步在做什么。

代码举例：

实现获取数据，然后操作dom显示数据，最后添加事件

函数提炼前

1// 逻辑都写在一起，需要将所有逻辑看完才知道这段代码是干嘛的，局部逻辑无法复用
2function main() {
3    $.ajax.get('/getData').then((res) => {
4        const ul = document.getElementById('ul');
5        ul.innerHTML = res.list.map(text => `<li class="li">${text}</li>`).join('\n');
6        const list = document.getElementsByClassName('li');
7        for (let i = 0; i < list.length; i ++) {
8            list[i].addEventListener('focus', () => {
9                // do something
10            });
11        }
12    });
13}

函数提炼后

1function getData() {
2    return $.ajax.get('/getData').then((res) => res.data.list);
3}
4function showList(list) {
5    const ul = document.getElementById('ul');
6    ul.innerHTML = list.map(text => `<li class="li">${text}</li>`).join('\n');
7}
8function addEvent() {
9    const list = document.getElementsByClassName('li');
10    for (let i = 0; i < list.length; i ++) {
11        list[i].addEventListener('focus', () => {
12            // do something
13        });
14    }
15}
16// 逻辑清晰，一眼读懂每一步在做什么，某些提炼出来的函数还可以被复用
17async function main() {
18    const list = await getData(); // 获取数据
19    showList(list); // 显示页面
20    addEvent(); // 添加事件
21}

2. 合并重复的条件片段

如果一个函数体内有一些条件分支语句，而这些条件分支语句内部散布了一些重复的代码，那么就有必要进行合并去重工作。

1// 合并前
2function main( currPage ){
3    if ( currPage <= 0 ){
4        currPage = 0;
5        jump( currPage ); // 跳转
6    }else if ( currPage >= totalPage ){
7        currPage = totalPage;
8        jump( currPage ); // 跳转
9    }else{
10        jump( currPage ); // 跳转
11    }
12};
13
14// 合并后
15function main( currPage ){
16    if ( currPage <= 0 ){
17        currPage = 0;
18    }else if ( currPage >= totalPage ){
19        currPage = totalPage;
20    }
21    jump( currPage ); // 把jump 函数独立出来
22};

3. 把条件分支语句提炼成函数

复杂的条件分支语句是导致程序难以阅读和理解的重要原因，而且容易导致一个庞大的函数。有时可以将条件分支语句提炼成语义化的函数，使代码更加直观，逻辑清晰。

1// 根据不同季节决定打折力度
2function getPrice( price ){
3    var date = new Date();
4    if ( date.getMonth() >= 6 && date.getMonth() <= 9 ){ // 夏天
5        return price * 0.8;
6    }
7    return price;
8};
9
10// 是否是夏天
11function isSummer(){
12    var date = new Date();
13    return date.getMonth() >= 6 && date.getMonth() <= 9;
14};
15// 提炼条件后
16function getPrice( price ){
17    if ( isSummer() ){
18        return price * 0.8;
19    }
20    return price;
21};

4. 合理使用循环

如果多段代码实际上负责的是一些重复性的工作，那么可以用循环代替，使代码量更少。

1// 判断是什么浏览器
2function getBrowser(){
3    const str = navigator.userAgent;
4    if (str.includes('QQBrowser')) {
5	return 'qq';
6    } else if (str.includes('Chrome')) {
7	return 'chrome';
8    } else if (str.includes('Safari')) {
9        return 'safri';
10    } else if (str.includes('Firefox')) {
11        return 'firefox';
12    } else if(explorer.indexOf('Opera') >= 0){
13        return 'opera';
14    } else if (str.includes('msie')) {
15        return 'ie';
16    } else {
17        return 'other';
18    }
19};
20
21// 循环判断，将对应关系抽象为配置，更加清晰明确
22function getBrowser(){
23    const str = navigator.userAgent;
24    const list = [
25        {key: 'QQBrowser', browser: 'qq'},
26        {key: 'Chrome', browser: 'chrome'},
27        {key: 'Safari', browser: 'safari'},
28        {key: 'Firefox', browser: 'firefox'},
29        {key: 'Opera', browser: 'opera'},
30        {key: 'msie', browser: 'ie'},
31    ];
32    for (let i = 0; i < list.length; i++) {
33        const item = list[i];
34        if (str.includes(item.key)) {return item.browser};
35    }
36    return 'other';
37}
38

5. 提前让函数退出代替嵌套条件分支

让函数变成多出口提前返回，替换嵌套条件分支。

1function del( obj ){
2    var ret;
3    if ( !obj.isReadOnly ){ // 不为只读的才能被删除
4        if ( obj.isFolder ){ // 如果是文件夹
5            ret = deleteFolder( obj );
6        }else if ( obj.isFile ){ // 如果是文件
7            ret = deleteFile( obj );
8        }
9    }
10    return ret;
11};
12
13function del( obj ){
14    if ( obj.isReadOnly ){ // 反转if 表达式
15        return;
16    }
17    if ( obj.isFolder ){
18        return deleteFolder( obj );
19    }
20    if ( obj.isFile ){
21        return deleteFile( obj );
22    }
23};

6. 传递对象参数代替过长的参数列表

函数参数过长那么就增加出错的风险，想保证传递的顺序正确就是一件麻烦的事，代码可读性也会变差，尽量保证函数的参数不会太长。如果必须传递多个参数的话，建议使用对象代替。

一般来说，函数参数最好不要超过3个

1function setUserInfo( id, name, address, sex, mobile, qq ){
2    console.log( 'id= ' + id );
3    console.log( 'name= ' +name );
4    console.log( 'address= ' + address );
5    console.log( 'sex= ' + sex );
6    console.log( 'mobile= ' + mobile );
7    console.log( 'qq= ' + qq );
8};
9setUserInfo( 1314, 'sven', 'shenzhen', 'male', '137********', 377876679 );
10
11function setUserInfo( obj ){
12    console.log( 'id= ' + obj.id );
13    console.log( 'name= ' + obj.name );
14    console.log( 'address= ' + obj.address );
15    console.log( 'sex= ' + obj.sex );
16    console.log( 'mobile= ' + obj.mobile );
17    console.log( 'qq= ' + obj.qq );
18};
19setUserInfo({
20    id: 1314,
21    name: 'sven',
22    address: 'shenzhen',
23    sex: 'male',
24    mobile: '137********',
25    qq: 377876679
26});

7. 少用三目运算符

三目运算符性能高，代码量少。

但不应该滥用三目运算符，我们应该在简单逻辑分支使用，在复杂逻辑分支避免使用。

1// 简单逻辑可以使用三目运算符
2var global = typeof window !== "undefined" ? window : this;
3
4// 复杂逻辑不适合使用
5var ok = isString ? (isTooLang ? 2 : (isTooShort ? 1 : 0)) : -1;

8. 合理使用链式调用

优点： 链式调用使用简单，代码量少。

缺点： 链式调用带来的坏处就是在调试不方便，如果我们知道一条链中有错误出现，必须得先把这条链拆开才能加上一些调试 log 或者增加断点，这样才能定位错误出现的地方。

如果该链条的结构相对稳定，后期不易发生修改，可以使用链式。

1var User = {
2    id: null,
3    name: null,
4    setId: function( id ){
5        this.id = id;
6        return this;
7    },
8    setName: function( name ){
9        this.name = name;
10        return this;
11    }
12};
13User
14  .setId( 1314 )
15  .setName( 'sven' );
16
17var user = new User();
18user.setId( 1314 );
19user.setName( 'sven' );

9. 分解大型类

大型类的分解和函数的提炼很像，类太大会出现逻辑不清晰，难以理解和维护的问题。

合理的大类分解可以使类的逻辑清晰，且子模块可以方便复用。

10. 活用位操作符

编程语言计算乘除的性能都不高，但是某些情况使用位操作符可以提升乘除等运算的性能。

11. 纯函数

纯函数是指不依赖于且不改变它作用域之外的变量状态的函数。

纯函数的返回值只由它调用时的参数决定，它的执行不依赖于系统的状态（执行上下文）。

相同的输入参数，一定会得到相同的输出，也就是内部不含有会影响输出的随机变量。

不属于纯函数的特点：

更改文件系统
往数据库插入记录
发送一个 http 请求
可变数据
打印/log
获取用户输入
DOM 查询
访问系统状态

纯函数的作用：

可靠性：函数返回永远和预期一致
可缓存性：因为只要输入一样输出一定一样，因此可将输入作为key，输出作为值，使用对象缓存已经计算的结果
可移植性：因为没有外部依赖，所以移植到任何环境都可正确运行
可测试性：方便针对函数做单元测试
可并行性：对一些复杂计算，可以并行计算（例如使用nodejs多个子进程同时并行计算多个任务，提高计算速度）

应用场景：

工具函数最好使用纯函数
多平台使用的代码（nodejs、浏览器、微信小程序、native客户端等）
相对独立的功能

1var a = 1;
2// 非纯函数
3function sum(b) {
4    return a + b;
5}
6// 非纯函数
7function sum(b) {
8    a = 2;
9    return b;
10}
11// 非纯函数
12function sum(b) {
13    return b + Math.random();
14}
15
16// 纯函数
17function sum (b, c) {
18    return b + c;
19}

参考

JavaScript设计模式与开发实践