99%的程序都沒有考慮的網絡異常

絕大多數程序只考慮了接口正常工做的場景,而用戶在使用咱們的產品時遇到的各種異常,全都丟在看似 ok 的 try catch 中。若是沒有作好異常的兼容和兜底處理,會極大的影響用戶體驗,嚴重的還會帶來安全和資損風險。html

接口異常,一般能夠分爲如下三類:前端

  • CGI 邏輯出錯。如調用方入參缺失類業務邏輯報錯;
  • 服務不穩定。如服務器不穩定致使 nginx 各種 500、502,cgi 路徑調整致使的 404
  • 用戶網絡環境差。如,網絡不穩定、網速慢、運營商劫持等

那麼,咱們在寫代碼時,如何快速的模擬這些接口異常,作好程序的兼容處理呢?nginx

今天向你們介紹網絡調試神器 whistle 的網絡異常調試方法,若是你還沒用過 whistle,請參考《8102 年的程序員不須要 Hosts 和 Fiddler》。程序員

假設咱們有如下前端頁面 index.html,放置在本身的本地路徑:web

<p id="success" style="color:green;"></p>
<p id="fail" style="color:red;"></p>
<script>
  fetch(`/mock?r=${Math.random()}`)
    .then(response => {
      return response.json()
    })
    .then(v => {
      document.getElementById('success').innerHTML = v.data;
    }).catch(err => {
      document.getElementById('fail').innerHTML = err.message;
    })
</script>

接下來,打開 whistle Rules 配置面板 http://127.0.0.1:8899/#rules ,配置模擬的 demo page 和 mock CGI:面試

*/mock file://({"code":0,"data":"success"}) # 配置 mock cgi 爲模擬的 json 數據
example.com file:///Users/kaiye/Projects/Markdown/20181213/ # 配置任意域名到本地 demo 目錄,這裏注意替換成本身的路徑

打開 http://example.com ,正常邏輯下頁面展現出了綠色的 success ,如今咱們開始加入一些網絡異常。json

一、業務邏輯異常處理

例如 CGI 沒有返回 data 字段,而是返回了一個錯誤碼 code 和對應的 message,針對這種業務邏輯異常咱們只需在第二個 then 中作好 code 值的判斷便可(注意,這裏的 code、message、data 只是示例,實際業務 CGI 中的 JSON 結構體的字段名極可能不一樣):安全

fetch(`/mock?r=${Math.random()}`)
  .then(response => response.json())
  .then((v) => {
    // 業務邏輯異常處理
    if (v.code !== 0) {
      return Promise.reject(new Error(`ERROR_LOGIC_CODE:${v.code}`));
    }
    document.getElementById('success').innerHTML = v.data;
  })
  .catch((err) => {
    document.getElementById('fail').innerHTML = err.message;
  });

相應的 whistle 配置以下:服務器

*/mock file://({"code":12345,"message":"some_logic_error"}) # 模擬業務邏輯異常

二、服務器異常處理

若是服務器直接拋出了 502 錯誤碼,咱們但願代碼能給用戶提示的同時,再作一個異常上報。網絡

fetch(`/mock?r=${Math.random()}`)
  .then((response) => {
    // 服務器異常處理
    if (response.ok) {
      return response.json();
    }
    return Promise.reject(new Error(`ERROR_STATUS_CODE:${response.status}`));
  })
  .then((v) => {
    // 業務邏輯異常處理
    if (v.code !== 0) {
      return Promise.reject(new Error(`ERROR_LOGIC_CODE:${v.code}`));
    }
    document.getElementById('success').innerHTML = v.data;
  })
  .catch((err) => {
    const [type, value] = err.message.split(':');
    // 異常類型上報
    console.log(type, value);
    document.getElementById('fail').innerHTML = err.message;
  });

經過 whistle 的模擬配置以下:

*/mock statusCode://502 # 模擬 HTTP 狀態碼異常

