axios

选择什么网络模块

传统的Ajax是基于XMLHttpRequest(XHR)
配置和调用方式等非常混乱.
真实开发中很少直接使用, 而是使用jQuery-Ajax。

Fetch API
Fetch是AJAX的替换方案，基于Promise设计，很好的进行了关注分离；
但是Fetch的缺点也很明显，首先需要明确的是Fetch是一个low-level的API，没有帮助你封装好各种各样的功能和实现；
比如发送网络请求需要自己来配置Header的Content-Type，不会默认携带cookie等；
比如错误处理相对麻烦（只有网络错误才会reject，http状态码404或500不会表示为reject）；
比如不支持取消一个请求，不能查看一个请求的进度等等；

在Vue的整个开发中都是不需要使用jQuery了。
完全没有必要为了用网络请求就引用这个重量级的框架。

axios功能特点

• 在浏览器中发送 XMLHttpRequests 请求
• 支持 Promise API
• 拦截请求和响应
• 转换请求和响应数据
• 在 node.js 中发送 http请求

支持多种请求方式

axios(config)
axios.request(config)
axios.get(url[, config])
axios.post(url[, data[, config]])
axios.delete(url[, config])
axios.head(url[, config])
axios.put(url[, data[, config]])
axios.patch(url[, data[, config]])

axios基本使用

axios({	
  // 默认get
  url:'http://123.207.32.32:8000/api/home/multidata',
  method:'get'
}).then(res=>{
  console.log(res);
})

axios({
  // url: "http://123.207.32.32:8000/api/home/data?type=sell&page=3",
  url: "http://123.207.32.32:8000/api/home/data",
  params:{
    type:'sell',
    page:3
  }
}).then((res) => {
  console.log(res);
}) 

axios发送并发请求

axios.all([]) 返回的是一个数组，可以放入多个请求的数组
axios.spread() 可以将数组展开

// 使用全局的配置和对应的网络请求
axios.defaults.baseURL = "http://123.207.32.32:8000";
axios.defaults.timeout=5000
axios.all([axios({
    url: "home/multidata",
  }),axios({
    url: "home/data",
    params: {
      type: "pop",
      page: 1,
    }
  })]).then(axios.spread((res1,res2)=>{
  console.log(res1);
  console.log(res2);
}))

创建axios实例

当我们从axios模块中导入对象时, 使用的实例是默认的实例。
当给该实例设置一些默认配置时, 这些配置就被固定下来了。
但是后续开发中, 某些配置可能会不太一样。
比如某些请求需要使用特定的baseURL或者timeout或者content-Type等。
这个时候, 我们就可以创建新的实例, 并且传入属于该实例的配置信息。

const instance = axios.create({
    baseURL: "http://123.207.32.32:8000",
    timeout: 5000,
  })
instance({
  url: "home/multidata"
}).then(res=>{
  console.log(res);
})

axios封装

export function request(config, success, failure) {
  const instance = axios.create({
    baseURL: "http://123.207.32.32:8000",
    timeout: 5000,
  });
  // 发送真正的网络请求
  instance(config)
    .then((res) => {
      success(res);
    })
    .catch((err) => {
      failure(err);
    });
}

// 使用
import{request} from "./network/request";
request({
	url:"/home/multidata"
},res=>{
	console.log(res);
},err=>{
	console.log(err);
})

export function request(config) {
  return new Promise((resolve, reject) => {
    // 创建axios实例
    const instance = axios.create({
      baseURL: "http://123.207.32.32:8000",
      timeout: 5000,
    });
    //发送真正的网络请求
    instance(config)
      .then((res) => {
        resolve(res);
      })
      .catch((err) => {
        reject(err);
      });
  });
}

最终封装

export function request(config) {
  const instance = axios.create({
    baseURL: "http://123.207.32.32:8000",
  })
  //发送真正的网络请求
  return instance(config)
}

使用

import {request} from "./request"
export function getHomeMultidata(){
  return request({
    url:'/home/multidata'
  })
}

getHomeMultidata(){
    getHomeMultidata().then(res=>{
    //console.log(res);
    // result在组件中，会一直存在，保存在data中
    //this.result=res;
    this.banners=res.data.data.banner.list;
    this.recommends=res.data.data.recommend.list;
  })
},

axios的配置信息

请求配置选项

{
   // `url` 是用于请求的服务器 URL，是必须传的
  url: '/user',

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

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

  // `transformRequest` 允许在向服务器发送前，修改请求数据
  // 只能用在 'PUT', 'POST' 和 'PATCH' 这几个请求方法
  // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
  transformRequest: [function (data, headers) {
    // 对 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, // default

  // `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', // default

  // `responseEncoding` indicates encoding to use for decoding responses
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

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

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

   // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `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; // default
  },

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

  // `socketPath` defines a UNIX Socket to be used in node.js.
  // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
  // Only either `socketPath` or `proxy` can be specified.
  // If both are specified, `socketPath` is used.
  socketPath: null, // default

  // `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) {
  })
}

响应结构信息

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

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

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

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

   // `config` 是为请求提供的配置信息
  config: {},
 // 'request'
  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance the browser
  request: {}
}

默认配置信息

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参数配置；
其次是实例的default的配置；
最后是创建实例时的配置；

拦截器的使用

请求的拦截器

比如config中的一些信息不符合服务器的请求；
比如每次发送网络请求时，都希望界面中显示一个请求的图标；
某些网络请求(比如登录token)，需要携带一些信息；

  instance.interceptors.request.use(config => {
  	// ...
    return config;
  }, err => {
  	// 没有发送成功
    console.log(err);
  })

响应的拦截器

响应拦截中可以对结果进行二次处理（比如服务器真正返回的数据其实是在response的data中）；
对于错误信息进行判断，根据不同的状态进行不同的处理;

  instance.interceptors.response.use(res => {
    return res
  }, err => {
    console.log(err);
  })