摘要：由服务器提供的响应来自服务器响应的状态码来自服务器响应的状态信息服务器响应的头是为请求提供的配置信息所以请求返回后，我们可以通过来获取响应情况。拦截器拦截器拦截器用于拦截发起的请求或用于拦截返回的响应。

目录

• 上节内容回顾
• 使用第三方组件库
• 如何发起请求
  • 请求错误处理
  • 请求带参
    • 以get的方式带参：
    • 以post的方式带参：
  • 封装处理
    • 请求的配置
    • axios实例
  • 实现调用自定义函数来发起请求
    • 抽取axios请求到函数
    • 抽取函数到js文件
    • 抽取axios对象到js文件
  • 响应的数据
  • 拦截器
    • 拦截请求
    • 拦截响应
  • 补充：

首发日期：2019-01-29
作者：http://www.cnblogs.com/progor/

修改：
2019-02-11：发现发起请求的封装中的export default 写错了，是export，在后面的代码是使用了export ，但有一个地方使用了export default
------------

上节内容回顾

• npm(介绍，安装，命令)
• 基于npm的Hello World（学会如何初始化一个vue项目，并启动项目）
• 项目结构分析（重点是src目录）
• 用法迁移（根实例怎么创建，页面是怎么渲染的，组件怎么注册，）
• 小提醒（语法注意，和‘@’）
• 单文件组件
• 路由（开启路由，定义路由，带参路由，使用路由（router-link，router-view），嵌套路由，嵌套路由，命名路由，编程式路由，）
• vuex(actioins,mutaions,state,怎么创建store,怎么读取数据，怎么修改数据)

使用第三方组件库

网上有很多vue的第三方组件库，为了简化开发，我们通常都会使用第三方的组件库。

下面以导入element UI 组件库为例：
首先，安装element UI模块，并把依赖添加到package.json中：
npm install element-ui --save

然后，如果你是要在整个项目中都用到element UI的话，那就在main.js中添加下列代码，这样就可以在所有的组件中使用elmenent UI中的所有组件了：

import ElementUI from "element-ui"
import "element-ui/lib/theme-chalk/index.css"
Vue.use(ElementUI)

如果你仅仅想使用某个组件的话，可以仅仅在某个组件中使用import来导入element UI的组件。

如何发起请求

我们搭建了一个页面后，通常都希望从后端接口获取数据来渲染页面。现在推荐的发起请求的方式是使用axios来发起请求。

首先，我们要安装axios
npm install axios

然后在组件中使用axios来发请求：

上面只演示了axios.get，类似的，还有axios.post,axios.put等等请求方法。

请求错误处理

如果请求失败了，那么不会跳到then，而是交给catch来处理,catch里面的第一个参数就是错误信息：

axios
  .get("https://api.coindesk.com/v1/bpi/currentprice.json")
  .then(response => (this.info = response.data.bpi))
  .catch(error => console.log(error))

请求带参

以get的方式带参：

      axios.get("https://api.coindesk.com/v1/bpi/currentprice.json",{params: {ID: 12345}})
           .then(response => {
              this.msg = response
            })

以post的方式带参：

      axios.post("/user", {firstName: "Fred", lastName: "Flintstone"})
        .then((response) => {
          console.log(response)
        })
        .catch((error) => {
          console.log(error)
        })

封装处理

在上面的例子中，我们可以看到如果我们想要发送请求，将要在axios.xxx()的参数中写很长的代码。该怎么优化呢？

请求的配置

其实也可以使用axios()来发起请求，axios里面的参数是关于请求的配置，例如：

      var request = {
        method: "post",
        url: "/user",
        data: {firstName: "Fred", lastName: "Flintstone"}
      }
      axios(request).then(response => (this.msg = response))
        .catch(error => {
          console.log(error)
        })

贴一下可以设置的配置：

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

axios实例

虽然使用了配置之后不用把参数都写在axios.xxx()里面了，但是这样好像每一次都要定义一个关于请求参数的配置。有些数据我是不想重新定义的，能不能再优化呢？我们可以使用axios实例提前来读取一部分共用配置，然后后续再传入的配置的会与先前的配置进行合并。
【下面以提前配置baseUrl，后面的配置传入url为例，如果最终的请求是baseurl和url的拼接结果(通过监听浏览器网络请求得到)，那么就说明配置合并成功】

      var instance = axios.create({
        baseURL: "https://www.baidu.com"
      })
      var request = {
        method: "get",
        url: "/s",
        params: {wd: "vue"}
      }
      // 当传入了url参数的时候，才会发起请求，所以虽然都是传配置，但上面的那个并没有发起请求
      instance(request)
        .then(response => {
          console.log(response)
        })
        .catch(error => {
          console.log(error)
        })