三、接口被劫持注入

若是 CGI 被運營商劫持注入,可能致使接口返回一個不合法的 JSON 結構,最前面的 response.json() 會拋異常,咱們能夠提早 catch 住:

fetch(`/mock?r=${Math.random()}`).then((response) => {
  // 服務器異常處理
  if (response.ok) {
    return (
      response
        .json()
        // 接口數據解碼異常處理
        .catch(err => Promise.reject(new Error('ERROR_DECODE_JSON')))
    );
  }
  return Promise.reject(new Error(`ERROR_STATUS_CODE:${response.status}`));
});

whistle 模擬配置以下:

*/mock file://(<div>hijacking</div>{"code":0,"data":"success"}) # 模擬接口被劫持注入 1

藉助 htmlAppend 和 values 配置,能夠模擬更復雜的注入示例:

*/mock file://({"code":0,"data":"success"}) htmlAppend://{hijacking.html} # 模擬接口被劫持注入 2
```hijacking.html
<script>
alert('hijacking')
</script>
```

四、用戶網絡不穩定

若是咱們要模擬請求發出 10 秒後斷網或網絡不通的狀況,能夠經過 whistle 這樣配置:

*/mock reqDelay://10000 enable://abort # 模擬 10 秒超時後網絡不通

讓用戶苦苦等待 10 秒,再報錯的體驗太糟糕。咱們能夠封裝一個能配置超時時間的請求發送函數,同時把上面提到的錯誤異常都一塊兒配置進來。

<p id="success" style="color:green;"></p>
<p id="fail" style="color:red;"></p>
<script>
  function myFetch(url, configOptions) {
    const options = Object.assign(
      {
        timeout: 3000
      },
      configOptions
    )
    const { timeout } = options
    return new Promise((resolve, reject) => {
      // 超時異常處理
      const timer = setTimeout(() => {
        reject(new Error(`ERROR_TIMEOUT:${timeout}`))
      }, timeout)
      fetch(url, options)
        .then(data => {
          clearTimeout(timer)
          resolve(data)
        })
        .catch(err => {
          clearTimeout(timer)
          reject(err)
        })
    })
      .then(response => {
        // 服務器異常處理
        if (response.ok) {
          return (
            response
              .json()
              // 接口數據解碼異常處理
              .catch(err => Promise.reject(new Error('ERROR_DECODE_JSON')))
          )
        } else {
          return Promise.reject(
            new Error(`ERROR_STATUS_CODE:${response.status}`)
          )
        }
      })
      .then(v => {
        // 業務邏輯異常處理
        if (v.code !== 0) {
          return Promise.reject(new Error(`ERROR_LOGIC_CODE:${v.code}`))
        } else {
          return v.data
        }
      })
      .catch(err => {
        const [type, value] = err.message.split(':')
        // 異常類型上報
        console.log(type, value)
        return Promise.reject(err)
      })
  }
  myFetch(`/mock?r=${Math.random()}`)
    .then(data => {
      document.getElementById('success').innerHTML = data
    })
    .catch(err => {
      document.getElementById('fail').innerHTML = err.message
    })
</script>

這樣,自定義的 myFetch 只需關注業務具體邏輯,針對不一樣的 catch error 作對應的處理。

除以上提到的協議命令字外,whistle 還支持 resSpeed 用於模擬低網速傳輸(單位:kb/s),tpl 協議則能夠根據請求傳入參數來動態模擬不一樣的數據。在 Frames 面板,還能夠對 WebSocket/Socket 請求進行暫停、延遲等網絡異常的模擬。

歡迎工做一到五年的Java工程師朋友們加入Java架構開發:855801563

本羣提供免費的學習指導 架構資料 以及免費的解答

不懂得問題均可以在本羣提出來 以後還會有職業生涯規劃以及面試指導

同時你們能夠多多關注一下小編 純乾貨 你們一塊兒學習進步

相關文章
相關標籤/搜索