@mini-dev/request

miniapp request

一个简单的小程序 request 封装，在原有的小程序 request 上增加了以下支持：

1. 自定义拦截器（RequestInterceptor、ResponseInterceptor）；
2. Promise；
3. 取消请求；
4. 更常用的接口字段命名；

使用方法

安装依赖

npm i @mini-dev/request

创建 request 对象。

const {request} = require('@mini-dev/request');
request({...});

上述方式引用的是默认 request 对象，如果需要多个不同的request，可以自行创建：

const {request} = require('@mini-dev/request');
const anotherRequest = request.create();
anotherRequest({...});

发起请求

const {request} = require('@mini-dev/request');
request({
    url: 'https://xxxxxxx',
    method: 'post',
    params: {
        name: 'xesam'
    },
    data: {
        name: 'xesam'
    },
    headers: {
        auth: 'xxx'
    }
}).then(...).catch(...);

由于小程序的字段定义比较特异，所以对 option 做了一个略规范的定义：

method：如果没有设置，就使用 GET
params：添加到 url 上的参数
headers：请求头字段

其他参数会原样传入。

添加拦截器

const {request} = require('@mini-dev/request');

request.addRequestInterceptor(req => {
    return new Promise(resolve => {
        console.log('this is request interceptor A');
        setTimeout(function () {
            resolve(req);
        }, 1000);
    })
}).addRequestInterceptor(req => {
    console.log('this is request interceptor B');
    return req;
}).addResponseInterceptor(res => {
    console.log('this is response interceptor A');
    return new Promise(resolve => {
        setTimeout(function () {
            resolve(res);
        }, 1000);
    })
}).addResponseInterceptor(res => {
    console.log('this is response interceptor B');
    return res;
})

对于 request 拦截器，先添加的拦截器都会后执行 对于 response 拦截器，先添加的拦截器都会先执行。 因此，上述拦截器的调用顺序为：

request interceptor B 
-> request interceptor A 
-> {http request}
-> response interceptor A 
-> response interceptor B

页面调用

Page({
    onLoad(query) {
    },
    onTapGet(e) {
        const controller = new AbortController();
        request({
            url: 'https://httpbin.org/get',
            method: 'get', //默认使用 get
            params: {},
            signal: controller.signal
        }).then(res => {
            console.log(res);
        }).catch(err => {
            console.error(err);
        });
        controller.abort();
    }
})

ChangeLogs

0.1.0

1. 拆分 VendorHttpEngine；
2. 补全 tests；