lei-mu/luch-request lei-mu/luch-request

  • Stars
    star
    618
  • Rank 72,605 (Top 2 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 5 years ago
  • Updated over 1 year ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
lei-mu/luch-request
github

lei-mu

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

luch-request 是一个基于Promise 开发的uni-app跨平台、项目级别的请求库，它有更小的体积，易用的api，方便简单的自定义能力。

luch-request

npm npm github github stars github forks

  • 基于 Promise 对象实现更简单的 request 使用方式，支持请求和响应拦截
  • 支持全局挂载
  • 支持多个全局配置实例
  • 支持自定义验证器
  • 支持文件上传/下载
  • 支持task 操作
  • 支持自定义参数
  • 支持多拦截器
  • 对参数的处理比uni.request 更强

安装

使用npm
npm install luch-request -S

使用npm前阅读快速上手

github

github 安装依赖后 npm run build ，使用DCloud/luch-request 文件夹即可

DCloud插件市场:

DCloud插件市场

Example

创建实例

import Request from '@/utils/luch-request/index.js' // 下载的插件
// import Request from 'luch-request' // 使用npm

const http = new Request();

执行GET请求

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
    responseType: 'text',
    // #endif
    // #ifdef H5 || APP-PLUS || MP-ALIPAY || MP-WEIXIN
    timeout: 60000, // H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)、微信小程序（2.10.0）、支付宝小程序
    // #endif
    // #ifdef APP-PLUS
    sslVerify: true, // 验证 ssl 证书 仅5+App安卓端支持（HBuilderX 2.3.3+）
    // #endif
    // #ifdef H5
    withCredentials: false, // 跨域请求时是否携带凭证（cookies）仅H5支持（HBuilderX 2.6.15+）
    // #endif
    // 返回当前请求的task, options。请勿在此处修改options。非必填
    getTask: (task, options) => {
         // setTimeout(() => {
         //   task.abort()
         // }, 500)
    },
    // 自定义验证器。statusCode必存在。非必填
    validateStatus: function validateStatus(statusCode) {
       return statusCode >= 200 && statusCode < 300
    },
    // forcedJSONParsing: true, // 是否尝试将响应数据json化,默认为true。如果失败则返回原数据
}).then(res => {

}).catch(err => {

})

执行POST请求

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
    responseType: 'text',
    // #endif
    // #ifdef H5 || APP-PLUS || MP-ALIPAY || MP-WEIXIN
    timeout: 60000, // H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)、微信小程序（2.10.0）、支付宝小程序
    // #endif
    // #ifdef APP-PLUS
    sslVerify: true, // 验证 ssl 证书 仅5+App安卓端支持（HBuilderX 2.3.3+）
    // #endif
    // #ifdef H5
    withCredentials: false, // 跨域请求时是否携带凭证（cookies）仅H5支持（HBuilderX 2.6.15+）
    // #endif
    // 返回当前请求的task, options。请勿在此处修改options。非必填
    getTask: (task, options) => {
         // setTimeout(() => {
         //   task.abort()
         // }, 500)
    },
     // 自定义验证器。statusCode必存在。非必填
     validateStatus: function validateStatus(statusCode) {
        return statusCode >= 200 && statusCode < 300
     }
}).then(res => {

}).catch(err => {

})

执行upload请求

  http.upload('api/upload/img', {
    params: {}, /* 会加在url上 */
    // #ifdef APP-PLUS || H5
    files: [], // 需要上传的文件列表。使用 files 时，filePath 和 name 不生效。App、H5（ 2.6.15+）
    // #endif
    // #ifdef MP-ALIPAY
    fileType: 'image/video/audio', // 仅支付宝小程序，且必填。
    // #endif
    filePath: '', // 要上传文件资源的路径。
    // 注：如果局部custom与全局custom有同名属性，则后面的属性会覆盖前面的属性，相当于Object.assign(全局，局部)
    custom: {auth: true}, // 可以加一些自定义参数，在拦截器等地方使用。比如这里我加了一个auth，可在拦截器里拿到，如果true就传token
    name: 'file', // 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容
    // #ifdef H5 || APP-PLUS
    timeout: 60000, // H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)
    // #endif
    header: {},  /* 会与全局header合并，如有同名属性，局部覆盖全局 */
    formData: {}, // HTTP 请求中其他额外的 form data
    // 返回当前请求的task, options。请勿在此处修改options。非必填
    getTask: (task, options) => {
      // task.onProgressUpdate((res) => {
      //   console.log('上传进度' + res.progress);
      //   console.log('已经上传的数据长度' + res.totalBytesSent);
      //   console.log('预期需要上传的数据总长度' + res.totalBytesExpectedToSend);
      //
      //   // 测试条件，取消上传任务。
      //   if (res.progress > 50) {
      //     uploadTask.abort();
      //   }
      // });
    },
    // 是否尝试将响应数据json化。boolean 或者一个包含include的对象。非必填。默认true。include为数组，包含需要json化的method
     // forcedJSONParsing: {include: ['UPLOAD', 'DOWNLOAD']}
  }).then(res => {
    // 返回的res.data 已经进行JSON.parse
  }).catch(err => {

  })