实现调用自定义函数来发起请求

像上面，我们都是直接调用axios来发起请求的，这可能会导致一些问题，例如在多个组件中都需要发起针对同一个url的请求的时候，如果按照上面直接axios来发起请求的话，那么就会造成代码冗余（想象一下，针对同一个url请求，却要在不同组件中都写一个axios.xxx）。为了减少代码冗余，我们通常都会进行代码抽取，我们把重复的代码都抽取到函数中。

抽取axios请求到函数

上面的例子只是用作演示如何把发起请求的代码抽取到函数中。事实上，上面的抽取并没有完全抽取干净，另一个组件中发起请求时，也要重新定义函数。所以我们要想办法把上面的函数抽取到一个js文件中，抽取到js文件后，我们就可以通过import来导入了。

抽取函数到js文件

首先， 在src下，我们新建一个文件夹api，在api下，我们创建一个index.js【由于一般会有很多个api请求，为了分文件管理api，我们通常会根据api的功能来把发起请求的函数划分到不同的文件中,所以我们可能有时候会创建类似user.js这样命名的文件来存储发起请求的函数。这里由于用于演示，所以命名为index.js】


然后，在index.js中添加下列代码：

import axios from "axios"

const request = axios.create({
  baseURL: "http://www.xxxx.com"
})

export function getUserList (params) {
  return request({
    url: "/getuserlist",
    method: "get",
    params: params
  })
}

// 可以有多个export function xxxx

最后，在组件中导入getUserList这个函数，并发起请求：

抽取axios对象到js文件

【如果你有留心的话，你应该感觉到上面的axios对象应该也要进行抽取，因为如果有个js文件的话，会导致创建axios对象的这部分代码赘余了，我们可以把这部分的代码抽取到src/plugin/axios的index.js中】

import axios from "axios"

const request = axios.create({
  baseURL: "http://www.xxxx.com"
})
export default request // 记得导出

不要忘了，api中也要对应修改：

响应的数据

请求响应后，响应的数据都会封装到response中，其中response.data是服务器返回的响应信息，response.status是响应码，具体如下。

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

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

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

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

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

所以请求返回后，我们可以通过response.xxx来获取响应情况。

拦截器

• 拦截器用于拦截发起的请求或用于拦截返回的响应。
• 为什么需要拦截器呢？例如，假如某个请求需要带指定的请求头才能请求成功，我们必须要处理一下请求的信息才能够请求成功，这时候我们就可以把请求交给拦截器去处理，使用拦截器来加上请求头是很常见的操作。【加请求头其实我们也可以手动做，为什么要交给拦截器呢？因为拦截器是拦截所有请求，它能给每一个请求都加上头，如果交给我们自己做，那就很累了。】
• 所以，拦截器可以拦截发起的请求来添加我们需要的数据；拦截器也可以拦截返回的响应，来过滤响应（比如服务器返回的只有一个状态码，那么拦截器可以根据状态码来确认“错误信息”，其实catch(error)中error的原生数据是比较不友好的，所以我们通常都会使用拦截器来“翻译”返回的响应）。

拦截请求

拦截器是基于axios实例来添加的。我们可以使用如下代码来添加一个请求拦截器：

const request = axios.create({
  baseURL: "https://www.xxxx.com"
})

request.interceptors.request.use((config) => { // config是请求的配置
// 这里写在发送请求之前做些什么，我们这里尝试加一个请求头
  config.headers["Access-Token"] = "123456"
  console.log("发起请求了")
  return config
}, (error) => {
// 这里写对请求错误做些什么
  return Promise.reject(error)
})

拦截响应

request.interceptors.response.use((response) => {
  // 对响应数据做点什么
  console.log("请求返回响应了" + response)
  return response
}, (error) => {
  // 对响应错误做点什么
  return Promise.reject(error)
})

补充：

• 如果想了解更多，可以查看axios的文档