code review

所谓code review,意思很明确,就是代码回顾,这个环节能帮你发现一些你代码中的不好的习惯,或者一些错误的行为。这个工作一般是团队的老大来做的,但是

我们的团队人均大佬

所以我们都是一起code review的,人多力量大,参加的人越多,越能让你发现自己的错误,从而能及时改正,收益颇丰!!!

注:下方代码都是虚构,主要为了讲解代码错误习惯,请勿较劲~

分析一下我的错误代码行为

1、写没必要的函数

场景:我需要给某个html根标签设置一个属性,而这个行为是需要在项目初始化的时候去做的,我当时的做法是:

// utils
export const setXXXyyy = () => {
  const tag = document.tag;
  const xxx = tag.getAttribute('xxx');
  if (xxx || xxx === null) {
    tag.setAttribute('xxx', 'yyy');
  }
};
// app.tsx
import { setXXXyyy } from 'utils'
// 初始化时
setXXXyyy()

缺陷:可能我有考虑到以后会在此函数里去做更多事,但是现阶段这么写确实有点多余

改正:直接在模板html里把此属性加到标签上即可

// public/index.html
<tag xxx="yyy"></tag>

2、Promise传递不明值

场景:我需要请求一个接口,请求返回一组数据,我需要把这组数据中的某个参数通过Promise带出去

// 请求方法
const request = () => {
  return new Promise(async (resolve) => {
    const res = await axios(...)
    resolve(res)
  })
}
// 使用
const res = await request()
console.log(res.data.answer)

缺陷:直接把res传递出去了,如果没有ts的限制,那么下一个使用request的开发人员根本不知道这个res里有什么,也自然就不知道有answer这个目标数据了

改正:直接把目标数据answer传递出去

const request = () => {
  return new Promise(async (resolve) => {
    const res = await axios(...)
    // 改正
    resolve(res.data.answer)
  })
}
const answer = await request()
console.log(answer)

3、使用没必要try catch

场景:试异步操作1,如果失败的话试异步操作2,如果失败进行操作3

action1().catch(() => {
  try {
    await action2()
  }  catch(e) {
    throw e
  }
}).catch(() => {
  action3()
})

错误:没必要使用try catch,await失败之后,会自动返回一个失败的Promise,通过链式调用,会执行下一个catch

改正:去除try catch

action1().catch(() => {
  await action2()
}).catch(() => {
  action3()
})

4、Promise.all并发限制

场景:我需要用Promise.all去进行并行执行一些异步操作,这个操作是在服务端的。。

// promises可能会有几十个,几百个,上千个
await Promise.all(promises)

缺陷:众所周知,服务端有时候是很脆弱的,可能你几十个并发就会把服务端给折腾的不要不要的了,所以控制并发是很重要的

改正:既然承受不住,那就控制并发呗,网上很多控制并发的方案。这里我就不说哪个方案比较好了。。自己实现也行,用库也行,看你们团队需要哪个吧。。

// 控制并发
await promiseAllLimit(promises)

5、Nodejs中使用过多sync函数

场景:在后端那边进行文件操作,由于比较喜欢用同步方法,所以用了

const readData = fs.readFileSync(filepath);
fs.writeFileSync(targetPath, readData);
const workbook = xlsx.readFile(targetPath);
fs.unlinkSync(targetPath);

缺陷:Nodejs引以为傲的就是他的大部分方法都支持异步,所以它才能在高并发的场景中那么牛,所以尽量少用它的同步方法,性能会好一些

改正:使用它对应的异步方法吧,,不过要嵌套了。。很烦啊

6、判空要放前面

场景:有两个参数,我要对他们进行一系列判断:

  • 1、判断数据表里有没有这两个参数
  • 2、判断这两个参数是否重叠
  • 3、判断这两个参数是否为空
if (usename) {
  ...
}
if (password) {
  ...
}
if (!username || !password) {
  ...
}

缺陷:这个顺序是不对的,如果两个参数为空,则没必要进行另外两步

改正:改变顺序:

  • 1、这两个参数是否为空
  • 2、判断数据表里有没有这两个参数
  • 3、判断这两个参数是否重叠
