1 Star 0 Fork 90

jack / HXAPIGate

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

简介

操作文档

操作文档目前正在整理中,后续会将网关的部署、接口发布等操作的详细说明贴出来,为大家参考

概念

HXAPIGate(中文名:浩心API网关)——如果觉得可以请star本项目。 HXAPIGate基于Netty+Shiro开发的一款高性能API网关,对基于REST服务的细粒度API资源的权限管理平台,支持http,dubbo等多协议微服务接口代理。 输入图片说明

MECHA--机甲

电影阿凡达肯定很多人都看过,地球大军在潘多拉星球的穿着各种武装机甲(mecha)战斗的场面很是震撼! macha

大家可以想象一下,机甲里面的战士就是我们的微服务,虽然我们的战士在不借助机甲的情况下也能战斗,但是穿上机甲能让我们变得更加强大,同时提供一些我们所不具备的其他能力。同理,单纯的一个微服务个体虽然能够处理各种业务逻辑, 但是能力总是不足以完全胜任越来越严苛的运行环境,比如微服务的分布式限流、服务熔断、权限认证等,如果把这些功能都下放到微服务本身,除了会增加微服务开发人员的学习成本外,还会导致微服务的研发不能专注于业务本身,而需要做 大量与业务无关的操作。

浩心网关是微服务思想结合mecha 思想落地的产物。如下图所示,描述微服务与浩心网关的关系,内部浅绿色区域为业务相关微服务区,浩心网关所在区域为外部分布式特性区域, 由图可知,微服务不需要考虑任何分布式特性,更不需要在服务的生命周期中引入与业务功能不相关的任何第三方分 布式组件特性(典型如spring cloud全家桶),当一个业务微服务单元发布之后,浩心网关会直接赋予该服务所有分 布式组件特性。当然大家如果了解过service mesh,就会发现与其有神似之处,未来将浩心网关打造成一款工业级sidecar, 也是我希望的能够达到的目标之一。

输入图片说明

为什么不选择springCloud or dubbo

  • 不选择springcloud的原因很简单,除非贵公司项目全是新上马的项目,没有任何历史遗留问题——就算果真如此,在某些情况下也不建议使用springCloud(springCloud的学习成本等因素)--不选择 springCloud的原因就是因为考虑到很多公司遗留的一些历史问题,无法改用springCloud,但是如果在无法改用dubbo或者springCloud却想在不更改或者极少更改的情况下实现微服务的分布式限流、服务熔断等 分布式服务特性,那么恭喜您,HXAPIGate的目的正是如此。
  • 不选择dubbo的原因,首先HXAPIGate其实是兼容了dubbo协议的,用户侧目前统一为HTTP协议,因此虽然API网关本身不对外提供dubbo服务对外服务,但是可以代理dubbo微服务,同时也可以实现对dubbo的分布式限流。

项目文档

项目文档请参加项目的Wiki,里面会介绍项目的使用方法已经路由的配置方法等信息。如果觉得项目不错,别忘了给个star!谢谢!

特色

目前多数授权管理平台都只单单对api路径资源本身授权,而不能做到更细粒度的权限控制,HXAPIGate通过组合bootshiroPro实现了对“api资源+请求方式”的授权模式。 如: 新增如下四个接口

接口路径 请求方式
“/user/list” GET
“/user/list” POST
“/user/list” DELETE
“/user/list” PUT

传统授权模式下,这四个接口会被当做一个接口(因为接口路径一致)授权给第三方,而通过HXAPIGate可分别对每个资源进行授权,当仅仅授权“/user/list”+“GET”给第三方平台时,被授权放无法访问同一资源的POST、DELETE、PUT请求当时的接口!

授权认证时序图

授权流程

性能

2000并发事务压测报告(jdk1.8,jvm堆内存512M) API网关2000并发压测图(jvm=512M)

网关部署结构

输入图片说明

操作演示

登录(用户名密码为:admin/admin)

输入图片说明

新增接口类别

输入图片说明

新增接口

输入图片说明

接口授权

输入图片说明

目前网关已实现功能

  1. 授权、鉴权管理
  2. 路由配置
  3. 路由负载(轮寻和赋权值)
  4. HTTP、dubbo多协议协议
  5. 接口分布式限流
  6. 金丝雀发布
  7. 接口降级

项目进度

目前HXAPIGate仍在继续进行项目重构和功能完善中,目前HXAPIGate的分布式特性只完成了一部分,由于作者和团队的精力实在有限,因此开发进度会比较缓慢,希望大家谅解,同时请star并持续关注本项目!

相关博文

《netty整合shiro,报There is no session with id [xxxxxx]问题定位及解决》

https://blog.csdn.net/sinat_28771747/article/details/105245229

感谢

Netty 项目及作者,项目地址: https://github.com/netty/netty ignite 项目及作者,项目地址: https://github.com/apache/ignite shiro 项目及作者,项目地址: https://github.com/apache/shiro dubbo 项目及作者,项目地址: https://github.com/apache/dubbo bootshiro 项目及作者,项目地址:https://gitee.com/tomsun28/bootshiro

参与贡献

当前项目仍处在研发过程中,由于目前只有两三个人贡献源码,且都是利用周末研发,导致目前研发进度缓慢, 因此迫切希望有识之士一起参与到浩欣API网关的建设中来,共同推进该项目的研发进程,力争在2020年年底发 布alpha版本,2021年3月发布第一个稳定版本,有意报名者请发送邮件至:ycheng155@gmail.com;邮件中简单 描述一下自己对网络编程、网络通信协议的理解,注明自己目前主要使用的编程语言(java、golang等),前 端研发的同学注明自己主要使用的前端框架技术(angular、vue等)。欢迎大家积极参与到HXAPIGate的项目建设中来。

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.

简介

浩心API网关--基于Netty+Shiro开发的一款高性能零侵入式API网关,适用于REST微服务的API资源授权管理等 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/jack888/HXAPIGate.git
git@gitee.com:jack888/HXAPIGate.git
jack888
HXAPIGate
HXAPIGate
master

搜索帮助