23 Star 135 Fork 50

palading / clivia

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

image

clivia是一款基于spring webflux的可扩展、高性能、高弹性、响应式的 api gateway

clivia_V0.0.1

License Travis


架构概览

image

模块介绍

  • clivia-admin-core : 网关配置管理后台核心模块

  • clivia-client-core : 网关核心模块

  • clivia-example : 开箱即用的实例

  • clivia-event : 系统事件入口模块

  • clivia-api : 基础api信息模块

  • clivia-cache : 系统缓存模块

  • clivia-dynamic : 基于groovy的动态代码文件加载模块

  • clivia-filter : 可扩展的系统过滤器集合模块

  • clivia-invoke : 可扩展的系统执行器集合模块

  • clivia-loadbalance : 内置可扩展的负载均衡策略模块

  • clivia-assembly-base : 系统中间件模块(redis、metrics、httpClient)

  • clivia-spi : 系统spi模块

  • clivia-support : 系统公共支撑模块


特点

  • 支持多种API配置方式,例如数据库、文件、可视化界面方式(规划中)配置API信息;支持系统/接口级别的服务接入
  • 系统具备安全验证、黑名单、验签、限流、url重写、熔断、mock、header、系统开关等常用过滤器;具备http、dubbo、spring cloud、websocket等类型rpc转发功能
  • 系统具备高弹性,在不停机的情况下支持基于groovy的代码文件加载
  • 模块划分清晰;扩展性强,具有完善的扩展机制
  • 支持高可用集群及灰度发布

系统介绍

1、API信息的配置

  • 数据库配置方式请参考/script/apiCconfig.docx
  • 文件配置方式请参考/script/fileConfig/fileConfig.md
  • web配置方式(规划中)

2、缓存&数据同步

  • spring 框架启动后会进行clivia-event模块调用,clivia-event会加载clivia-cache模块DefaultCliviaCacheManager类中的initCache方法,完成全量API配置/黑名单/filter/invoker的加载,并放入CliviaCacheFactory进行缓存。在首次加载完成后,系统会定时进行缓存增量更新
  • CliviaCacheFactory目前有三种缓存实现,分别为CliviaStandandCacheFactory(直接将数据更新到内存),CliviaLocalCacheFactory(分离式内存缓存更新) ,CliviaRemoteCacheFactory(分离式远程缓存,待完善)
  • API配置/黑名单配置的数据同步机制:clivia-cache模块通过http请求clivia-admin模块,clivia-admin 优先从本地缓存获取数据并响应该请求。

3、弹性

  • 在网关运行期间,可在不停机的情况下将测试完成的groovy动态代码文件放置在扫描目录下,系统将自动定时扫描该目录下的文件,并进行编译和加载
  • 目前支持filter和invoker的弹性加载,如有定制化需要,可参考clivia-dynamic

4、过滤器

  • 目前内置了多种网关过滤器,包括安全验证、黑名单、验签、限流、重写、熔断、header、mock、系统开关等,后续将持续添加更多过滤器
  • 定制化的方式:1、新增自定义过滤器模块,实现CliviaFilter接口并重新进行编译;2、通过加载动态文件的方式完成扩展定制。

5、执行器

  • 执行器提供不同Rpc下游服务转发,目前支持dubbo、http/https、spring cloud、websocket,后续可以添加更多执行器
  • 定制化的方式同过滤器

6、安全设计

  • 网关与配置管理端均使用token的方式进行单向交互
  • 网关提供请求的appKey校验以及请求数据验签

Getting started

1、clone project

 git clone https://gitee.com/palading_cr/clivia.git
 git clone https://github.com/palading123/clivia.git

2、install

   mvn clean install

3、check

  • json配置文件需要放到和clivia-gateway-admin同一台机器下,集群环境也是如此,也需要确保clivia-gateway-admin有权限读取配置文件
  • 如果json配置文件目录为D://opt//clivia//gateway//,clivia-gateway-admin配置文件(application.properties)中的属性clivia.admin.config.absoluteFilePath=D://opt//clivia//gateway//
  • clivia-gateway-client配置文件中的clivia.server.config.cliviaAdminUrl属性为clivia-gateway-admin的地址
  clivia.server.config.cliviaAdminUrl=http://localhost:1023

4、run

  • 先后启动clivia-example下的admin和client子工程,默认端口分别为1023和8099
     java -jar clivia-gateway-admin-0.0.1.jar
     java -jar clivia-gateway-client-0.0.1.jar
  • client启动成功时会显示clivia的logo:
   _____ _      _______      _______
/ ____| |    |_   _\ \    / /_   _|   /\
| |    | |      | |  \ \  / /  | |    /  \
| |    | |      | |   \ \/ /   | |   / /\ \
| |____| |____ _| |_   \  /   _| |_ / ____ \
\_____|______|_____|   \/   |_____/_/    \_\
:: clivia ::    (v0.0.1)

5、test

  • 我在clivia-gateway-admin中内置了一个测试的TestController,可以测试get和post请求,curl命令如下:
curl --location --request GET 'localhost:8099/clivia-server/api/get?test=reganmian' \
--header 'group: 1' \
--header 'version: V0.0.1' \
--header 'appKey: appKey1'
curl --location --request POST 'localhost:8099/clivia-server/api/post' \
--header 'group: 1' \
--header 'version: V0.0.1' \
--header 'appKey: appKey1' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"小陈","value":"25岁","house":{"houseAddr":"武汉","houseName":"光谷未来城"},"a":null,"c":null}'

交流

欢迎您加入到clivia交流群。 QQ群 1:574835875

协议


关于

  • 2021年3月后,作者个人利用零散的节假日时间完成了项目设计以及各模块的开发,劳烦大家star,让更多人关注到clivia。 作者最大的愿望是该项目能够让使用者受益,同时也希望开源社区爱好者能够一起完善该项目,争取早日能够将项目推进到release阶段。

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 2021 chenjiajun 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.

简介

clivia是一款基于spring webflux的可扩展、高性能、高弹性、响应式的 Api Gateway 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/palading_cr/clivia.git
git@gitee.com:palading_cr/clivia.git
palading_cr
clivia
clivia
main

搜索帮助