使用 axios 实现 ajax 方案

来源：互联网发布：js 动态修改url参数编辑：程序博客网时间：2024/06/16 14:47

使用 axios 实现 ajax 方案

vue.js 自2.0版本已经不对 vue-resource 更新了，官方推荐使用 axios 解决方案。axios 使用了 Promise,而 jquery 自3.0 版本才支持 Promise,如果你只是想使用 jquery 的 ajax 的话，引入整个 jquery 是很大的负担，所以 axios 是一个很好的工具。

知识点：
1.webpack
2.ES6
3.babel
4.node npm
5.eslint
6.axios
7.DOS基本命令

注意：需要使用 node环境，请先安装node,并学习 npm 的使用方法。

为了熟练操作，该文章中会使用一些DOS命令，很多人觉得window比linux方便，但是当你用习惯了linux命令的话，操作确实比window方便很多。

开始

创建项目目录

打开 DOS，切换到一个目录下，使用:
md axiosTest

建立空文件夹, 然后使用模糊匹配切换到创建的目录：
cd axios*

使用 npm init 创建 package.json 文件：

项目文件

创建 webpack.config.js 文件：
webpack.config.js:

module.exports = {    entry: {        page1: './main'    },    output: {        path: __dirname + '/build',        filename: '[name].bundle.js'    },    module: {        loaders:[            {                test: /\.js$/,                loaders: ['babel-loader', 'eslint-loader'],                exclude: '/node_modules'  /*排除该文件夹*/            }        ]    }}

同目录下建立 main.js:

import app from './app';

同目录建立 app.js:

import axios from 'axios';//请求前拦截axios.interceptors.request.use((config) => {    console.log("请求前拦截！");    return config;}, (err) => {    return Promise.reject(err);});//发送一个 get 请求axios.get('package.json')    .then( (res) => {        console.log(res);    })    .catch( (err) => {        console.log(err);    });

同目录建立 index.html:

<html><head>    <title>axios</title>    <meta name="charset" content="utf8">    <script type="text/javascript" src="./build/page1.bundle.js"></script></head><body></body></html>

因为使用了 eslint, 所以编写配置文件，同目录建立 .eslintrc:

