>  기사  >  웹 프론트엔드  >  가장 완벽한 Axios 가이드

가장 완벽한 Axios 가이드

小云云
小云云원래의
2017-12-23 09:34:402589검색

axios는 브라우저 및 nodejs용 Promise를 기반으로 하는 HTTP 클라이언트입니다. 이 기사에서는 vuejs 작성자 You Yuxi의 발표로 vue-resource가 더 이상 유지되지 않으며 모든 사람이 사용하도록 권장합니다. axios를 시작으로 axios는 점점 더 많은 사람들에게 알려지고 있습니다. 원래는 인터넷에서 자세한 가이드를 찾고 싶었는데, 갑자기 Axios의 공식 문서 자체가 매우 상세하다는 걸 알게 됐어요! 따라서 모든 사람이 이러한 종류의 라이브러리를 배우는 것이 좋으며 공식 문서를 자세히 읽는 것이 가장 좋습니다. 저는 axios의 공식 문서를 대략적으로 번역했습니다. 이 글을 철저하게 이해하고 실천한다면 axios는 쉽게 될 것이라고 믿습니다! !

axios 소개

axios는 브라우저 및 nodejs를 위한 Promise 기반 HTTP 클라이언트입니다. 자체적으로 다음과 같은 특성을 갖습니다.


  • 브라우저에서 XMLHttpRequest 생성

  • node.js에서 http 요청 만들기

  • Promise API 지원

  • 요청 및 응답 차단

  • 요청 및 응답 데이터 변환

  • 요청 취소

  • JSON 데이터 자동 변환

  • CSRF/XSRF 방지를 위한 클라이언트 지원

브라우저 호환성

소개 방법:

$ npm install axios
$ cnpm install axios //taobao源
$ bower install axios
或者使用cdn:
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>



예:

Perform GET request

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

Perform POST request

