axios使用详解
json-server 环境搭建
- 第一步:安装 json-server
npm i -g json-server
第二步:创建文件
// 创建一个 db.json 的文件 // 可以添加官网的数据作为测试 { "posts":[ { "id": 1, "title": "json-server", "author": "typicode" } ], "comments": [ { "id": 1, "body": "some comment", "postId": 1 } ], "profile": { "name": "typicode" } }
第三步:启动服务
json-server --watch db.json
axios 的基本使用
- axios 有很多种请求的方式,但常用的请求一般是四种,分别是:
GET
、POST
、PUT
、DELETE
,我们就以这四种请求方式为例,讲解一下 axios 的基本使用。
- GET 请求
axios({ methods: 'GET', url: 'http://localhost:3000/get', }).then(res => { console.log(res) })
POST 请求
axios({ methods: 'POST', url: 'http://localhost:3000/post', data: { title: '我是 POST 请求' } }).then(res => { console.log(res) })
PUT 请求
axios({ methods: 'PUT', url: 'http://localhost:3000/put', data: { title: '我是 PUT 请求' } }).then(res => { console.log(res) })
DELETE 请求
axios({ methods: 'DELETE', url: 'http://localhost:3000/delete', }).then(res => { console.log(res) })
其他方式发送请求
- 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]])
axios 响应结构
{ // `data` 由服务器提供的响应 data: {}, // `status` HTTP 状态码 status: 200, // `statusText` 来自服务器响应的 HTTP 状态信息 statusText: "OK", // `headers` 服务器响应的头 headers: {}, // `config` 是为请求提供的配置信息 config: {} }
axios 请求配置项
{ // `url` 是用于请求的服务器 URL url: "/user", // `method` 是创建请求时使用的方法 method: "get", // 默认是 get // `baseURL` 将自动加在 `url` 前面,除非 `url` 是一个绝对 URL。 // 它可以通过设置一个 `baseURL` 便于为 axios 实例的方法传递相对 URL baseURL: "https://some-domain.com/api/", // `transformRequest` 允许在向服务器发送前,修改请求数据 // 只能用在 "PUT", "POST" 和 "PATCH" 这几个请求方法 // 后面数组中的函数必须返回一个字符串,或 ArrayBuffer,或 Stream transformRequest: [function (data) { // 对 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, https://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, // 默认的 // `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", // 默认的 // `xsrfCookieName` 是用作 xsrf token 的值的cookie的名称 xsrfCookieName: "XSRF-TOKEN", // default // `xsrfHeaderName` 是承载 xsrf token 的值的 HTTP 头的名称 xsrfHeaderName: "X-XSRF-TOKEN", // 默认的 // `onUploadProgress` 允许为上传处理进度事件 onUploadProgress: function (progressEvent) { // 对原生进度事件的处理 }, // `onDownloadProgress` 允许为下载处理进度事件 onDownloadProgress: function (progressEvent) { // 对原生进度事件的处理 }, // `maxContentLength` 定义允许的响应内容的最大尺寸 maxContentLength: 2000, // `validateStatus` 定义对于给定的HTTP 响应状态码是 resolve 或 reject promise 。如果 `validateStatus` 返回 `true` (或者设置为 `null` 或 `undefined`),promise 将被 resolve; 否则,promise 将被 rejecte validateStatus: function (status) { return status >= 200 && status < 300; // 默认的 }, // `maxRedirects` 定义在 node.js 中 follow 的最大重定向数目 // 如果设置为0,将不会 follow 任何重定向 maxRedirects: 5, // 默认的 // `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: "rapunz3l" } }, // `cancelToken` 指定用于取消请求的 cancel token // (查看后面的 Cancellation 这节了解更多) cancelToken: new CancelToken(function (cancel) { }) }
axios 的默认配置
axios.defaults.methods = 'GET' // 设置默认的请求类型为 GET axios.defaults.baseURL = 'http://localhost:3000' // 设置基础 URL axios.defaults.params = {id: 0} // 设置默认的请求参数 axios.defaults.timeout = 3000 // 设置请求时间
axios 创建实例对象发送请求
// 创建实例对象,这里创建的额 joke 与 axios 对象的功能几乎是一样的 const joke = axios.create({ baseURL: 'https://api.apiopen.top', timeout: 2000 }) // 发送请求 joke({ url: '/getJoke', }).then(res => { console.log(res) }) // 上述代码也可以使用 axios 的方法进行请求 joke.get('/getJoke').then(res => { console.log(res) })
如果存在两个请求的 baseURL 不一样,此时应该怎么办?
- 可以创建两个实例对象,再根据需要使用不同的实例对象发送请求。
const joke = axios.create({ baseURL: 'https://api.apiopen.top', timeout: 2000 }) const another = axios.create({ baseURL: 'https://api.apiclose.top', timeout: 2000 }) joke({ url: '/getJoke', }).then(res => { console.log(res) }) joke.get('/getJoke').then(res => { console.log(res) })
axios 拦截器
- axios 拦截器有两种:一是请求拦截器,二是响应拦截器。
- 请求拦截器:请求拦截器的作用是在请求发送前进行一些操作,例如在每个请求体里加上token,统一做了处理以后,再发送请求。
- 响应拦截器:在请求结果返回后,先不直接导出,而是先对响应码等等进行处理,处理好后再导出给页面,如果将这个对响应码的处理过程抽出来,就成了所谓的响应拦截器。响应拦截器的作用是在接收到响应后进行一些操作。
// 添加请求拦截器 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); });
axios 取消请求
- 上代码!!!
// 2. 声明全局变量 let cancel = null btn.onclick = function() { // 判断上一次的请求是否已经完成 if (cancel != null) { // 取消上一次的请求 cancel() } axios({ methods: 'GET', url: 'http://localhost:3000/posts', // 1. 添加配置对象的属性 cancelToken: new axios.CancelToken(c => { // 2. 将 c 的值赋值给 cancel cancel = c }) }).then(res => { // 将 cancel 的值初始化 cancel = null }) }