/** * 手动构建 api tree */ const APITREE = { domain1: { api: { v1: { user: { getByName: 'https://www.xxx.com/api/v1/user/getByName', getByAge: 'https://www.xxx.com/api/v1/user/getByAge' }, animal: { getByType: 'https://www.xxx.com/api/v1/animal/getByType', getByAge: 'https://www.xxx.com/api/v1/animal/getByAge' } } } }, domain2: { api: { car: { api1: 'https://xxx.xxx.cn/api/car/api1', api2: 'https://xxx.xxx.cn/api/car/api2' } } }, domain3: {} }; export { APITREE };
有了api tree，我们就可以采用如下方式来从api树上摘取各个api节点的url，代码如下：
// 获取url：https://www.xxx.com/api/v1/user/getByName const getByNameUrl = APITREE.domain1.api.v1.user.getByName; // 获取url：https://xxx.xxx.cn/api/car/api1 const carApi1Url = APITREE.domain2.api.car.api1;
但是以上构建api tree的方式存在两个缺点：
1、需要在各个节点手动拼接全路径
2、只能摘取子节点的url：getByName和getByAge,无法摘取父节点的url，比如我想获取 https://www.xxx.com/api/v1/user ，无法通过 APITREE.domain1.api.v1.user 获取
const APITREE = { domain1: { api: { v1: { // user为父节点 // 缺点一：无法通过APITREE.domain1.api.v1.user获取 // https://www.xxx.com/api/v1/user user: { // 缺点二：在getByName和getByAge节点中手动写入全路径拼接 getByName: 'https://www.xxx.com/api/v1/user/getByName', getByAge: 'https://www.xxx.com/api/v1/user/getByAge' } } } } };
五、Api Tree生成器（ApiTreeGenerator）
针对手动构建Api Tree的问题，我引入了两个概念：apiTreeConfig（基本配置）和apiTreeGenerator（生成器）。
通过apiTreeGenerator对apiTreeConfig进行处理，最终生成真正的apiTree。
1、apiTreeConfig我把它称之为基本配置，apiTreeConfig具有一定的配置规则，要求每个节点名（除了域名）必须与api url中的每一节点名一致，因为apiTreeGenerator是根据apiTreeConfig的各个节点名进行生成， api tree config配置如下：
/** * api tree config * _this可以省略不写，但是不写的话，在ts就没有语法提示 * 子节点getByName,getByAge以及_this可以为任意值，因为将会被apiTreeGenerator重新赋值 */ const APITREECONFIG = { api: { v1: { user: { getByName: '', getByAge: '', _this: '' } }, _this: '' } }; export { APITREECONFIG };
2、apiTreeGenerator我把它称之为生成器，具有如下功能：
1） 遍历apiTreeConfig，处理apiTreeConfig的所有子节点，并根据该节点的所有父节点链生成完整的url，并且作为该节点的value，比如： APITREECONFIG.api.v1.user.getByName -> https://www.xxx.com/api/v1/user/getByName
2） 遍历apiTreeConfig，处理apiTreeConfig的所有父节点，在每个父节点中添加_this子节点指向父节点的完整url。
apiTreeGenerator（生成器）的代码如下：
（由于项目中只用到一个后端的数据，这里只实现了单域名的apiTreeGenerator，关于多域名的apiTreeGenerator，大家可以自行修改实现。）
import { APITREECONFIG } from './api-tree.config'; const APITREE = APITREECONFIG; const HOST_URL = `https://www.xxx.com`; /** * 为api node chain添加HOST_URL前缀 */ const addHost = (apiNodeChain: string) => { return apiNodeChain ? `${HOST_URL}/${apiNodeChain.replace(/^\//, '')}` : HOST_URL; }; /** * 根据api tree config 生成 api tree： * @param apiTreeConfig api tree config * @param parentApiNodeChain parentApiNode1/parentApiNode2/parentApiNode3 */ const apiTreeGenerator = (apiTreeConfig: string | object, parentApiNodeChain?: string) => { for (const key of Object.keys(apiTreeConfig)) { const apiNode = key; const prefixChain = parentApiNodeChain ? `${parentApiNodeChain}/` : ''; if (Object.prototype.toString.call(apiTreeConfig[key]) === '[object Object]') { apiTreeGenerator(apiTreeConfig[key], prefixChain + apiNode); } else { apiTreeConfig[key] = parentApiNodeChain ? addHost(prefixChain + apiTreeConfig[key]) : addHost(apiTreeConfig[key]); } } // 创建_this节点 (这里需要放在上面的for之后) apiTreeConfig['_this'] = parentApiNodeChain ? addHost(`${parentApiNodeChain}`) : addHost(''); }; apiTreeGenerator(APITREECONFIG); export { APITREE };
结果：
优化后的UserHttpService代码如下： user.http.service.ts
import { Injectable } from '@angular/core'; import { HttpClient } from '@angular/common/http'; import { APITREE } from './api-tree'; @Injectable() export class UserHttpService { constructor(private http: HttpClient) { } async getUserById(userId) { const url = APITREE.api.v1.user._this + 'https://www.jb51.net/' + userId; return this.http.get(url).toPromise(); } async getUserByName(name) { const url = APITREE.api.v1.user.getByName + 'https://www.jb51.net/' + name; return this.http.get(url).toPromise(); } async getUserByAge(age) { const url = APITREE.api.v1.user.getByAge + 'https://www.jb51.net/' + age; return this.http.get(url).toPromise(); } }
六、总结
通过api tree，能带来如下好处：
1、能够通过树的形式来获取api，关键是有语法提示
APITREE.api.v1.user.getByName
2、apiTreeConfig配置文件与后端的api接口一 一对应，方便维护
3、当后端修改api名时，apiTreeConfig可以很方便的进行调整
七、demo
github代码：https://github.com/SimpleCodeCX/myCode/tree/master/angular/api-tree