首页 > 其他分享 >Uni-App Http请求

Uni-App Http请求

时间:2023-10-21 23:12:02浏览次数:40  
标签:Vue Http 请求 res App http token Uni config

该插件适用于一般的请求场景

只支持postgetputdelete请求,目前不适用于其他的请求形式,比如上传,下载等。插件定位为 小而美,而不是大而全,目标是切合实际,开箱即用。

平台差异说明

AppH5微信小程序支付宝小程序百度小程序头条小程序QQ小程序

由于某些小程序平台的限制:

  • delete请求,不支持支付宝和头条小程序(HX2.6.15)
  • put请求,不支持支付宝小程序(HX2.6.15)

基本使用

get | post | put | delete(url, params, header).then(res => {}).catch(res => {})

  • url 请求的URL,可以完整的URL(http开头),或者是路径的一部分,这时会自动拼接上baseUrl(一般为api的域名部分)
  • params 请求的参数,对象形式,如”{name: ‘lisa’, age: 23}”,该参数是可选的
  • header 请求的header,对象形式,如果token等字段,建议通过配置写入,该参数是可选的

    getpost都挂载在$u对象下,其中getpost使用方法完全一致,只是一个为this.$u.get,一个为this.$u.post,使用如下:

    一般来说,只在then中接收返回值即可,catch无特殊情况,无需编写和理会,因为如果服务端返回的不是200状态,插件内部会弹出model提示

    1. <script>
    2. export default {
    3. onl oad() {
    4. // 不带header
    5. this.$u.post('http://www.example.com', {
    6. id: 3,
    7. menu: 1
    8. }).then(res => {
    9. console.log(res);
    10. });
    11. // 带上header(对象形式),由于header为第三个参数,如果不需要请求参数,第二个参数传一个空对象"{ }"即可
    12. this.$u.get('http://www.example.com', {}, {
    13. token: 'xyz'
    14. }).then(res => {
    15. console.log(res);
    16. });
    17. }
    18. }
    19. </script>

    配置参数

    配置参数的时候,需要调用$u.http.setConfig()方法,传递一个对象作为参数。

    • 强烈建议在此配置统一请求的baseUrl
    • 同时看情况是否开启(默认关闭)请求加载中的loading,该功能需要设置一个时间(默认800ms),如果超过此时间,请求尚未返回,则显示一个loading,直至返回后,取消loading。

    说明:请求loading超时时间的意义为,一般情况下,请求会在几十毫秒返回,时间极短,无需loading,如果显示loading,会导致 动画一闪而过,体验不好。如果用户网络慢,或者服务器堵塞,可能一个请求需要几秒钟,这时请求达到设定时间(800ms), 就会显示loading,几秒钟后请求返回,loading消失。

    提示

    uView在1.1.0版本后,建议将拦截器内容部分,写入到独立的外部JS文件中,而不是写在App.vue中,这样有更好的可读性,可维护性。
    uView已经为用户考虑好了所有的情况,并详细指导您如何在外部JS中引用vuex变量以及Vue的this实例等。
    建议在根目录下新建/common/http.interceptor.js文件,也即创建common目录(如果没有的话),再创建http.interceptor.js文件,将拦截器相关代码写在里面。

    以下为可选的配置参数,这个配置是一次配置,全局通用的

    1. config =
    2. {
    3. baseUrl: '', // 请求的本域名
    4. method: 'POST',
    5. // 设置为json,返回后会对数据进行一次JSON.parse()
    6. dataType: 'json',
    7. showLoading: true, // 是否显示请求中的loading
    8. loadingText: '请求中...', // 请求loading中的文字提示
    9. loadingTime: 800, // 在此时间内,请求还没回来的话,就显示加载中动画,单位ms
    10. originalData: false, // 是否在拦截器中返回服务端的原始数据
    11. loadingMask: true, // 展示loading的时候,是否给一个透明的蒙层,防止触摸穿透
    12. }

    具体写法,建议在写在/common/http.interceptor.js(如无此文件夹和文件,请手动创建,一次配置,全局通用),写完之后,请在根目录的main.js 的new Vue()app.$mount()之间引入此文件,在new Vue()后面的原因是,外部JS文件需要引用vue的实例,也即this对象,要等main.js中通过new创建了实例之后才能引用。 在app.$mount()之前的原因是,在Vue挂载this实例(也即初始化App.vue)之前配置请求信息,所以在App.vue中也能正常发出请求。

    以下为在main.js中的引入示例:

    1. // main.js
    2. // 此为main.js本身已有内容
    3. const app = new Vue({
    4. ...App
    5. })
    6. // http拦截器,此为需要加入的内容,如果不是写在common目录,请自行修改引入路径
    7. import httpInterceptor from '@/common/http.interceptor.js'
    8. // 这里需要写在最后,是为了等Vue创建对象完成,引入"app"对象(也即页面的"this"实例)
    9. Vue.use(httpInterceptor, app)
    10. app.$mount()

    下面为拦截器的具体内容:

    1. // common/http.interceptor.js
    2. // 这里的Vue为Vue对象(非创建出来的实例),vm为main.js中“Vue.use(httpInterceptor, app)”这一句的第二个参数,
    3. // 为一个Vue的实例,也即每个页面的"this"
    4. // 如果需要了解这个install方法是什么,请移步:https://uviewui.com/components/vueuse.html
    5. const install = (Vue, vm) => {
    6. // 此为自定义配置参数,具体参数见上方说明
    7. Vue.prototype.$u.http.setConfig({
    8. baseUrl: 'https://api.example.com',
    9. loadingText: '努力加载中~',
    10. loadingTime: 800,
    11. // ......
    12. });
    13. }
    14. export default {
    15. install
    16. }

    请求拦截和响应拦截(如配置,每次请求都会执行)

    此两个拦截,是可选配置的

    何谓请求拦截?

    顾名思义,就是在请求发出之前,对请求做一些额外处理,比如对不同api接口,携带不同的header参数,或者(也是最重要) 配置统一的token到header中,这样就不用每次请求,都写token相关的部分到this.$u.post()的第三个请求头参数中,如下:

    $u.http.interceptor.request = (config) => { … }

    • config 此config参数,带有header和url属性,header属性是为了添加请求头信息,url属性是为了对某些url进行特别处理

      一般建议对此进行token的配置,说明:由于本拦截是每次请求都会调用的,如果在此写入token到header中,即使再次您重新登录,token发生变化,也无需再次调用本拦截

      1. // common/http.interceptor.js
      2. const install = (Vue, vm) => {
      3. // 此为自定义配置参数,具体参数见上方说明
      4. Vue.prototype.$u.http.setConfig({
      5. // ......
      6. });
      7. // 请求拦截部分,如配置,每次请求前都会执行
      8. Vue.prototype.$u.http.interceptor.request = (config) => {
      9. // 引用token
      10. // 方式一,存放在vuex的token,假设使用了uView封装的vuex方式
      11. // 见:https://uviewui.com/components/globalVariable.html
      12. // config.header.token = vm.token;
      13. // 方式二,如果没有使用uView封装的vuex方法,那么需要使用$store.state获取
      14. // config.header.token = vm.$store.state.token;
      15. // 方式三,如果token放在了globalData,通过getApp().globalData获取
      16. // config.header.token = getApp().globalData.username;
      17. // 方式四,如果token放在了Storage本地存储中,拦截是每次请求都执行的
      18. // 所以哪怕您重新登录修改了Storage,下一次的请求将会是最新值
      19. // const token = uni.getStorageSync('token');
      20. // config.header.token = token;
      21. config.header.Token = 'xxxxxx';
      22. // 可以对某个url进行特别处理,此url参数为this.$u.get(url)中的url值
      23. if(config.url == '/user/login') config.header.noToken = true;
      24. // 最后需要将config进行return
      25. return config;
      26. // 如果return一个false值,则会取消本次请求
      27. // if(config.url == '/user/rest') return false; // 取消某次请求
      28. }
      29. }
      30. export default {
      31. install
      32. }

      何谓响应拦截?

      响应拦截,意味着是在请求返回时,对返回的数据进行一些处理,如不同的状态对应的关系,比如约定状态码200为成功, 则把返回数据返回到this.$u.post().then()then中,如果为201(约定为token失效,需要登录),则可以在在拦截中进行toast 提示,并跳转到登录页。

      注意

      响应拦截器中默认返回的是response.data,如果您的需求比较特殊,需要返回response,请在”$u.http.setConfig”配置 originalDatatrue,如果配置了,服务端返回的”response.statusCode”不为”200”的时候,将不会自动弹出”modal”框,请自行 在响应拦截器中配置相关行为。

      $u.http.interceptor.response = (res) => { … }

      • res 该参数为服务器返回的数据,具体可打印查看
        1. // common/http.interceptor.js
        2. const install = (Vue, vm) => {
        3. // 此为自定义配置参数,具体参数见上方说明
        4. Vue.prototype.$u.http.setConfig({
        5. // ......
        6. });
        7. // 请求拦截部分,如配置,每次请求前都会执行,见上方说明
        8. Vue.prototype.$u.http.interceptor.request = (config) => {
        9. // ......
        10. return config;
        11. }
        12. // 响应拦截,如配置,每次请求结束都会执行本方法
        13. Vue.prototype.$u.http.interceptor.response = (res) => {
        14. if(res.code == 200) {
        15. // res为服务端返回值,可能有code,result等字段
        16. // 这里对res.result进行返回,将会在this.$u.post(url).then(res => {})的then回调中的res的到
        17. // 如果配置了originalData为true,请留意这里的返回值
        18. return res.result;
        19. } else if(res.code == 201) {
        20. // 假设201为token失效,这里跳转登录
        21. vm.$u.toast('验证失败,请重新登录');
        22. setTimeout(() => {
        23. // 此为uView的方法,详见路由相关文档
        24. vm.$u.route('/pages/user/login')
        25. }, 1500)
        26. return false;
        27. } else {
        28. // 如果返回false,则会调用Promise的reject回调,
        29. // 并将进入this.$u.post(url).then().catch(res=>{})的catch回调中,res为服务端的返回值
        30. return false;
        31. }
        32. }
        33. }
        34. export default {
        35. install
        36. }

        实践: 上面写完了请求配置(强烈建议),请求拦截(可选,推荐),响应拦截(可选,推荐),下面为postget请求的示例:

        1. // /pages/index/index.vue
        2. <script>
        3. export default {
        4. onl oad() {
        5. this.$u.get('/ebapi/store_api/hot_search', {
        6. id: 2
        7. }).then(res => {
        8. this.result = res;
        9. })
        10. this.$u.post('/ebapi/public_api/index', {
        11. id: 1
        12. }).then(res => {
        13. this.result = res;
        14. })
        15. }
        16. }
        17. </script>

        如何使用await进行同步操作

        • 有时候我们需要同步的写法,即下一步的结果依赖于上一步的请求返回结果,当然我们可以把下一步的写法,放入请求的then回调中, 但这是不直观的,比如我们需要打印请求的返回结果,可以这样做:
        1. export default {
        2. methods: {
        3. login() {
        4. // 正确,但是需要在回调中打印
        5. this.$u.post('/user/login').then(res => {
        6. console.log(res);
        7. })
        8. // 错误,如果想要使用同步的形式,无需then回调,且需要await关键字
        9. let result = this.$u.post('/user/login').then(res => {
        10. console.log(res);
        11. })
        12. console.log(result);
        13. // 错误,无需then回调是对的,但是ret会为undefined,因为登录是一个异步过程(可能需要几十毫秒)
        14. // 下一行打印的时候,请求还没返回,所以ret会为undefined
        15. let ret = this.$u.post('/user/login');
        16. console.log(ret);
        17. }
        18. }
        19. }

        上面演示了错误的示例,如果下一步需要依赖上一步的返回结果,并且需要需要同步的写法,我们可以结合”async/await”, 如不理解这个写法,可直接使用,或者搜索相关知识。
        说明:我们在某个地方使用await,意味着调用的函数本身或者生命周期,必须要加上async前缀,否则出错

        此为在onLoad生命周期中的请求示例:

        1. export default {
        2. // 可以放心在生命周期前加上async,不会导致问题
        3. async onl oad() {
        4. let ret = await this.$u.post('/user/login');
        5. // 此处在函数体外写了async,并且使用了await等待返回,所以可以打印ret结果
        6. // 意味着这里的console.log是等待了几十毫秒请求返回后才执行的
        7. console.log(ret);
        8. }
        9. }

        此为在methods方法中的请求示例:

        1. export default {
        2. methods: {
        3. async login() {
        4. let ret = await this.$u.post('/user/login');
        5. // 此处在函数体外写了async,并且使用了await等待返回,所以可以打印ret结果
        6. // 意味着这里的console.log是等待了几十毫秒请求返回后才执行的
        7. console.log(ret);
        8. }
        9. }
        10. }

        API集中管理

        这里说的集中管理,是指把各个请求,统一放到一个文件中进行管理,这样的好处是不用每次调用this.$u.get时都需要传入url参数,一些固定的 请求参数也可以不用显式的传入,如下为配置后的使用示例:

        1. this.$u.api.getSearch().then(res => {
        2. console.log(res);
        3. })

        此部分内容放到了另外的专题,请移步:API集中管理

        完整示例

        如果您不想阅读上方的内容的,或者觉得繁琐,下面给出一个完整的示例,复制修改某些提示的值即可直接使用

        1. // /common/http.interceptor.js
        2. // 这里的vm,就是我们在vue文件里面的this,所以我们能在这里获取vuex的变量,比如存放在里面的token变量
        3. const install = (Vue, vm) => {
        4. // 此为自定义配置参数,具体参数见上方说明
        5. Vue.prototype.$u.http.setConfig({
        6. baseUrl: 'https://api.example.com',
        7. loadingText: '努力加载中~',
        8. loadingTime: 800,
        9. // ......
        10. });
        11. // 请求拦截,配置Token等参数
        12. Vue.prototype.$u.http.interceptor.request = (config) => {
        13. // 引用token
        14. // 方式一,存放在vuex的token,假设使用了uView封装的vuex方式
        15. // 见:https://uviewui.com/components/globalVariable.html
        16. // config.header.token = vm.token;
        17. // 方式二,如果没有使用uView封装的vuex方法,那么需要使用$store.state获取
        18. // config.header.token = vm.$store.state.token;
        19. // 方式三,如果token放在了globalData,通过getApp().globalData获取
        20. // config.header.token = getApp().globalData.username;
        21. // 方式四,如果token放在了Storage本地存储中,拦截是每次请求都执行的
        22. // 所以哪怕您重新登录修改了Storage,下一次的请求将会是最新值
        23. // const token = uni.getStorageSync('token');
        24. // config.header.token = token;
        25. config.header.Token = 'xxxxxx';
        26. // 可以对某个url进行特别处理,此url参数为this.$u.get(url)中的url值
        27. if(config.url == '/user/login') config.header.noToken = true;
        28. // 最后需要将config进行return
        29. return config;
        30. // 如果return一个false值,则会取消本次请求
        31. // if(config.url == '/user/rest') return false; // 取消某次请求
        32. }
        33. // 响应拦截,判断状态码是否通过
        34. Vue.prototype.$u.http.interceptor.response = (res) => {
        35. if(res.code == 200) {
        36. // res为服务端返回值,可能有code,result等字段
        37. // 这里对res.result进行返回,将会在this.$u.post(url).then(res => {})的then回调中的res的到
        38. // 如果配置了originalData为true,请留意这里的返回值
        39. return res.result;
        40. } else if(res.code == 201) {
        41. // 假设201为token失效,这里跳转登录
        42. vm.$u.toast('验证失败,请重新登录');
        43. setTimeout(() => {
        44. // 此为uView的方法,详见路由相关文档
        45. vm.$u.route('/pages/user/login')
        46. }, 1500)
        47. return false;
        48. } else {
        49. // 如果返回false,则会调用Promise的reject回调,
        50. // 并将进入this.$u.post(url).then().catch(res=>{})的catch回调中,res为服务端的返回值
        51. return false;
        52. }
        53. }
        54. }
        55. export default {
        56. install
        57. }

        具体请求使用示例:

        1. // login.vue
        2. export default {
        3. methods: {
        4. // post示例
        5. sumbitByPost() {
        6. this.$u.post('/user/login', {
        7. username: 'lisa',
        8. password: '123456'
        9. }).then(res => {
        10. // res为服务端返回的数据
        11. })
        12. },
        13. // get示例
        14. sumbitByGet() {
        15. this.$u.get('/user/login', {
        16. username: 'lisa',
        17. password: '123456'
        18. }).then(res => {
        19. // res为服务端返回的数据
        20. })
        21. },
        22. }
        23. }