luch-request Guide

luch-request 官网地址
github

友情链接

vue-admin-beautiful

vue-admin-beautiful ——企业级、通用型中后台前端解决方案（基于vue/cli 4 最新版，同时支持电脑，手机，平板）

vue-admin-beautiful ——在线演示

uView

uView 文档 ——超棒的移动跨端框架，文档详细，上手容易

常见问题

  1. 为什么会请求两次？
    • 总有些小白问这些很那啥的问题，有两种可能，一种是‘post三次握手’，还有一种可能是本地访问接口时跨域请求，所以浏览器会先发一个option 去预测能否成功，然后再发一个真正的请求（自己观察请求头，Request Method，百度简单请求）。
  2. 如何跨域？
    • 问的人不少，可以先百度了解一下。如何跨域
  3. post 怎么传不了数组的参数啊？
    • uni-request
      可以点击看一下uni-request 的api 文档，data支持的文件类型只有Object/String/ArrayBuffer这个真跟我没啥关系 0.0
  4. TypeError: undefined is not an object (evaluating 'this.$http.get')
    • 不知道为啥问的人这么多？太基础了，百度学习一下 export default 和export，头大。
    • import { http } from '@/utils/luch-request/index.js'
  5. 什么参数需要在setConfig 设置？什么参数需要在request 拦截器设置？
    • setConfig 适用于设置一些静态的/默认的参数；比如header 里的一些默认值、默认全局参数（全局请求配置）。token 并不适合在这里设置。
    • interceptors.request 拦截器适用范围较广，但我仍然建议把一些静态的东西放在 setConfig 里。拦截器会在每次请求调用，而 setConfig 仅在调用时修改一遍。

tip

  • nvue 不支持全局挂载
  • 当前的hbuilderx 版本号：beat-3.0.4 alpha-3.0.4
  • 推荐使用下载插件的方式使用。如果本插件完全满足你的需求可直接使用 npm安装
  • license: MIT

issue

  • DCloud: 有任何问题或者建议可以=> issue提交,先给个五星好评QAQ!!
  • github: Issues

作者想说

  • 写代码很容易，为了让你们看懂写文档真的很lei 0.0
  • 最近发现有插件与我雷同，当初接触uni-app 就发现插件市场虽然有封装的不错的request库，但是都没有对多全局配置做处理，都是通过修改源码的方式配置。我首先推出通过class类，并仿照axios的api实现request请求库，并起名‘仿axios封装request网络请求库，支持拦截器全局配置’。他们虽然修改了部分代码，但是功能与性能并没有优化，反而使代码很冗余。希望能推出新的功能，和性能更加强悍的请求库。（2019-05）
  • 任何形式的‘参考’、‘借鉴’，请标明作者
<a href="https://ext.dcloud.net.cn/plugin?id=392">luch-request</a>
  • 关于问问题
  1. 首先请善于利用搜索引擎，不管百度，还是Google，遇到问题请先自己尝试解决。自己尝试过无法解决，再问。
  2. 不要问类似为什么我的xx无法使用这种问题。请仔细阅读文档，检查代码，或者说明运行环境，把相关代码贴至评论或者发送至我的邮箱，还可以点击上面的issue提交，在里面提问，可能我在里面已经回答了。
  3. 我的代码如果真的出现bug,或者你有好的建议、需求，可以提issue,我看到后会立即解决
  • 如何问问题
  1. 问问题之前请换位思考，如果自己要解决这个问题，需要哪些信息
  2. 仔细阅读文档，检查代码
  3. 说明运行环境，比如：app端 ios、android 版本号、手机机型、普遍现象还是个别现象（越详细越好）
  4. 发出代码片段或者截图至邮箱（很重要）
  5. 或者可以在上方的'issue提交' 里发出详细的问题描述
  6. 以上都觉得解决不了你的问题，可以加QQ:370306150

个人网站

土豪赞赏

wechat 打赏 支付宝 打赏

打赏事宜具体说明

您的鼓励是我更新的动力

创作不易，五星好评你懂得！

More Repositories

1

single-promises

Create a singleton pattern Promise-invoking function
JavaScript
10
star
2

obs-upload

浏览器端的obs简易上传封装
JavaScript
4
star
3

build-cdn-from-cdnjs

基于cdnjs open api快速构建自己的前端资源静态库
Vue
2
star
4

lei-mu

个人介绍
1
star
5

luch-audio

基于createInnerAudioContext封装audio音频组件（样式同原生audio组件)
Vue
1
star
6

object-process

obs,oss 等对象处理
JavaScript
1
star
7

process-model

obs,oss 等对象处理模型序列化
JavaScript
1
star