在前端开发中,我们偶然会遇到这样的情况,【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。我们将开发中的代码放在一个服务上,通过 【原创内容,转载请注明出处】【原创不易,请尊重版权】host 为 127.0.0.1 来限制【原创不易,请尊重版权】【原创不易,请尊重版权】外部用户访问,这样,外部用户就不能访问我【本文首发于唐霜的博客】【原创不易,请尊重版权】们开发中的服务,只有我们在本机可以测试访【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。问。但是,在一些情况下,我们又希望随即给本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】另外一位同事查看自己机器上的某个效果,想【版权所有,侵权必究】转载请注明出处:www.tangshuang.net临时将服务开放给他,为了不被其他人访问,【原创不易,请尊重版权】【版权所有,侵权必究】我发给他的地址会带上一个 token。这【本文受版权保护】著作权归作者所有,禁止商业用途转载。个 token 代表着是给他看的,其他人【未经授权禁止转载】转载请注明出处:www.tangshuang.net没有 token,会被我拒绝访问。但是,转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net我不想更改我自己的代码,毕竟这只是一个临【原创不易,请尊重版权】【原创内容,转载请注明出处】时的访问,没有必要为了一个临时访问而修改【访问 www.tangshuang.net 获取更多精彩内容】【访问 www.tangshuang.net 获取更多精彩内容】代码。这可怎么办呢?
【版权所有,侵权必究】【访问 www.tangshuang.n未经授权,禁止复制转载。著作权归作者所有,禁止商业用途转载。et 获取更多精彩内容】基于这样的动机,我开发了 Easy-Ga【未经授权禁止转载】【原创不易,请尊重版权】teWay,它是一个基于 nodejs 本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net的代理转发工具,目的是在开发中快速起一个【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。代码,可以通过代理访问到其他服务上,而无未经授权,禁止复制转载。【本文首发于唐霜的博客】需修改原始服务的代码。
【本文首发于唐霜的博客】未经授权,禁止复制转载。【本文受版权保护】【原创不易,请尊重版权】快速上手
由于 Easy-GateWay 的目标是未经授权,禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】简单的代理启动方式,我可没有试过在真正的原创内容,盗版必究。【转载请注明来源】生产环境中使用它来做代理分发。但是,如果【关注微信公众号:wwwtangshuangnet】【版权所有,侵权必究】你仅仅是为了快速启动一个代理,那么 Ea【未经授权禁止转载】【未经授权禁止转载】sy-GateWay 肯定是你的首选。
【访问 www.tangshuang.n本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。et 获取更多精彩内容】【访问 www.tangshuang.n未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.netet 获取更多精彩内容】【版权所有】唐霜 www.tangshu【作者:唐霜】未经授权,禁止复制转载。ang.net本文版权归作者所有,未经授权不得转载。npm i -g easy-gateway # 另外建议全局安装 pm2 这个依赖,因为在一些非 js 的项目中,如果没有安装 pm2,命令会变得很慢
通过上面的命令来全局安装 easy-ga【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。teway,全局安装之后,你将拥有 eg转载请注明出处:www.tangshuang.net【作者:唐霜】w 命令行工具。
【本文受版权保护】【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。【本文受版权保护】egw start --target=http://localhost:8080
通过上面这条命令,我们启动了一个代理,这原创内容,盗版必究。【未经授权禁止转载】个代理将会以一个随机端口号对外开放,也就原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。是说,别人想要访问被代理的服务,需要访问【作者:唐霜】【版权所有】唐霜 www.tangshuang.net你的该端口。而这个被代理的服务,就是你只【版权所有,侵权必究】【原创不易,请尊重版权】能通过本地地址 http://local【本文受版权保护】原创内容,盗版必究。host:8080 访问的服务。现在,原【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。本只能你自己访问的服务,可以被别人访问了【本文受版权保护】【转载请注明来源】。
著作权归作者所有,禁止商业用途转载。【本文受版权保护】【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。但是,怎么带上 token 呢?
【本文受版权保护】原创内容,盗版必究。egw start --target=http://localhost:8080 --token
传入 –token 就可以让未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。对外暴露的服务带上 token 验证了,本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。它会产生一个随机 token,并在命令行转载请注明出处:www.tangshuang.net【转载请注明来源】中输出,你可以拷贝它。
本文作者:唐霜,转载请注明出处。【未经授权禁止转载】【版权所有,侵权必究】对于访问你提供的服务的下游开发者,tok【原创内容,转载请注明出处】【原创不易,请尊重版权】en 验证有 3 种方式:a)直接在 u【原创不易,请尊重版权】【访问 www.tangshuang.net 获取更多精彩内容】rl 中传入 ?token=xx 这个参数;b)cookie 中携带 EGW-TOKEN-[PORT] 的 key,其中 PORT 就是 本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net8211;port 参数的值(因为对于同【本文受版权保护】【原创不易,请尊重版权】一个域名而言,即使端口号不同,cooki【本文受版权保护】【本文受版权保护】e 同样生效,因此,要避免不同端口号的 本文版权归作者所有,未经授权不得转载。【访问 www.tangshuang.net 获取更多精彩内容】cookie 串号);c)http he【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。aders 中携带 EGW-TOKEN 的 key.
egw stop
这样就可以停止刚才启动的代理了。(但需要转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。注意,必须在相同目录中执行。)
【转载请注明来源】本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshu【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。ang.net著作权归作者所有,禁止商业用途转载。命令行工具
前面我们已经预览了 egw 的功能,这一未经授权,禁止复制转载。【版权所有,侵权必究】节我们详细讲解命令和参数。
【原创不易,请尊重版权】【原创内容,转载请注明出处】【本文首发于唐霜的博客】start
启动一个代理。在启动时,需要注意一些问题【未经授权禁止转载】【关注微信公众号:wwwtangshuangnet】,每一个代理都是有名字的,这个名字不能重【作者:唐霜】转载请注明出处:www.tangshuang.net复,一台机器上如果已经有一个名字了,那么【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。相同名字的代理无法启动。(Easy-Ga本文版权归作者所有,未经授权不得转载。【访问 www.tangshuang.net 获取更多精彩内容】teWay 依赖 pm2 作为后台运行时【本文受版权保护】本文作者:唐霜,转载请注明出处。工具,因此,这个名字不能和 pm2 列表【转载请注明来源】原创内容,盗版必究。中的名字相同,可以通过命令 npx pm【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号:wwwtangshuangnet】2 ls 查看所有服务。)
【原创内容,转载请注明出处】原创内容,盗版必究。- name 选传,代理的名字,必须唯一,默【未经授权禁止转载】【原创不易,请尊重版权】认情况下,使用当前文件夹的名字作为代理的【本文首发于唐霜的博客】【本文受版权保护】名字,如果需要使用这个名字,必须先使用
stop命令停掉这个名字的代理。 【关注微信公众号:wwwtangshua原创内容,盗版必究。【本文首发于唐霜的博客】ngnet】原创内容,盗版必究。
- host 选传,代理服务绑定的 ip 地【版权所有】唐霜 www.tangshuang.net【转载请注明来源】址,默认是 0.0.0.0,表示任何其他未经授权,禁止复制转载。未经授权,禁止复制转载。电脑都可以访问,如果设置为 127.0.【关注微信公众号:wwwtangshuangnet】原创内容,盗版必究。0.1 表示只能自己的电脑可以访问这个服【本文受版权保护】原创内容,盗版必究。务,也可以设置为其他值。 本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshua著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshuangnet】ng.net
- port 选传,代理服务的端口,默认会使未经授权,禁止复制转载。原创内容,盗版必究。用一个 [10000, 2000] 之间【版权所有】唐霜 www.tangshuang.net【转载请注明来源】的随机端口号 【版权所有】唐霜 www.tangshu原创内容,盗版必究。【本文首发于唐霜的博客】ang.net本文作者:唐霜,转载请注明出处。
- target 选传,被代理的服务的访问地址(url),也可【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。以是一个本机的路径,如果是一个路径,会启【版权所有】唐霜 www.tangshuang.net【作者:唐霜】动一个静态服务器,该服务由 expres著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。s.static 提供。 【版权所有】唐霜 www.tangshu【关注微信公众号:wwwtangshuangnet】【版权所有,侵权必究】ang.net本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。
- base 选传,如果你想利用本地文件起一个服务,可以通【访问 www.tangshuang.net 获取更多精彩内容】【版权所有,侵权必究】过 base 参数传入本地文件或目录路径【原创内容,转载请注明出处】【原创内容,转载请注明出处】,如果要传入多个,可以使用 ;; 进行分转载请注明出处:www.tangshuang.net【作者:唐霜】割。 本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】
- token 选传,用于用户访问这个代理服【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。务时,所需要的令牌,当不给值时,使用一个未经授权,禁止复制转载。【原创内容,转载请注明出处】随机字符串(16位)作为 token 转载请注明出处:www.tangshua【版权所有】唐霜 www.tangshuang.net【原创不易,请尊重版权】ng.net【作者:唐霜】【版权所有,侵权必究】
- cookies 选传,在向目标服务发出请【未经授权禁止转载】【原创内容,转载请注明出处】求时,在客户端请求送出的原始 cooki著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。e 基础上,附加带上这里传入的 cook著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】ies,传入格式为 cookies 原始【版权所有,侵权必究】未经授权,禁止复制转载。字符串格式。 本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshua转载请注明出处:www.tangshuang.net【原创不易,请尊重版权】ng.net【转载请注明来源】
- headers 选传,在向目标服务发出请【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】求时,所携带的 HEADER 信息,he本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。aders 的传入格式为:Key1:Va【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】lue1;;Key2:Value2,其中多个 key原创内容,盗版必究。转载请注明出处:www.tangshuang.net-value 之间使用 ;; 分割。 【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。
- debug 选传,是否开启调试模式,调试未经授权,禁止复制转载。原创内容,盗版必究。模式下,会在命令行中输出日志(虽然仍然常【转载请注明来源】未经授权,禁止复制转载。驻后台)。 【访问 www.tangshuang.n【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。et 获取更多精彩内容】【作者:唐霜】【本文受版权保护】
- script 【高级用法】选传,传入一个未经授权,禁止复制转载。原创内容,盗版必究。 js 文件的路径,在文件中重写 gat著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。eway。这会在下文中详细讲解。 【版权所有】唐霜 www.tangshu本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshuangnet】ang.net转载请注明出处:www.tangshua【转载请注明来源】著作权归作者所有,禁止商业用途转载。ng.net【版权所有,侵权必究】未经授权,禁止复制转载。
target 和 base 必须传入一个【本文受版权保护】【原创内容,转载请注明出处】或两个同时传,如果两个都不传,会报错。
【原创不易,请尊重版权】原创内容,盗版必究。未经授权,禁止复制转载。其中,cookies 传入原始的 coo【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。kie 字符串。这些字符串会被添加在用户【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。浏览器请求时携带的 cookie 的后面【作者:唐霜】【转载请注明来源】,也就是说,对于真正的服务而言,在用户的【本文受版权保护】转载请注明出处:www.tangshuang.net cookie 基础上,你还可以新增其他【原创不易,请尊重版权】【原创内容,转载请注明出处】 cookie。
【未经授权禁止转载】【转载请注明来源】【原创内容,转载请注明出处】著作权归作者所有,禁止商业用途转载。用于分隔两个 header 的是 ;; 转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net两个分号,这是因为在 HEADER 中几著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。乎不会出现同时有两个相连的值的情况。而且本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net需要注意,由于 Cookie 这个 HE【作者:唐霜】【访问 www.tangshuang.net 获取更多精彩内容】ADER 比较特殊,如果你在 heade转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。rs 中自己设定了 Cookie 这个字【原创不易,请尊重版权】未经授权,禁止复制转载。段,那么,整个代理请求的 Cookie 【作者:唐霜】【关注微信公众号:wwwtangshuangnet】字段会被你在 headers 中设定的覆【转载请注明来源】本文版权归作者所有,未经授权不得转载。盖,即使你设定了 cookies 参数,【本文首发于唐霜的博客】【原创内容,转载请注明出处】也会被覆盖。这在一些场景下可能反而有用。
【版权所有,侵权必究】【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。stop
stop 命令简单的多,用于关闭已经启动转载请注明出处:www.tangshuang.net原创内容,盗版必究。的代理。
【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshu本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】ang.net著作权归作者所有,禁止商业用途转载。【本文受版权保护】- name 要关闭的代理的名字 【版权所有】唐霜 www.tangshu原创内容,盗版必究。【原创不易,请尊重版权】ang.net【作者:唐霜】
如果你在运行 egw start 之后,【本文受版权保护】【本文受版权保护】并没有切换到其他目录,想要关闭这个代理,【原创内容,转载请注明出处】【原创内容,转载请注明出处】不需要传 name,当前文件夹的名字会被本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。作为 name 传入。
本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。.egwrc
如果你嫌每次启动代理都要传入一大堆参数,【作者:唐霜】【访问 www.tangshuang.net 获取更多精彩内容】特别麻烦,可以在需要运行 egw 命令的【作者:唐霜】【原创不易,请尊重版权】目录中创建一个 .egwrc 文件来固定【作者:唐霜】本文作者:唐霜,转载请注明出处。这些参数。我们来看下一个例子:
【关注微信公众号:wwwtangshua【本文首发于唐霜的博客】【转载请注明来源】ngnet】【原创内容,转载请注明出处】【本文首发于唐霜的博客】【原创不易,请尊重版权】## .egwrc name=some_name host=127.0.0.1 port=4000 base=. target=http://some.domain.com:8080 token=xxxxx headers=Auth-Token: xxxxxx;; Auth-User: xxxx
这样,当我们在这个目录下运行 egw s【作者:唐霜】【作者:唐霜】tart/stop 时,不需要传入任何参转载请注明出处:www.tangshuang.net【原创内容,转载请注明出处】数,.egwrc 文件中的配置,会覆盖 未经授权,禁止复制转载。【未经授权禁止转载】egw 的默认参数,从而起到固定参数的效【版权所有】唐霜 www.tangshuang.net【版权所有,侵权必究】果。参数的优先级:命令行参数 > 【版权所有】唐霜 www.tangshuang.net本文版权归作者所有,未经授权不得转载。.egwrc > 内置默认参数。
【转载请注明来源】著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。on/off
如果你需要一次性启动多个 .egwrc,【关注微信公众号:wwwtangshuangnet】【关注微信公众号:wwwtangshuangnet】那么,你可以使用 on 命令。因为在有些【访问 www.tangshuang.net 获取更多精彩内容】【访问 www.tangshuang.net 获取更多精彩内容】情况下,你需要多个代理启动起来,而不是只【未经授权禁止转载】【本文首发于唐霜的博客】有一个。这种情况下,你使用 on 命令,【原创不易,请尊重版权】【关注微信公众号:wwwtangshuangnet】而且,必须使用 .egwrc 文件来完成著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】。off 命令则是关掉 on 启动的服务转载请注明出处:www.tangshuang.net未经授权,禁止复制转载。。
著作权归作者所有,禁止商业用途转载。【本文受版权保护】egw on
该命令没有参数,它会去找到当前目录下的 原创内容,盗版必究。【原创不易,请尊重版权】.egwrc 目录。注意,是 .egwrc 目录,而非文件。在 .egwrc 目录中,你【版权所有】唐霜 www.tangshuang.net【转载请注明来源】可以创建任意多个以 .egwrc 结尾的文件,这些文件会被作为配置文件启【转载请注明来源】原创内容,盗版必究。动。通过这样的方式,你可以一起管理多个 未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。.egwrc。
【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshu本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】ang.net【原创内容,转载请注明出处】
API
在 start 命令中,有一个非常高级的【原创内容,转载请注明出处】【访问 www.tangshuang.net 获取更多精彩内容】 script 参数,这个参数意味着,你【本文首发于唐霜的博客】本文作者:唐霜,转载请注明出处。可以自己撰写自己的代理程序。要撰写自己的【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。代理程序,你需要了解 Easy-Gate本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.netWay 内置的 API。接下来,我们就会转载请注明出处:www.tangshuang.net原创内容,盗版必究。讲解接口。
原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】Proxier
什么是 Proxier 呢?它是一个用于【访问 www.tangshuang.net 获取更多精彩内容】【转载请注明来源】启动代理服务的对象,简单理解为,一个 E【版权所有,侵权必究】【作者:唐霜】asy-GateWay 的代理服务,就是转载请注明出处:www.tangshuang.net【原创不易,请尊重版权】一个 Proxier。如果你不需要 eg本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.netw 这个 CLI 命令工具,而是在 no【版权所有】唐霜 www.tangshuang.net【原创不易,请尊重版权】dejs 代码中自己启动一个 Proxi【本文首发于唐霜的博客】【原创不易,请尊重版权】er,可以如下操作。
本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。// proxier.js
const { Proxier } = require('easy-gateway')
const proxier = new Proxier({
host: '127.0.0.1',
port: 1080,
base: __dirname, // 可选,可以是一个路径,也可以是一组路径的数组
target: 'http://xxx.com',
})
proxier.start()
Proxier 的参数,和 http-p【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】roxy-middleware 的 cr著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshuangnet】eateProxyMiddleware 【原创不易,请尊重版权】【原创内容,转载请注明出处】方法的参数差不多,但不支持 pathRe【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.netwrite, router, onPro【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.netxyReq, onProxyRes。
【版权所有】唐霜 www.tangshu【本文受版权保护】【版权所有,侵权必究】ang.net【转载请注明来源】node proxier.js
获得一个 proxier 之后,你可以对转载请注明出处:www.tangshuang.net【本文受版权保护】它进行一些操作。然后调用 start 方【本文首发于唐霜的博客】未经授权,禁止复制转载。法。proxier.start 将会调用转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net express 的 listen 方法【版权所有,侵权必究】【原创不易,请尊重版权】,启动一个服务。这个服务就是我们需要的代转载请注明出处:www.tangshuang.net【原创内容,转载请注明出处】理服务。
【版权所有】唐霜 www.tangshu【转载请注明来源】原创内容,盗版必究。ang.net【关注微信公众号:wwwtangshua本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。ngnet】GateWay
为了给开发者提供复杂的网关管理,我将有关本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】转发的相关内容集成到 GateWay 对未经授权,禁止复制转载。【原创内容,转载请注明出处】象中,每一个 proxier 服务都有一本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】个 gateway 属性,用以控制转发逻未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.net辑。
【关注微信公众号:wwwtangshua【作者:唐霜】【作者:唐霜】ngnet】【版权所有】唐霜 www.tangshu【转载请注明来源】【原创不易,请尊重版权】ang.net【作者:唐霜】proxier.gateway.use(rule)
对 Proxier 的转发进行处理,都只本文作者:唐霜,转载请注明出处。【未经授权禁止转载】需要靠这个 gateway 对象就可以了【本文首发于唐霜的博客】转载请注明出处:www.tangshuang.net,不需要做其他修改。use 方法接收一个【版权所有,侵权必究】【作者:唐霜】 rule,也就是转发规则。
【未经授权禁止转载】未经授权,禁止复制转载。【本文受版权保护】const rule = {
// 认证阶段,通过 throw new Error 抛出认证失败错误
async auth(req, res, token) {
throw new Error('认证失败')
},
// 仅对 target 生效
// 代理请求阶段,当代理服务器准备向目标服务器发起请求时执行,req 为代理服务器发出的 request
request(proxyReq, req, res) {
proxyReq.setHeader('some-key', 'some-value') // 从代理往目标服务发起请求时,会带上这个 HEADER
},
// 仅对 target 生效
// 代理响应阶段,当代理服务器接收到目标服务器响应,并向客户端发送响应时执行,res 为代理服务器向客户端发出的 response
response(proxyRes, req, res) {
proxyRes.headers['some-key'] = 'some-value' // 从代理向客户端返回请求时,会带上这个 HEADER
},
// 仅对 target 生效
// 动态返回对 uri 的重写规则,比如客户端请求的是 /a,通过该规则,通过判断返回 /b,那么就会请求目标服务的 /b,当然,也可以返回 /c 来请求目标服务的另外一个地址
async rewrite(req, path) {
if (path.indexOf('/api') === 0) {
// 当请求代理服务的 /api 时,相当于请求目标服务的 /api/v2
return '/api/v2'
}
// 不返回的时候,表示不做任何处理,因为 gateway 中可能存在多个 rule,这一条处理完之后,如果不返回任何东西,还会继续检查下一条 rule
},
// 仅对 target 生效
// 逻辑和 rewrite 一样,但是是针对的 target,比如,本来请求的是 http://localhost:8080 可以通过判断请求 http://localhost:8081
async retarget(req, target) {
if (req.url.indexOf('/api2') > -1) {
// 原本我们请求的是 http://localhost:8080/api2,但是经过这么处理之后,请求到了 http://localhost:8087/api2
// 这有利于我们动态分配资源,比如进行一些负载均衡管理
return 'http://localhost:8087'
}
// 同理,不返回任何东西,进入下一条规则判断
},
// 在代理之前生效
async serve(req, res) {
if (req.url.indexOf('/status') > -1) {
res.end('ok')
// 如果要结束整个规则链条,返回 true 来结束
// 同上,规则检查也是会遍历 gateway 内部的多条规则,因此需要通过这种方式来结束
return true
}
// 不返回任何东西,规则会继续往下遍历
// 这里还可以进行一些操作
res.set('some-key', 'some-value')
},
}
按照这个结构,往 proxier.gat未经授权,禁止复制转载。【原创内容,转载请注明出处】eway 里面塞,就可以完成规则控制了。【未经授权禁止转载】【本文受版权保护】简单讲一下它的规则顺序:
未经授权,禁止复制转载。原创内容,盗版必究。- auth 原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。【原创不易,请尊重版权】【原创不易,请尊重版权】
- base 利用 base 完成静态资源的【未经授权禁止转载】【访问 www.tangshuang.net 获取更多精彩内容】服务 著作权归作者所有,禁止商业用途转载。【原创不易,请尊重版权】
- serve 你可以在这里进行深入编程,例未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net如拦截请求,返回内容,不走代理部分 本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。【原创内容,转载请注明出处】
- retarget + rewrite +本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】 request 【本文首发于唐霜的博客】【未经授权禁止转载】
- response 本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。
在实例化 Proxier 时,支持传入 转载请注明出处:www.tangshuang.net【版权所有,侵权必究】gateway:
【版权所有】唐霜 www.tangshu著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。ang.net【原创内容,转载请注明出处】本文作者:唐霜,转载请注明出处。原创内容,盗版必究。const gateway = new GateWay([
rule,
])
const proxier = new Proxier({
host: '127.0.0.1',
port: 1080,
target: 'http://xxx.com',
gateway,
})
这样就可以用你自己定义的 gateway未经授权,禁止复制转载。原创内容,盗版必究。。你甚至可以在其他地方,某些特定的时间,【原创内容,转载请注明出处】【版权所有,侵权必究】为 gateway 使用新的 rule 【作者:唐霜】【作者:唐霜】来改变 Proxier 的转发逻辑。但是【版权所有,侵权必究】未经授权,禁止复制转载。需要注意一点,目前,rule 只能被添加【关注微信公众号:wwwtangshuangnet】未经授权,禁止复制转载。,不能被取消,因此要在 rule 的内部【版权所有】唐霜 www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】做好条件判断。
【作者:唐霜】【关注微信公众号:wwwtangshua【原创内容,转载请注明出处】未经授权,禁止复制转载。ngnet】【原创内容,转载请注明出处】利用脚本
前面提到参数 script,它是一个高级著作权归作者所有,禁止商业用途转载。【转载请注明来源】用法。 它的作用就是通过传入一个 js/【版权所有】唐霜 www.tangshuang.net【版权所有,侵权必究】json 文件,用以提供新的 gatew【作者:唐霜】转载请注明出处:www.tangshuang.netay 规则。用 –scrip转载请注明出处:www.tangshuang.net【作者:唐霜】t 参数指定脚本的路径。脚本的代码如下:
未经授权,禁止复制转载。【关注微信公众号:wwwtangshua【转载请注明来源】原创内容,盗版必究。ngnet】【关注微信公众号:wwwtangshua【未经授权禁止转载】【本文受版权保护】ngnet】// gateway.js
module.exports = function(args) { // args 是由命令行传入的参数,这些参数被以对象的形式提供
// this 指向 gateway 实例,你可以通过调用 use 方法添加规则
this.use(rule)
// 这个函数默认不返回任何东西,表示直接修改 proxier.gateway 上的规则,
// 可以返回 this
// 更高级的用法,是返回一个新的 GateWay 实例,太过复杂,开发者可以自己摸索
}
// .egwrc name=my-custom-proxier port=3033 target=http://localhost:8080 script=./gateway.js
egw start egw stop
这样,既使用了脚本,又结合了 .egwr本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】c 文件,让这个代理服务固定了下来。
【关注微信公众号:wwwtangshua【作者:唐霜】【本文受版权保护】ngnet】【本文首发于唐霜的博客】同时,为了简化逻辑,它也支持指定一个 j著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】son 文件,并按照一定的规则撰写。
【版权所有,侵权必究】【原创不易,请尊重版权】【未经授权禁止转载】{
"rules": [
{
"route": "/api",
"rewrite: "/api/v2"
}
]
}
上面这个 json 脚本,使得当我们访问原创内容,盗版必究。【作者:唐霜】 /api 这个路径时,实际上是在访问 原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。/api/v2 这个路径。
【本文首发于唐霜的博客】【未经授权禁止转载】对于 json 中的一个 rule,包含本文作者:唐霜,转载请注明出处。【关注微信公众号:wwwtangshuangnet】如下字段:
【本文首发于唐霜的博客】【关注微信公众号:wwwtangshua【转载请注明来源】转载请注明出处:www.tangshuang.netngnet】【版权所有,侵权必究】未经授权,禁止复制转载。- route: 必传,表示当访问到哪一个 【访问 www.tangshuang.net 获取更多精彩内容】【作者:唐霜】uri 的时候执行这一条规则,它的值有两【版权所有】唐霜 www.tangshuang.net【原创不易,请尊重版权】种形式
- 正则表达式 [^\/api\/proje【关注微信公众号:wwwtangshuangnet】未经授权,禁止复制转载。cts\/(.*?)] 用 [] 作为正著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。则表达式的开头和结尾 【转载请注明来源】【版权所有】唐霜 www.tangshu【版权所有,侵权必究】【本文首发于唐霜的博客】ang.net著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。
- 字符串 /api/projects/* 转载请注明出处:www.tangshuang.net【未经授权禁止转载】其中支持 * 和末尾的 $ 【关注微信公众号:wwwtangshua【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】ngnet】未经授权,禁止复制转载。
本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】
- rewrite: 字符串 【未经授权禁止转载】原创内容,盗版必究。原创内容,盗版必究。【本文首发于唐霜的博客】
- retarget: 字符串 本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshu【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.netang.net
- rebase: 字符串,相对于 egw 未经授权,禁止复制转载。原创内容,盗版必究。命令执行目录的相对路径,也可以是绝对路径 【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshu【未经授权禁止转载】【原创不易,请尊重版权】ang.net【原创不易,请尊重版权】原创内容,盗版必究。
- request:
- headers: {} 未经授权,禁止复制转载。【版权所有】唐霜 www.tangshu转载请注明出处:www.tangshuang.net【未经授权禁止转载】ang.net
- cookies: ” 注意,著作权归作者所有,禁止商业用途转载。原创内容,盗版必究。是字符串 本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】未经授权,禁止复制转载。
【关注微信公众号:wwwtangshua本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。ngnet】原创内容,盗版必究。【访问 www.tangshuang.n未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。et 获取更多精彩内容】
- response:
- headers: {} 【版权所有】唐霜 www.tangshu【作者:唐霜】未经授权,禁止复制转载。ang.net未经授权,禁止复制转载。
- cookies: {} 【版权所有】唐霜 www.tangshu【版权所有,侵权必究】【版权所有,侵权必究】ang.net未经授权,禁止复制转载。
- data: {} 【本文受版权保护】【版权所有】唐霜 www.tangshu【原创内容,转载请注明出处】【转载请注明来源】ang.net转载请注明出处:www.tangshua未经授权,禁止复制转载。转载请注明出处:www.tangshuang.netng.net
原创内容,盗版必究。未经授权,禁止复制转载。【关注微信公众号:wwwtangshua本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】ngnet】转载请注明出处:www.tangshua【本文首发于唐霜的博客】【作者:唐霜】ng.net
其中,最后一个 data 表示你希望返回【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。给前端什么数据。需要注意,仅支持 jso【访问 www.tangshuang.net 获取更多精彩内容】【原创内容,转载请注明出处】n 结构。相当于你规定了前端将接受到什么【本文受版权保护】【原创内容,转载请注明出处】数据。
转载请注明出处:www.tangshua【原创不易,请尊重版权】原创内容,盗版必究。ng.net转载请注明出处:www.tangshua【版权所有,侵权必究】转载请注明出处:www.tangshuang.netng.netdata: {
"name": "name", // 表示使用后端服务返回的 name 字段的值作为要返回数据的 name 字段的值
"age": "some.age", // 表示用后端返回的 some 字段下的 age 字段,作为返回数据的 age 字段的值,你需要明确知道 some 为一个对象
"height": "some.height ? some.height : 0" // 支持非常简单的表达式,比如三目运算、加减乘除等等
}
场景重现
场景一
本文版权归作者所有,未经授权不得转载。【本文首发于唐霜的博客】转载请注明出处:www.tangshua【版权所有,侵权必究】【原创不易,请尊重版权】ng.net我们来看下一些场景。现在,我们在自己的一【转载请注明来源】著作权归作者所有,禁止商业用途转载。台服务器上运行着一个 phpmyadmi【作者:唐霜】本文版权归作者所有,未经授权不得转载。n,但是大家都知道,它有安全隐患,于是,【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。我们运行的这个 phpmyadmin 是原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net只能以 http://localhost本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】:8080/phpmyadmin 进行访【作者:唐霜】【未经授权禁止转载】问的。也就是说,一般情况下,没人能访问到本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net这个服务。
【关注微信公众号:wwwtangshua【原创不易,请尊重版权】【本文受版权保护】ngnet】【关注微信公众号:wwwtangshua原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。ngnet】现在,我们在这台服务器上使用 Easy-【版权所有】唐霜 www.tangshuang.net【版权所有,侵权必究】GateWay 做如下操作:
【转载请注明来源】【版权所有】唐霜 www.tangshu著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。ang.netegw start --port=3009 --target=http://localhost:8080/phpmyadmin --token=saf89wgn23minaop03jfoi
这个时候,我们就可以通过 http://著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】server-ip-address:30【作者:唐霜】【原创不易,请尊重版权】09?token=saf89wgn23m【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。inaop03jfoi 访问这个 php【本文首发于唐霜的博客】【转载请注明来源】myadmin 了。
【转载请注明来源】【本文受版权保护】在完成一些数据库操作之后,我们运行
【版权所有】唐霜 www.tangshu【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。ang.net原创内容,盗版必究。【本文首发于唐霜的博客】【关注微信公众号:wwwtangshua【作者:唐霜】原创内容,盗版必究。ngnet】egw stop
结束这次数据库处理任务。
本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshua原创内容,盗版必究。【关注微信公众号:wwwtangshuangnet】ng.net场景二
【版权所有】唐霜 www.tangshu【作者:唐霜】【未经授权禁止转载】ang.net本文版权归作者所有,未经授权不得转载。接下来我们再来看另外的一个场景。我们在某【本文受版权保护】【本文首发于唐霜的博客】台开放服务器上的某个服务正在运行在 ht【原创不易,请尊重版权】原创内容,盗版必究。tp://localhost:8080 【访问 www.tangshuang.net 获取更多精彩内容】【作者:唐霜】原本是不对外的。你希望临时进行调试,于是【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。利用 egw 进行代理:
【原创不易,请尊重版权】【关注微信公众号:wwwtangshua转载请注明出处:www.tangshuang.net本文版权归作者所有,未经授权不得转载。ngnet】egw start --port=3030 --target=http://localhost:8080 --token=xxsfiweg99we8fnwekwoig90
现在,你开始用对应的 url 进行访问查【本文首发于唐霜的博客】【版权所有,侵权必究】看。但是,每次都要带上 token,太麻本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net烦了。于是,你在自己的当前电脑上也安装了【作者:唐霜】【版权所有,侵权必究】 egw,然后在自己电脑上启动了一个代理【版权所有】唐霜 www.tangshuang.net著作权归作者所有,禁止商业用途转载。:
【本文首发于唐霜的博客】【本文首发于唐霜的博客】【本文首发于唐霜的博客】egw start --host=127.0.0.1 --port=8080 --target=http://some-address:3030 --headers=EGW-TOKEN:xxsfiweg99we8fnwekwoig90
在本机的启动时,你通过 host 限制了本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。只能本机进行访问,没有设置 token 【转载请注明来源】本文版权归作者所有,未经授权不得转载。表示可以直接访问,不需要身份验证,传入 本文版权归作者所有,未经授权不得转载。原创内容,盗版必究。headers 参数,则在访问远程服务时本文作者:唐霜,转载请注明出处。【转载请注明来源】,自动带上了 http HEADER 字本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net段。通过 headers 的配置,你访问【原创不易,请尊重版权】【作者:唐霜】本地代理出来的服务时,不需要自己手动传 【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】token,但实际上,本地代理在访问远端转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net代理出来的服务时,自动带上了该 toke【原创不易,请尊重版权】转载请注明出处:www.tangshuang.netn,于是非常容易的在本地进行远端的调试。
【原创不易,请尊重版权】【访问 www.tangshuang.n未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。et 获取更多精彩内容】小结
其实市面上也有挺多类似的代理工具。但主要【原创内容,转载请注明出处】【版权所有,侵权必究】出于自己开发过程中的一些特殊性考虑,所以【本文受版权保护】【关注微信公众号:wwwtangshuangnet】写了 Easy-GateWay,开发花的本文版权归作者所有,未经授权不得转载。【转载请注明来源】时间也不多,使用起来也更符合自己的习惯,著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。所以就写了它。另外,我还将创建一个 UI【原创内容,转载请注明出处】【转载请注明来源】 界面,用户通过 UI 界面来进行管理,【原创不易,请尊重版权】【版权所有,侵权必究】比如自动生成随机 token,比如将所有【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】代理服务集中到一个界面进行观看,而不是通【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。过命令行和文件进行管理。如果你有兴趣,欢转载请注明出处:www.tangshuang.net【转载请注明来源】迎参与到本项目中。
【访问 www.tangshuang.n【本文首发于唐霜的博客】【作者:唐霜】et 获取更多精彩内容】【转载请注明来源】著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。

