摘要：返回狀態(tài)碼，如果返回或者設(shè)置成，將會其他的將。一些錯誤是在設(shè)置請求時觸發(fā)的你可以使用設(shè)置選項自定義狀態(tài)碼的錯誤范圍。

版本:v0.18.0

0.18.0的版本更新有一段時間了，使用起來跟原先基本沒有什么變化。但是增加了一些功能，例如錯誤處理的辨別，于07-06-2018重新翻譯和校驗了該翻譯，更正了一些錯別字和表達不準的地方，但是難免仍有錯誤，歡迎指出。

由于工作需要，個人也包裝了一個簡易的跟axios風格一樣在小程序中使用的請求函數(shù)。方便一些使用類似vue寫法框架來開發(fā)小程序的人更方便的無縫橋接。
有需要的讀者可以觀看一下。 傳送門

關(guān)于Promise的一練習(xí)和訓(xùn)練，此處有一個比較好的集合。傳送門

基于Promise的http庫，適用于瀏覽器和node.js。

點擊查看原文

瀏覽器端發(fā)起XMLHttpRequests請求

node端發(fā)起http請求

支持Promise API

攔截請求和返回

轉(zhuǎn)化請求和返回（數(shù)據(jù)）

取消請求

自動轉(zhuǎn)化json數(shù)據(jù)

客戶端支持抵御XSRF（跨站請求偽造）

使用npm：

$ npm i axios

使用 bower

$ bower instal axios

使用cdn

發(fā)起一個GET請求

const axios = require("axios")

//發(fā)起一個user請求，參數(shù)為給定的ID
axios.get("/user?ID=12345")
.then(function(respone){
    console.log(response);
})
.catch(function(error){
    console.log(error);
});

//可配置的方式實現(xiàn)上面的代碼如下
axios.get("/user",{
    params:{
        ID:12345
    }
}).then(function(response){
        console.log(response);
  }).catch(function(error){
        console.log(error)
    });

注意：async/await是ECMAScript2017的語法，ie和一些老舊的瀏覽器不支持，請小心使用。
（譯者話：使用ts的話可以很容易的編譯和使用，也不需要任何墊片，目標編譯成es5即可）

發(fā)起一個POST請求

axios.post("/user",{
    firstName:"friend",
    lastName:"Flintstone"
})
.then(function(response){
    console.log(response);
})
.catch(function(error){
    console.log(error);
});

發(fā)起一個多重并發(fā)請求

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){
        //兩個請求現(xiàn)在都完成
    }));

譯者話：因為axios.all使用的是類似Primise.all的功能，所以如果其中有一個請求出現(xiàn)了錯誤那么就會停止請求，所以建議對于單個請求最好附加上處理的catch。

根據(jù)自己需求可以對axios傳遞一些的設(shè)置來生成請求（Request）。

axios(config)

//發(fā)起 POST請求

axios({
    method:"post",//方法
    url:"/user/12345",//地址
    data:{//參數(shù)
        firstName:"Fred",
        lastName:"Flintstone"
    }
});

//通過請求獲取遠程圖片
axios({
    method:"get",
    url:"http://bit.ly/2mTM3Ny",
    responseType:"stream"
})
    .then(function(response){
        response.data.pipe(fs.createWriteStream("ada_lovelace.jpg"))
    })

axios(url[,config])

