在vue项目中,避免接口调用混乱,难以维护,采用接口配置的方式统一管理。
主体思想为:调用接口时使用统一入口,通过配置进行调用。
实现如下:
项目中新增interfaceService文件夹,
新增接口配置文件interfaceConfig.js:
export default {
basePath: '/',
mockBasePath: './static/mockData/',
// 前端独立分离开发配置
FEIndependence: false,
data: {
getIntro: {
url: 'getIntro',
method: 'get',
description: '获取介绍信息',
isMock: true,
mockUrl: 'getIntro.json'
},
login: {
url: 'login',
method: 'post',
description: '用户登录',
isMock: false,
mockUrl: ''
}
}
}
新增getInterface.js
import axios from 'axios'
import interfaceConfig from './interfaceConfig.js'
/**
* 添加请求、响应拦截器
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)
})
*/
export default function (interfaceName, param = null) {
let interfaceContent = interfaceConfig.data[interfaceName]
// 匹配不到接口配置
if (!interfaceContent) {
return Promise.reject(new Error('non-existent interfaceName:' + interfaceName))
}
// mock模式,获取mock数据
if (interfaceConfig.FEIndependence || interfaceContent.isMock) {
return axios.get(interfaceConfig.mockBasePath + interfaceContent.mockUrl)
} else {
// 真实接口调用时,获取接口配置
let method = interfaceContent.method
let requestUrl = interfaceConfig.basePath + interfaceContent.url
// 调用接口
switch (method) {
case 'get':
case 'delete':
return axios[method](requestUrl, { params: param })
case 'post':
case 'put':
return axios[method](requestUrl, { data: param })
default:
return Promise.reject(new Error('request method error:' + method))
}
}
}
模块通过引入getInterface.js进行调用
import getInterface from '@/interfaceService/getInterface'
getInterface('getIntro').then(res => {
...
}).catch(err => {
...
})
Angular则通过将服务进行依赖注入的方式
import { Injectable } from '@angular/core';
import { HttpClient, HttpParams, HttpHeaders } from '@angular/common/http';
import { InterfaceConfig } from './interface.config.service';
import { throwError } from 'rxjs'
@Injectable()
export class InterfaceService {
constructor(
public http: HttpClient,
) {
}
interfaceObj: object = {};
interfaceConfigs: object = InterfaceConfig;
getInterface(interfaceName, param?: any, isMockShow?: boolean) {
let interfaceObj: any = this.interfaceObj,
interfaceConfigs: any = this.interfaceConfigs,
isMock: Boolean;
const httpOptions: object = {
headers: new HttpHeaders({
'Content-Type': 'application/json'
})
};
let interfaceContent: any = interfaceConfigs.data[interfaceName];
if (interfaceContent == undefined) {
return throwError('未找到对应接口')
}
isMock = isMockShow || interfaceContent.isMock;
// 获取mock数据
if (interfaceConfigs.FEIndependence || isMock) {
interfaceObj = (() => {
return this.http.get(interfaceContent.mockUrl)
})()
} else {
// 调用后端接口
if (interfaceContent.method == 'get') {
interfaceObj = (() => {
if (param) {
const params = new HttpParams({ fromObject: param });
return this.http.get(interfaceConfigs.basePath + interfaceContent.url, { params })
}
return this.http.get(interfaceConfigs.basePath + interfaceContent.url)
})()
} else {
this.http[interfaceContent.method] && (interfaceObj = (() => {
return this.http[interfaceContent.method](interfaceConfigs.basePath + interfaceContent.url, param,
httpOptions)
})())
}
}
return interfaceObj;
}
}