{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/180", "result": {"data":{"issuesJson":{"id":"3c445159-2df6-5f77-bbef-bf7385654420","title":"didi/gatekeeper: 一款golang编写的支持快速开发、插件化的高性能网关。使用二进制文件安装即刻体验网关功能。","number":180,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposdidi/gatekeeper
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

项目介绍

\n

GateKeeper是一款golang编写的支持快速开发、插件化的高性能网关。使用二进制文件安装即刻体验网关功能。

\n

功能特性：
\n1、快速开发：插件化支持功能拓展+参数配置化，双管齐下。
\n2、健康检查：支持主动+被动探活检测，还可拓展第三方配置中心。
\n3、内置插件：分布式限流(秒/时/日三种粒度)、header头转换、白名单、租户鉴权、QPS统计等

\n

系统架构：
\n\"avatar\"

\n

1、系统分为两个端：控制端(Control Plane)负责服务编辑配置和自定义参数管理；代理端(Proxy Plane)负责协议数据中间处理及转发。两端可以分开启动也同时启动。
\n2、控制端与代理端交互：控制端编辑完服务信息会写入Mysql中，代理端定时从Mysql中拉取服务配置信息，然后平滑处理代理端服务启停。
\n3、自定义化插件：支持最常见的业务需求快速定制化，主要包含业务中间件自定义、服务负载配置自定义、负载策略自定义等，如果插件需要参数配置则可以在控制端配置相应参数。

\n

快速开始（Quick Start）

\n

环境要求

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
软件版本官网安装教程
mysql>=5.1官网教程
redis>=3.0官网教程
\n

服务安装(二选一)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
类型优点
二进制文件安装适合无golang环境且无插件开发需求用户.
源码安装支持插件定制化用户.
\n

1. 二进制文件安装

\n

目前支持64位windows/linux/mac 操作系统下用户，运行以下命令可自动化进行提示安装。
\nwindows用户需要启动powershell运行以下脚本。

\n
bash <(curl -s -S -L 'https://download.fastgit.org/didi/GateKeeper/releases/download/v1.0.0/setup.sh')  \n
\n

执行完毕后，会提示启动服务的命令，按照操作运行即可，执行二进制安装无需再进行源码安装。

\n

2. 源码安装

\n

使用源码安装，需依赖golang环境，要求如下：

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
软件版本官网安装教程
golang>=1.16官网教程
\n

2.1 git clone code

\n
git clone https://github.com/didi/GateKeeper.git\n
\n

2.2 set go proxy & download golang dependency

\n
export GO111MODULE=on && export GOPROXY=https://goproxy.cn\ncd GateKeeper\ngo mod tidy\n
\n

2.3 edit mysql connect info

\n
vim ./conf/dev/mysql_map.toml\n# set data_source_name = \"{dbUser}:{dbPwd}@tcp({dbIp}:{dbPort})/{dbDatabase}?charset=utf8&parseTime=true&loc=Asia%2FChongqin\" \n
\n

2.4 edit redis connect info

\n
vim ./conf/dev/redis_map.toml\n# set proxy_list = \"redisIP:redsiPort\"\n# set password = \"redisPwd\"\n
\n

2.5 create database & import data

\n
mysql -h 127.0.0.1 -u root -p -e \"CREATE DATABASE gatekeeper DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;\"\nmysql -h 127.0.0.1 -u root -p gatekeeper < gatekeeper.sql --default-character-set=utf8\n
\n

2.6 run gatekeeper

\n\n
sh control.sh start_control \n
\n\n
sh control.sh start_proxy \n
\n\n
sh control.sh start_both \n
\n

插件化

\n

网关中最常见的业务需求，包含业务中间件自定义、服务负载配置自定义、负载策略自定义等。
\n这些常见功能我们都支持插件化定义，除此之外还支持了插件内部的动态参数配置及获取。

\n

业务中间件插件

\n

由于中间件内部采用AOP切面编程实现，所以业务中间件我们直接套用了 gin 中间件定义：

\n
type HandlerFunc func(*Context)\n
\n

示例demo，func直接返回定义的方法即可：

\n
func HTTPFlowLimitMiddleware() gin.HandlerFunc {\n\treturn func(c *gin.Context) {\n\t\t_, err := model.GetServiceDetailFromGinContext(c)\n\t\tif err != nil {\n\t\t\tpublic.ResponseError(c, 2001, err)\n\t\t\tc.Abort()\n\t\t\treturn\n\t\t}\n\t\t//todo\n\t\tc.Next()\n\t}\n}\n
\n

最后记得完成中间件在 http_proxy_router/route.go 的内部注册。

\n
router.Use(\n    http_proxy_middleware.HTTPAccessModeMiddleware(),\n    ...\n    http_proxy_middleware.HTTPFlowLimitMiddleware(),\n    http_proxy_middleware.HTTPReverseProxyMiddleware())\n
\n

负载配置插件

\n

系统默认支持兜底下游节点配置，但是有些服务是使用服务发现协调器实现的如 consul、zookeeper 这就需要自定义服务负载配置了。
\n与上面相同首先是接口定义：

\n
type LoadBalanceConf interface {\n\tAttach(o Observer)\n\tGetConf() []string\n\tWatchConf()\n\tUpdateConf(conf []string)\n\tCloseWatch()\n}\n
\n

实现完上述接口的结构后，还需要注册这个步骤。

\n
func init() {\n\tRegisterCheckConfigHandler(\"upstream_config\", NewLoadBalanceCheckConf)\n}\n
\n

负载策略插件

\n

系统默认提供了4种负载均衡策略：轮询、权重轮询、基于客户端IP的一致性Hash、随机。如果有定义需求还可以使用插件进行功能拓展。
\n同样首先是接口定义

\n
type LoadBalanceStrategy interface {\n\tAdd(...string) error\n\tRemoveAll() error\n\tGetAll() ([]string, error)\n\tGet(string) (string, error)\n}\n
\n

实现完上述接口的结构后，还需要注册这个步骤。

\n
func init() {\n\tRegisterLoadBalanceStrategyHandler(\"random\", func() LoadBalanceStrategy {\n\t\treturn &RandomStrategy{}\n\t})\n}\n
\n

动态参数配置及获取

\n

插件要做到一处开发多处使用，就离不开动态参数配置功能。
\nGateKeeper要实现参数配置主要以下几个步骤：
\n首先编辑 conf/dev/plugin_config.toml 增加参数配置，具体参数格式介绍 待补充，现举例如下：

\n
[[http]]\n  display_name = \"url地址重写\"\n  sort = 6\n  postion = \"normal\"\n  unique_name = \"url_rewrite\"\n\n  [[http.items]]\n    field_type = \"textarea\"\n    field_display = \"block\"\n    field_clear = \"none\"\n    field_placeholder = \"格式：^/test_service(.*) $1\\n多条请换行\"\n    field_option = \"\"\n    field_value = \"\"\n    field_default_value = \"\"\n    field_unique_name = \"rewrite_rule\"\n    field_display_name = \"URL重写\"\n    field_required = false\n    field_valid_rule = \"/^[\\\\S]+ [\\\\S]+$/is\"\n
\n

其次，打开控制端修改响应服务信息。
\n\"avatar\"

\n

最后在响应中间件调用即可。

\n
func HTTPUrlRewriteMiddleware() gin.HandlerFunc {\n\treturn func(c *gin.Context) {\n\t\tserviceDetail, err := model.GetServiceDetailFromGinContext(c)\n\t\tif err != nil {\n\t\t\tpublic.ResponseError(c, 2001, err)\n\t\t\tc.Abort()\n\t\t\treturn\n\t\t}\n\t\trewriteUrl := serviceDetail.PluginConf.GetPath(\"url_rewrite\", \"rewrite_rule\").MustString()\n\t\t...\n\t\tc.Next()\n\t}\n}\n
\n

性能测试

\n

GateKeeper 对比业界其他知名API网关 APISIX、Nginx、HAProxy、Kong、manba
\n硬件配置：128G、40核 Intel(R) Xeon(R) Silver 4114 2.20GHz
\n测试参数：wrk -t50 -c500 -d30s --latency \"http://xxxx/xxxx/\"

\n

\"avatar\"

\n

\"avatar\"

\n

\"avatar\"

\n

通过以上图片分析不难得出，GateKeeper性能的表现特点为：

\n\n

注：以上服务均为默认安装未做调优、不同电脑配置测试结果可能不同。
\n更多详细内容 待补充

\n

自动化集成测试

\n

自动化集成测试

","updatedAt":"2025-05-21T15:58:34Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"Gateway","color":"1986c2"}},{"node":{"name":"didi","color":"df6c8f"}}]},"comments":{"edges":[]}}},"pageContext":{"number":180,"previous":{"title":"antonmedv/fx: go 语言编写的终端下的 json 浏览工具，比 jq 更强大","number":179},"next":{"title":"matt-harvey/git_curate: 一个交互式删除 git 仓库本地分支的工具。","number":181}}}, "staticQueryHashes": ["151096407","2861350382"]}