VX-API-Gateway开源网关技术的使用记录

绝地灬酷狼 2024-03-23 18:30 2阅读 0赞

## VX-API-Gateway开源网关技术的使用记录 ##

![在这里插入图片描述][eaf43d21300248bc9a175810cd0de39d.png]

官网地址 https://mirren.gitee.io/vx-api-gateway-doc/

VX-API-Gateway(以下称为VX-API)是基于Vert.x (java)开发的
    API网关,
    是一个分布式、全异步、高性能、可扩展、轻量级的可视化配置的API网关服务

### 官网下载程序zip包 ###

访问 https://gitee.com/mirren/VX-API-Gateway/releases

下载最新的程序zip包

![在这里插入图片描述][03e26cd1245f49b6a5beca652cc41d7c.png]

### 安装和使用 ###

#### 找个目录解压程序包 ####

![在这里插入图片描述][89e11f0fdc824efe9c1674c81fdb9e30.png]

#### 启动程序bin目录里的start.bat或start.sh ####

![在这里插入图片描述][70fe3b82ce63472fa38c5c8e1b98eca8.png]  
![在这里插入图片描述][d90b6daf681d4668b5b2432c2b3b569a.png]

#### 浏览器访问5256端口 ####

![在这里插入图片描述][4251c7fc81cf4ca59064aa2f96aed2dc.png]  
点击进入首页后，会进入  
http://localhost:5256/static/Application.html  
提示要登录，默认账号是VXAdmin，密码是hivx  
![在这里插入图片描述][cb277e12bd3d4061a64db49f54882bd6.png]

登录密码在安装目录的conf下的user.json中配置  
![在这里插入图片描述][4380a0c67fff4fba8408e3cf22e9eca8.png]

### 登录后可以新建应用 ###

新建应用是指 你的vx-api-gateway网关要对接的服务名或应用名以及相关信息配置

#### 创建应用 ####

![在这里插入图片描述][467fb07df79647b69aa9c8f477a9ea12.png]  
![在这里插入图片描述][5bd13068bc8b45edbda2d98198086214.png]  
![在这里插入图片描述][b501b1a4bc304fe1ba02b776df3a9fd6.png]  
vx网关代理的http参数设置，都可以不填，会自动使用默认参数设置，（如需修改可以按需填写）  
![在这里插入图片描述][3f5ee004dca244cc8b0d1d59bf596143.png]  
![在这里插入图片描述][a6c9e0003d884ee8b9d30607e60f5a46.png]

![在这里插入图片描述][059a518c3d1e49d78182c2d886a9cc1a.png]  
应用创建好后，可以在应用列表中看到

#### 创建应用下的API代理 ####

点击API管理，可以在刚刚建的应用上创建API  
![在这里插入图片描述][bd0a215878f746dfaeaadf2887ab5560.png]  
![在这里插入图片描述][a5aabbffde794e0999741cfa356c219d.png]

##### 创建一个get请求代理 #####

目标：访问/sgate/t1 后自动代理到真实后端的/demo/t1

![在这里插入图片描述][868fd78982df486e8aa2b317aa31b7bf.png]  
![在这里插入图片描述][2f37808578b44616bd7392a05ef58849.png]  
![在这里插入图片描述][4157c812bdd24475af04a010e3ae14fd.png]  
![在这里插入图片描述][2b705e6a926f405e89ec50f4461361bc.png]  
代理API的的返回结果配置不用特别修改，默认会自动返回后端真实API的数据

![在这里插入图片描述][16effa33cb3d4644a3ca25bc900862db.png]  
创建完成后，可以在api列表里看到  
最后，要启用刚刚建的应用和应用下的API代理

在应用详情页面点击启动应用  
![在这里插入图片描述][0468c770c86b44d7b758123cf8320beb.png]  
在API详情页面点击启动某个API代理  
![在这里插入图片描述][0f09241eb21948f69bb73dd56a212e8d.png]  
启动完成后，点击运行状态页面，可以观察到当前vx-api-gateway的运行状态  
![在这里插入图片描述][f7695f5c904948d786abac7f0c549216.png]  
最后可以使用postman测试是否代理成功  
访问  
http://127.0.0.1:8330/sgate/t1 后  
自动代理到真实后端的  
http://127.0.0.1:8085/demo/t1  
返回后端真实服务接口的数据

![在这里插入图片描述][6abf5e781396400f94f58214b5f94ba5.png]  
实测发现可以代理成功，请求耗时188ms

在API详情页也可以看到相关的网关日志如下  
![在这里插入图片描述][dc9a73b7a132462195ec250c7aacc4be.png]

### VX-API-Gateway技术架构 ###

#### 应用Application ####

