详细了解axios

Axios APIAxios API可以通过向 axios 传递相关配置来创建请求：axios(config)// 发送 POST 请求axios({method: 'post',url: '/user/12345',data: {firstName: 'Fred',lastName: 'Flintstone'...

沐风系大佬

171人浏览 · 2020-03-20 15:51:46

沐风系大佬 · 2020-03-20 15:51:46 发布

Axios API

		data: qs.stringify(params)等同于：
		transformRequest: [function (data) {
		 	let ret = ''
		 	for (let it in data) {
		 		ret += encodeURIComponent(it) + '=' + encodeURIComponent(data[it]) + '&'
		 	}
		 	return ret
		}],
		encodeURIComponent：对特殊字符编码

Axios API
可以通过向 axios 传递相关配置来创建请求：

	axios(config)
	// 发送 POST 请求
	axios({
	    method: 'post',
	    url: '/user/12345',
	    data: {
	        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])
	// 发送 GET 请求（默认的方法）
	axios('/user/12345');


	请求方法的别名
	为方便起见，为所有支持的请求方法提供了别名
	
	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 这些属性都不必在配置中指定。



	并发
	处理并发请求的助手函数：
	
	axios.all(iterable)
	axios.spread(callback)
	
	创建实例
	可以使用自定义配置创建一个 axios 实例
	
	axios.create([config])
	
	const instance = axios.create({
	    baseURL: 'https://some-domain.com/api/',
	    timeout: 1000,
	    headers: {'X-Custom-Header': 'foobar'}
	})
	注意：使用创建的 axios 实例请求时，请求的配置项将与实例的配置合并。

请求配置

{
    // url 是用于请求的服务器 URL
    url: '/user'

    // method 是创建请求时使用的方法
    method: 'get',    // default

    // baseURL 将自动加在 url 前面，除非 url 是一个绝对 URL
    // 它可以通过设置一个 baseURL 便于为 axios 实例的方法传递相对 URL
    baseURL: 'https://some-domain.com/api/',

    // transformRequest 允许在向服务器发送前，修改请求数据
    // 只能用在 PUT、POST 和 PATCH 这几个请求方法
    // 后面数组中的函数必须返回一个字符串，或 ArrayBuffer，或 Stream
    transformRequest: [function (data, headers) {
        // 对 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,    // default
    
    // 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',    // default

    // responseEncoding 表示对响应的编码
    // Note：对于 responseType 为 stream 或 客户端请求会忽略
    responseEncoding: 'utf-8',

    // xsrfCookieName 是用作 xsrf token 值的 cookie 名称
    xsrfCookieName: 'XSRF-TOKEN',    // default

    // xsrfHeaderName 是 xsrf token 值的 http 头名称
    xsrfHeaderName: 'X-XSRF-TOKEN',    // default
        
    // onUploadProgress 允许为上传处理进度事件
    onUploadProgress: function (progressEvent) {
        // ... ...
    },
    
    // onDownloadProgress 允许为下载处理进度事件
    onDownloadProgress: function (progressEvent) {
        // ... ...
    },

    // maxContentLength 定义允许的响应内容的最大尺寸
    maxContentLength: 2000,
    
    // validateStatus 定义对于给定的 HTTP 响应状态码是 resolve 或 reject promise。
    // 如果 validateStatus 返回 true (或者设置为 null 或 undefined)，promise 将被 resolve，否则 promise 将被 reject
    validateStatus: function (status) {
        return status >= 200 && status < 300;    // default
    },

    // maxRedirects 定义在 node.js 中 follow 的最大重定向数目
    // 如果设置为 0，将不会 follow 任何重定向
    maxRedirects: 5,

    // socketPath 用于在 node.js 中定义 UNIX Socket
    // e.g. '/var/run/docker.sock' to send requests to the docker daemon.
    // 只能指定 socketPath 或 proxy，如果两者同时指定，将使用 socketPath
    socketPath: null,

    // 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: 'rapunz31'
        }
    },

    // cancelToken 指定用于取消请求的 cancel token
    cancelToken: new CancelToken(function (cancel) {
        // ... ...
    })
}

全局axios默认配置

	axios.defaults.baseURL = 'http://api.example.com';
	axios.defaults.headers.common['Authorization'] = AUTH_TOKEN;
	axios.defaults.headers.post['Content-Type'] = 'application/x-www-form-urlencoded';

自定义实例默认值

	// 创建实例时设置配置默认值
	const instance = axios.create({
	    baseURL: 'https://api.example.com'
	});

	// 实例创建之后可修改默认配置
	instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置的优先顺序
配置会以一个优先顺序进行合并。这个顺序是：在 lib/defaults.js 找到的库的默认值，然后是实例的 defaults 属性，最后是请求的 config 参数。后者将优先于前者。这里是一个例子：

	// 使用由库提供的配置默认值来创建实例
	// 此时超时配置的默认值是 0
	const instance = axios.create();
	
	// 覆写库的超时默认值
	// 现在，在超时前，所有请求都会等待 2.5 秒
	instance.defaults.timeout = 2500;
	
	// 为已知需要花费很长时间的请求覆写超时设置
	instance.get('/longRequest', {
	    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);
	    }
	);

如果你想在稍后移除拦截器，可以这样：



	const myInterceptor = axios.interceptors.request.use(function () { /* ... */ });
	axios.interceptors.request.eject(myInterceptor);
	
	
	可以为自定义 axios 实例添加拦截器：
	
	const instance = axios.create();
	instance.interceptors.request.use(function () { /* ... */ });

取消请求

	使用 cancel token 取消请求。
	
	 Axios 的 cancel token API 基于 cancelable promises proposal，它还处于第一阶段。
	
	 可以使用 CancelToken.source 工厂方法创建 cancel token 像这样：
	
	const CancelToken = axios.CancelToken;
	const source = CancelToken.source();
	
	axios.get('/user/12345', {
	    cancelToken: source.token
	}).catch(function (thrown) {
	    if (axios.isCancel(thrown)) {
	        console.log('Request canceled', thrown.message);
	    } else { /* 处理错误 */ }
	});
	
	axios.post('/user/12345', {
	    name: 'new name'
	}, {
	    cancelToken: source.token
	});
	
	// 取消请求 (message 参数是可选的)
	source.cancel('Operation canceled by the user.');
	
	
	还可以通过传递一个 executor 函数到 CancelToken 的构造函数来创建 cancel token ：
	
	const CancelToken = axios.CancelToken;
	let cancel;
	
	axios.get('/user/12345', {
	    cancelToken: new CancelToken(function executor(c) {
	        // executor 函数接收一个 cancel 函数作为参数
	        cancel = c;
	    })
	});
	
	// 取消请求
	cancel();
	注意：可以使用同一个 cancel token 取消多个请求。