axios

冲冲冲引入方式

npm install axios
<!-- 或者使用cdn -->
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

执行GET请求

// 向具有指定ID的用户发出请求
axios.get('/user?ID=1235')
  .then(function (response) {
      console.log(response)
  })
  .catch(function (error) {
      console.log(error)
  })
  
  // 也可以通过params传递参数
  axios.get('/user' , {
      params: {
          ID: 1235
      }
  })
  .then(function (response) {
      console.log(response)
  })
  .then(function (error) {
      console.log(error)
  })

执行post请求

axios.post('/user', {
    username: 'asdf',
    password: '2332331'
})
.then(function (response) {
    console.log(response)
})
.catch( fucntion (error) {
    console.log(error)
})

执行多个并发请求

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) {
    // 现在两个请求都完成了
    }))

axios Api

可以通过将相关配置传递给axios来进行请求。将配置写在axios中 axios(config)

// 发送一个 POST 请求
axios({
    method: 'post',
    url: '/user/12345',
    data: {
        firstName: 'Xu',
        lastName: 'Yu'
    }
})

// GET 方法 获取远端图片
axios({
    method:'get',
    url:'http://bit.ly/2mTm3nY',
    responseType: 'stream'
})
    .then(function(response) {
    response.data.pipe(fs.createWriteStream('ada_lovelace.jpg'))
    })

axios(url[,config])
// 发送 GET 请求（默认方法）
axios('/user/12345')
// 上面的
axios.get('/user/12345',{
//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]])

注意
当使用别名方法时，不需要在config中指定url， method和data属性

并发
帮助函数处理并发请求

axios.all (iterable)
axios.spread (callback)

创建实例

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

const instance = axios.create({
    baseURL: 'https://some-domain.com/api/',
    timeout: 1000,
    headers: {'X-Custom—Header': 'foobar'}
})

实例方法

以下是可用的实例方法。指定的配置将于实例的配置合并

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]])

请求配置

这些是创建请求时可以用的配置选项。只有 url 是必须的。如果没有指定method ，请求时默认使用 GET

{
    // 'url' 是用于请求的服务器 URL
    url: '/user',
    // 'method' 是创建请求时使用的方法
    method: 'get',
    // baseURL 将自动加在url前面，除非 url 是一个绝对的URL
    baseURL: 'https://some-domain.com/api',
    
    // transformRequest 允许在向服务器发送前，修改请求数据
   // 只能用在 PUT, POST, PATCH 这几个请求方法
   // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer, 或 Stream
   transformRequest: [function (data, headers) {
   // 对data任意转换
   return data
   }],
    
    // headers 是即将被发送的自定义请求头
    headers: {'X-Requested-With':'XMLHttpRequest'}
    
    // params 是即将与请求一起发送的 URL 参数。加在url上
    // 必须是一个无格式对象(plain object) 或 URLSearchParmas对象
    params: {
        ID: 12345
    },
    
    //paramsSerializer 是一个负责 param 序列化的函数 stringify是使数组或者对象转变为json
    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,
    
    // widthCredentials 表示跨域请求时是否需要使用凭证
    widthCredentials: false, // default
    
    // adapter 允许自定义处理请求 ，以使测试更轻松
    // 返回一个 promise 并应用一个有效的响应
    adapter: function (config) {
        /*..*/
    },
    
     // `auth` 表示应该使用 HTTP 基础验证，并提供凭据
     // 这将设置一个 `Authorization` 头，覆写掉现有的任意使用 `headers` 设置的自定义 `Authorization`头
    auth: {
      username: 'janedoe',
      password: 's00pers3cret'
    },
    
    // responseType 表示服务器响应的数据类型
    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: {}
}

则使用then时，你将接受下面这样的响应

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

使用 catch 时，或传递 rejection callback 作为 then 的第二个参数时，响应可以通过 error对象可悲使用，正如错误处理这一节所讲

配置默认值

你可以指定将被用在各个请求的配置默认值

全局 axios 默认值

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'

自定义实例默认值

const instance = axios.create({
    baseURL: 'https://api.example.com'
})
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN

配置的优先顺序

配置会以一个优先顺序进行合并。这个顺序是: lib/defaults.js找到库的默认值 < 实例的defaults属性 <
请求的config后者优先于前者

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

//覆写库的超时默认值
instance.defaults.timeout = 2500

//在请求的config中修改覆盖timeout
instance.get('/longRequest', {
    timeout: 5000
})

拦截器

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

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

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

在稍后移除拦截器

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

自定义axios实例添加拦截器
const instance = axios.create()
instance.interceptors.request.use(function (){})

错误处理

axios.get('/user/12345')
  .catch(function (error) {
    if(error.response) {
        console.log(error.response.data)
        console.log(error.response.status)
        console.log(error.response.headers)
    } else if (error.request) {
        console.log(error.request)
    } else {
        console.log('Error', error.message)
    }
    console.log(error.config)
  })

也可以使用 validateStatus 配置选项定义一个自定义HTTP 状态码的错误范围
axios.get('/user/12345', {
    validateStatus: function (status) {
        return status < 500
    }
})

取消

使用cancel token 取消请求可以使用CancelToken.source工厂方法创建 cancel token。如下

const CancelToken = axios.CancelToken
const source = CancelToken.source()

axios.get('/user/12345', {
    cancelToken: source.token
}).catch( function(thrown) {
    if (axios.isCancel(thrown)) {
    console.log('Request canceled', thrown.messgae)
    }) else {
        // 处理错误
    }
})

axios.post('/user/12345', {
    name: 'new name'
},{
    cancelToken: source.token
})

source.cancel('Operation canceled by the user.')

还可以通过传递一个executor 函数到 CancelToken 的构造函数来创建 cancel token

const CancelToken = axios.CancelToken;
let cancel;

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

cancel();

注意：可以使用同一个cancel token 取消多个请求

使用 application/x-www-form-urlencoded format

默认情况下， axios将js对象序列化为json。要以application/x-www-form-urlencoded格式来发送数据，有以下两种选择
URLSearchParams API
qs库编码数据
一，使用URLSearchParams API

const params = new URLSearchParams()
params.append('param1', 'value1')
params.append('params', 'value2')
axios.post('/foo', params)

二，使用qs库编码数据

const qs = require('qs')
axios.post('/foo', qs.stringify({ 'bar': 123 }))

三，以ES6的方式

import qs from 'qs'
const data = {'bar': 123}
const options = {
    method: 'POST',
    headers: { 'content-type': 'application/x-www-form-urlencoded' },
    data: qs.stringif(data),
    url
}
axios(options)

← session，cookies和Token Git基本命令 →

# axios

# axios Api

# 请求方法的别名

# 创建实例

# 实例方法

# 请求配置

# 响应结构

# 配置默认值

# 全局 axios 默认值

# 自定义实例默认值

# 配置的优先顺序

# 拦截器

# 错误处理

# 取消

# 使用 application/x-www-form-urlencoded format