/tags/%E6%9E%B6%E6%9E%84.html Recent content in 架构 on IT 运维小秋 Hugo -- gohugo.io zh-cn chenwx716@139.com chenwx716@139.com Tue, 11 Jul 2023 12:53:32 +0800 /p/gateway.html Tue, 11 Jul 2023 12:53:32 +0800 chenwx716@139.com /p/gateway.html <h2 id="基础概念">基础概念</h2> <p>一个物理或逻辑区域的入口或出口</p> <h2 id="网关分类">网关分类</h2> <ol> <li>网络层网关: 重点是网络数据包转发和访问控制</li> <li>API 网关: 属于业务网关, 主要附带身份认证、流控、安全等业务功能</li> <li>数据网关; 缓存, 数据库, 存储, 数据仓库</li> <li>安全网关: 隔离，鉴权</li> <li>管理网关</li> <li>边界网关: 逻辑概念, 区分不同区域</li> </ol> <hr /> <h2 id="api-网关">API 网关</h2> <p>将统一业务入口, 流控, 负载均衡, 鉴权, 安全等功能进行前置<br /> 黑白名单, 协议适配(tcp/udp/http), 容错可用能力</p> <h3 id="主要用途">主要用途</h3> <ol> <li>隔离: 作为企业系统边界, 隔离外网系统与内网系统, 隐藏内部细节</li> <li>解耦: 使得各业务系统之间 或 微服务系统 之间能够独立, 自由, 高效, 灵活地调整;</li> </ol> <h3 id="常用方式">常用方式</h3> <ol> <li>nginx+lua</li> <li>traefix</li> <li>Spring Cloud Gateway</li> <li>业务自建</li> </ol> <h3 id="通用api网关设计要点">通用api网关设计要点</h3> <ol> <li>高性能</li> <li>安全性: 身份认证、权限认证</li> <li>高可用: 无状态设计原则</li> <li>可扩展: 支持插件, 脚本 等扩展功能</li> <li>运维友好</li> <li>隔离性：某个类型的后端服务异常时不影响其它类型服务</li> <li>动态变更: 负载规则变更时，不影响其它服务</li> </ol> <h2 id="api-网关设计要点">API 网关设计要点</h2> <ol> <li> <p>API标准化: 无标准不平台</p> </li> <li> <p>支持 API接口测试: 即可以方便地对接口进行测试, 或者方便区分或隔离测试流量和生产流量</p> </li> <li> <p>全生命周期管理<br /> 覆盖 API 的定义、测试、发布的整个生命周期管理，<br /> 便捷的日常管理、版本管理，支持热升级和快速回滚</p> </li> <li> <p>协议主流化<br /> http, https, xml, json, grpc<br /> 提供 java php python 等SDK</p> </li> </ol> <h1 id="业务-api-网关设计">业务 API 网关设计</h1> <h2 id="接口命名">接口命名</h2> <ol> <li>风格统一 (都为英文小写)</li> <li>模式固定 (xx.xx.xx.xx)</li> <li>简洁明了</li> <li>有扩展性</li> <li>分类与分层</li> </ol> <p>举例：suning.custom.order.get</p> <p>格式：suning. 业务分类. 模块简称. 操作符</p> <h2 id="文档规范化">文档规范化</h2> <p>API文档组成<br /> 简介、接口描述、公共参数、请求参数、响应参数、请求示例<br /> 业务异常码、公共异常码、响应示例、FAQ、异常示例、API工具</p> <h2 id="异常码标准化">异常码标准化</h2> <p>统一风格，分类，唯一性，有利于监控、告警、问题排查<br /> 有条件的情况，除返回异常码外，还要有中文描述</p> <h2 id="api管理">API管理</h2> <p>可以开关、流量控制和限流<br /> 安全管理、<br /> 接口分流: 不同的分类对应不同的后端服务<br /> 服务降级: 进行快速错误</p> <h2 id="api监控">API监控</h2> <p>日志<br /> 接口统计<br /> 告警<br /> 存储监控数据</p> <hr />