一、基本使用

axios 是一个基于Promise 用于浏览器和 nodejs 的 HTTP 客户端,它本身具有以下特征:

1、从浏览器中创建 XMLHttpRequest
2、从 node.js 发出 http 请求
3、支持 Promise API
4、拦截请求和响应
5、转换请求和响应数据
6、取消请求
7、自动转换JSON数据
8、客户端支持防止 CSRF/XSRF

<script>
  import axios from 'axios'
  export default {
    name:'Product',
    created(){
    	//get
        axios.get('http://127.0.0.1:8000/api/show_books/',{
          params:{
            id:12
          }
        }).then((res) => {
          console.log(res.data)
        })
      //post
      let data={
        book_name:"开发到放弃"
        }
      axios.post('http://127.0.0.1:8000/api/add_book/',data).then(res =>{
        console.log(res.data)
      })
      //并发请求
      axios.all([
        axios.get('http://127.0.0.1:8000/api/show_books/'),
        axios.get('http://127.0.0.1:8000/api/show_books/'),
      ]).then(axios.spread((dataRes,cityRes)=> {
        console.log(dataRes,cityRes)
      }) )
    }
  }
</script>

二、axios的实例

created(){
  let instance = axios.create({
    baseURL:'http://127.0.0.1:8000/api',
    timeout:1000
  })
  instance.get('/show_books').then(res=>{
    console.log(res.data)
  })
}

axios的配置参数

created(){
    axios.create({
      baseURL:'http://127.0.0.1:8000',//请求的域名,基本地址
      timeout:1000,//请求超时时长ms
      url:'/api/book',//请求路径
      method:'get',//请求方法
      headers:{
        token:'',
        cookie:'',
        seesion:''
      },//请求头
      params:{},//请求参数,参数会拼接到url上
      data:{},//请求参数,参数放在请求体里
    })
    
      //1、axios全局配置
      axios.defaults.timeout = 1000
      axios.defaults.baseURL = 'http://127.0.0.1:8000'
      //2、axios的实例配置
      let instance = axios.create({
        baseURL:'http://127.0.0.1:8000',//请求的域名,基本地址
        timeout:1000,//请求超时时长ms
      })
      instance.defaults.timeout=3000
      //3、请求配置
      instance.get('/data.json',{
        timeout:5000
      })
}
{
// `url`是将用于请求的服务器URL
url: '/user',
 
// `method`是发出请求时使用的请求方法
method: 'get', // 默认
 
// `baseURL`将被添加到`url`前面,除非`url`是绝对的。
// 可以方便地为 axios 的实例设置`baseURL`,以便将相对 URL 传递给该实例的方法。
baseURL: 'https://some-domain.com/api/',
 
// `transformRequest`允许在请求数据发送到服务器之前对其进行更改
// 这只适用于请求方法'PUT','POST'和'PATCH'
// 数组中的最后一个函数必须返回一个字符串,一个 ArrayBuffer或一个 Stream
 
transformRequest: [function (data) {
// 做任何你想要的数据转换
 
return data;
}],
 
// `transformResponse`允许在 then / catch之前对响应数据进行更改
transformResponse: [function (data) {
// Do whatever you want to transform the data
 
return data;
}],
 
// `headers`是要发送的自定义 headers
headers: {'X-Requested-With': 'XMLHttpRequest'},
 
// `params`是要与请求一起发送的URL参数
// 必须是纯对象或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
// - Browser only: FormData, File, Blob
// - Node only: Stream
data: {
firstName: 'Fred'
},
 
// `timeout`指定请求超时之前的毫秒数。
// 如果请求的时间超过'timeout',请求将被中止。
timeout: 1000,
 
// `withCredentials`指示是否跨站点访问控制请求
// should be made using credentials
withCredentials: false, // default
 
// `adapter'允许自定义处理请求,这使得测试更容易。
// 返回一个promise并提供一个有效的响应(参见[response docs](#response-api))
adapter: function (config) {
/* ... */
},
 
// `auth'表示应该使用 HTTP 基本认证,并提供凭据。
// 这将设置一个`Authorization'头,覆盖任何现有的`Authorization'自定义头,使用`headers`设置。
auth: {
username: 'janedoe',
password: 's00pers3cret'
},
 
// “responseType”表示服务器将响应的数据类型
// 包括 'arraybuffer', 'blob', 'document', 'json', 'text', 'stream'
responseType: 'json', // default
 
//`xsrfCookieName`是要用作 xsrf 令牌的值的cookie的名称
xsrfCookieName: 'XSRF-TOKEN', // default
 
// `xsrfHeaderName`是携带xsrf令牌值的http头的名称
xsrfHeaderName: 'X-XSRF-TOKEN', // default
 
// `onUploadProgress`允许处理上传的进度事件
onUploadProgress: function (progressEvent) {
// 使用本地 progress 事件做任何你想要做的
},
 
// `onDownloadProgress`允许处理下载的进度事件
onDownloadProgress: function (progressEvent) {
// Do whatever you want with the native progress event
},
 
// `maxContentLength`定义允许的http响应内容的最大大小
maxContentLength: 2000,
 
// `validateStatus`定义是否解析或拒绝给定的promise
// HTTP响应状态码。如果`validateStatus`返回`true`(或被设置为`null` promise将被解析;否则,promise将被
  // 拒绝。
validateStatus: function (status) {
return status >= 200 && status < 300; // default
},
 
// `maxRedirects`定义在node.js中要遵循的重定向的最大数量。
// 如果设置为0,则不会遵循重定向。
maxRedirects: 5, // 默认
 
// `httpAgent`和`httpsAgent`用于定义在node.js中分别执行http和https请求时使用的自定义代理。
// 允许配置类似`keepAlive`的选项,
// 默认情况下不启用。
httpAgent: new http.Agent({ keepAlive: true }),
httpsAgent: new https.Agent({ keepAlive: true }),
 
// 'proxy'定义代理服务器的主机名和端口
// `auth`表示HTTP Basic auth应该用于连接到代理,并提供credentials。
// 这将设置一个`Proxy-Authorization` header,覆盖任何使用`headers`设置的现有的`Proxy-Authorization` 自定义 headers。
proxy: {
host: '127.0.0.1',
port: 9000,
auth: : {
username: 'mikeymike',
password: 'rapunz3l'
}
},
 
// “cancelToken”指定可用于取消请求的取消令牌
// (see Cancellation section below for details)
cancelToken: new CancelToken(function (cancel) {
})
}