axios.post(&#39;/user&#39;, {
firstName: &#39;Fred&#39;,
lastName: &#39;Flintstone&#39;
})
.then(function (response) {
console.log(response);
})
.catch(function (error) {
console.log(error);
});
function getUserAccount() {
return axios.get(&#39;/user/12345&#39;);
}
 
function getUserPermissions() {
return axios.get(&#39;/user/12345/permissions&#39;);
}
 
axios.all([getUserAccount(), getUserPermissions()])
.then(axios.spread(function (acct, perms) {
//两个请求现已完成
}));

Perform 다중 동시 요청

axio s API


예 요청이 이루어졌습니다. 관련 구성을 axios에 전달합니다.

axios(config)

// 发送一个 POST 请求
axios({
method: &#39;post&#39;,
url: &#39;/user/12345&#39;,
data: {
firstName: &#39;Fred&#39;,
lastName: &#39;Flintstone&#39;
}
});
// 发送一个 GET 请求 (GET请求是默认请求模式)
axios(&#39;/user/12345&#39;);

axios(url[, config])

요청 메서드 별칭

편의를 위해 지원되는 모든 요청 메서드에 별칭이 제공되었습니다.

  • axios.request(config)

  • axios.get(url[,config])

  • axios.delete(url[,config])

  • axios.head(url[,config ] ])

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

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

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

Note
별칭 메서드를 사용하는 경우 구성에서 url, 메서드 및 데이터 속성을 지정할 필요가 없습니다.

Concurrency

동시 요청을 처리하는 도우미 기능입니다.

  • axios.all(iterable)

  • axios.spread(콜백)

인스턴스 생성

사용자 정의 구성을 사용하여 axios의 새 인스턴스를 생성할 수 있습니다.

axios.create([config])

var instance = axios.create({
baseURL: &#39;https://some-domain.com/api/&#39;,
timeout: 1000,
headers: {&#39;X-Custom-Header&#39;: &#39;foobar&#39;}
});

사용 가능한 인스턴스 메소드는 아래와 같습니다. 지정된 구성이 인스턴스 구성과 병합됩니다. 인스턴스 메소드

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

구성 요청


이것들이 사용됩니다 요청에 사용 가능한 구성 옵션입니다. URL만 필수입니다. 메소드를 지정하지 않으면 요청은 기본적으로 GET으로 설정됩니다.

{
// `url`是将用于请求的服务器URL
url: &#39;/user&#39;,
 
// `method`是发出请求时使用的请求方法
method: &#39;get&#39;, // 默认
 
// `baseURL`将被添加到`url`前面,除非`url`是绝对的。
// 可以方便地为 axios 的实例设置`baseURL`,以便将相对 URL 传递给该实例的方法。
baseURL: &#39;https://some-domain.com/api/&#39;,
 
// `transformRequest`允许在请求数据发送到服务器之前对其进行更改
// 这只适用于请求方法&#39;PUT&#39;,&#39;POST&#39;和&#39;PATCH&#39;
// 数组中的最后一个函数必须返回一个字符串,一个 ArrayBuffer或一个 Stream
 
transformRequest: [function (data) {
// 做任何你想要的数据转换
 
return data;
}],
 
// `transformResponse`允许在 then / catch之前对响应数据进行更改
transformResponse: [function (data) {
// Do whatever you want to transform the data
 
return data;
}],
 
// `headers`是要发送的自定义 headers
headers: {&#39;X-Requested-With&#39;: &#39;XMLHttpRequest&#39;},
 
// `params`是要与请求一起发送的URL参数
// 必须是纯对象或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: &#39;brackets&#39;})
},
 
// `data`是要作为请求主体发送的数据
// 仅适用于请求方法“PUT”,“POST”和“PATCH”
// 当没有设置`transformRequest`时,必须是以下类型之一:
// - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams
// - Browser only: FormData, File, Blob
// - Node only: Stream
data: {
firstName: &#39;Fred&#39;
},
 
// `timeout`指定请求超时之前的毫秒数。
// 如果请求的时间超过&#39;timeout&#39;,请求将被中止。
timeout: 1000,
 
// `withCredentials`指示是否跨站点访问控制请求
// should be made using credentials
withCredentials: false, // default
 
// `adapter&#39;允许自定义处理请求,这使得测试更容易。
// 返回一个promise并提供一个有效的响应(参见[response docs](#response-api))
adapter: function (config) {
/* ... */
},
 
// `auth&#39;表示应该使用 HTTP 基本认证,并提供凭据。
// 这将设置一个`Authorization&#39;头,覆盖任何现有的`Authorization&#39;自定义头,使用`headers`设置。
auth: {
username: &#39;janedoe&#39;,
password: &#39;s00pers3cret&#39;
},
 
// “responseType”表示服务器将响应的数据类型
// 包括 &#39;arraybuffer&#39;, &#39;blob&#39;, &#39;document&#39;, &#39;json&#39;, &#39;text&#39;, &#39;stream&#39;
responseType: &#39;json&#39;, // default
 
//`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名称
xsrfCookieName: &#39;XSRF-TOKEN&#39;, // default
 
// `xsrfHeaderName`是携带xsrf令牌值的http头的名称
xsrfHeaderName: &#39;X-XSRF-TOKEN&#39;, // default
 
// `onUploadProgress`允许处理上传的进度事件
onUploadProgress: function (progressEvent) {
// 使用本地 progress 事件做任何你想要做的
},
 
// `onDownloadProgress`允许处理下载的进度事件
onDownloadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
 
// `maxContentLength`定义允许的http响应内容的最大大小
maxContentLength: 2000,
 
// `validateStatus`定义是否解析或拒绝给定的promise
// HTTP响应状态码。如果`validateStatus`返回`true`(或被设置为`null` promise将被解析;否则,promise将被
  // 拒绝。
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
 
// `maxRedirects`定义在node.js中要遵循的重定向的最大数量。
// 如果设置为0,则不会遵循重定向。
maxRedirects: 5, // 默认
 
// `httpAgent`和`httpsAgent`用于定义在node.js中分别执行http和https请求时使用的自定义代理。
// 允许配置类似`keepAlive`的选项,
// 默认情况下不启用。
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
 
// &#39;proxy&#39;定义代理服务器的主机名和端口
// `auth`表示HTTP Basic auth应该用于连接到代理,并提供credentials。
// 这将设置一个`Proxy-Authorization` header,覆盖任何使用`headers`设置的现有的`Proxy-Authorization` 自定义 headers。
proxy: {
host: &#39;127.0.0.1&#39;,
port: 9000,
auth: : {
username: &#39;mikeymike&#39;,
password: &#39;rapunz3l&#39;
}
},
 
// “cancelToken”指定可用于取消请求的取消令牌
// (see Cancellation section below for details)
cancelToken: new CancelToken(function (cancel) {
})
}
rrree

구성 기본값 then을 사용하면 다음과 같은 응답을 받게 됩니다.


모든 요청에 ​​적용될 구성 기본값을 지정할 수 있습니다.

글로벌 axios 기본값

axios.get(&#39;/user/12345&#39;)
.then(function(response) {
console.log(response.data);
console.log(response.status);
console.log(response.statusText);
console.log(response.headers);
console.log(response.config);
});
axios.defaults.baseURL = &#39;https://api.example.com&#39;;
axios.defaults.headers.common[&#39;Authorization&#39;] = AUTH_TOKEN;
axios.defaults.headers.post[&#39;Content-Type&#39;] = &#39;application/x-www-form-urlencoded&#39;;

사용자 정의 인스턴스 기본값

구성 우선 순위 순서

구성이 우선 순위 순서와 병합됩니다. 순서는 lib/defaults.js의 라이브러리 기본값, 인스턴스의 기본값 속성, 마지막으로 요청의 구성 매개변수입니다. 후자가 전자보다 우선합니다. 여기에 예가 있습니다.

//在创建实例时设置配置默认值
var instance = axios.create({
   baseURL:&#39;https://api.example.com&#39;
});
 
//在实例创建后改变默认值
instance.defaults.headers.common [&#39;Authorization&#39;] = AUTH_TOKEN;


Interceptors

요청이나 응답이 처리되기 전에 가로채거나

//使用库提供的配置默认值创建实例
//此时,超时配置值为`0`,这是库的默认值
var instance = axios.create();
 
//覆盖库的超时默认值
//现在所有请求将在超时前等待2.5秒
instance.defaults.timeout = 2500;
 
//覆盖此请求的超时,因为它知道需要很长时间
instance.get(&#39;/ longRequest&#39;,{
   timeout:5000
});
//添加请求拦截器
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);
   });

을 포착할 수 있습니다. Axios의 사용자 정의 인스턴스에 인터셉터를 추가할 수 있습니다. 나중에 인터셉터를 제거해야 할 수도 있습니다.

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


오류 처리

var instance = axios.create();
instance.interceptors.request.use(function () {/*...*/});
axios.get(&#39;/ user / 12345&#39;)
   .catch(function(error){
     if(error.response){
       //请求已发出,但服务器使用状态代码进行响应
       //落在2xx的范围之外
       console.log(error.response.data);
       console.log(error.response.status);
       console.log(error.response.headers);
     } else {
       //在设置触发错误的请求时发生了错误
       console.log(&#39;Error&#39;,error.message);
     }}
     console.log(error.config);
   });

제거 verifyStatus 구성 옵션을 사용하여 사용자 정의 HTTP 상태 코드 오류 범위를 정의할 수 있습니다.


취소 토큰을 사용하여 요청을 취소할 수 있습니다.

axios 취소 토큰 API는 취소 가능한 약속 제안을 기반으로 하며 현재 1단계에 있습니다.

다음과 같이 CancelToken.source 팩토리를 사용하여 취소 토큰을 생성할 수 있습니다.

axios.get(&#39;/ user / 12345&#39;,{
   validateStatus:function(status){
     return status < 500; //仅当状态代码大于或等于500时拒绝
   }}
})
var CancelToken = axios.CancelToken;
var source = CancelToken.source();
 
axios.get(&#39;/user/12345&#39;, {
cancelToken: source.token
}).catch(function(thrown) {
if (axios.isCancel(thrown)) {
console.log(&#39;Request canceled&#39;, thrown.message);
} else {
// 处理错误
}
});
 
//取消请求(消息参数是可选的)
source.cancel(&#39;操作被用户取消。&#39;);


참고: 동일한 취소 토큰을 사용하여 여러 요청을 취소할 수 있습니다.
Executor 함수를 CancelToken 생성자에 전달하여 취소 토큰을 생성할 수도 있습니다.

application/x-www-form-urlencoded 형식 사용


기본적으로 axios는 JavaScript 개체를 JSON으로 직렬화합니다. application/x-www-form-urlencoded 형식으로 데이터를 보내려면 다음 옵션 중 하나를 사용할 수 있습니다.

浏览器

在浏览器中,您可以使用URLSearchParams API,如下所示:

var params = new URLSearchParams();
params.append(&#39;param1&#39;, &#39;value1&#39;);
params.append(&#39;param2&#39;, &#39;value2&#39;);
axios.post(&#39;/foo&#39;, params);


或者,您可以使用qs库对数据进行编码:
请注意,所有浏览器都不支持URLSearchParams,但是有一个polyfill可用(确保polyfill全局环境)。

var qs = require(&#39;qs&#39;);
axios.post(&#39;/foo&#39;, qs.stringify({ &#39;bar&#39;: 123 });

在node.js中,可以使用querystring模块,如下所示:Node.js

var querystring = require(&#39;querystring&#39;);
axios.post(&#39;http://something.com/&#39;, querystring.stringify({ foo: &#39;bar&#39; });

Promise你也可以使用qs库。


axios 依赖本机要支持ES6 Promise实现。 如果您的环境不支持ES6 Promises,您可以使用polyfill。

TypeScript


axios包括TypeScript定义。

import axios from &#39;axios&#39;;
axios.get(&#39;/user?ID=12345&#39;);

axios在很大程度上受到Angular提供的$http服务的启发。 最终,axios努力提供一个在Angular外使用的独立的$http-like服务。

学完本文相信大家对axios更加深入了解了吧,赶紧收藏起来吧。

相关推荐:

vue配置axios的方法步骤示例

关于VueJs 搭建Axios接口请求工具分析

浅谈axios中的get,post方法介绍

위 내용은 가장 완벽한 Axios 가이드의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.