miniprogram network

miniprogram-network

小程式網路庫,提供完整代码自动完成和类型检查,支援Promise 、自動重试、缓存、取消、自定义超时、自动暂停恢复、全域拦截、和事件监听等…

Redefine the network API of Wechat MiniProgram, including full IntelliSense and Type Checking , with Promise , retry , Cache , CancelToken , timeout , ensureOnline , global interceptors , event listeners and more.

Features 主要功能

• Promise泛型Promise支持
• Retry 網路錯誤自動重試
• Cache 底層快取支援(包括並發請求合併)
• CancelToken 可取消操作
• Timeout 自訂逾時時間
• 確保網路可用時發送請求,離線和切換到後台時暫停發送請求
• timestamp 記錄耗時統計(需開啟設定)
• 每個請求的原生回調介面支援( onHeadersReceived事件)和( onProgressUpdate事件)
• Interceptors 攔截器transformSend / transformRresponse自訂資料攔截
• Listeners 全域事件監聽onSend , onResponse , onRejected , onAbort , onComplete
• 支援全域預設配置和每個請求單獨配置
• 類型推斷和程式碼自動提示(TypeScript)

Examples 範例

安裝

npm i miniprogram-network

JavaScript

es5 相容

 const Network = require ( 'miniprogram-network' ) ;
// 也可使用 es6 import 写法

// setConfig设置所有网络请求的全局默认配置,一次定义，所有文件中使用均生效
Network . setConfig ( 'baseURL' , 'https://miniprogram-network.newfuture.cc/' )
// 也可Network.REQUEST.Defaults,Network.DOWNLOAD.Defaults,Network.UPLOAD.Defaults 分别设置不同默认配置
Network . REQUEST . Defaults . transformResponse = Network . transformRequestResponseOkData

Network . get ( 'index.html' )
    . then ( res => console . log ( res ) )
    . finally ( ( ) => { console . info ( 'done' ) } ) //支持 finally操作

Network . patch ( 'items/{id}' , { dataKey : 'dataValue' } , {
        params : { id : 123456 } , // 绑定模板参数
        retry : 3 , // 重试3次
    } ) . then ( ( item ) => console . log ( item ) )

Network . download ( 'network/' , 'lcoalpath' , {
        onProgressUpdate : progressUpdateCallBack , //进度回调
        transformResponse : Network . transformDownloadResponseOkData , //状态码2xx成功,返回本地路径
    } ) . then ( path => console . log ( path ) )
    . catch ( console . error )

TypeScript

裝完即用，無需額外配置和類型聲明

 import { setConfig , REQUEST , download , transformRequestResponseOkData , transformDownloadResponseOkData , delayRetry } from 'miniprogram-network' ;

// setConfig设置所有网络请求的全局默认配置,一次定义，所有文件中使用均生效
setConfig ( 'baseURL' , 'https://miniprogram-network.newfuture.cc/' ) ;
// 也可通过 REQUEST.Defaults,DOWNLOAD.Defaults,UPLOAD.Defaults 分别设置不同默认配置
REQUEST . Defaults . transformResponse = transformRequestResponseOkData ;
// 请求发送失败时, 间隔1s再次重试，最多重试2次
REQUEST . Defaults . retry = delayRetry ( 1000 , 2 ) ;

REQUEST . get ( 'index.html' )
    . then ( res => console . log ( res ) )
    . finally ( ( ) => { console . info ( 'done' ) } ) ; //支持 finally操作

REQUEST . patch < Item > ( 'items/{id}' , { dataKey : 'dataValue' } , {
        params : { id : 123456 } , // 绑定参数
        retry : 3 , // 重试3次
    } ) . then ( ( item : Item ) => console . log ( item ) ) ;

download < string > ( 'network/' , 'lcoalpath' , {
        onProgressUpdate : ( res ) => console . log ( res ) , //进度回调
        transformResponse : transformDownloadResponseOkData , //状态码2xx成功,返回本地路径
    } ) . then ( ( path : string ) => console . log ( path ) )
    . catch ( console . error ) ;

miniprogram-network對網路操作做了統一封裝，詳細操作和用法可查看完整miniprogram-network 完整文檔

• 如果只需要微信request的相關的HTTP操作API可只使用miniprogram-request(文檔?)
• 如果只需要微信downloadFile的相關下載API可只使用miniprogram-downloader(文檔?)
• 如果只需要微信uploadFile的相關上傳API可只使用miniprogram-uploader(文檔?)

IntelliSense & Types 程式碼提示與型別檢查

包含完整的類型定義,結合編輯器(VScode)等,能提供完整的程式碼提示和自動完成功能。

對於TypeScript提供泛型支援,可完整的進行靜態型別檢查。

Main Packages 所有包

如果擔心套件依賴多,可使用miniprogram-build 打包小程式rollup 精簡為單一檔案。

tips: 自miniprogram-network >= 5.0.0 底層預設不在直接使用miniprogram-queue進行佇列封裝, 如果有需要可自行引用, 或直接使用v4.x

• wx.request 自基礎庫1.4.0 (2017.07) 小程式開始支援佇列
• wx.downloadFile 自基礎庫1.4.0 (2017.07) 小程式開始支援佇列
• wx.uploadFile 自基礎函式庫2.4.1 (2018.11) 小程式開始支援佇列

• miniprogram-network All in one 小程式網路庫庫集
  • Request from miniprogram-request
  • Upload from miniprogram-uploader
  • Download from miniprogram-downloader
  • 網路快取和請求合併
• miniprogram-request 小程式請求函式庫
  • Promise支援+finally+泛型
  • CancelToken 取消支持
  • retry 網路錯誤重試
  • Interceptors 自訂請求/回應攔截
  • Listeners 事件監聽
  • OnHeadersReceived 回應頭回呼
  • axios like API
• miniprogram-uploader 小程式上傳函式庫
  • Promise支援+finally+泛型
  • Cancelable 可取消
  • OnProgressUpdate 進度回調
  • OnHeadersReceived 回應頭回呼
  • retry 網路錯誤重試
  • Interceptors 自訂請求/回應攔截
  • Listeners 事件監聽
• miniprogram-downloader 小程式下載庫
  • Promise支援+finally+泛型
  • Cancelable 可取消
  • retry 網路錯誤重試
  • OnProgressUpdate 進度回調
  • OnHeadersReceived 回應頭回呼
  • Interceptors 自訂請求/回應攔截
  • Listeners 事件監聽
• miniprogram-network-life-cycle 網路操作流程與事件
  • 事件週期監聽器
  • 事件週期攔截器
  • 自訂逾時
  • 時間戳打點
• miniprogram-fetch 小程式中使用Fetch API
  • 自動隊列支援
• miniprogram-queue 自訂佇列封裝
  • 可自動注入/手動管理
  • 支援取消操作( abort )
  • OnProgressUpdate 進度回調
  • OnHeadersReceived 回應頭回呼
  • 支援插隊
  • 支援自訂超時