**插件使用说明** - 基于 Promise 对象实现更简单的 request 使用方式，支持请求和响应拦截 - 支持全局挂载 - 支持多个全局配置实例 - 支持自定义验证器 - 支持文件上传（如不使用可以删除class里upload 方法） - 支持` typescript `、` javascript ` 版本(如果不使用ts版本，则可以把luch-request-ts 文件夹删除) - 下载后把 http-request 文件夹放到项目 utils/ 目录下 **Example** --- 创建实例 ``` javascript const http = new Request(); ``` 执行` GET `请求 ``` javascript http.get('/user/login', {params: {userName: 'name', password: '123456'}}).then(res => { }).catch(err => { }) // 局部修改配置，局部配置优先级高于全局配置 http.get('/user/login', { params: {userName: 'name', password: '123456'}, /* 会加在url上 */ header: {}, /* 会覆盖全局header */ dataType: 'json', // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部) custom: {auth: true}, // 可以加一些自定义参数，在拦截器等地方使用。比如这里我加了一个auth，可在拦截器里拿到，如果true就传token // #ifndef MP-ALIPAY || APP-PLUS responseType: 'text', // #endif // #ifdef MP-ALIPAY timeout: 30000, // 仅支付宝小程序支持 // #endif // #ifdef APP-PLUS sslVerify: true // 验证 ssl 证书 仅5+App安卓端支持（HBuilderX 2.3.3+） // #endif }).then(res => { }).catch(err => { }) ``` 执行` POST `请求 ``` javascript http.post('/user/login', {userName: 'name', password: '123456'} ).then(res => { }).catch(err => { }) // 局部修改配置，局部配置优先级高于全局配置 http.post('/user/login', {userName: 'name', password: '123456'}, { params: {}, /* 会加在url上 */ header: {}, /* 会覆盖全局header */ dataType: 'json', // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部) custom: {auth: true}, // 可以加一些自定义参数，在拦截器等地方使用。比如这里我加了一个auth，可在拦截器里拿到，如果true就传token // #ifndef MP-ALIPAY || APP-PLUS responseType: 'text', // #endif // #ifdef MP-ALIPAY timeout: 30000, // 仅支付宝小程序支持 // #endif // #ifdef APP-PLUS sslVerify: true // 验证 ssl 证书 仅5+App安卓端支持（HBuilderX 2.3.3+） // #endif }).then(res => { }).catch(err => { }) ``` 执行` upload `请求 ``` javascript http.upload('api/upload/img', { files: [], // 仅5+App支持 fileType：'image/video/audio', // 仅支付宝小程序，且必填。 filePath: '', // 要上传文件资源的路径。 // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部) custom: {auth: true}, // 可以加一些自定义参数，在拦截器等地方使用。比如这里我加了一个auth，可在拦截器里拿到，如果true就传token name: 'file', // 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 header: {}, formData: {}, // HTTP 请求中其他额外的 form data }).then(res => { }).catch(err => { }) ``` **luch-request API** -- ``` javascript http.request({ method: 'POST', // 请求方法必须大写 url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' }, params: { // 会拼接到url上 token: '1111' }, // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部) custom: {} // 自定义参数 }) 具体参数说明：[uni.uploadFile](https://uniapp.dcloud.io/api/request/network-file) http.upload('api/upload/img', { files: [], // 仅5+App支持 fileType：'image/video/audio', // 仅支付宝小程序，且必填。 filePath: '', // 要上传文件资源的路径。 name: 'file', // 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容 header: {}, // 如填写，会覆盖全局header, custom: {} // 自定义参数 formData: {}, // HTTP 请求中其他额外的 form data }) ``` 请求方法别名 / 实例方法 ``` javascript http.request(config) http.get(url[, config]) http.upload(url[, config]) http.delete(url[, data[, config]]) http.head(url[, data[, config]]) http.post(url[, data[, config]]) http.put(url[, data[, config]]) http.connect(url[, data[, config]]) http.options(url[, data[, config]]) http.trace(url[, data[, config]]) ``` **全局请求配置** -- ``` javascript { baseUrl: '', header: { 'content-type': 'application/json;charset=UTF-8' }, method: 'GET', dataType: 'json', // #ifndef MP-ALIPAY || APP-PLUS responseType: 'text', // #endif // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部) custom: {}, // 全局自定义参数默认值 // #ifdef MP-ALIPAY timeout: 30000, // #endif // #ifdef APP-PLUS sslVerify: true // #endif } ``` 全局配置修改` setConfig ` ``` javascript /** * @description 修改全局默认配置 * @param {Function} */ http.setConfig((config) => { /* config 为默认全局配置*/ config.baseUrl = 'http://www.bbb.cn'; /* 根域名 */ config.header = { a: 1, b: 2 } return config }) ``` 自定义验证器` validateStatus ` ``` javascript /** * 自定义验证器，如果返回true 则进入响应拦截器的响应成功函数(resolve)，否则进入响应拦截器的响应错误函数(reject) * @param { Number } statusCode - 请求响应体statusCode（只读） * @return { Boolean } 如果为true,则 resolve, 否则 reject */ http.validateStatus = (statusCode) => { // 默认 return statusCode === 200 } // 举个栗子 http.validateStatus = (statusCode) => { return statusCode && statusCode >= 200 && statusCode < 300 } ``` **拦截器** -- 在请求之前拦截 ``` javascript /** * @param { Function} cancel - 取消请求,调用cancel 会取消本次请求，但是该函数的catch() 仍会执行; 不会进入响应拦截器 * * @param {String} text ['handle cancel'| any] - catch((err) => {}) err.errMsg === 'handle cancel'。非必传，默认'handle cancel' * @cancel {Object} config - catch((err) => {}) err.config === config; 非必传，默认为request拦截器修改之前的config * function cancel(text, config) {} */ http.interceptor.request((config, cancel) => { /* cancel 为函数，如果调用会取消本次请求。需要注意：调用cancel,本次请求的catch仍会执行。必须return config */ config.header = { ...config.header, a: 1 } // if (config.custom.auth) { // config.header.token = 'token' // } if (!token) { // 如果token不存在，调用cancel 会取消本次请求，但是该函数的catch() 仍会执行 cancel('token 不存在', config) // 把修改后的config传入，之后响应就可以拿到修改后的config。 如果调用了cancel但是不传修改后的config，则catch((err) => {}) err.config 为request拦截器修改之前的config } */ return config; }) ``` 在请求之后拦截 ``` javascript http.interceptor.response((response) => { /* 对响应成功做点什么 （statusCode === 200），必须return response*/ // if (response.data.code !== 200) { // 服务端返回的状态码不等于200，则reject() // return Promise.reject(response) // } // if (response.config.custom.verification) { // 演示自定义参数的作用 // return response.data // } console.log(response) return response }, (response) => { /* 对响应错误做点什么 （statusCode !== 200），必须return response*/ console.log(response) return response }) ``` **typescript使用** -- 在` request.ts `里还暴露了五个接口 ```javascript { options, // request 方法配置参数 handleOptions, // get/post 方法配置参数 config, // init 全局config接口(setConfig 参数接口) requestConfig, // 请求之前参数配置项 response // 响应体 } ``` **常见问题** -- 1. 为什么会请求两次？ - 总有些小白问这些很那啥的问题，有两种可能，一种是‘post三次握手’(不知道的请先给个五星好评，然后打自己一巴掌，并问自己，为什么这都不知道)，还有一种可能是`本地访问接口时跨域请求，所以浏览器会先发一个option 去预测能否成功，然后再发一个真正的请求`（没有自己观察请求头，Request Method，就跑来问的，请再打自己一巴掌，并问自己，为什么这都不知道，不知道也行，为什么不百度）。 2. 如何跨域？ - 问的人不少，可以先百度了解一下。如何跨域 3. post 怎么传不了数组的参数啊？ - uni-request
可以点击看一下uni-request 的api 文档，data支持的文件类型只有Object/String/ArrayBuffer这个真跟我没啥关系 0.0 4. 'Content-Type' 为什么要小写？ - hbuilderX 更新至‘2.3.0.20190919’ 后，uni.request post请求，如果 ‘Content-Type’ 大写，就会在后面自动拼接‘ application/json’，请求头变成 `Content-Type: application/json;charset=UTF-8 application/json`，导致后端无法解析类型，`Status Code 415`，post 请求失败。但是小写就不会出现这个问题。至于为什么我也没有深究，我现在也不清楚这是他们的bug,还是以后就这样规范了。我能做的只有立马兼容，至于后边uni官方会不会继续变动也不清楚。 5. 为什么不支持task？ - 一方面精力有限，另一方面违背了本人的一些意愿，具体看第6条 6. 为什么不能配置超时时间？ - 配置超时时间，请求时需要task,并且每个请求都需要创建一个定时器，本人认为这个消耗没必要。设置超时时间可以通过manifest.json 配置进行设置。我想用的就是一个小而简单的请求插件。 **tip** -- - 不想使用upload 可把class 里的upload 删除 **issue** -- 有任何问题或者建议可以=> issue提交,先给个五星好评QAQ!! **作者想说** -- - 主体代码9kb - 目前该插件已经上项目，遇到任何问题请先检查自己的代码（排除新版本发布的情况）。最近新上了` typescript ` 版本，因为本人没使用过ts,所以写的不好的地方，还请见谅~ - 写代码很容易，为了让你们看懂写文档真的很lei 0.0 - 最近发现有插件与我雷同，当初接触uni-app 就发现插件市场虽然有封装的不错的request库，但是都没有对多全局配置做处理，都是通过修改源码的方式配置。我首先推出通过class类，并仿照axios的api实现request请求库，并起名‘仿axios封装request网络请求库，支持拦截器全局配置’。他们虽然修改了部分代码，但是功能与性能并没有优化，反而使代码很冗余。希望能推出新的功能，和性能更加强悍的请求库。 - 任何形式的‘参考’、‘借鉴’，请标明作者 ```javascript luch-request ``` - 关于问问题 1. 首先请善于利用搜索引擎，不管百度，还是Google，遇到问题请先自己尝试解决。自己尝试过无法解决，再问。 2. 不要问类似为什么我的xx无法使用这种问题。请仔细阅读文档，检查代码，或者说明运行环境，把相关代码贴至评论或者发送至我的邮箱，还可以点击上面的issue提交，在里面提问，可能我在里面已经回答了。 3. 我的代码如果真的出现bug,或者你有好的建议、需求，可以提issue,我看到后会立即解决 4. 不要问一些弱智问题！！！ - 如何问问题 1. 仔细阅读文档，检查代码 2. 说明运行环境，比如：app端 ios、android 版本号、手机机型、普遍现象还是个别现象（越详细越好） 3. 发出代码片段或者截图至邮箱（很重要） 4. 或者可以在上方的'issue提交' 里发出详细的问题描述 5. 以上都觉得解决不了你的问题，可以加QQ:`370306150` **土豪赞赏** -- ####创作不易，五星好评你懂得！