6.axios

视频教程使用的服务端是JSON Server

1.JSON server安装

官方地址：JSON Server

• 全局安装

npm install -g json-server

• 新建db.json文件

{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

• 在db.json所在文件夹，启动服务

json-server --watch db.json

Plural routes

GET    /posts			//所有文章
GET    /posts/1			//第一篇文章（靠db.json中的id索引）
POST   /posts			//新增内容
PUT    /posts/1			//	
PATCH  /posts/1
DELETE /posts/1

2、axios介绍与页面配置

Features

• Make XMLHttpRequests from the browser
• Make http requests from node.js
• Supports the Promise API
• Intercept(拦截) request and response
• Transform request and response data
• Cancel requests
• Automatic transforms for JSON data
• Client side support for protecting against XSRF

Installing

Using npm:（项目中常用）

$ npm install axios

Using bower:

$ bower install axios

Using yarn:（项目中常用）

$ yarn add axios

Using jsDelivr CDN:

<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>

Using unpkg CDN:

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

3.axios的基本使用

发送GET请求：

axios({
    //请求类型
    method:'GET',
    //URL
    url:'http://localhost:3000/posts/1',
}).then(response=>{
    console.log(response);
})

发送POST请求(添加)：

axios({
    //请求类型
    method:'POST',
   	//URL
    url:'http://localhost:3000/posts',
    //设置请求体
    data:{
         title:"张三",
         author:"张三"
  	}
}).then(response=>{
	console.log(response)
})

发送PUT请求（修改）：

axios({
	//请求类型
	method:'PUT',
	//URL
	url:'http://localhost:3000/posts/2',
	//设置请求体
	data:{
		title:"张三的世界",
		author:"张三"
	}
}).then(response=>{
	console.log(response)
})

发送DETELE请求（删除）：

axios({
	//请求类型
	method:'DELETE',
	//URL
	url:'http://localhost:3000/posts/2',
}).then(response=>{
	 console.log(response)
})

4.axios的其他方式发送请求

Instance methods 别名方法

The available instance methods are listed below. The specified config will be merged with the instance config.

• axios.request(config)

• axios.get(url[, config])

• axios.delete(url[, config])

• axios.head(url[, config])

• axios.options(url[, config])

• axios.post(url[, data[, config]])

• axios.put(url[, data[, config]])

• axios.patch(url[, data[, config]])

• axios.getUri([config])

并发

处理并发请求的助手函数

• axios.all(axios数组)

• axios.spread(callback)

<script>
  function getData1() {
    return axios.get('http://localhost:3000/posts?id=1');
  }

  function getData2() {
    return axios.get('http://localhost:3000/posts?id=2');
  }

  axios.all([getData1(), getData2()])
          .then(axios.spread((data1, data2) => {
            // 两个请求都完成后
              console.log(data1.data);
              console.log(data2.data);
          }));
</script>

axios.all方法接受一个数组作为参数，数组中的每个元素都是一个请求，返回一个promise对象，当数组中所有请求均已完成时，执行then方法。
在then方法中执行了 axios.spread 方法。该方法是接收一个函数作为参数，返回一个新的函数。接收的参数函数的参数是axios.all方法中每个请求返回的响应。
回到顶部

axios.request(config)发送GET请求(和axios()类似)

axios.requset({
    method:'GET',
    url;'http://localhost:3000/posts'
}).then(response=>{
    console.log(response)
})
// 发送 GET 请求（默认的方法）
axios('/user/12345');

3中的代码可以改写为：

<script>
    const btn = document.querySelectorAll('button')
    btn[0].onclick = function (){
        axios.get('http://localhost:3000/posts').then(response=>{
            console.log(response)
        })
    }
    btn[1].onclick = function () {
        axios.post('http://localhost:3000/posts', {title: "张三", author: "张三"}).then(response => {
            console.log(response)
        })
    }
    btn[2].onclick = function (){
        axios.put('http://localhost:3000/posts/2',{title:"张三的世界", author:"张三"}).then(response=>{
            console.log(response)
        })
    }
    btn[3].onclick = function (){
        axios.delete('http://localhost:3000/posts/2').then(response=>{
            console.log(response)
        })
    }
</script>

5.axios请求响应结果的结构

• config

• data

• headers

• request

• status

• statusText

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

6.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) {
  })
}

7.默认配置值

eg:

axios.defaults.method = 'GET'
axios.defaults.baseURL = 'http://localhost:3000'
axios.defaults.params = {id='100'}
axios.defaults.timeout = 1000

配置的优先顺序

配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

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

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

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

8.创建实例对象发送请求

可以使用自定义配置新建一个 axios 实例

axios.create([config])

const demo = axios.create({
  baseURL: 'http://localhost:3000',
  timeout: 1000,
  headers: {'X-Custom-Header': 'foobar'}
});
demo.get('/posts')..then(response=>{
	console.log(response.data)
})

9.axios拦截器

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

请求拦截器→请求→响应拦截器→响应.catch(error=>{…})

请求拦截器

config是请求配置的回调，在发送请求前可以对请求配置进行修改，

eg： config.timeout = 1000;

axios.interceptors.request.use((config)=>{
    //在发送请求之前做些什么
    ...
    return config;
},(error)=>{
    //对请求错误做些什么
    ...
    return Promise.reject(error);
})

响应拦截器

response是响应结果的回调，再响应结果输出前可以对响应结果进行处理；

eg：可以直接return response.data

axios.interceptors.response.use((response)=>{
    // 对响应数据做点什么
    return response;
  }, (error)=>{
    // 对响应错误做点什么
    return Promise.reject(error);
  });

移除拦截器：

把拦截器赋值给一变量，再通过axios.interceptors.request.eject(变量)来移除；

eg

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

10.取消请求

let cancel = null;

axios.get('/user/12345', {
  cancelToken: new axios.CancelToken(function (c) {
    //接收一个 cancel 函数作为参数
    cancel = c;
  })
}).then(response=>{
    ...
});

// cancel the request
cancel();