1 Star 0 Fork 176

yousun / flying-fish-gateway

forked from jiang88 / flying-fish-gateway 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

flying-fish-gateway(飞鱼网关系统)

介绍

基于spring-cloud-gateway开发的网关路由服务,用于服务与服务之间的通讯边界管理,支持过滤器、熔断、鉴权、限流、日志、监控等功能

解决目前项目中A==>B,A==>C,A==>...,服务与服务之间以直链访问的方式,改为A==>gateway==>B\C...,服务走网关访问另一个服务,使得服务通讯可控、可复用、统一管理、安全鉴权、服务能力保护等效果

特色

  1. 完全支持动态网关路由配置,在控制台界面修改完毕,即可生效
  2. 支持可动态配置IP、ID、TOKEN过滤器
  3. 支持可动态配置全局、自定义熔断器,实现业务高峰抗压能力
  4. 支持可动态配置IP、URL、REQUESTID等基于令牌桶算法自定义限流器,实现业务峰值固化,避免雪崩效应
  5. 支持可动态配置HEADER、IP、请求参数、时间、Cookie等鉴权验证,加强业务访问安全,避免或减少每个业务服务重复实现安全鉴权规则

流程图

网络拓扑图 (网络拓扑) 执行流程图 (执行流程)

  1. 前置nginx用于负载均衡,将请求代理分发到不同网关;
  2. gateway网关路由对请求进行鉴权、限流、熔断、日志等;
  3. gateway网关路由对注册服务进行管理与路由转发;

注:可不使用nginx,单机部署,客户端直连gateway网关转发到服务端,考虑高可用推荐前置nginx代理

软件架构

软件架构说明

本工程共分六个模块:

  1. dynameic-gateway为核心网关路由服务,提供客户端请求转发,服务端地址路由功能,以及过滤器、熔断、鉴权、限流、日志、监控等功能
  2. dynameic-manage为界面可视化管理后台,提供客户端管理、服务端管理、IP访问管理等功能
  3. formwork为核心框架,提供基础与公共业务处理模块与类
  4. eureka-server为注册与发现服务,只需启动即可,无其它业务操作
  5. admin-server为springboot服务提供监控管理,支持可视化WEBUI,只需启动即可,无其它业务操作
  6. examples为示例项目

后续开发计划:

  1. 增加全局日志输出,按一定格式存储,方便后续引入elk做数据分析
  2. 增加临控功能,支持大厅全局图表展示,与单个服务、单个客户端等访问量、流量、错误等监控图表展示

安装教程

  1. 依赖spring-boot 2.3.9.RELEASE、spring-cloud Hoxton.SR10 版本,注意版本的搭配
  2. 需安装eureke、consul等其中任意一种,也可无需注册中心运行
  3. 详细安装文档:doc/flying-fish-gateway-说明文档.docx

使用说明

  1. jdk1.8 +
  2. mysql.5.x +
  3. redis3.x +

前端项目

  1. 本项目采用前后端分离,此git仓库为纯后台模块
  2. 点击此链接下载,前端控制台管理项目 flying-fish-manage

前端界面

负载管理 (负载管理) 服务详情 (服务详情) 注册服务 (注册服务) 创建网关服务 (创建网关服务) IP名单 (IP名单) 接口文档 (接口文档) 接口统计 (接口统计) 接口监控 (接口监控)

参见个人说明文章

更新记录

++++++++ snapshot.v.3.0

  1. 升级springcloud Hoxton.SR10\springboot 2.3.9.RELEASE版本
  2. 扩展功能:新增接口心跳监控、邮件告警功能
  3. 代码优化,已知问题题修复

注:前端需要同步更新到v.3.0

++++++++ snapshot.v.2.0

  1. 代码优化,已知问题题修复
  2. 扩展功能:新增接口访问统计功能
  3. 优化:客户端名称可修改。

注:前端需要同步更新到v.2.0

++++++++ snapshot.v.1.0

  1. 代码优化,已知问题题修复
  2. 扩展功能:接口文档,提供API接口文档描述功能
  3. 添加限流拦截之后的通用规范json格式输出

++++++++ master

  1. 初始版本
  2. 建立基础功能:负载管理、服务管理、客户端管理、IP名单管理
  3. 其它底层开发

参与贡献

  1. 本项目为个人开发,基于实际应用场景设计与架构,满足内部业务代理网关需求与使用
  2. 欢迎有兴趣的朋友下载、学习、使用,如有问题请在issues中留言
  3. 本项目完全免费开源,可自行修改、编辑、另行发版与使用,不受任何商业限制(保不保留原作者信息,无所谓了)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

基于spring-cloud-gateway开发的网关路由服务,用于服务与服务之间的通讯边界管理,支持过滤器、熔断、鉴权、限流、日志、监控等功能 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/nmch/flying-fish-gateway.git
git@gitee.com:nmch/flying-fish-gateway.git
nmch
flying-fish-gateway
flying-fish-gateway
snapshot.v.3.0

搜索帮助