2018-04-19 20:41:47 frank_come 阅读数 22081

日结博客 04.19.18 HZ

对于每次都要从页面导入axios和配置路径的行为简直没完没了地厌恶,每次后台修改api地址都得从一大堆页面里寻找到那小小的一个axios.get,简直深恶痛绝

请封装吧,万物皆能封装,封装治好了你多年的眼疾

封装更合理的Axios操作类

 

1.导入axios至你的项目

npm install --save axios

2.在根路径创建http.js

首先导入axios至http文件


import axios from 'axios'import axios from 'axios'

配置axios的默认URL

axios.defauls.baseURL = 'xxx'

配置允许跨域携带cookie

axios.defaults.withCredentials = true

配置超时时间

axios.defaults.timeout = 100000

标识这是一个 ajax 请求


axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest'axios.defaults.headers.common['X-Requested-With'] = 'XMLHttpRequest'

配置请求拦截

 axios.interceptors.request.use(config => {
    config.setHeaders([
        ...
        // 在这里设置请求头与携带token信息
    ])
    return config
 })
    config.setHeaders([
        ...
        // 在这里设置请求头与携带token信息
    ])
    return config
 })

配置相应拦截

// axios拦截器
axios.interceptors.response.use(response => {
 // 在这里你可以判断后台返回数据携带的请求码
if (response.data.retcode === 200 || response.data.retcode === '200') {
  return response.data.data || response.data
}else {
  // 非200请求抱错
  throw Error(response.data.msg || '服务异常')
}
​
axios.interceptors.response.use(response => {
 // 在这里你可以判断后台返回数据携带的请求码
if (response.data.retcode === 200 || response.data.retcode === '200') {
  return response.data.data || response.data
}else {
  // 非200请求抱错
  throw Error(response.data.msg || '服务异常')
}
​

最后返回(更多配置可以查看axio的官方api)


export defaul axiosexport defaul axios

全部文件

import axios from 'axios'
axios.defauls.baseURL = 'xxx'
axios.defaults.withCredentials = true
axios.defaults.timeout = 100000
// // axios拦截器
 axios.interceptors.request.use(config => {
    config.setHeaders([
        ...
        // 在这里设置请求头与携带token信息
    ])
    return config
 })
 
 axios.interceptors.response.use(response => {
     // 在这里你可以判断后台返回数据携带的请求码
    if (response.data.retcode === 200 || response.data.retcode === '200') {
      return response.data.data || response.data
    }else {
      // 非200请求抱错
      throw Error(response.data.msg || '服务异常')
 }
​
export default axios
axios.defauls.baseURL = 'xxx'
axios.defaults.withCredentials = true
axios.defaults.timeout = 100000
// // axios拦截器
 axios.interceptors.request.use(config => {
    config.setHeaders([
        ...
        // 在这里设置请求头与携带token信息
    ])
    return config
 })
 
 axios.interceptors.response.use(response => {
     // 在这里你可以判断后台返回数据携带的请求码
    if (response.data.retcode === 200 || response.data.retcode === '200') {
      return response.data.data || response.data
    }else {
      // 非200请求抱错
      throw Error(response.data.msg || '服务异常')
 }
​
export default axios

是不是看到这里大失所望,别着急,接下来再新建一个api.js文件

封装一个匿名函数返回一个apis对象,通过apis对象的键名去获取对应的api地址

// 集中管理路由,所有的接口地址:
//  1.整个应用用到了哪些接口一目了然
//  2.接口地址可能变化,方便管理
​
const prefix = '' // api地址前缀
export default(config => {
    return Object.keys(config).reduce((copy, name) => {
      copy[name] = `${prefix}$config[name]`
      return copy
    }, {})
})({
  // example api
  "getExampleData": "/api/example/data" 
})
​
//  1.整个应用用到了哪些接口一目了然
//  2.接口地址可能变化,方便管理
​
const prefix = '' // api地址前缀
export default(config => {
    return Object.keys(config).reduce((copy, name) => {
      copy[name] = `${prefix}$config[name]`
      return copy
    }, {})
})({
  // example api
  "getExampleData": "/api/example/data" 
})
​

文件最终返回一个对象

// api对象
{
  getExampleData: '/api/example/data'
}
{
  getExampleData: '/api/example/data'
}

看到这里是不是有点迷糊,接下来上重头戏~

再新建一个service文件夹,在其下新建一个index.js

(src/server/index.js)


import http from '../http.js' // 导入我们封装好的axios对象
import apis from '../api.js' // 导入我们封装好的apis对象
​
export funciton getExampleData (params = {}) { // 从外部接受参数,没有参数默认为空对象
    retun http.get(apis.getExampleData, params) // return对应的get/post方法,第一个填路径,第二个给参数对象
}import http from '../http.js' // 导入我们封装好的axios对象
import apis from '../api.js' // 导入我们封装好的apis对象
​
export funciton getExampleData (params = {}) { // 从外部接受参数,没有参数默认为空对象
    retun http.get(apis.getExampleData, params) // return对应的get/post方法,第一个填路径,第二个给参数对象
}

看到这里是不是就恍然大悟了,把获取exampleData这个接口封装成了一个方法,在所需的页面调用对应的方法就好了

Vue页面引用

import { getExampleData } from 'services'
​
...
beforeCreate() {
    getExampleData({ name: 'xxx'} ).then(res => {
        this.exampleData = res // 绑定到data里
        consonle.log(res) // 这里返回的是你根据http.js拦截器中定义的返回数据
    }).catch(err => console.log(err)) // 处理报错信息
}
...
​
...
beforeCreate() {
    getExampleData({ name: 'xxx'} ).then(res => {
        this.exampleData = res // 绑定到data里
        consonle.log(res) // 这里返回的是你根据http.js拦截器中定义的返回数据
    }).catch(err => console.log(err)) // 处理报错信息
}
...

React页面引用

import { getExampleData } from 'services'
​
...
componentWillMount() {
    getExampleData({ name: 'xxx'} ).then(res => {
        this.setState({
            exampleData: res // 赋值到state里
        })
        consonle.log(res) // 这里返回的是你根据http.js拦截器中定义的返回数据
    }).catch(err => console.log(err)) // 处理报错信息
}
​
...
componentWillMount() {
    getExampleData({ name: 'xxx'} ).then(res => {
        this.setState({
            exampleData: res // 赋值到state里
        })
        consonle.log(res) // 这里返回的是你根据http.js拦截器中定义的返回数据
    }).catch(err => console.log(err)) // 处理报错信息
}

希望大家能用上这个以后不再烦恼apis的杂多或者难以管理,难以修改之类的通病

 

喜欢就点个赞吧。谢谢你~

:D

2019-04-26 09:01:37 weixin_34071713 阅读数 1089
import React from 'react'
import { Route, Switch, withRouter } from 'react-router-dom'
import axios from 'axios'
import { Toast } from 'antd-mobile'
import ReactDOM from 'react-dom'
import Error from '../components/Error'

import Home from '../pages/Home'
import NoPage from '../pages/404'
import Login from '../pages/Login'

class Interceptors extends React.Component {
	constructor(props) {
		super(props)
		this.errorDom = null
		this.cancel = null
	}


	componentDidMount() {
		// 监听路由变化
		this.props.history.listen(route => {
			if (this.cancel) {
				this.cancel("取消请求")
				Toast.hide()
			}
		})
	}


	renderError() {
		if (this.errorDom) {
			return
		}
		this.errorDom = document.createElement('div')
		ReactDOM.render(
			<Error reload={() => {
				this.errorDom.remove()
				window.location.reload()
			}}
			goBack={() => {
				this.errorDom.remove()
				this.props.history.goBack()
			}}
			/>, this.errorDom)
		document.body.appendChild(this.errorDom)
	}

	componentWillMount() {
		let cancelToken = axios.CancelToken
		/**
	 	* 添加请求拦截器
	 	*/
		axios.interceptors.request.use(config => {
			this.errorDom && this.errorDom.remove()
			config.headers['token'] = getToken()
			config.cancelToken = new cancelToken(c => {
				this.cancel = c
			})
			return config
		}, error => {
			return Promise.reject(error)
		})

		/**
	 	* 添加响应拦截器
	 	*/
		axios.interceptors.response.use(response => {
			const { data, msg, success } = response.data
			if (success === -1) {
				this.props.history.push('/login')
				return ''
			}
			if (success === false) {
				Toast.info(msg, 2)
				return Promise.reject(msg)
			}
			return data || response.data
		}, error => {
			if (axios.isCancel(error)) {
				return Promise.reject(error)
			}
			Toast.fail('服务器出错', 2)
			this.renderError()
			return Promise.reject(error)
		})
	}

	render() {
		return (
			<div>
				<Switch>
					<Route path='/home' component={Home} />
					<Route path='/404' component={NoPage} />
					<Route path='/login' component={Login} />
				</Switch>
			</div>
		)
	}
}

export default withRouter(Interceptors)
复制代码
2018-09-07 10:01:16 bbsyi 阅读数 2803

1.config.js配置数据请求路径和一些公共变量

// 定义常量及api接口地址
export const access_token = ''
export const platform = ''

let env = 'develop'
//开发环境、测试环境、生产环境
if(window.location.hostname == 'localhost'){
  env = 'develop'
}else if(window.location.hostname == ''){
  env = 'develop'
}else {
  env = 'product'
}

export const ENV = env

export const HOSTS = {
  develop: {
    api: 'http://www.baidu.com', // 测试环境
    domain: 'http://www.baidu.com',
  },
  product: {
    api: 'http://www.baidu.com',
    domain: 'http://www.baidu.com'
  }
}

export const ROOT = HOSTS[ENV].api

export const API = {
	memberInfo: ROOT + '/baidu.json'
}

2.api.js axios全局拦截处理及导出api

import axios from 'axios';

import { API,platform,access_token } from './config'

// 把默认配置withCredentials改为true,就可以允许跨域携带cookie信息了
axios.defaults.withCredentials = false
axios.defaults.timeout = 100000
// // axios拦截器
axios.interceptors.request.use(request => {

  if (request.params) {

    for (let key in request.params) {
      request.params[key] || (delete request.params[key])
    }
    request.params.access_token = access_token
    request.params.platform || (request.params.platform = platform)
  } else {
    
    request.params = {
      platform,
      access_token: access_token,
    }
  }
  return request
})

axios.interceptors.response.use(response => {
   // 在这里你可以判断后台返回数据携带的请求码
  if (response.data.status === 'success') {
    return response.data
  }else {
    // 非200请求抱错
    throw Error(response.data.message || '服务异常')
  }
})

//获取数据
export const fetchData = params => axios.get(API.memberInfo, {params});

3.page2.js 使用


import React, { Component } from 'react';
import {Router,Route,browserHistory} from 'react-router-dom';

import { fetchMember } from '../../api.js';

import { Button } from 'antd-mobile';

class Page1 extends Component {
	constructor(props) {
		super(props);
   	}


   	// 生命周期
	componentDidMount(){
		
	}


  	render() {
	    return (
	      <div className="page2">
	        这是page2
	        <Button type="primary" onClick={this.getData}>获取信息</Button>
	      </div>
	    );
	}


	getData(){
		fetchMember({'openId':"1"})
	  	    .then(res=>{
	  	    	if (res.status=="success") {
	  	    	  console.log(res.data)
	  		    }

	  	})
	}
}

export default Page1;

参考:https://blog.csdn.net/bbsyi/article/details/82388500

2020-03-04 13:49:55 yitian_z 阅读数 320

React中安装并引入axios依赖

在React项目中使用axios请求,首先需要安装axios:

npm install axios --save

然后在react文件中使用typescript方式导入axios依赖:

import axios from 'axios';

使用axios进行GET请求

axios中使用GET请求时有两中方式:

  • 一种是使用axios.get的方式进行
  • 一种是使用axios(config { ... })的方式进行

使用axios.get方式

使用封装的axios.get进行请求的常用格式如下:

// Make a request for a user with a given ID
axios.get('/getUser?id=12345')
  .then(function (response) {
    // handle success
    console.log(response);

    // update state or do something
    this.setState({
      // ...
    })
  })
  .catch(function (error) {
    // handle error
    console.log(error);
  })
  .then(function () {
    // always executed
  });

// Optionally the request above could also be done as
axios.get('/getUser', {
    params: { // 这里的参数设置为URL参数(根据URL携带参数)
      id: 12345
    }
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  })
  .then(function () {
    // always executed
  });  

// Want to use async/await? Add the `async` keyword to your outer function/method.
async function getUser() {
  try {
    const response = await axios.get('/getUser?id=12345');
    console.log(response);
  } catch (error) {
    console.error(error);
  }
}

使用axios(config {...})

使用axios(config {...}) 的方式发送GET请求格式如下:

axios({
  method: 'get',
  url: '/getUser',
  params: {
    id: 12345,
  }
})
  .then(function (response) {
    console.log(response);
  });

以上的get请求发送的URL均为如下:

http:HOST_IP:XXXX/getUser?id=12345

使用axios进行POST请求

同GET请求一样,使用POST也有两种请求方式。

使用axios.post

axios.post('/createUser', {
    firstName: 'Fred',
    lastName: 'Flintstone'
  })
  .then(function (response) {
    console.log(response);
  })
  .catch(function (error) {
    console.log(error);
  });

使用axios(config {...})

    // Send a POST request
    axios({
      method: 'post',
      url: '/createUser',
      data: { // 这里data中的参数为requestBody参数,服务端需要使用@RequestBody注解进行获取
        firstName: 'Fred',
        lastName: 'Flintstone'
      }
    }).then(function (response) {
      console.log(response);
    }).catch(function (error) {
      console.log(error);
    });

需要注意的是,在使用axios(config {})方式进行GET或POST请求发送时,GET请求中params为URL参数,POST请求中data为RequestBody参数,在服务端需要使用@RequestBody注解接收,Spring Boot能够自动解析为Java相应的对象。

同时发送多个请求

使用axios也可以一次发送多个请求:

function getUserAccount() {
  return axios.get('/user/12345');
}

function getUserPermissions() {
  return axios.get('/user/12345/permissions');
}

axios.all([getUserAccount(), getUserPermissions()])
  .then(axios.spread(function (acct, perms) {
    // Both requests are now complete
  }));

详细config对象配置项

在axios的readme文档中,有对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 data

    return 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 data

    return 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', 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
  // 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
  maxContentLength: 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: 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` 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 and port 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`.
  proxy: {
    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) {
  })
}

axios的返回值对象response

axios在进行请求后得到的response对象格式如下:

{
  // `data` is the response that was provided by the server
  data: {},

  // `status` is the HTTP status code from the server response
  status: 200,

  // `statusText` is the HTTP status message from the server response
  statusText: 'OK',

  // `headers` the HTTP headers that the server responded with
  // All header names are lower cased and can be accessed using the bracket notation.
  // Example: `response.headers['content-type']`
  headers: {},

  // `config` is the config that was provided to `axios` for the request
  config: {},

  // `request` is the request that generated this response
  // It is the last ClientRequest instance in node.js (in redirects)
  // and an XMLHttpRequest instance in the browser
  request: {}
}

当在请求后使用then方法时,可以获取response对象的各个属性值,其中data即为服务端返回的相应对象:

axios.get('/user/12345')
  .then(function (response) {
    console.log(response.data);
    console.log(response.status);
    console.log(response.statusText);
    console.log(response.headers);
    console.log(response.config);
  });

axios的全局配置

在使用axios时,可以对axios对象进行全局的设置,该设置会应用于axios所在当前javascript类中的所有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的单一实例化配置

如果不需对axios进行全局设置,则可以在使用某个axios对象时,进行单一对象的设置,例如如下:

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

axios拦截器的使用

可以使用axios拦截器来在发送请求之前或在响应response之前(then方法)来拦截请求并进行自定义的设置,定义request和response拦截器示例如下:

// Add a request interceptor
axios.interceptors.request.use(function (config) {
    // Do something before request is sent
    return config;
  }, function (error) {
    // Do something with request error
    return Promise.reject(error);
  });

// Add a response interceptor
axios.interceptors.response.use(function (response) {
    // Any status code that lie within the range of 2xx cause this function to trigger
    // Do something with response data
    return response;
  }, function (error) {
    // Any status codes that falls outside the range of 2xx cause this function to trigger
    // Do something with response 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文档,具体参见:https://github.com/axios/axios

2019-01-13 13:34:00 weixin_30617797 阅读数 111

一、最近做的一个后台管理项目,基于antd-pro做的,需要封装基于axios请求,便于开发,直接上代码。

import axios from 'axios';

export const MethodType = {
  GET: 'GET',
  POST: 'POST',
  PUT: 'PUT',
  DELETE: 'DELETE',
  PATCH:'PATCH'
};

/**
 * 模块说明:有api_token的请求
 */
export const request = (api, method = MethodType.GET, params = {}, config = {}) => {
  const apiToken = '************';
  const data = (method === 'GET') ? 'params' : 'data';
  let headers = {
    'X-Requested-With': 'XMLHttpRequest',
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${apiToken}`,
  };
  if (config.headers) {
    headers = {
      ...headers,
      ...config.headers
    }
  }
  return new Promise((resolve, reject) => {
    axios({
      url: api,
      method,
      [data]: params,
      headers,
    }).then(resolve)
      .catch(error => {
        console.dir(error);
        Message.error(typeof error.response.data === 'string' ? error.response.data : JSON.stringify(error.response.data));
        reject(error);
      });
  });
};

二、另外项目统一管理api请求,将api请求都放在了api.js目录下

示例:

import {MethodType} from "./promise";

const promise = require('./promise');

export const _goodsList = async (page,keyword,catId,onSale)=>{
  return await promise.request('/api/admin/goods/list', MethodType.GET, {
    page,
    keyword,
    catId,
    onSale,
  })
};

三、使用api方法

import {
  _goodsList,
} from '../utils/api';


  @action.bound
  async handleSearchData(page,keyword,catId,onSale){
    await _goodsList(page,keyword,catId,onSale);
  }

 

总结:上面的就是项目中api的用法,可以完全按照这样来写

转载于:https://www.cnblogs.com/piaobodewu/p/10262397.html