前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >代码质量第4层——健壮的代码!

代码质量第4层——健壮的代码!

作者头像
腾讯云开发者
发布2021-12-31 10:41:16
6320
发布2021-12-31 10:41:16
举报

导语 | 腾讯腾讯云开发者社区精品内容栏目《云荐大咖》,特邀行业佼者,聚焦前沿技术的落地与理论实践,持续为您解读云时代热点技术,探秘行业发展新机。

健壮性(Robustness) 是指程序在遇到规范以外的输入,错误和异常时,仍能正常运行。简单来说,健壮代码的适应性很强,不会因为一些异常,就导致程序崩溃。

不健壮的前端代码体现为:

  • 接口返回异常或报错时,页面白屏。
  • 用户做一些非常规操作时,页面白屏。

一、如何写出健壮的前端代码

要写出健壮的前端代码,就要处理规范以外的输入,错误和异常。具体来说,有4点:

  • 异常处理。
  • 输入检查。
  • 写法优化。
  • 第三方库的选择。

下面,我们具体来说。

(一)异常处理

不做异常做处理,轻则导致功能出错,重则导致页面白屏。异常处理,可以分为如下几种情况。

  • 主动捕获运行时异常

用try-catch捕获同步代码的运行时错误。如果是异步代码,需要转化成await的写法。如:

代码语言:javascript
复制
try {  doSth()  await doSth2()} catch (e) {  // 处理异常}
  • 处理意料之外的全局运行时异常

未被处理的JavaScript运行时错误(包括语法错误)发生时, window会触发error事件。这么处理:

代码语言:javascript
复制
window.addEventListener(  'error',  (e) => {/* 处理异常 */})

当一项资源(如<img>或<script>)加载失败时,加载资源的元素会触发error事件。这么处理:

代码语言:javascript
复制
const img = new Image();img.addEventListener(  'error',  (e) => {/* 处理异常 */})img.src = 'xxx'
  • 异步代码:Promise reject的处理

Promise被reject时,可以在then的第二个参数或catch中处理。如:

代码语言:javascript
复制
p().then(onSuccess, onReject)p().catch(onReject)

Promise reject没有被处理的话,window会触发unhandledrejection事件。可以统一来处理:

代码语言:javascript
复制
window.addEventListener(  'unhandledrejection',  (e) => {/* 处理异常 */})
  • 用Axios时,接口报错的通用处理

可以在Axios接口返回的拦截器中,加入接口报错的通用处理。例如:

代码语言:javascript
复制
axios.interceptors.response.use(function (response) {  return response;}, err => {  // 报错处理  if(err.response) {    switch (err.response.status) {      case 400: err.message = '请求错误(400)'; break;      case 500: err.message = '服务器错误(500)'; break;      // ...    }  }  return Promise.reject(error);})
  • Vue的异常处理
代码语言:javascript
复制
app.config.errorHandler = (err, vm, info) => {  // 处理异常}
  • React的异常处理

React的生命周期函数ComponentDidCatch可以捕获子组件的异常。因此,可以在根组件外包裹一个组件来处理错误。如:

代码语言:javascript
复制
class ErrorBoundary extends React.Component {  componentDidCatch(error, info) {    // 处理异常  }}

使用:

代码语言:javascript
复制
<ErrorBoundary>  <App /></ErrorBoundary>

(二)输入检查

当输入不满足条件时,要尽早返回或主动报错。这里的输入包括:接口的返回结果,函数的参数,组件的属性等。

  • 接口返回格式检查

接口的返回会出现和前端预期不一致的情况。原因可能是:

  • 接口的返回结果变更,但未通知前端。
  • 一些特殊的请求参数,导致接口的返回和预期值不同。

因此,我们要对接口返回格式做检查。我们来看个例子:

代码语言:javascript
复制
const res = await fetchList()const list = res.map(...)

如果接口返回的不是数组,程序就会报错。可以做类似这样的优化:

代码语言:javascript
复制
const res = await fetchList()const list = Array.isArray(res) ? res.map(...) : []
  • 函数参数检查

JavaScript是弱类型语言,函数的参数可以传任意值或不传参。因此,不对函数参数检查,会出现一些和预期不一致的情况。比如,期望实现两数求和的功能:

代码语言:javascript
复制
function sum (a, b) {  return a + b}
sum(3, 4) // 7。和预期一致sum() // NaN。和预期不一致sum('3', 4) // '34'。和预期不一致

对函数参数做检查,可以这么优化:

代码语言:javascript
复制
function sum (a, b) {  if(isNaN(parseFloat(a)) || isNaN(parseFloat(b))) {    throw 'param error. param should be a num'  }  return parseFloat(a) + parseFloat(b)}

推荐使用TypeScript。可以用它检查函数参数。上面的代码用TypeScript这么写:

代码语言:javascript
复制
function sum (a: number | string, b: number | string) {  return parseFloat(a as string) + parseFloat(b as string)}
  • 组件属性检查

对组件的属性检查和函数参数检查类似,就不做赘述了。

(三)写法优化

很多写法优化能提升代码健壮性。这里介绍2点。

  • switch都需要有default来做异常或默认情况的处理。
  • 访问对象或数组前要做判断

如:a.b.c改成a&&a.b&&a.b.c。如果用了TypeScript,可以这么写:a?.b?.c。

(四)第三方库的选择

使用第三库,可以减少造轮子,从而提升开发效率。但如果第三方包不健壮,用到第三方包的功能也就不健壮了。

健壮的第三方库是成熟,稳定的。最好不要选择以下情况的第三方库:

  • 刚出来不久的。
  • 还没出稳定版的。如果库遵循的是语意化版本规范,主版本号为0的都不是稳定版。
  • 使用人数很少的。下载量少,star数低。
  • 没有代码测试的。

二、健壮性的测试方法

可以用猴子测试来测试代码的健壮性

:猴子测试(Money Test),也称搞怪测试。在软件测试中,测试者可以进行各种稀奇古怪的操作模式,用以测试软件的健壮性。

这里推荐一个适用于浏览器的猴子测试工具:gremlins.js。工具会对要测试的页面进行一通乱点。如下图所示:

三、提升代码质量的下一步

提升代码质量的下一步就是提升代码的可读性。我会在下一篇文章中介绍。

 推荐阅读

代码质量第5层-只是实现了功能

聊聊代码质量-《学得会,抄得走的提升前端代码质量方法》前言

公司的电脑为什么卡——因为缺少工程师文化!

OpenTelemetry项目解读

👇戳「阅读原文」一键订阅《云荐大咖》专栏,看云端技术起落,听大咖指点迷津!云荐官将在每周五抽取部分订阅小伙伴,送出云加视频礼盒!

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-12-30,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 腾讯云开发者 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • (一)异常处理
  • (二)输入检查
  • (三)写法优化
  • (四)第三方库的选择
相关产品与服务
云开发 CloudBase
云开发(Tencent CloudBase,TCB)是腾讯云提供的云原生一体化开发环境和工具平台,为200万+企业和开发者提供高可用、自动弹性扩缩的后端云服务,可用于云端一体化开发多种端应用(小程序、公众号、Web 应用等),避免了应用开发过程中繁琐的服务器搭建及运维,开发者可以专注于业务逻辑的实现,开发门槛更低,效率更高。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档