淺談小程式中的請求封裝

来源:https://www.cnblogs.com/karthuslorin/archive/2018/10/30/9877826.html
-Advertisement-
Play Games

淺談小程式中的請求封裝 近兩個月學習了小程式的開發,並且擼了一個不大不小的demo,算是正式入門了小程式,在此想分享下小程式的開發經驗。 前言 在小程式的開發中,或者說在整個前端開發中,請求都是繞不過去的一道坎。在Vue開發中,我們可以採用 "axios" 這個成熟的插件來進行HTTP請求。但是,遺 ...


淺談小程式中的請求封裝

近兩個月學習了小程式的開發,並且擼了一個不大不小的demo,算是正式入門了小程式,在此想分享下小程式的開發經驗。

前言

在小程式的開發中,或者說在整個前端開發中,請求都是繞不過去的一道坎。在Vue開發中,我們可以採用 axios 這個成熟的插件來進行HTTP請求。但是,遺憾的是,到目前為止,小程式沒有一個比較好用的插件來進行HTTP請求。此時,我們需要對小程式的HTTP請求進行封裝,以方便我們後續開發。

淺析wx.request

眾所周知,在小程式中,我們通過 wx.request 方法來進行HTTP請求(或者說是HTTPS請求)。

通過 官方文檔 我們可以知道, wx.request 方法接收一個對象,對象可以有9個屬性:urldataheadermethoddataTyperesponseTypesuccessfailcomplete。除了url是必填的以外,其餘都是可選項。在這些屬性裡面,最常用的是 methoddataheadersuccess以及fail這幾個屬性。畢竟我們總要設置請求方法、請求數據、請求頭以及請求成功或失敗的處理方法是不是?

所以接下來我們的目標我們已經明確,就是對這些常用屬性進行封裝。

封裝HTTP類

對於HTTP請求的封裝,有很多種方法,比如:axios 採用的是通過IIFE作為工廠函數處理並返回一個Axios的實例。在這裡,我推薦使用類,因為類的封裝形式,正是axios 的封裝形式的加強版。

為了一致性,我也採用request作為請求的方法名,並且接受相同的對象作為參數。此時,我們已經可以實現出以下代碼:

class HTTP {
    request (params) {
        wx.request({
            url: params.url,
            method: params.method,
            data: params.data,
            header: params.header,
            success: (res) => {
                params.success(res)
            },
            fail: (err) => {
                params.fail(err)
            }
        })
    }
}

接下來,我們需要對各個屬性進行處理。

預設屬性處理

由於除了url,其餘的的屬性皆為可選可選項,所以需要對可選屬性進行預設屬性的處理。

在小程式官方文檔中,當不傳入method屬性時,預設採用GET方法,所以我們需要將method的預設值設為GET,設置method的預設值的方式很簡單:

if (!params.method) {
    params.method = 'GET'
}

但是,這種方式不夠優雅,我們可以採用位運算符的方式進行預設複製:

...
method: params.method || 'GET'
...

其餘屬性也採用類似方式進行預設值處理,除了successfail屬性,這個我們後面說。

從配置文件中導入HTTP參數

在正常情況下,REST風格的介面協議給的介面路徑都是諸如/pathA/a,在此之前還有一個類似於www.baidu.com/root類似的base url,兩者結合才是真正的請求路徑。在Vue中,我們可以通過webpack中的proxyTable來解決這個問題,但是,小程式中沒有webpack中的proxyTable,所以需要每次請求的時候,都輸入完整請求路徑。

在HTTP類中的request方法,我們可以實現路徑的拼接。

...
url: 'www.baidu.com/root' + params.url,
...

但是,這裡有個問題,base url是寫死的,也就是說,我們每做一個項目,都需要重新設置一次base url的值,這顯然是有問題的。

為了處理該問題,我新建了一個config.js文件,作為該項目的配置文件,用來存儲所有項目相關的配置,比如base url以及HTTP Header。

const config = {
  api_base_url: 'www.baidu.com/root',
  // 更多的配置項
}

export {config}

擁有配置文件最大的好處就是,每次修改項目,只需要修改配置文件中的配置項的值即可,重覆保證了組件的封閉性,減少了對項目的耦合。

封裝success

最後,我們需要封裝success以及fail

顯而易見,我們只有在HTTP狀態碼為2**或者304才調用success,所以我們需要對響應結果的狀態碼進行判斷,根據判斷結果決定是否執行params.success

