在vue中,axios是一個基於promise的HTTP庫,主要用於實現AJAX非同步通訊功能;axios可以在瀏覽器中發送XMLHttpRequests請求,可以在nodejs中發送http請求,也可以攔截請求和回應、轉換請求和回應資料。
本教學操作環境:windows7系統、vue2.9.6版,DELL G3電腦。
axios:前端通訊框架,因為vue的邊界很明確,就是為了處理DOM,所以並不具備通訊功能,此時就需要額外使用一個通訊框架與伺服器互動;當然也可以使用jQuery提供的AJAX通訊功能。
Axios是基於 promise 的 HTTP 函式庫,簡單的講就是可以傳送get、post請求。
說到get、post,大家應該第一時間想到的就是Jquery吧,畢竟前幾年Jquery比較火紅的時候,大家都在用他。但由於Vue、React等框架的出現,Jquery也不是那麼吃香了。也正是Vue、React等框架的出現,促使了Axios輕量級函式庫的出現,因為Vue等,不需要操作Dom,所以不需要引進Jquery.js了。
Axios特性
1、可以在瀏覽器中傳送XMLHttpRequests
2、可以在node.js 發送http 請求
3、支援Promise API
4、攔截請求和回應
5、轉換請求資料和回應資料
6、能夠取消請求
7 、自動轉換JSON 資料
8、客戶端支援保護安全性免受XSRF 攻擊
Axios用在什麼場景?
在功能裡面已經有提到,瀏覽器發送請求,或者Node.js發送請求都可以用到Axios。像是Vue、React、Node等專案就可以使用Axios,如果你的專案裡面用了Jquery,此時就不需要多此一舉了,jquery裡面本身就可以發送請求。
Axios如何使用?
安裝模組
npm install axios
或直接引入
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
引入模組後可以直接使用
範例(一)
// GET axios.get('/user', { params: { ID: 12345 } }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); // POST axios.post('/user', { name: 'Javan', website: 'www.javanx.cn' }) .then(function (response) { console.log(response); }) .catch(function (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 傳遞相關配置來建立請求,例如:
// POST axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' } });
語法
axios(url[, config])
config
{ // `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 實例,並且可以在請求或回應被then 或catch 處理前攔截它們。
// 如文件名叫http.js import axios from 'axios' // 创建实例时设置配置的默认值 var instance = axios.create({ baseURL: 'https://some-domain.com/api/', timeout: 1000, headers: {'X-Custom-Header': 'foobar'} }); // 添加请求拦截器 instance.interceptors.request.use(function (config) { // 在发送请求之前做些什么 /** 1、比如添加token之类的请求头信息 2、添加每次请求loading等 */ return config; }, function (error) { // 对请求错误做些什么 return Promise.reject(error); }); // 添加响应拦截器 instance.interceptors.response.use(function (response) { // 对响应数据做点什么 /** 1、集中处理响应数据(如错误码处理) */ return response; }, function (error) { // 对响应错误做点什么 return Promise.reject(error); }); export default instance
如何使用上面的http.js???
import http from 'xxx/http' http({ method: 'POST', url: '/user', data: { name: 'Javan', website: 'www.javanx.cn' } }).then((response) => { // 200响应 }, (err) => { // 500响应 })
#範例(四)
如何取消介面? ? ?
場景:一個搜尋框,每次輸入字元都會調用接口,這時候沒有辦法來知道那個接口資料放回是最後一次的,只能取消之前發起的相同接口,所以就有了取消接口。
var CancelToken = axios.CancelToken; var source = CancelToken.source(); axios.get('/user/12345', { cancelToken: source.token }).catch(function(thrown) { if (axios.isCancel(thrown)) { console.log('Request canceled', thrown.message); } else { // 处理错误 } }); // 取消请求(message 参数是可选的) source.cancel('Operation canceled by the user.');
總結
Axios可以說把請求這件事做到了極致,封裝的很好用,目前下載次數:4,784,599次,github star:60,584次。足矣說明開發者們還是很喜歡他的。瀏覽器支援方法,除了IE低版本以外,最新版的瀏覽器都是支援的。
以上是vue的axios是做什麼的的詳細內容。更多資訊請關注PHP中文網其他相關文章!