更新记录

1.2.1(2020-05-16)

优化代码

1.2(2020-05-16)

修复 X.prototype.y called on incompatible type。使用原生 Promise 代理 Promise polyfill。新增支持 finally。修复服务器响应不为 200 时,catch 没有参数

查看更多

欢迎使用 uni_request.js

最近在使用uni-app开发应用,因为用axios用的太顺手了,就对uni.request方法做了一个封装,使其使用起来和axios的方法和效果一样。因为是自己现做现用,api设计的都比较简单,代码不也不复杂,但是却很实用。如有BUG,还请不吝指出,非常感谢。

主要功能:

  • 支持异步拦截器(请求/响应拦截器中支持异步操作并阻塞)
  • 支持Promise 操作,错误捕获
  • 支持全局错误监听
  • 支持文件上传/下载
  • 支持主动取消请求(包括普通请求 GET POST 等)
  • 支持超时取消

封装

初始化

import uni_request from './uni_request.js'

const request = uni_request({ // 有效配置项只有三个
    baseURL: 'http://192.168.0.13/dwbsapp', //baseURL
    timeout: 1111, // 超时时间
    header: { 'x-custom-header': 'x-custom-header' } // 设置请求头,建议放在请求拦截器中
})

请求拦截器

可以设置多个, 同时可以也可以使用异步方法。拦截器回调函数接受4个参数,分别是 config, method, url, data。其中 config 中包含请求头和请求体( uploadFile()请求的请求体只包含 formData 部分),可以修改:


request.interceptors.request.use(async (config, ...args) => {
    await new Promise(resolve => setTimeout(() => resolve(), 3000))
    console.log('请求拦截器, 网络请求会等 3 秒后上面的异步任务结束后执行') // args[0] method args[1] url args[3] data
    config.header.Authorization = 'Bearer ' + $store.state.app.token // 修改请求头
    config.body.test = 'test' // 修改请求体
    return config
})

响应拦截器

响应拦截器(可以设置多个, 同时可以也可以使用异步方法。拦截器回调函数接受4个参数,分别是 response, method, url, data:

request.interceptors.response.use((response, ...args) => { // 响应拦截器(可以设置多个, 同时可以也可以使用异步方法)
    const { data: res } = response // args[0] method args[1] url args[3] data
    await new Promise(resolve => setTimeout(() => resolve(), 3000))
    if (res.code === 200) {
        console.log('响应拦截器, 会阻塞 3 s')
    }
    return response
})

全局错误监听

当某个请求出现 请求失败、超时、服务器请求异常、主动取消等都会触发 方法。 接收4个参数,分别是 method url data reason(失败原因)。 事件一个 request 实例只能设置一个,后设置的会覆盖前面的。 中也支持异步操作:

request. = async (...args) => { // 请求失败统一处理方法(可以也可以使用异步方法)
    console.log('网络请求失败了', `url为${args[1]}`)
}

使用

基本使用

request.get('/').then(res => {
    console.log(res)
}).catch(e => console.error(e))

request.get('http://xxx.com').then(res => { // 也可以使用配置的 baseURL 之外的 url,但是注意 url 路径要写完整
    console.log(res)
}).catch(e => console.error(e))

取消请求

如果想要取消某个请求,需要在 then 之前将 request.get 方法返回的 promise 对象保存在一个变量里。在需要的时候调用 abort 方法,会使当前网络请求取消并且使 request.get 方法返回的 promise 进入 reject 状态,可被 catch 捕获,错误信息为 【网络请求失败:主动取消】。如果在请求拦截器的异步期间取消,那么会在请求拦截器的异步操作结束后直接使返回的 Promise 进入 reject 状态,并不会发出网络请求

const task = request.get('/abort') 
task.then(res => {
    console.log(res)
}).catch(e => console.error(e)) // 网络请求失败:主动取消
task.abort()

上传下载

上传

上传文件仅支持单文件上传,uploadFile() 方法接受两个参数:url 和 config。config 中有效配置项有四个,分别是:name filePaht header formData:

request.uploadFile('/upload', {
    name: 'img',
    filePath: 'tempFilePath',
    formData: {
        a: 1,
        b: 2
    },
    header: {}
}).then(res => ...).catch(e => console.error(e))

下载

uploadFile() 方法接受两个参数:url 和 config。config 中有效配置项只有有一个 header :

request.uploadFile('/download', {
    header: {}
}).then(res => {
    console.log(res) // cookies: [], errMsg: "downloadFile:ok", header: { ... },statusCode: 200, tempFilePath: "http://tmp/w...d2.jpg"
}).catch(e => console.error(e))

取消上传/下载

和普通请求取消一样。也需要在 then 之前将 request 方法返回的 promise 对象保存在一个变量里。在需要的时候调用 abort 方法。

const task = request.uploadFile('/download', {
    header: {}
})
task.then(res => {
    console.log(res) // cookies: [], errMsg: "downloadFile:ok", header: { ... },statusCode: 200, tempFilePath: "http://tmp/w...d2.jpg"
}).catch(e => console.error(e))

task.abort() // 取消上传/下载

监听上传/下载进度

和请求取消一样。也需要在 then 之前将 request 方法返回的 promise 对象保存在一个变量里。

const task = request.uploadFile('/download', {
    header: {}
})
task.then(res => {
    console.log(res) // cookies: [], errMsg: "downloadFile:ok", header: { ... },statusCode: 200, tempFilePath: "http://tmp/w...d2.jpg"
}).catch(e => console.error(e))

fileU.onProgressUpdate(e => console.log(e)) // { progress: 2, totalBytesExpectedToSend: 1254676, totalBytesSent: 35244 }

注意事项

所有服务器响应不为 200 的请求会被视为请求失败,可以 catch 和被 监听

隐私、权限及商业化声明

说明:除收费原生SDK插件外,其他插件或示例工程默认均为MIT开源协议。如提供了github地址,并在github上专门标注了开源协议,则以github标注为准。

1. 本插件需要申请的手机端权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问