Axios 总结

1.基础说明

Axios 是一个基于 promise 的 HTTP 库，可以用在浏览器和 node.js 中。

1.1 特点

1. 创建 XMLHttpRequests
2. 从 node.js 创建 http 请求
3. 支持 Promise 语法
4. 拦截请求和响应
5. 转换 请求数据 和 响应数据
6. 自动转化 JSON 数据
7. 客户端支持防御 XSRF

1.2 安装

npm install -S axios

2.使用

Axios的使用方式有两种，

• 第一种是直接调用 axios 的 API，
• 第二种是先将 axios 实例化，使用 axios 的实例化方法
  • 实例有两个属性：defaults（可以很方便的设置config参数）、interceptors（拦截器）

2.1 Axios API

语法语法：

axios(config): 万能写法，config 基本可以配置一切，但是url、method、data 也不必全部在配置中指定。可有如下写法：

• axios(url[, config])（url写在config外面）
• axios.get(url[, config])（method写在config外面）
• axios.post(url[, data[, config]])（data写在config外面）

DEMO：

// 基础记忆写法：
const config = {....};
axios(config);

// 也可以这么写
axios({.....}）

2.2 Axios 实例化

DEMO：可以自定义 config

// 第1步：实例化对象，create中对公共的config进行了设置，如BaseURL,Timeout
var instance = axios.create({默认config设置});

// 第2步：使用实例化方法
instance.request(config)
instance.get(url[, config])
instance.delete(url[, config])
instance.head(url[, config])
instance.post(url[, data[, config]])
instance.put(url[, data[, config]])
instance.patch(url[, data[, config]])

2.3 并发事件处理

// API 方法处理
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.config

我们可以在三个地方对config进行配置：全局config配置、自定义配置(实例化时使用)、调用时配置

⚠️注意：配置会以一个优先顺序进行合并：写在后面的config会覆盖掉前面设置的config

常用配置 config 设置：

const config = {
    url: ‘’//请求的服务区URL
    method: // 请求方法
    baseURL: // baseURL 将自动加在 url 前面，除非 url 是一个绝对 URL。
    transformRequest: // 允许在向服务器发送前，修改请求数据
    transformResponse: // 在传递给 then/catch 前，允许修改响应数据
    headers: // 自定义请求头
    params: // 请求一起发送的 URL 参数
    data: // 发送的数据
    timeout:  // 如果请求话费了超过 timeout 的时间，请求将被中断
    withCredentials: false, // 表示跨域请求时是否需要使用凭证
    responseType: // 表示服务器响应的数据类型
    maxContentLength: // 定义允许的响应内容的最大尺寸
    validateStatus: // 根据 HTTP 响应状态码去设置resolve 或 reject 的条件（status >= 200，resolve）
    proxy: // 定义代理服务器的主机名称和端口
}

Default Config 设置：

当我们需要多次请求同一个 URL 时，如为了避免重复设置 BaseURL，可以设置 Config 的默认值

// 全局 axios 配置，此内容被存放在 lib/defaults.js
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";

// 利用实例化的方法：修改默认值
// 1.create()时设置config
var instance = axios.create({
  baseURL: "https://api.example.com",
});
// 2.create() 后设置config
// 在实例已创建后修改默认值
instance.defaults.headers.common["Authorization"] = AUTH_TOKEN;

// ========以上时设置Default config 配置=========
// 调用实例化方法时，又可以设置一次config
instance.get("/longRequest", {
  timeout: 5000,
});

完整 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 参数
  // 必须是一个无格式对象(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) {
  })
}

4.then[response 处理]

某个请求的响应包含以下信息

{
  // `data` 由服务器提供的响应
  data: {},

  // `status` 来自服务器响应的 HTTP 状态码
  status: 200,

  // `statusText` 来自服务器响应的 HTTP 状态信息
  statusText: 'OK',

  // `headers` 服务器响应的头
  headers: {},

  // `config` 是为请求提供的配置信息
  config: {}
}

使用 then 时，你将接收下面这样的响应：

axios.get('/user/12345')
  .then(function(response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

5.catch[error 处理]

axios.get("/user/12345").catch(function(error) {
  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", error.message);
  }
  console.log(error.config);
});

可以使用 validateStatus 配置选项定义一个自定义 HTTP 状态码的错误范围。

axios.get("/user/12345", {
  validateStatus: function(status) {
    return status < 500; // 状态码在大于或等于500时才会 reject
  },
});

6.拦截器

在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器
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);
  }
);

如果你想在稍后移除拦截器，可以这样：

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

可以为自定义 axios 实例添加拦截器

var instance = axios.create();
instance.interceptors.request.use(function() {
  /*...*/
});