更新记录

v1.1.0（2021-02-03） 下载此版本

修改拦截器取消逻辑， 由原来boolean值改为use + eject 方式

v1.0.1（2021-02-02） 下载此版本

更新声明，附demo

v1.0.0（2021-02-01） 下载此版本

fork 自https://ext.dcloud.net.cn/plugin?id=946， 借鉴学习之用【支持原创】

平台兼容性

Uni-phenix-request

uniapp 网络请求插件封——基于uni request原生

声明

此插件fork自 https://ext.dcloud.net.cn/plugin?id=946, 此处为借鉴学习之用（建议萌新阅读源码）， 同时也是熟悉插件发布流程， 源码作了部分修改（非bug，自身需求），使用方式未变化，如何使用？传送门

主要功能：

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

初始化实例

import uni_request from '@/hooks/request.js'

const request = uni_request({ // 有效配置项只有三个
    baseUrl: 'https://api.xiaobaibk.com/api', //baseUrl
    timeout: 15000, // 超时时间，单位毫秒。默认 60 秒
    header: {
        'x-custom-header': 'x-custom-header__phenix'
    }, // 设置请求头，建议放在请求拦截器中
    codes: [200, 401] // 服务器相应状态码为 200/401 时，网络请求不会 reject。也就是不会被 catch 到。如响应 401 时可以在响应拦截后 await 刷新 token + await 重新请求 + return response。即可实现无痛刷新。 
})

// 导出实例供调用
export default request

请求拦截器

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

request.interceptors.request.use((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' // 修改请求体
    // config.cancel = true // 取消请求
    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 实例只能设置一个，后设置的会覆盖前面的。（“on error” 好像被屏蔽了Σ(☉▽☉"a）：

request['onerror'] = function(...e) {
    // 如果返回异常， 此处却为执行， 说明没有执行到网络请求逻辑， 检查拦截器是否设置正确
    console.log('onerror::', e);
    return false // 返回true 将拦截reject/resolve， 及Promise catch方法执行
}

基本使用

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))

高级使用

取消拦截器操作变为

function testInterceptor(config, ...args) {
    return config
}

request.interceptors.request.use(testInterceptor)
request.interceptors.request.eject(testInterceptor)

// 或者
const id = request.interceptors.request.use(testInterceptor)
request.interceptors.request.eject(id)

request.request({
    url:'/', 
    data:{ name: 'zhangsan' }, 
    header:{ 'Content-Type': 'application/x-www-form-urlencoded' }, 
//  reqIntercept: false,  // depressed 不再支持
//  resIntercept: false   // depressed 不再支持
}).then(res => {
    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()

上传

上传文件仅支持单文件上传，upload方法接受4个参数：url, Update, data, header

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

下载

download 方法接受4个参数：url, Update, data, header

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

注意事项

默认所有服务器响应不为 [200, 401] 的请求会被视为请求失败，会被 catch 和被 监听，如果想要更多请求不被 catch 。可以在实例化时配置 statusCode: [201, 302, ...]