Axios|axios的配置对象说明(config) ajax|axios|前端

文章目录

axios的配置对象(config)

axios的配置对象(config) 【Axios|axios的配置对象说明(config)】这些是用于发出请求的可用配置选项

{ // `url` is the server URL that will be used for the request 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. 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', 'PATCH' and 'DELETE' // The last function in the array must return a string or an instance of Buffer, ArrayBuffer, // FormData or Stream // You may modify the headers object. transformRequest: [function (data, headers) { // Do whatever you want to transform the datareturn 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 datareturn 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', 'DELETE , 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, Buffer data: { firstName: 'Fred' },// syntax alternative to send data into the body // method post // only the value is sent, not the key data: 'Country=Brasil&City=Belo Horizonte',// `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, // default is `0` (no timeout)// `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 lib/adapters/README.md). 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`. // Please note that only HTTP Basic auth is configurable through this parameter. // For Bearer tokens and such, use `Authorization` custom headers instead. auth: { username: 'janedoe', password: 's00pers3cret' },// `responseType` indicates the type of data that the server will respond with // options are: 'arraybuffer', 'document', 'json', 'text', 'stream' //browser only: 'blob' responseType: 'json', // default// `responseEncoding` indicates encoding to use for decoding responses (Node.js only) // Note: Ignored for `responseType` of 'stream' or client-side requests responseEncoding: 'utf8', // 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 // browser only onUploadProgress: function (progressEvent) { // Do whatever you want with the native progress event },// `onDownloadProgress` allows handling of progress events for downloads // browser only onDownloadProgress: function (progressEvent) { // Do whatever you want with the native progress event },// `maxContentLength` defines the max size of the http response content in bytes allowed in node.js maxContentLength: 2000,// `maxBodyLength` (Node only option) defines the max size of the http request content in bytes allowed maxBodyLength: 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: 21, // default// `beforeRedirect` defines a function that will be called before redirect. // Use this to adjust the request options upon redirecting, // to inspect the latest response headers, // or to cancel the request by throwing an error // If maxRedirects is set to 0, `beforeRedirect` is not used. beforeRedirect: (options, { headers }) => { if (options.hostname === "example.com") { options.auth = "user:password"; } }; // `socketPath` defines a UNIX Socket to be used in node.js. // e.g. '/var/run/docker.sock' to send requests to the docker daemon. // Only either `socketPath` or `proxy` can be specified. // If both are specified, `socketPath` is used. socketPath: null, // default// `httpAgent` and `httpsAgent` define a custom agent to be used when performing http // and https requests, respectively, in node.js. This allows options to be added like // `keepAlive` that are not enabled by default. httpAgent: new http.Agent({ keepAlive: true }), httpsAgent: new https.Agent({ keepAlive: true }),// `proxy` defines the hostname, port, and protocol of the proxy server. // You can also define your proxy using the conventional `http_proxy` and // `https_proxy` environment variables. If you are using environment variables // for your proxy configuration, you can also define a `no_proxy` environment // variable as a comma-separated list of domains that should not be proxied. // Use `false` to disable proxies, ignoring environment variables. // `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`. // If the proxy server uses HTTPS, then you must set the protocol to `https`. proxy: { protocol: 'https', 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) { }),// an alternative way to cancel Axios requests using AbortController signal: new AbortController().signal,// `decompress` indicates whether or not the response body should be decompressed // automatically. If set to `true` will also remove the 'content-encoding' header // from the responses objects of all decompressed responses // - Node only (XHR cannot turn off decompression) decompress: true // default// `insecureHTTPParser` boolean. // Indicates where to use an insecure HTTP parser that accepts invalid HTTP headers. // This may allow interoperability with non-conformant HTTP implementations. // Using the insecure parser should be avoided. // see options https://nodejs.org/dist/latest-v12.x/docs/api/http.html#http_http_request_url_options_callback // see also https://nodejs.org/en/blog/vulnerability/february-2020-security-releases/#strict-http-header-parsing-none insecureHTTPParser: undefined // default// transitional options for backward compatibility that may be removed in the newer versions transitional: { // silent JSON parsing mode // `true`- ignore JSON parsing errors and set response.data to null if parsing failed (old behaviour) // `false` - throw SyntaxError if JSON parsing failed (Note: responseType must be set to 'json') silentJSONParsing: true, // default value for the current Axios version// try to parse the response string as JSON even if `responseType` is not 'json' forcedJSONParsing: true,// throw ETIMEDOUT error instead of generic ECONNABORTED on request timeouts clarifyTimeoutError: false, },env: { // The FormData class to be used to automatically serialize the payload into a FormData object FormData: window?.FormData || global?.FormData } }

其中有几个注意点：

baseURL是一个URL的基础结构，axios内部会自动将baseURL与url进行一个结合，形成最终的url结果。例如你可以将域名和协议写在baseURL中，而在url中直接写路径
transformRequest可以对请求的数据进行一个处理，处理完之后，再将处理的结果发送给服务器。(对请求参数进行一个预处理)
transformResponse可以对相应的数据进行处理，改变完之后我们再用自定义的回调去处理这个结果。(对响应参数进行一个预处理)
headers对请求头信息进行一个配置
params对url参数(准确的说是url里面的查询字符串)进行设置

例如：

axios({ url: '/post', //post?a=100&b=200params: { a:100, b:200 }

paramsSerializer是一个参数序列化的配置对象(用的相对较少)，作用：对请求的参数进行一个序列化，转化成一个字符串。根据服务器端接口的要求，对这个对象进行处理，与服务器进行一个统一

例如：

/post?a=100&b=2 00 ///post/a/100/b/200 ///post/a.100/b.200

data是请求体设置，有两种形式：对象形式和字符串形式。如果是对象形式，axios会将其转化为json形式字符串；如果是字符串形式，那么axios会直接传递
timeout为超时时间，发送请求时如果超过时间则这个请求就会被取消。单位为毫秒
withCredentials在跨域请求时对cookie的携带作一个设置。false为不携带，true则在跨域请求时可以携带cookie。
adapter对请求的适配器进行设置
responseType响应体结果的格式做一个设置，默认值是json
responseEncoding响应结果的编码设置
xsrfCookieName、xsrfHeaderName跨站请求的标识，对cookie的名字和头信息进行设置
onUploadProgress在上传的时候做出的回调
onDownloadProgress在下载的时候做出的回调
maxContentLength设置http响应的最大尺寸，单位：字节
maxBodyLength设置请求体的最大尺寸，单位：字节
validateStatus对响应结果的成功进行一个设置。也就是说什么情况下才认定他是成功的。默认值为响应代码大于200，小于300.(status >= 200 && status < 300)
maxRedirects设置最大跳转次数
socketPath设定socket文件的位置。作用:向docker的守护进程发送请求。
httpAgent、 httpsAgent对客户端的信息进行设置
proxy设置代理
cancelToken对AJAX请求做一个取消的设置
decompress设置对响应结果是不是做一个解压。默认：解压