@bingoit/ajax

通用的ajax请求方法

Usage no npm install needed!

<script type="module">
  import bingoitAjax from 'https://cdn.skypack.dev/@bingoit/ajax';
</script>

README

ajax

定义了一些AJAX请求相关的方法;

安装方法

npm install @bingoit/ajax --save

使用方法

按需引入:

import {get, post} from '@bingoit/ajax'

方法调用:get(url, args)


全部引入:

import * as ajax from '@bingoit/ajax'

方法调用:ajax.get(url, args)

注:

  • 如果请求过程中接口返回未登录状态时;需要通过调用setNotLoginHandler方法设置处理的方法;
  • 如果请求过程中需要添加请求token;需要调用setTokenHandler方法设置获取token的方法。

包含的方法有:

  • setNotLoginHandler 设置未登录处理者
  • setNotLoginStatus 设置未登录状态值
  • setTokenHandler 设置获取token值的处理者
  • setTokenHeaderName 设置token请求头的名称
  • setTimeout 设置请求超时时间
  • get GET请求
  • post POST请求
  • getAutoConvert GET请求(请求参数驼峰参数转换为下划线参数名,响应内容下划线变量名转换为驼峰命名)
  • postAutoConvert POST请求(请求参数驼峰参数转换为下划线参数名,响应内容下划线变量名转换为驼峰命名)
  • postFormData POST提交表单数据(一般用在文件的提交,默认情况下,参数会按驼峰命名或下划线转换)
  • requestList 请求列表的通用方法

使用注意事项

  1. 设置未登录处理者及未登录状态码:
    在项目的main.js文件中设置:

    import {setNotLoginHandler} from '@bingoit/ajax';
    setNotLoginHandler(this, function () {
        //未登录时执行的方法;如跳转到登录页面等
    }, 10004);
    
    

    说明: 第一个参数为当前对象;第二个参数为未登录时的处理方法;第三参数为未登录的状态码(由后端返回)。

  2. 设置获取token值的处理者及token请求头的名称: 在项目的main.js文件中设置:

     import {setTokenHandler} from '@bingoit/ajax';
     setTokenHandler(this, function () {
         //这里调用获取token的方法并返回;如:
        // return getToken();
     }, 'X-Authorization-Token');
     
    

    说明: 第一个参数为当前对象;第二个参数为提供获取token的方法;第三参数为token在请求头中的名称。