应用可以理解为分组,是VX-AP中的一个运行单元,一个应用相当于一个服务器(Server)不同的是他的端口号允许被重复使用,也就是说在VX-API中一个端口号可以给任意应用绑定(前提是这个端口号没有被别的程序绑定),应用用于管理API
    访问http://localhost:端口号(默认5256)/static/Application.html或者通过http://localhost:端口号(默认5256)进入后便可以查看与管理应用

#### API接口 ####

API是VX-API的服务核心,创建应用后便可以在应用的API管理中创建API;
    当前版本中API支持三种服务类型,
    HTTP/HTTPS服务(既VX-API需要去请到后台服务器的类型):参数检查与透传,支持带权重的负载均衡访问策略,轮询与IP哈希化,自动断路与重试不可用的后台服务地址
    页面跳转服务:当用户访问时redirect到指定页面
    自定义服务:可以自定义任意服务,当前版本中实现了,基于session-token的认证授权,获取服务器时间戳,与获取常量
    同时API支持全局黑名单,流量限制,权限认证,自定义前置/后置处理器等

#### API的执行流程 ####

![在这里插入图片描述][db25fab15442433ab8ca15a24f2ed6e2.png]  
绿线代表一定会执行,黑线代表当存在时执行,当用户请求的时候,完整的流程按组件顺序由1开始执行到7,如果不满足任意一个组件时请求结束并响应(fail-end-response),当任意组件出现异常时统一进入异常组件(Exception Handler)请求结束并响应错误信息  
更多API的执行流程介绍参考下方API组件介绍

### 总结 ###

VX-API-Gateway 是一个轻量的，支持可视化配置的网关代理服务。
    可以代理多个后端应用，同时可以对每个后端应用的API做精细化的API代理配置。
    由于VX-API-Gateway 底层使用的是vert.x技术，所以不必担心性能问题

[eaf43d21300248bc9a175810cd0de39d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b8411ef88f7645deb545acc36d8d4d1c.png
[03e26cd1245f49b6a5beca652cc41d7c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/c689118474b4467795ba1ba87d73589f.png
[89e11f0fdc824efe9c1674c81fdb9e30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/61089a2f3b314e8e888c59b3cecb060c.png
[70fe3b82ce63472fa38c5c8e1b98eca8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5b71e6195da240e8aaab663a2ab735cc.png
[d90b6daf681d4668b5b2432c2b3b569a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/3ef3f5c8ce7943508aec6c8a9a4cf260.png
[4251c7fc81cf4ca59064aa2f96aed2dc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/311b2ad2251a4162abfe1be656a8851d.png
[cb277e12bd3d4061a64db49f54882bd6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/f254cf161deb419c8fb612f8f9bf90ef.png
[4380a0c67fff4fba8408e3cf22e9eca8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/d3ef87142206475b97cfc3393ae485b8.png
[467fb07df79647b69aa9c8f477a9ea12.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/52c763f1445247589fbcb88b68e24c3f.png
[5bd13068bc8b45edbda2d98198086214.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/a811288115214985a82a9adcbbe2493f.png
[b501b1a4bc304fe1ba02b776df3a9fd6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/a0c691df10184b56a17efdae411762d2.png
[3f5ee004dca244cc8b0d1d59bf596143.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/0f8825bb96ed47e8926a3894a13093df.png
[a6c9e0003d884ee8b9d30607e60f5a46.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/d4bd2d6ebbb649c4860582a8de6e7631.png
[059a518c3d1e49d78182c2d886a9cc1a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/4a12d64f1cb04693ac7dadddbeb01265.png
[bd0a215878f746dfaeaadf2887ab5560.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/3f2a2854a3de42e8a443fb78832ee277.png
[a5aabbffde794e0999741cfa356c219d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b2adc95faa51434a813f55e560a9f9f7.png
[868fd78982df486e8aa2b317aa31b7bf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/298fc87edef349279523fa01bd031c96.png
[2f37808578b44616bd7392a05ef58849.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/691cc5f2c087496fa3760de294b6db0b.png
[4157c812bdd24475af04a010e3ae14fd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/7ee739df050a4552979ecf730c04d161.png
[2b705e6a926f405e89ec50f4461361bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/9c3095de6ce64b93aa15e63813e6404f.png
[16effa33cb3d4644a3ca25bc900862db.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/9d0b4d656d414aeabd45501c4118dd62.png
[0468c770c86b44d7b758123cf8320beb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5b6c70d211874b27ba2b6945aae0b3d3.png
[0f09241eb21948f69bb73dd56a212e8d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/363f4f1d26ad4a43a1807655b6a48533.png
[f7695f5c904948d786abac7f0c549216.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/321844bd47294276895c4cbc8fdddb9e.png
[6abf5e781396400f94f58214b5f94ba5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/5433c68441c1468a9bdb323044138115.png
[dc9a73b7a132462195ec250c7aacc4be.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/996cd62d482d45f7a553400f8b3df124.png
[db25fab15442433ab8ca15a24f2ed6e2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/e0614757125c41089c4fe3fa4027fddd.png