Vue官方推荐的网络通讯库再也不是vue-resource了,推荐使用axiosvue
npm:node
$ npm install axios
bower:jquery
$ bower install axios
Using cdn:ios
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
GET
请求git
// Make a request for a user with a given ID axios.get('/user?ID=12345') .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); }); // Optionally the request above could also be done as axios.get('/user', { params: { ID: 12345 } }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });
POST
请求github
axios.post('/user', { firstName: 'Fred', lastName: 'Flintstone' }) .then(function (response) { console.log(response); }) .catch(function (error) { console.log(error); });
同时执行多个请求ajax
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) { // Both requests are now complete }));
其实和其余的ajax库同样,基本用法都是差很少的。你们一看就知道怎么用。npm
能够直接经过config
来完成请求
axios(config)json
axios({ method: 'post', url: '/user/12345', data: { firstName: 'Fred', lastName: 'Flintstone' } });
axios(url, [config])axios
// Send a GET request (default method) axios('/user/12345');
下面是axios支持的全部请求方法别名,便于各类请求。
注:[...]
中的数据表示能够为空。url
是ajax请求地址;data
是提交的数据对象;config
是配置对象,全部ajax配置均可以在config
中实现。
下列接口用于处理并发请求(同时处理多个多个request)
能够用自定义的config建立一个axios实例
axios.create([config])
var instance = axios.create({ baseURL: 'https://some-domain.com/api/', timeout: 1000, headers: {'X-Custom-Header': 'foobar'} });
下面是实例的全部可用方法,方法中的config
会与axios实例中的config合并。(实例能够将一些通用的config先配置好)
重点来了,来看看Config。
下面列出了config的全部配置项,其中以后url
是必填的。当method
没有指定方法,默认为GET
。
{
// `url` is the server URL that will be used for the request // 用来向服务器发送请求的url url: '/user', // `method` is the request method to be used when making the request // 请求方法 method: 'get', // default // `baseURL` will be prepended to `url` unless `url` is absolute. // It can be convenient to set `baseURL` for an instance of axios to pass relative URLs // to methods of that instance. // 假如`url`不是绝对路径,那么向服务器发送请求的URL将是`baseURL + url` baseURL: 'https://some-domain.com/api/', // `transformRequest` allows changes to the request data before it is sent to the server // This is only applicable for request methods 'PUT', 'POST', and 'PATCH' // The last function in the array must return a string, an ArrayBuffer, or a Stream transformRequest: [function (data) { // Do whatever you want to transform the data return data; }], // `transformResponse` allows changes to the response data to be made before // it is passed to then/catch transformResponse: [function (data) { // Do whatever you want to transform the data return data; }], // `headers` are custom headers to be sent headers: {'X-Requested-With': 'XMLHttpRequest'}, // `params` are the URL parameters to be sent with the request // Must be a plain object or a URLSearchParams object params: { ID: 12345 }, // `paramsSerializer` is an optional function in charge of serializing `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` is the data to be sent as the request body // Only applicable for request methods 'PUT', 'POST', and 'PATCH' // When no `transformRequest` is set, must be of one of the following types: // - string, plain object, ArrayBuffer, ArrayBufferView, URLSearchParams // - Browser only: FormData, File, Blob // - Node only: Stream data: { firstName: 'Fred' }, // `timeout` specifies the number of milliseconds before the request times out. // If the request takes longer than `timeout`, the request will be aborted. timeout: 1000, // `withCredentials` indicates whether or not cross-site Access-Control requests // should be made using credentials withCredentials: false, // default // `adapter` allows custom handling of requests which makes testing easier. // Return a promise and supply a valid response (see [response docs](#response-api)). adapter: function (config) { /* ... */ }, // `auth` indicates that HTTP Basic auth should be used, and supplies credentials. // This will set an `Authorization` header, overwriting any existing // `Authorization` custom headers you have set using `headers`. auth: { username: 'janedoe', password: 's00pers3cret' }, // `responseType` indicates the type of data that the server will respond with // options are 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream' responseType: 'json', // default // `xsrfCookieName` is the name of the cookie to use as a value for xsrf token xsrfCookieName: 'XSRF-TOKEN', // default // `xsrfHeaderName` is the name of the http header that carries the xsrf token value xsrfHeaderName: 'X-XSRF-TOKEN', // default // `onUploadProgress` allows handling of progress events for uploads onUploadProgress: function (progressEvent) { // Do whatever you want with the native progress event }, // `onDownloadProgress` allows handling of progress events for downloads onDownloadProgress: function (progressEvent) { // Do whatever you want with the native progress event }, // `maxContentLength` defines the max size of the http response content allowed maxContentLength: 2000, // `validateStatus` defines whether to resolve or reject the promise for a given // HTTP response status code. If `validateStatus` returns `true` (or is set to `null` // or `undefined`), the promise will be resolved; otherwise, the promise will be // rejected. validateStatus: function (status) { return status >= 200 && status < 300; // default }, // `maxRedirects` defines the maximum number of redirects to follow in node.js. // If set to 0, no redirects will be followed. maxRedirects: 5, // default // `httpAgent` and `httpsAgent` define a custom agent to be used when performing http // and https requests, respectively, in node.js. This allows to configure options like // `keepAlive` that are not enabled by default. httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }), // 'proxy' defines the hostname and port of the proxy server // `auth` indicates that HTTP Basic auth should be used to connect to the proxy, and supplies credentials. // This will set an `Proxy-Authorization` header, overwriting any existing `Proxy-Authorization` custom headers you have set using `headers`. proxy: { host: '127.0.0.1', port: 9000, auth: : { username: 'mikeymike', password: 'rapunz3l' } }, // `cancelToken` specifies a cancel token that can be used to cancel the request // (see Cancellation section below for details) cancelToken: new CancelToken(function (cancel) { }) }
配置参数不少,咱们一个一个来了解它们
GET
方法url
不是绝对路径,如https://some-domain.com/api/v1/login?name=jack
,那么向服务器发送请求的URL将会是baseURL + url
。transformRequest
方法容许在请求发送到服务器以前修改该请求,此方法只适用于PUT
、POST
和PATCH
方法中。并且,此方法最后必须返回一个string、ArrayBuffer或者Stream。transformResponse
方法容许在数据传递到then/catch以前修改response
数据。此方法最后也要返回数据。params
是发送请求的查询参数对象,对象中的数据会被拼接成url?param1=value1¶m2=value2
。params
参数序列化器。data
是在发送POST
、PUT
或者PATCH
请求的数据对象。adapter
容许用户处理更易于测试的请求。返回一个Promise和一个有效的responseauth
代表提供凭证用于完成http的身份验证。这将会在headers中设置一个Authorization
受权信息。自定义Authorization
受权要设置在headers
中。arraybuffer
、blob
、document
、json
、text
、stream
这6个类型,默认是json
相似数据。validateStatus
定义了根据HTTP响应状态码决定是否接收或拒绝获取到的promise。若是 validateStatus
返回 true
(或设置为 null
或 undefined
),promise将被接收;不然,promise将被拒绝。maxRedirects
定义了在node.js中redirect的最大值,若是设置为0,则没有redirect。proxy
定义代理服务器的主机名和端口,auth
cancelToken
定义一个 cancel token
用于取消请求当咱们ajax获取数据成功后会返回一个response对象,它包含了如下内容:
{
// `data` is the response that was provided by the server data: {}, // `status` is the HTTP status code from the server response status: 200, // `statusText` is the HTTP status message from the server response statusText: 'OK', // `headers` the headers that the server responded with headers: {}, // `config` is the config that was provided to `axios` for the request config: {} }
response是经过promise的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); });
相对的,咱们有时也会出现ajax报错,此时就会到咱们的catch
中去捕获异常error
对象。