标签:Vue,Http,请求,res,App,http,token,Uni,config
From: https://www.cnblogs.com/Alex80/p/17779728.html

相关文章

  • Unity2023零基础入门学习
    Unity游戏引擎是什么?游戏引擎是一种软件框架,用于开发和创建电子游戏。它提供了一系列工具和功能,帮助开发者设计、构建和管理游戏的各个方面,包括图形渲染、物理模拟、音频处理、动画、碰撞检测、人工智能等。游戏引擎可以简化游戏开发过程,提高效率,并提供跨平台的支持,使开发者能......
  • uniapp环境配置
    uniapp笔记1.Uniapp-原生环境搭建[1]接口模块环境1:【安装IDEA软件】环境2:【安装maven】(1)下载并解压到非C盘目录【原因:maven配置本地仓库-企业非常大!一直在西在jar包】(2)创建一个本地仓库【步骤:在maven的根路径创建一个文件夹repo】(3)集成本地仓库路劲的配置,【作用:使你配置的本......
  • 第三章 Unix/Linux进程管理
    #第三章Unix/Linux进程管理##多任务处理Unix/Linux中的多任务处理是指通过操作系统的调度机制,使多个进程可以同时运行,互不影响,并共享计算机系统的资源。这样可以提高系统的效率和利用率。1.进程状态:进程可以处于运行(Running)、就绪(Ready)、等待(Blocked)等不同的状态,调度器根......
  • uboot为LED添加DM驱动--Apple的学习笔记
    一,前言开始玩所有板子一般都是先点灯,比如我可以在汇编中点灯,可以在board_init中用writel写寄存器点灯,当我要进一步熟悉下设备树驱动模型,不管学习linux还是学习uboot这块我理解类似,所以我要通过添加设备树及配置开关来实现默认打开led0和led1的功能。二,实现的过程1,先有了dts信息,我从......
  • uniCloud cms 自媒体资讯新闻文章应用系统 uniapp+uniCloud+AntDesignVue Life cms
    介绍LifeCMS是uniCloud+uni-app云端一体全套CMS/自媒体/资讯/新闻/文章应用系统,前台包含注册、登录(账号密码登录、短信登录、微信手机号快捷登录、微信一键登录、App手机一键登录、Apple登录)、文章列表、文章详情、搜索、广告、分享、评论、回复、点赞、收藏、用户中心、意见......
  • 循序渐进介绍基于CommunityToolkit.Mvvm 和HandyControl的WPF应用端开发(11) -- 下拉
    在我们开发的前端项目中,往往为了方便,都需对一些控件进行自定义的处理,以便实现快速的数据绑定以及便捷的使用,本篇随笔介绍通过抽取常见字典列表,实现通用的字典类型绑定;以及通过自定义控件的属性处理,实现系统字典内容的快捷绑定的操作。1、下拉列表的数据绑定在我们创建下拉列表的......
  • 一文1000字彻底搞懂Web测试与App测试的区别
    总结分享一些项目需要结合Web测试和App测试的工作经验给大家:从功能测试区分,Web测试与App测试在测试用例设计和测试流程上没什么区别。而两者的主要区别体现在如下几个方面:1系统结构方面Web项目,B/S架构,基于浏览器的;Web测试过程中,客户端会随服务器端同步更新,所以只需更新服务器......
  • 《Unix/Linux系统编程》教材学习笔记第三章
    chapter3多任务处理一般来说,多任务处理指的是同时进行几项独立活动的能力。在计算机技术中,多任务处理指的是同时执行几个独立的任务。在单处理器(单CPU)系统中,一次只能执行一个任务。多任务处理是通过在不同任务之间多路复用CPU的执行时间来实现的,即将CPU执行操作从一个任务切换到......
  • 【Unity3D】资源管理
    1前言​Unity中资源管理方案主要有Resources、TextAsset、ScriptableObject、AssetDatabase、PlayerPrefs、Addressables、AssetBundle、SQLite,本文将介绍其中大部分方案。2Resources​Resources主要用于加载资源,被加载的资源需要放在Resources目录下,可以在As......
  • NGINX 安装 SSL 证书 - 开启 HTTPS 访问
    在NGINX上安装SSL证书-开启HTTPS访问一、在你开始之前请确保您已下载证书文件。没有证书?请从https://www.sslforfree.com上申请90天免费证书。下载证书后,您应该有一个包含以下证书文件的ZIP:certificate.crtca_bundle.crtprivate.key二、上传证书文件首先,......