Tips on axios

什么是 axios

  • axios 是一个基于 Promise 的,为浏览器和 Node.js 设计的 HTTP 客户端。它尽可能简化封装了 HTTP 相关的各种操作,在 Web App 中使用非常方便。
  • Vue 2 官方建议在由 Vue 构建的 SPA 中使用 axios 进行 HTTP 操作。
  • 传送门:mzabriskie/axios

基本用法

  • 初始化一个 axios 实例

    const ajaxInstance = axios.create({
        baseURL: url,
        timeout: 30000 // 30 seconds.
    });
    
  • GET .get(url, [conf])

    ajaxInstance.get('/job/joblist', {
        params: {
            user: store.state.auth.username
        }
    }).then((response) => {
        if (response.status === 200) {
            return true;
        } else {
            console.log(response.status);
            return false;
        }
    }).catch((error) => {
        console.error(error);
        return false;
    });
    
  • POST Params .post(url, [data, [conf]])

    ajaxInstance.post('/auth/userLogin', {}, {
        params: {
            username: user.username,
            password: user.password
        },
    }).then((response) => {
        // if auth success. then ->
        console.log(response); // for test only
        console.log(response.data.Login;
        if((response.data.Login === 0)) { // login success
            return true;
        } else {
            return false;
        }
    }).catch((error) => {
        console.error(error);
        return false;
    });
    
  • POST JSON

    ajaxInstance.post('/auth/userLogin', {
        username: '',
        password: ''
    }).then((response) => {
        // if auth success. then ->
        console.log(response); // for test only
        console.log(response.data.Login;
        if((response.data.Login === 0)) { // login success
            return true;
        } else {
            return false;
        }
    }).catch((error) => {
        console.error(error);
        return false;
    });
    
  • POST 表单( FormData )

    let data = new FormData();
    data.append('upload_file', file);
    data.append('path', store.state.dataPreview.path);
    data.append('user', store.state.auth.username);
    return ajaxInstance.post('/action/upload', data).then((response) => {
        if (response.data === 'success') {
            return true;
        } else {
            console.log(response.data);
            return false;        
        }
    }).catch((error) => {
        console.error(error);
        return false;
    });
    

遇到的问题

  1. 如何在 SPA 中封装 axios 以供组件使用:
    • 首先,直接在组件中进行 HTTP Request 是不合理的,因为维护起来不方便,也不利于代码复用。

    • 可以封装一个全局 util 类,实例化一个 axios 对象,涉及与 axios 相关的操作的函数都放在这个类中,组件通过引用这个类并调用相关函数来发起 HTTP Request 。

    • 要注意的是,如果需要用到 Promise 的异步特性,通过异步返回值控制视图,以实现友好的界面交互 / 提示(或者其他目的),一定要将整个 axios 返回(其实就是返回一个 Promise),而不是只返回某个结果值(可以参考上述代码中 POST 表单的部分)。然后再利用 Promise 异步处理返回的结果即可。

      // util 中的 submit 函数
      
      const submitTask = (taskInfo, file) => {
          let data = new FormData();
          data.append('job', JSON.stringify(taskInfo));
          data.append('user', store.state.auth.username);
          data.append('job_file', file);
          return ajaxInstance.post('/job/start_job', data).then((response) => {
              console.log(response);
              if (response.data === 'success') {
                  return true;
              } else {
                  return false;
              }
          }).catch((error) => {
              console.error(error);
              return false;
          });
      }
      
      // submit 页面
      
      util.submitTask(taskInfo, this.newFile).then((res) => {
          if (res) {
              this.$Message.success('已提交。');
              cleanSubmit();
          } else {
              this.$Message.error('提交失败。');
              cleanSubmit();
          };
      })
      
  2. 如何提交表单:
    • 提交表单时一定要使用 FromData 对象手动生成一个表单,并把 FormData 当做 data 传递给 axios ,axios 会自动识别 data 的类型并设置好相应的 Request Header 。提交文件只需要将文件对象 append 到表单中即可。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • 时间2017-03-31 13:43:44Hope’s Blog 原文https://blog.ygxdxx.co...
    萧玄辞阅读 15,185评论 3 16
  • 一、安装 1、 利用npm安装npm install axios --save 2、 利用bower安装bower...
    kiddings阅读 1,745评论 0 3
  • 感受我爱你的心跳在左边,你离我远去,让我已经感受不到自己的存在,你以前总是用右手牵着我,你却不知,我感觉不到你的心...
    双兔阅读 228评论 0 0
  • int ia_ + virtual f() + class B:virtual public A+ int ib_...
    HenryTien阅读 320评论 1 0