if (!username || !password) {
  ...
}
if (usename) {
  ...
}
if (password) {
  ...
}

以上就是代码规范需要防微杜渐code review6个小错误纠正的详细内容,更多关于代码规范code review错误纠正的资料请关注Devmax其它相关文章!

代码规范需要防微杜渐code review6个小错误纠正的更多相关文章

  1. 后端代码规范避免数组下标越界

    这篇文章主要为大家介绍了后端开发中的代码如何规范避免数组下标越界示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  2. vue2项目增加eslint配置代码规范示例

    这篇文章主要为大家介绍了vue2项目增加eslint配置代码规范示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  3. visual studio code 调试php方法(图文详解)

    本篇文章主要介绍了visual studio code 调试php方法(图文详解),具有一定的参考价值,有兴趣的可以了解一下

  4. PHP 代码规范小结

    PHP 代码规范小结

  5. vscode使用Prettier Code插件的详细教程

    这篇文章主要介绍了vscode使用Prettier Code插件的详细教程,本文通过图文实例相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

  6. vue生成二维码QR Code的简单实现方法示例

    这篇文章主要为大家介绍了vue生成二维码QR Code的实现示例详情,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  7. VS Code开发React-Native及Flutter 开启无线局域网安卓真机调试问题

    这篇文章主要介绍了VS Code开发React-Native,Flutter 开启无线局域网安卓真机调试,需要的朋友可以参考下

  8. java代码规范review异常事故记录

    这篇文章主要为大家介绍了java代码规范关于异常review代码发生异常的事故记录,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

  9. 一文教你将Visual Studio Code变成Python开发神器

    Visual Studio Code 是一款功能强大、可扩展且轻量级的代码编辑器,经过多年的发展,已经成为 Python 社区的首选代码编辑器之一。本文将为大家介绍一下如何将Visual Studio Code变成Python开发神器,需要的可以参考一下

  10. AndroidStudio修改Code Style来格式化自定义标签的xml文件方式

    这篇文章主要介绍了AndroidStudio修改Code Style来格式化自定义标签的xml文件方式,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧

随机推荐

  1. js中‘!.’是什么意思

  2. Vue如何指定不编译的文件夹和favicon.ico

    这篇文章主要介绍了Vue如何指定不编译的文件夹和favicon.ico,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  3. 基于JavaScript编写一个图片转PDF转换器

    本文为大家介绍了一个简单的 JavaScript 项目,可以将图片转换为 PDF 文件。你可以从本地选择任何一张图片,只需点击一下即可将其转换为 PDF 文件,感兴趣的可以动手尝试一下

  4. jquery点赞功能实现代码 点个赞吧!

    点赞功能很多地方都会出现,如何实现爱心点赞功能,这篇文章主要为大家详细介绍了jquery点赞功能实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  5. AngularJs上传前预览图片的实例代码

    使用AngularJs进行开发,在项目中,经常会遇到上传图片后,需在一旁预览图片内容,怎么实现这样的功能呢?今天小编给大家分享AugularJs上传前预览图片的实现代码,需要的朋友参考下吧

  6. JavaScript面向对象编程入门教程

    这篇文章主要介绍了JavaScript面向对象编程的相关概念,例如类、对象、属性、方法等面向对象的术语,并以实例讲解各种术语的使用,非常好的一篇面向对象入门教程,其它语言也可以参考哦

  7. jQuery中的通配符选择器使用总结

    通配符在控制input标签时相当好用,这里简单进行了jQuery中的通配符选择器使用总结,需要的朋友可以参考下

  8. javascript 动态调整图片尺寸实现代码

    在自己的网站上更新文章时一个比较常见的问题是:文章插图太宽,使整个网页都变形了。如果对每个插图都先进行缩放再插入的话,太麻烦了。

  9. jquery ajaxfileupload异步上传插件

    这篇文章主要为大家详细介绍了jquery ajaxfileupload异步上传插件,具有一定的参考价值,感兴趣的小伙伴们可以参考一下

  10. React学习之受控组件与数据共享实例分析

    这篇文章主要介绍了React学习之受控组件与数据共享,结合实例形式分析了React受控组件与组件间数据共享相关原理与使用技巧,需要的朋友可以参考下

返回
顶部