//發(fā)起一個GET請求
axios("/user/12345/);

為了方便，axios提供了所有請求方法的別名支持

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,以及data屬性不必在config中明確指定（如上面示例的post方法請求）。

有用的方法

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

你可以使用自定義設(shè)置創(chuàng)建一個新的實例

axios.create([config])

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

下面列出了一些實例可用方法，具體的設(shè)置將在實例中應(yīng)用。

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

以下列出了一些請求時的設(shè)置選項。只有url是必須的，如果沒有指明method的話，默認的請求方法是GET.

{
    //`url`是服務(wù)器鏈接，用來請求
    url:"/user",

    //`method`是發(fā)起請求時的方法
    method:`get`,

    //`baseURL`如果`url`不是絕對地址，那么將會加在其前面。
    //可以很方便的對相對地址的axios實例設(shè)置`baseUrl`。
    baseURL:"http://some-domain.com/api/",

    //`transformRequest`允許請求的數(shù)據(jù)在發(fā)送至服務(wù)器之前進行轉(zhuǎn)化。
    //這個只適用于`PUT`,`POST`,`PATCH`方法。
    //數(shù)組中的最后一個函數(shù)必須返回一個字符串或者一個`ArrayBuffer`,或者`Stream`,`Buffer`實例,`ArrayBuffer`,`FormData`
    //此外你也可能需要設(shè)置下headers對象
    transformRequest:[function(data,headers){
        //依自己的需求對請求數(shù)據(jù)進行處理
        return data;
    }],

    //`transformResponse`允許對返回的數(shù)據(jù)傳入then/catch之前進行處理
    transformResponse:[function(data){
        //依需要對數(shù)據(jù)進行處理
        return data;
    }],

    //`headers`是自定義的要被發(fā)送的信息頭
    headers:{"X-Requested-with":"XMLHttpRequest"},

    //`params`是請求連接中的請求參數(shù)，必須是一個純對象，或者URLSearchParams對象
    params:{
        ID:12345
    },
    
    //`paramsSerializer`是一個可選的函數(shù)，用來控制和序列化參數(shù)
    //例如：（https://ww.npmjs.com/package/qs,http://api.jquery.com/jquery.param/)
    paramsSerializer: function(params){
        return Qs.stringify(params,{arrayFormat:"brackets"})
    },

    //`data`是請求時作為請求體的數(shù)據(jù)
    //只適用于應(yīng)用的"PUT","POST","PATCH"，請求方法
    //當沒有設(shè)置`transformRequest`時，必須是以下其中之一的類型（不可重復(fù)？）：
    //-string(字符串),plain object(純對象),ArrayBuffer,ArrayBufferView,URLSearchParams
    //-限瀏覽器：FormData(表格數(shù)據(jù)),File(文件數(shù)據(jù)),Blob
    //-限Node：Stream
    data:{
        firstName:"fred"
    },
    //`timeout`定義請求的時間，單位是毫秒。
    //如果請求的時間超過這個設(shè)定時間，請求將會停止。
    timeout:1000,
    
    //`withCredentials`表明跨跨域請求書否需要證明。
    withCredentials:false //默認值

    //`adapter`適配器，允許自定義處理請求，這會使測試更簡單。
    //返回一個promise，并且提供一個有效的相應(yīng)。（查看[response docs](#response-api)）
    adapter:function(config){
        /*...*/
    },

    //`auth`表明HTTP基礎(chǔ)的認證應(yīng)該被使用，并且提供證書。
    //這個會設(shè)置一個`authorization` 頭（header），并且覆蓋你在header設(shè)置的Authorization頭信息。
    auth:{
        username:"janedoe",
        password:"s00pers3cret"
    },

    //`responsetype`表明服務(wù)器返回的數(shù)據(jù)類型，這些類型的設(shè)置應(yīng)該是
    //"arraybuffer","blob","document","json","text",stream"
    responsetype:"json",

    //`responseEncoding`表明解析相應(yīng)的編碼方式。
    //**注意**會忽視responseType為stream或者客戶端的請求。
    responseEncoding:"utf8"http://默認值

    //`xsrfCookieName`時cookie做xsrf會話時的名字。
    xsrfCookieName:"XSRF-TOKEN",//默認值

    //`xsrfHeaderName` 是http頭（header）的名字，并且該頭攜帶xsrf的值
    xrsfHeadername:"X-XSRF-TOKEN"，//默認值

    //`onUploadProgress`允許處理上傳過程的進程事件
    onUploadProgress: function(progressEvent){
        //本地過程事件發(fā)生時想做的事
    },

    //`onDownloadProgress`允許處理下載過程的進程事件
    onDownloadProgress: function(progressEvent){
        //下載過程中想做的事
    },

    //`maxContentLength` 定義http返回內(nèi)容的最大字節(jié)容量
    maxContentLength: 2000,

    //`validateStatus` 定義promise的resolve和reject。
    //http返回狀態(tài)碼，如果`validateStatus`返回true（或者設(shè)置成null/undefined），promise將會resolve；其他的promise將reject。
    validateStatus: function(status){
        return status >= 200 && stauts < 300;//默認
    },

    //`maxRedirect`定義重導(dǎo)向到node.js中的最大數(shù)量。
    //如果值為0，那么沒有redirect。
    maxREdirects:5,//默認值

    //`socketPath`定義一個在node.js中使用的 `UNIX Socket`。
    //例如 `/var/run/docker.sock`發(fā)送請求到docker daemon。
    //`socketPath`和`proxy`只可定義其一。
    //如果都定義則只會使用`socketPath`。
    socketPath:null,//默認值

    //`httpAgent` 和 `httpsAgent`當產(chǎn)生一個http或者https請求時分別定義一個自定義的代理，在nodejs中。
    //這個允許設(shè)置一些選選個，像是`keepAlive`--這個在默認中是沒有開啟的。
    httpAgent: new http.Agent({keepAlive:treu}),
    httpsAgent: new https.Agent({keepAlive:true}),

    //`proxy`定義服務(wù)器的主機名字和端口號。
    //`auth`表明HTTP基本認證應(yīng)該跟`proxy`相連接，并且提供證書。
    //這個將設(shè)置一個"Proxy-Authorization"頭(header)，覆蓋原先自定義的。
    proxy:{
        host:127.0.0.1,
        port:9000,
        auth:{
            username:"cdd",
            password:"123456"
        }
    },

    //`cancelTaken` 定義一個取消，能夠用來取消請求
    //（查看 下面的Cancellation 的詳細部分）
    cancelToken: new CancelToken(function(cancel){
    })
}

一個請求的返回包含以下信息

{
    //`data`是服務(wù)器的提供的回復(fù)（相對于請求）
    data{},

    //`status`是服務(wù)器返回的http狀態(tài)碼
    status:200,


    //`statusText`是服務(wù)器返回的http狀態(tài)信息
    statusText: "ok",

    //`headers`是服務(wù)器返回中攜帶的headers
    headers:{},

    //`config`是對axios進行的設(shè)置，目的是為了請求（request）
    config:{}

    //`request`是獲取當前相應(yīng)的請求
    //它是node.js中最后一次的 ClientRequest的實例（在redirect中）
    //或者是在瀏覽器中的XMLHttpREquest實例
}

使用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的第二個參數(shù)，那么返回的錯誤信息將能夠被處理。

你可以設(shè)置一個默認的設(shè)置，這設(shè)置將在之后的每次請求中生效。

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

//當創(chuàng)建一個實例時進行默認設(shè)置
var instance = axios.create({
    baseURL:"https://api.example.com"
});

//或者在實例創(chuàng)建之后改變默認值
instance.defaults.headers.common["Authorization"] = AUTH_TOKEN;

設(shè)置(config)將按照優(yōu)先順序合并起來。首先的是在lib/defaults.js中定義的默認設(shè)置，其次是defaults實例屬性的設(shè)置，最后是請求中config參數(shù)的設(shè)置。越往后面的等級越高，會覆蓋前面的設(shè)置。
看下面這個例子：

//使用默認庫的設(shè)置創(chuàng)建一個實例，
//這個實例中，使用的是默認庫的timeout設(shè)置，默認值是0。
var instance = axios.create();

//覆蓋默認庫中timeout的默認值
//此時，所有的請求的timeout時間是2.5秒
instance.defaults.timeout = 2500;

//覆蓋該次請求中timeout的值，這個值設(shè)置的時間更長一些
instance.get("/longRequest",{
    timeout:5000
});

你可以在請求或者返回被then或者catch處理之前對他們進行攔截。

//添加一個請求攔截器
axios.interceptors.request.use(function(config){
    //在請求發(fā)送之前做一些事
    return config;
},function(error){
    //當出現(xiàn)請求錯誤是做一些事
    return Promise.reject(error);
});

//添加一個返回攔截器
axios.interceptors.response.use(function(response){
    //對返回的數(shù)據(jù)進行一些處理
    return response;
},function(error){
    //對返回的錯誤進行一些處理
    return Promise.reject(error);
});

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

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

你可以在一個axios實例中使用攔截器

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

axios.get("user/12345")
    .catch(function(error){
        if(error.response){
            //存在請求，但是服務(wù)器的返回一個狀態(tài)碼
            //他們是在2xx之外
            console.log(error.response.data);
            console.log(error.response.status);
            console.log(error.response.headers);
        }else if(error.request){
          //如果是請求時的錯誤，且沒有收到相應(yīng)
          //`error.request`是一個瀏覽器的XMLHttpRequest實例，或者node.js的 ClientRequest實例。
          console.log(error.request)
        } 
        else{
            //一些錯誤是在設(shè)置請求時觸發(fā)的
            console.log("Error",error.message);
        }
        console.log(error.config);
    });

你可以使用validateStatus設(shè)置選項自定義HTTP狀態(tài)碼的錯誤范圍。

axios.get("user/12345",{
    validateStatus:function(status){
        return status < 500;//當返回碼小于等于500時視為錯誤
    }
});

你可以使用cancel token取消一個請求

axios的cancel token API是基于已經(jīng)撤銷的**cnacelable promises proposal**提議。

你可以使用CancelToken.source工廠函數(shù)創(chuàng)建一個cancel token，如下：

var CancelToken = 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
    }
});