三、axios的封装

1、axios封装,http.js

import axios from 'axios'
import {Message} from 'element-ui'

const instance = axios.create({

    baseURL: 'http://127.0.0.1:8000',
    withCredentials: true,
    timeout: 20000,
    headers: {
        'Content-Type': 'application/json; charset=utf-8',
        'X-Requested-With': 'XMLHttpRequest'
    },

    // `transformResponse` 在传递给 then/catch 前,允许修改响应数据
    // 统一处理接口后台异常弹出信息

    transformResponse: [function (res) {
        res = typeof res === 'string' ? JSON.parse(res) : res;
        if (res.code !== 0) {
            Message.error({
                message: res.msg,
                duration: 3000
            });
        }
        return res
    }]
})

/**
 * 后台接口返回规范格式
 * response = {
 *     code: '00'           # 正常返回,其他为业务逻辑提示
 *     msg: '提示信息'       # 异常信息
 *     data: {}             # 返回数据
 * }
 */

instance.interceptors.response.use(response => {
    return response
}, error => {
    try {
        switch (error.response.status) {
            case 400:
                error.message = '错误请求';
                break;
            case 401:
                error.message = '未授权,请重新登录';
                location.href = 'https://127.0.0.1?url=' + encodeURIComponent(location.href);
                break;
            case 403:
                error.message = '拒绝访问';
                break;
            case 404:
                error.message = '请求错误,未找到该资源';
                break;
            case 408:
                error.message = '请求超时';
                break;
            case 500:
                error.message = '服务器内部异常,请联系测试开发同事';
                break;
            case 502:
                error.message = '网络错误';
                break;
            case 503:
                error.message = '服务不可用';
                break;
            case 504:
                error.message = '网络超时';
                break;
        }
    }catch (e) {
        error.message = '服务器连接超时,请重试';
    }

    Message.warning({
        message: error.message,
        duration: 3000
    });

    return Promise.reject(error)
});

export default instance

2、api封装,bookinfo.js

import http from '../http'

export default {
  moneyList(params) {
    return http.get('/api/show_money/', {params: params}).then(res => res.data)
  },
}

3、导出api,index.js

import apiBook from "./map/bookInfo";

export {
    apiBook
}

4、引用API

import { apiBook } from '../../api/index';

export default {
    name: 'basetable',
    data() {
        return {
        };
    },
    created() {
        this.getMoneyData();
    },
    methods: {
        getMoneyData() {
            apiBook.moneyList().then(res => {
                console.log(res);
                this.tableData = res.list;
                this.pageTotal = res.pageTotal || 50;
            });
        },
    }
Logo

华为开发者空间,是为全球开发者打造的专属开发空间,汇聚了华为优质开发资源及工具,致力于让每一位开发者拥有一台云主机,基于华为根生态开发、创新。

更多推荐