axios教程

最新推荐文章于 2024-04-28 15:34:47 发布

前端榴脆骨

最新推荐文章于 2024-04-28 15:34:47 发布

阅读量205

点赞数

文章标签：前端

本文链接：https://blog.csdn.net/lllcuigu/article/details/133704869

版权

一、axios的安装方式

使用 npm:

$ npm install axios

使用 bower:

$ bower install axios

使用 cdn:

<script src="https://unpkg.com/axios/dist/axios.min.js"></script>

二、axios的基本使用

get、post、put、delete

<body>
    <h2>基本使用</h2>
    <div>
        <button onclick="getGet()">发送GET请求</button>
        <button onclick="getPost()">发送POST请求</button>
        <button onclick="getPUT()">发送PUT请求</button>
        <button onclick="getDelete()">发送DELETE</button>
    </div>
</body>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
</script>
<script>
    // get请求
    function getGet(){
        axios({
        url:'http://localhost:3000/posts/1'
    }).then(res=>{
        console.log(res.data)
    })
    };
    // Post请求
    function getPost(){
        axios({
            url:'http://localhost:3000/posts',
            // 设置请求体
            data:{
                title:"今天的天气还不错，挺风和日丽的",
                author:"张三"

            },
            method:'POST'
        }).then(res=>{
            console.log(res)
        })

    };
    // 更新 数据
    function getPUT(){
        axios({
            method:'put',
            url:'http://localhost:3000/posts/3',
            data:{
                title:'今天的天气还不错，挺风和日丽的',
                author:"李四",
                
            }
            
        }).then(res=>{
            console.log(res)
        })
    };
    // 删除数据
    function getDelete(){
        axios({
            method:'delete',
            url:'http://localhost:3000/posts/5'

        }).then(res=>{
            console.log(res)
        })
    }

    
</script>

三、axios其他方式发送请求

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.request(config) 和 axios.post(url[,data[,config]])

<body>
    <h2>axios的其他方式发松请求</h2>
   
    <div>
        <button onclick="getRequest()">axios的request</button>
        <button onclick="getPostUrl()">axios的Post</button>
    </div>
</body>
<script src="https://unpkg.com/axios/dist/axios.min.js"></script>
</script>
<script>
 
    // ---------------------axios的其他方式发送请求---------------------
    // request
    function getRequest(){
        axios.request({
            method:'get',
            url:'http://localhost:3000/posts',

        }).then(res=>{
            console.log(res.data)
        })
    }
// 发送post请求
// axios.post(url,data,config).then(res=>{})
    function getPostUrl(){
        axios.post('http://localhost:3000/posts',{
            "title":"嘿嘿把 烦恼摇出来",
                "author":"没烦恼"
        }).then(res=>{
            console.log(res)
        })
    }
</script>

四、axios请求响应结果的结构

config:配置对象，包含请求类型，请求url，请求体
data:响应体的结果。返回的数据，axios自动将json数据转化为对象
headers:响应头的信息
request:保存的是axios发送请求创建的原生的ajax对象
status:响应的状态
statusText:响应的状态字符串

五、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` indicates encoding to use for decoding responses
  // Note: Ignored for `responseType` of 'stream' or client-side requests
  responseEncoding: 'utf8', // default

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

  // `xsrfHeaderName` is the name of the http header that carries the xsrf token value
  xsrfHeaderName: 'X-XSRF-TOKEN', // default

   // `onUploadProgress` 允许为上传处理进度事件
  onUploadProgress: function (progressEvent) {
    // Do whatever you want with the native progress event
  },

  // `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; // default
  },

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

  // `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` 和 `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 默认值

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

实践：

 // ---------------------axios的默认配置---------------------------
    function getDefault(){
        axios.defaults.method='get'; //设置默认的请求类型
        axios.defaults.baseURL='http://localhost:3000';
        axios({
            url:'/posts'
        }).then(res=>{
            console.log(res)
        })
    }

自定义实例默认值

// Set config defaults when creating the instance
const instance = axios.create({
  baseURL: 'https://api.example.com'
});

// Alter defaults after instance has been created
instance.defaults.headers.common['Authorization'] = AUTH_TOKEN;

配置的优先顺序

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

// 使用由库提供的配置的默认值来创建实例
// 此时超时配置的默认值是 `0`
var instance = axios.create();

// 覆写库的超时默认值
// 现在，在超时前，所有请求都会等待 2.5 秒
instance.defaults.timeout = 2500;

// 为已知需要花费很长时间的请求覆写超时设置
instance.get('/longRequest', {
  timeout: 5000
});

