axios使用备忘录

$ npm install axios

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

// 为给定 ID 的 user 创建请求
axios.get('/user?ID=12345')
  .then(function (response) {
    console.log(response);
  })
  .catch( (error) {
    console.log(error);
  });

 可选地，上面的请求可以这样做
axios.get('/user',{
    params: {
      ID: 12345
    }
  })
  .then( (error) {
    console.log(error);
  });

axios.post('/user''Flintstone'
  })
  .then( (error) {
    console.log(error);
  });

 getUserAccount() {
  return axios.get('/user/12345');
}

 getUserPermissions() {
  return axios.get('/user/12345/permissions');
}

axios.all([getUserAccount(),getUserPermissions()])
  .then(axios.spread( (acct,perms) {
     两个请求现在都执行完成
  }));

 发送 POST 请求
axios({
  method: 'post''Fred'
  }
});

 发送 GET 请求（默认的方法）
axios('/user/12345');

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

{
   `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: [ (data) {
     对 data 进行任意转换处理

    return data;
  }],1)"> `transformResponse` 在传递给 then/catch 前，允许修改响应数据
  transformResponse: [ `headers` 是即将被发送的自定义请求头
  headers: {'X-Requested-With': 'XMLHttpRequest'},1)"> `params` 是即将与请求一起发送的 URL 参数
   必须是一个无格式对象(plain object)或 URLSearchParams 对象
  params: {
    ID: 12345
  },1)"> `paramsSerializer` 是一个负责 `params` 序列化的函数
   (e.g. https://www.npmjs.com/package/qs,http://api.jquery.com/jquery.param/)
  paramsSerializer: (params) {
    return Qs.stringify(params,{arrayFormat: 'brackets'})
  },1)"> `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,1)"> 默认的

   `adapter` 允许自定义处理请求，以使测试更轻松
   返回一个 promise 并应用一个有效的响应 (查阅 [response docs](#response-api)).
  adapter:  (config) {
    /* ... */ `auth` 表示应该使用 HTTP 基础验证，并提供凭据
   这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
  auth: {
    username: 'janedoe' `responseType` 表示服务器响应的数据类型，可以是 'arraybuffer','blob','document','json','text','stream'
  responseType: 'json',1)"> `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称
  xsrfCookieName: 'XSRF-TOKEN',1)"> default

   `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称
  xsrfHeaderName: 'X-XSRF-TOKEN',1)"> `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress:  (progressEvent) {
     对原生进度事件的处理
  },1)"> `onDownloadProgress` 允许为下载处理进度事件
  onDownloadProgress:  `maxContentLength` 定义允许的响应内容的最大尺寸
  maxContentLength: 2000 `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject  promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`)，promise 将被 resolve; 否则，promise 将被 rejecte
  validateStatus:  (status) {
    return status >= 200 && status < 300;  默认的
 `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目
   如果设置为0，将不会 follow 任何重定向
  maxRedirects: 5,1)"> `httpAgent` 和 `httpsAgent` 分别在 node.js 中用于定义在执行 http 和 https 时使用的自定义代理。允许像这样配置选项：
   `keepAlive` 默认没有启用
  httpAgent: new http.Agent({ keepAlive: true }),httpsAgent: new https.Agent({ keepAlive:  'proxy' 定义代理服务器的主机名称和端口
   `auth` 表示 HTTP 基础验证应当用于连接代理，并提供凭据
   这将会设置一个 `Proxy-Authorization` 头，覆写掉已有的通过使用 `header` 设置的自定义 `Proxy-Authorization` 头。
  proxy: {
    host: '127.0.0.1''mikeymike'
    }
  },1)"> `cancelToken` 指定用于取消请求的 cancel token
   （查看后面的 Cancellation 这节了解更多）
  cancelToken: new CancelToken( (cancel) {
  })
}

 `data` 由服务器提供的响应
  data: {},1)"> `status` 来自服务器响应的 HTTP 状态码
  status: 200 `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK' `headers` 服务器响应的头
  headers: {},1)"> `config` 是为请求提供的配置信息
  config: {}
}

axios.get('/user/12345'(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.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';

 创建实例时设置配置的默认值
 axios.create({
  baseURL: 'https://api.example.com'
});

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

 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
 axios.create();

 覆写库的超时默认值 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest'
});

 添加请求拦截器
axios.interceptors.request.use( 在发送请求之前做些什么
     config;
  },1)"> (error) {
     对请求错误做些什么
     Promise.reject(error);
  });

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

var myInterceptor = axios.interceptors.request.use(function () {...});
axios.interceptors.request.eject(myInterceptor);

 axios.create();
instance.interceptors.request.use(*/});

axios.get('/user/12345')
  .if (error.response) {
       请求已发出，但服务器响应的状态码不在 2xx 范围内
      console.log(error.response.data);
      console.log(error.response.status);
      console.log(error.response.headers);
    } else {
       Something happened in setting up the request that triggered an Error
      console.log('Error'
axios.get('/user/12345'return status < 500;  状态码在大于或等于500时才会 reject
  }
})

var CancelToken = axios.CancelToken;
var source = CancelToken.source();

axios.get('/user/12345'(thrown) {
   (axios.isCancel(thrown)) {
    console.log('Request canceled' {
     处理错误
  }
});

 取消请求（message 参数是可选的）
source.cancel('Operation canceled by the user.');

var cancel;

axios.get('/user/12345' executor(c) {
     executor 函数接收一个 cancel 函数作为参数
    cancel = c;
  })
});

 取消请求
cancel();