//取消請求(信息參數(shù)設(shè)可設(shè)置的)
source.cancel("操作被用戶取消");

你可以給CancelToken構(gòu)造函數(shù)傳遞一個executor function來創(chuàng)建一個cancel token:

var CancelToken = axios.CancelToken;
var source = CancelToken.source()

axios.get("/user/12345",{
  cancelToke:source.token
}).catch(function(thrown){
  if(axios.isCancel(throw)){
    console.log("請求已取消",throw.message)
  }else{
    //處理錯誤
  }
})

axios.post("/user/2345",{
  name:"new name"
},{
  cancelToken:source.toke
})

source.cancel("錯做已被用戶取消！")

你也可以給CancelToke的構(gòu)造函數(shù)傳遞一個處理函數(shù)來生成一個cancel token。

const CancelToken = axios.CancelToken
let cancel;

acios.get("/user/12345",{
  cancelToken:new CancelToken(function excutor(c){
    //一個處理函數(shù)接受一個cancel函數(shù)作為參數(shù)
    cancel = c
  })
})

// 取消請求
cancel()

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

本人做的簡單包裝

默認情況下，axios串聯(lián)js對象為JSON格式。為了發(fā)送application/x-wwww-form-urlencoded格式數(shù)據(jù)，
你可以使用一下的設(shè)置。

在瀏覽器中你可以如下使用URLSearchParams API:

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

注意：URLSearchParams不支持所有的瀏覽器，但是這里有個墊片
（poly fill）可用（確保墊片在瀏覽器全局環(huán)境中）

其他方法：你可以使用qs庫來對數(shù)據(jù)編碼。

var 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-from-urlencoded"
  },
  data:qs.stringify(data),
  url
}
axios(options)

當axios放出1.0版本時，一些不兼容的更改將會放在新的版本中。例如0.5.1和0.5.4有相同的api，但是0.6.0會有不兼容的變化。

譯者：小知識
在npn的版本習(xí)慣中，版本使用的習(xí)慣是a.b.c,其中c的變化是一些bug的修復(fù)，b是一些功能的添加，a是大的版本的變化，會出現(xiàn)不兼容的情況。

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

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

你同樣可以使用qs庫。

axios 基于原生的ES6 Promise 實現(xiàn)。如果環(huán)境不支持請使用墊片.

axios 包含TypeScript定義

import axios from "axios"
axios.get("/user?ID=12345")