七、axios创建实例对象发送请求

创建实例

可以使用自定义配置新建一个 axios 实例

axios.create([config])

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

实践：

    // 创建axios的实例 好处在于：可以发起两个不同的请求。简写默认配置。
    const mingyan=axios.create({
        baseURL:'https://api.apiopen.top/api',
        timeout:2000
    });
     //写法一
     mingyan({
         url:'/sentences',

     }).then(res=>{
         console.log(res)
     })
    // 写法二
    mingyan.get('/sentences').then(res=>{
        console.log(res.data)
    })

实例方法

以下是可用的实例方法。指定的配置将与实例的配置合并。

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的拦截器

拦截器Interceptors

在请求或响应被 then 或 catch 处理前拦截它们。

// 添加请求拦截器
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 () {/*...*/});

实践:

   // ------------------axios的拦截器---------------
    // Promise
    // 添加请求拦截器
axios.interceptors.request.use(function (config) {
    console.log('请求拦截器 成功  1号')
    // 修改config中的参数
    config.params={a:100};
    return config;
    // throw '参数出了问题'
  }, function (error) {
    console.log('请求拦截器 失败 1号')
    return Promise.reject(error);
  });
  axios.interceptors.request.use(function (config) {
    console.log('请求拦截器 成功  2号')
      // 修改config中的参数
      config.timeout=2000;
    return config;
    // throw '参数出了问题'
  }, function (error) {
    console.log('请求拦截器 失败 2号')
    return Promise.reject(error);
  });


// 添加响应拦截器
axios.interceptors.response.use(function (response) {
    console.log("响应拦截器 成功 1号")
// 设置之后，会处理发起请求中返回的结果，只有data了
    return response.data;
  }, function (error) {
    console.log("响应拦截器 失败 1号")
    return Promise.reject(error);
  });
  // 添加响应拦截器
axios.interceptors.response.use(function (response) {
    console.log("响应拦截器 成功 2号")
    return response;
  }, function (error) {
    console.log("响应拦截器 失败 2号")
    return Promise.reject(error);
  });
//   发起请求
  axios({
      method:'get',
      url:'/posts',
      baseURL:'http://localhost:3000'
  }).then(res=>{
      console.log("--------------")
      console.log(res)
  }).catch(resp=>{
      console.log("自定义失败回调")
  })

九、axios取消请求

取消cancel token

使用 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 the request
cancel();

注意: 可以使用同一个 cancel token 取消多个请求

实践：

//--------------html----------
 <div>
        <button onclick="getposts()">发起请求</button>
        <button onclick="cancelRequest()">取消请求</button>
    </div>
//-------------js---------------
//   ------------------取消请求----------------
// 声明全局变量
let cancel=null;
// 发起请求
function getposts(){
    // 检测上一次的请求是否已经完成
    if(cancel !== null){
        // 未完成 取消请求
        cancel();
    }
    axios({
        method:'get',
        url:'/comments',
        baseURL:'http://localhost:3000',
        // 添加配置对象 的属性
        cancelToken: new axios.CancelToken(function(c){
            // 将c的值赋值给cancal
            cancel=c;

        })

        }).then(response=>{
            console.log(response)
            // 将cancel的值初始化
            cancel=null

        })
    
}
// 取消请求
function cancelRequest(){
    cancel();
}

注意：要设置json-server --watch db.json -d 2000 超时2秒返回结果，不然取消不了请求

十、axios的文件结构

├── /dist/ # 项目输出目录

├── /lib/ # 项目源码目录

│ 

├── /adapters/ # 定义请求的适配器 xhr、http

│ 

│ 

├── http.js # 实现 http 适配器(包装 http 包)

│ 

│ 

└── **xhr.js #** **实现** **xhr** **适配器****(****包装** **xhr** **对象****)**

│ 

├── /cancel/ # 定义取消功能

│ 

├── /core/ # 一些核心功能

│ 

│ 

├── **Axios.js # axios** **的核心主类**

│ 

│ 

├── **dispatchRequest.js #** **用来调用** **http** **请求适配器方法发送请求的函数**

│ 

│ 

├── InterceptorManager.js # 拦截器的管理器

│ 

│ 

└── settle.js # 根据 http 响应状态，改变 Promise 的状态

│ 

├── /helpers/ # 一些辅助方法

│ 

├── axios.js # 对外暴露接口

│ 

├── **defaults.js # axios** **的默认配置**

│ 

└── utils.js # 公用工具

├── package.json # 项目信息

├── index.d.ts # 配置 TypeScript 的声明文件

└── index.js # 入口文件