...
success: (res) => {
    let code = res.statusCode.toString()
    // 狀態碼判斷
    if (code.startsWith('2') || code === '304') {
        params.success && params.success(res.data)
    } else {
        // 失敗
    }
}

tips:一般情況下,我們還可以對顯示錯誤的方法進行一次封裝,調用wx.showToast顯示伺服器返回的錯誤信息。

全部代碼

經過這麼多步驟,封裝結束後的代碼是:

import {config} from '../config.js'

class HTTP {
  request (params) {
    wx.request({
      url: config.api_base_url + params.url,
      method: params.method || 'GET',
      data: params.data || {},
      header: params.header ? Object.asign(config.header, params.header):config.header
      success: (res) => {
        let code = res.statusCode.toString()
        if (code.startsWith('2') || code === '304') {
          params.success && params.success(res.data)
        } else {
          params.fail && params.fail(res.data)
          let error_code = res.data.error_code
          this._show_error(error_code)
        }
      },
      fail: (err) => {
        params.fail && params.fail(res.data)
        this._show_error(1)
      }
    })
  }
    
  // 私有方法,顯示請求錯誤信息
  _show_error(error_code) {
    if (!error_code) {
      error_code = 1
    }
    const tip = config.tips[error_code]
    wx.showToast({
      title: tip ? tip : tips[1],
      icon: 'none',
      duration: 2000
    })
  }
}

其實,HTTP類還可以進一步優化,比如,使用解構以及預設賦值,使用promise等等,篇幅有限,我就不一一細說了,詳情可以查看我github上的代碼。

代碼路徑:https://github.com/KarthusLorin/mini-program/blob/master/util/http.js

如果覺得不錯,github點個star再走唄?


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 小編將此文獻給對數據有熱情,想長期從事此行業的年輕人,希望對你們有所啟發,並快速調整思路和方向,讓自己的職業生涯有更好的發展。 根據數據應用的不同階段,本文將從數據底層到最後應用,來談談那些數據人的必備技能。 1、大數據平臺 目前很火,數據源頭,各種炫酷新技術,搭建Hadoop、Hive、Spark ...
  • https://www.cnblogs.com/yx007/p/6519544.html https://blog.csdn.net/sinat_35626559/article/details/78912828 ...
  • 刪除視圖註意事項 刪除視圖時,將從系統目錄中刪除視圖的定義和有關視圖的其他信息。 還將刪除視圖的所有許可權。 使用 DROP TABLE 刪除的表上的任何視圖都必須使用 DROP VIEW 顯式刪除。 對索引視圖執行 DROP VIEW 時,將自動刪除視圖上的所有索引。 若要顯示視圖上的所有索引,請使 ...
  • 通過視圖增刪改數據註意事項 需要對目標表的 UPDATE、INSERT 或 DELETE 許可權(取決於執行的操作)。 如果視圖引用多個基表,則不能刪除行。 如果視圖引用多個基表,只能更新屬於單個基表的列。 如果視圖引用多個基表,則不能插入行。 使用SSMS資料庫管理工具通過視圖增刪改數據 1、連接數 ...
  • SqlServer主鍵和自增長設置 Intro 有時候有些 sql 語句有些不太記得了,謹以此文備忘。 設置主鍵以及自增長可分兩種情況: 1. 新創建表 2. 表已創建但是沒有設置主鍵和自增長 新創建表 創建表 sql: 其中 用來表明 欄位是主鍵,而 則為 欄位設置自增長,且從1開始,每次自增1 ...
  • 列表標簽 比如現在顯示這樣的效果 山水集團 財務部 學工部 人事部 <dl></dl> : 表示列表的範圍 在dl裡面 <dt></dt>:上層內容(沒有縮進) 在dl裡面 <dd></dd>: 下層內容(有縮進) 代碼: 想要在頁面上顯示這樣的內容(有序列表) 1.財務部 2.學工部 3.人事部 ...
  • 文字標簽:修改文字的樣式 <font></font> 屬性: size:文字的大小 取值範圍 1-7,超出了7,預設還是7 color:文字顏色 兩種表示方法 英文單詞:red、green、blue、black、white、yellow、gray 使用十六進位數表示 #ffffff : GRB 註釋 ...
  • 一、什麼是HTML? HypeText Markup Language:超文本標記語言,網頁語言 超文本:超出文本的範疇,使用HTML可以輕鬆實現這樣的操作 標記:HTML所有的操作都是通過標記實現的,標記就是標簽,<標簽名稱> 二、HTML的規範(遵循) 1、一個HTML文件開始標簽和結束標簽<h ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...