axios - http请求库

2018-12-21  本文已影响0人  杂选说
1.通过向 axios 传递相关配置来创建请求
  axios(config)
  注:默认请求为GET请求,例:axios('/user/12345');

  为所有支持的请求方法提供了别名(列举比较常用的别名)
  * axios.request(config)
  * axios.get(url[, config])
  * axios.post(url[, data[, config]])

  config 配置参数
  {
      // `url` 是用于请求的服务器 URL
      url: '/user',

      // `method` 是创建请求时使用的方法
      method: 'get', // 默认是 get

      // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。
      // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL
      baseURL: 'https://some-domain.com/api/',

      // `transformRequest` 允许在向服务器发送前,修改请求数据
      // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
      // 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream
      transformRequest: [function (data) {
            // 对 data 进行任意转换处理

          return data;
      }],

      // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
      transformResponse: [function (data) {
          // 对 data 进行任意转换处理

          return data;
      }],

      // `headers` 是即将被发送的自定义请求头
      headers: {'X-Requested-With': 'XMLHttpRequest'},

      // `params` 是即将与请求一起发送的 URL 参数,(Get请求)
      // 必须是一个无格式对象(plain object)或 URLSearchParams 对象
      params: {
        ID: 12345
      },

      // `paramsSerializer` 是一个负责 `params` 序列化的函数
      // (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
      paramsSerializer: function(params) {
          return Qs.stringify(params, {arrayFormat: 'brackets'})
      },

       // `data` 是作为请求主体被发送的数据
      // 只适用于这些请求方法 'PUT', 'POST', 和 'PATCH'
      // 在没有设置 `transformRequest` 时,必须是以下类型之一:
      // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
      // - 浏览器专属:FormData, File, Blob
      // - Node 专属: Stream
      data: {
        firstName: 'Fred'
      },

      // `timeout` 指定请求超时的毫秒数(0 表示无超时时间)
      // 如果请求话费了超过 `timeout` 的时间,请求将被中断
      timeout: 1000,

      // `withCredentials` 表示跨域请求时是否需要使用凭证
      withCredentials: false, // 默认的

      // `adapter` 允许自定义处理请求,以使测试更轻松
      // 返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
      adapter: function (config) {
        /* ... */
      },

      // `auth` 表示应该使用 HTTP 基础验证,并提供凭据
      // 这将设置一个 `Authorization` 头,覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
      auth: {
        username: 'janedoe',
        password: 's00pers3cret'
      },

      // `responseType` 表示服务器响应的数据类型,可以是 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
      responseType: 'json', // 默认的

      // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
      xsrfCookieName: 'XSRF-TOKEN', // default

      // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
      xsrfHeaderName: 'X-XSRF-TOKEN', // 默认的

      // `onUploadProgress` 允许为上传处理进度事件
      onUploadProgress: function (progressEvent) {
        // 对原生进度事件的处理
      },

      // `onDownloadProgress` 允许为下载处理进度事件
      onDownloadProgress: function (progressEvent) {
        // 对原生进度事件的处理
      },

      // `maxContentLength` 定义允许的响应内容的最大尺寸
      maxContentLength: 2000,

      // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte
      validateStatus: function (status) {
          return status >= 200 && status < 300; // 默认的
      },

      // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
      // 如果设置为0,将不会 follow 任何重定向
      maxRedirects: 5, // 默认的

      // `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项:
      // `keepAlive` 默认没有启用
      httpAgent: new http.Agent({ keepAlive: true }),
      httpsAgent: new https.Agent({ keepAlive: true }),

      // 'proxy' 定义代理服务器的主机名称和端口
      // `auth` 表示 HTTP 基础验证应当用于连接代理,并提供凭据
      // 这将会设置一个 `Proxy-Authorization` 头,覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
      proxy: {
        host: '127.0.0.1',
        port: 9000,
        auth: : {
          username: 'mikeymike',
          password: 'rapunz3l'
        }
      },

      // `cancelToken` 指定用于取消请求的 cancel token
      // (查看后面的 Cancellation 这节了解更多)
      cancelToken: new CancelToken(function (cancel) {
      })
}

2.并发请求
  axios.all(iterable)
  axios.spread(callback)
  //创建请求方法
  function getUserAccount() {
      return axios.get('/user/12345');
  }
  //创建请求方法
  function getUserPermissions() {
      return axios.get('/user/12345/permissions');
  }
  //并发请求
  axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // 两个请求现在都执行完成
  }));

3.创建实例
   axios.create([config])

   var instance = axios.create({
      baseURL: 'https://some-domain.com/api/',
      timeout: 1000,
      headers: {'X-Custom-Header': 'foobar'}
    });

    // 在实例已创建后修改默认值
    instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

    * instance.request(config)
    * instance.get(url[, config])
    * instance.post(url[, data[, config]])
    //自定义实例默认值
     instance.defaults.[config配置参数]=值;
     例: instance.defaults.timeout = 2500;

4.全局配置默认值
   axios.defaults.[config配置参数]=值;
   例:
       axios.defaults.baseURL = 'https://api.example.com';
       axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
       axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

注:配置的优先顺序,config配置 > 实例的defaults配置 > 系统默认配置

5.拦截器(直接copy,没来得及分析)
  // 添加请求拦截器
  axios.interceptors.request.use(function (config) {
      // 在发送请求之前做些什么
      return config;
   }, function (error) {
      // 对请求错误做些什么
      return Promise.reject(error);
  });

  // 添加响应拦截器
  axios.interceptors.response.use(function (response) {
      // 对响应数据做点什么
      return response;
  }, function (error) {
      // 对响应错误做点什么
      return Promise.reject(error);
  });

上一篇下一篇

猜你喜欢

热点阅读