{    "parser": 'babel-eslint',    "rules": {        // allow paren-less arrow functions    'arrow-parens': 0,    // allow async-await    'generator-star-spacing': 0,    // http://eslint.org/docs/rules/comma-dangle    'comma-dangle': ['error', 'only-multiline'],    'semi': 0,    'eol-last': 2    }}

安装必要模块

使用 npm install --save-dev XXX 安装以下模块：

webpack
webpack-dev-server
babel-core
babel-esling
babel-loader
babel-preset-es2015
babel-preset-stage-2
eslint
eslint-loader
axios
可以看到我们的 package.json 中已经有了安装的模块，继续在 scripts中添加我们的编译和启动静态服务器的命令：
package.json:

 {  "name": "axios_test",  "version": "1.0.0",  "description": "axios test",  "main": "index.js",  "scripts": {    "server": "webpack --progress --colors && webpack-dev-server --hot --watch --port 8086"  },  "keywords": [    "axios"  ],  "author": "zhao",  "license": "MIT",  "devDependencies": {    "axios": "^0.16.1",    "babel-core": "^6.24.1",    "babel-eslint": "^7.2.2",    "babel-loader": "^6.4.1",    "babel-preset-es2015": "^6.24.1",    "babel-preset-stage-2": "^6.24.1",    "eslint": "^3.19.0",    "eslint-loader": "^1.7.1",    "webpack": "^2.4.1",    "webpack-dev-server": "^2.4.2"  }}

运行

在 DOS 中对应工程目录下输入：
npm run server

项目开始编译及启动服务器：

npm run server

在浏览器输入：
http://localhost:8086/

可以看到运行结果：

好了，上述只是用综合的知识搭建了一个基本框架，下面详细讲述 axios 的内容。

原文

axios

基于http客户端的promise，面向浏览器和nodejs

特色

浏览器端发起XMLHttpRequests请求
node端发起http请求
支持Promise API
监听请求和返回
转化请求和返回
取消请求
自动转化json数据
客户端支持抵御

可以看到比 jquery 的 ajax 强多了！

示例

get 请求：

//发起一个user请求，参数为给定的IDaxios.get('/user?ID=1234').then(function(respone){    console.log(response);}).catch(function(error){    console.log(error);});//上面的请求也可选择下面的方式来写axios.get('/user',{    params:{        ID:12345    }})    .then(function(response){        console.log(response);    })    .catch(function(error){        console.log(error)    });

post 请求：

axios.post('/user',{    firstName:'friend',    lastName:'Flintstone'}).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([getUerAccount(),getUserPermissions()])    .then(axios.spread(function(acc,pers){        //两个请求现在都完成    }));

axios API
axios(config)

//发起 POST请求axios({    method:'post',    url:'/user/12345',    data:{        firstName:'Fred',        lastName:'Flintstone'    }});

axios(url[,config])

//发起一个GET请求axios('/user/12345/);

为了方便，axios提供了所有请求方法的重命名支持

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 , method ,以及 data 特性不需要在config中设置。

并发 Concurrency

有用的方法

axios.all(iterable)

axios.spread(callback)

创建一个实例

你可以使用自定义设置创建一个新的实例

axios.create([config])

var instance = axios.create({    baseURL:'http://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#post(url[,data[,config]])

axios#put(url[,data[,config]])

axios#patch(url[,data[,config]])

请求设置
以下列出了一些请求时的设置。只有 url 是必须的，如果没有指明的话，默认的请求方法是 GET .

{    //`url`是服务器链接，用来请求用    url:'/user',    //`method`是发起请求时的请求方法    method:`get`,    //`baseURL`如果`url`不是绝对地址，那么将会加在其前面。    //当axios使用相对地址时这个设置非常方便    //在其实例中的方法    baseURL:'http://some-domain.com/api/',    //`transformRequest`允许请求的数据在传到服务器之前进行转化。    //这个只适用于`PUT`,`GET`,`PATCH`方法。    //数组中的最后一个函数必须返回一个字符串，一个`ArrayBuffer`,或者`Stream`    transformRequest:[function(data){        //依自己的需求对请求数据进行处理        return data;    }],    //`transformResponse`允许返回的数据传入then/catch之前进行处理    transformResponse:[function(data){        //依需要对数据进行处理        return data;    }],    //`headers`是自定义的要被发送的头信息    headers:{'X-Requested-with':'XMLHttpRequest'},    //`params`是请求连接中的请求参数，必须是一个纯对象，或者URLSearchParams对象    params:{        ID:12345    },    //`paramsSerializer`是一个可选的函数，是用来序列化参数    //例如：（https://ww.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`定义请求的时间，单位是毫秒。    //如果请求的时间超过这个设定时间，请求将会停止。    timeout:1000,    //`withCredentials`表明是否跨域请求，    //应该是用证书    withCredentials:false //默认值    //`adapter`适配器，允许自定义处理请求，这会使测试更简单。    //返回一个promise，并且提供验证返回（查看[response docs](#response-api)）    adapter:function(config){        /*...*/    },    //`auth`表明HTTP基础的认证应该被使用，并且提供证书。    //这个会设置一个`authorization` 头（header），并且覆盖你在header设置的Authorization头信息。    auth:{        username:'janedoe',        password:'s00pers3cret'    },    //`responsetype`表明服务器返回的数据类型，这些类型的设置应该是    //'arraybuffer','blob','document','json','text',stream'    responsetype:'json',    //`xsrfHeaderName` 是http头（header）的名字，并且该头携带xsrf的值    xrsfHeadername:'X-XSRF-TOKEN'，//默认值    //`onUploadProgress`允许处理上传过程的事件    onUploadProgress: function(progressEvent){        //本地过程事件发生时想做的事    },    //`onDownloadProgress`允许处理下载过程的事件    onDownloadProgress: function(progressEvent){        //下载过程中想做的事    },    //`maxContentLength` 定义http返回内容的最大容量    maxContentLength: 2000,    //`validateStatus` 定义promise的resolve和reject。    //http返回状态码，如果`validateStatus`返回true（或者设置成null/undefined），promise将会接受；其他的promise将会拒绝。    validateStatus: function(status){        return status >= 200 && stauts < 300;//默认    },    //`httpAgent` 和 `httpsAgent`当产生一个http或者https请求时分别定义一个自定义的代理，在nodejs中。    //这个允许设置一些选选个，像是`keepAlive`--这个在默认中是没有开启的。    httpAgent: new http.Agent({keepAlive:treu}),    httpsAgent: new https.Agent({keepAlive:true}),    //`proxy`定义服务器的主机名字和端口号。    //`auth`表明HTTP基本认证应该跟`proxy`相连接，并且提供证书。    //这个将设置一个'Proxy-Authorization'头(header)，覆盖原先自定义的。    proxy:{        host:127.0.0.1,        port:9000,        auth:{            username:'cdd',            password:'123456'        }    },    //`cancelTaken` 定义一个取消，能够用来取消请求    //（查看 下面的Cancellation 的详细部分）    cancelToke: new CancelToken(function(cancel){    })}

返回响应概要 Response Schema
一个请求的返回包含以下信息

{    //`data`是服务器的提供的回复（相对于请求）    data{},    //`status`是服务器返回的http状态码    status:200,    //`statusText`是服务器返回的http状态信息    statusText: 'ok',    //`headers`是服务器返回中携带的headers    headers:{},    //`config`是对axios进行的设置，目的是为了请求（request）    config:{}}

使用 then ，你会得到下面的信息

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

使用 catch 时，或者传入一个 reject callback 作为 then 的第二个参数，那么返回的错误信息将能够被使用。

默认设置（Config Default)
你可以设置一个默认的设置，这设置将在所有的请求中有效。

全局默认设置 Global axios defaults

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';

实例中自定义默认值 Custom instance default

//当创建一个实例时进行默认设置var instance = axios.create({    baseURL:'https://api.example.com'});//在实例创建之后改变默认值instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

设置优先级 Config order of precedence
设置(config)将按照优先顺序整合起来。首先的是在 lib/defaults.js 中定义的默认设置，其次是 defaults 实例属性的设置，最后是请求中 config 参数的设置。越往后面的等级越高，会覆盖前面的设置。

看下面这个例子：

//使用默认库的设置创建一个实例，//这个实例中，使用的是默认库的timeout设置，默认值是0。var instance = axios.create();//覆盖默认库中timeout的默认值//此时，所有的请求的timeout时间是2.5秒instance.defaults.timeout = 2500;//覆盖该次请求中timeout的值，这个值设置的时间更长一些instance.get('/longRequest',{    timeout:5000});

拦截器 interceptors
你可以在请求或者返回被 then 或者 catch 处理之前对他们进行拦截。

//添加一个请求拦截器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);});

如果你需要在稍后移除拦截器,你可以:

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

你可以在一个axios实例中使用拦截器

var instance = axios.create();instance.interceptors.request.use(function(){/*...*/});

错误处理 Handling Errors

axios.get('user/12345')    .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('Error',error.message);        }        console.log(error.config);    });

你可以使用 validateStatus 设置选项自定义HTTP状态码的错误范围。

axios.get('user/12345',{    validateStatus:function(status){        return status < 500;//当返回码小于等于500时视为错误    }});

取消 Cancellation
你可以使用 cancel token 取消一个请求

axios的cancel token API是基于cnacelable promises proposal，其目前处于第一阶段。

你可以使用 CancelToke.source 工厂函数创建一个cancel token，如下：

var CancelToke = axios.CancelToken;var source = CancelToken.source();axios.get('/user/12345', {    cancelToken:source.toke}).catch(function(thrown){    if(axiso.isCancel(thrown)){        console.log('Rquest canceled', thrown.message);    }else{        //handle error    }});//取消请求(信息参数设可设置的)source.cancel("操作被用户取消");

你可以给 CancelToken 构造函数传递一个executor function来创建一个cancel token:

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

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

使用 application/x-www-form-urlencoded 格式化
默认情况下，axios串联js对象为 JSON 格式。为了发送 application/x-wwww-form-urlencoded 格式数据，

你可以使用一下的设置。

浏览器 Browser
在浏览器中你可以如下使用 URLSearchParams API:

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

注意： URLSearchParams 不支持所有的浏览器，但是这里有个垫片

（poly fill）可用（确保垫片在浏览器全局环境中）

其他方法：你可以使用 qs 库来格式化数据。

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

Node.js
在nodejs中，你可以如下使用 querystring :

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

你同样可以使用 qs 库。

promises

axios 基于原生的ES6 Promise 实现。如果环境不支持请使用垫片 .

0 1