1 Star 0 Fork 2

ParkJun / vertx-gateway-template

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

vertx-gateway-template

这不是一个框架,而是一个基于 Vert.x 的 OpenAPI 服务模板,用于快速构建微服务网关。充分利用 Vert.x 的响应式特性,提供高性能的 OpenAPI 服务。相比于其他的 Java 的多线程微服务框架,Vert.x 的性能更高,更轻量,更灵活,更易于扩展。

关键是服务启动时间是毫秒级的!

Vert.x 的性能介绍

相比于其他的 Java 框架,甚至是其他编程语言的框架,Vert.x 的性能都是遥遥领先的,请看来自 TechEmpower 的综合性能比较结果:

techmpower benchmark

这里有一篇文章详细介绍了 《Vert.x 为什么高性能》

为什么要搞这个模板

那么为什么要搞这么一个模板项目呢?因为 Vert.x 只是一个库,并非框架,也就是说不同人使用 Vert.x 写出来的应用风格五花八门,没有统一的规范。这个模板项目就是为了解决这个问题,它提供了一些基础的功能,让你可以快速的构建一个微服务网关。

该模板主要包括:

  • 根据配置加载微服务
  • 自动化分布式集群配置
  • 引入 jdbi 简化数据库访问(因为响应式的数据库访问方法实在很难受)
  • openapi 3.0 规范的接口文档自动映射 Handler
  • 封装了接口的限流能力 (HelloHandler.java#serviceTest)

目录及文件说明

  • [config] - 配置文件目录,包含了微服务的配置文件(核心服务、微服务定义、数据库、集群等配置)
  • [core] - 核心模块,包含了基础服务启动、集群配置、数据库连接管理、缓存等功能
  • [services] - 微服务模块,包含了多个微服务的代码
  • [services/openapi] - openapi 服务模块,对外提供 OpenAPI 的 HTTP 访问入口
  • [services/demo] - 一个最简单的微服务模块,用于演示如何编写微服务
  • [gateway] - 业务代码,一般业务相关的代码都在这里
  • [frontend/swagger] 存放了前端的 swagger-ui 代码,用于展示 OpenAPI 文档
  • start.sh (start.bat) 服务启动脚本

Requirements

  1. Git
  2. Java 21+
  3. Maven 3.8.x
  4. Vert.x 4.x
  5. jdbi 3.x

开发说明

业务代码统一放到 [gateway] 模块中,微服务代码统一放到 [services] 模块中。[gateway] 包含一个最简单的接口示例。

1. 编写接口处理

首先在 openapi.yaml 中定义接口。 这是 OpenAPI 接口定义文件,其中特别重要的部分是 operationId 的值,该值的格式形如 [category].[action]

你需要在 Handlers.java 的 handle 方法中定义对 [catagory] 的处理类,一般为 [Catagory]Handler,然后在该类中的 mapping 方法定义 [action] 的相应处理方法,具体请参考 HelloHandler.java

2. 编写微服务

微服务代码统一放到 [services] 模块中,每个微服务都是一个单独的模块,模块名一般为 [service-xxx],其中 xxx 为微服务的名称。

具体请参考 [services/demo] 模块。请特别主意源码中的 package-info.java 文件,Vert.x 根据这个文件来给微服务生成服务代理类,以便调用该服务。

3. 编写数据库访问方法

本模板使用 jdbi 库进行数据库读写,同时模板已经内置了一些缓存的注解,具体使用请参考 DemoDao.java

其中涉及到数据库记录与 Bean 类的映射,请参考 DemoBean.java

4. 用户鉴权

基于 UserAuthHandler.java 完善基于 Token 的用户鉴权机制。

集群部署

server.yaml 中的 cluster/enabled 值修改为 true 即可启用集群模式,默认使用 hazelcast 集群解决方案,详细的集群行为配置请看 hazelcast.yaml

在多个节点上,每个节点的配置都用启用集群模式,你可以在 services.yaml 决定每个节点运行什么微服务,然后启动服务即可。 例如在本例中你可以将 openapi 服务跑在 A 机器上,把 demo 服务跑在 B 机器上。

服务启动

启动前请使用 Maven 编译项目:

mvn clean package

本模板提供了服务启动脚本 start.sh 或者 start.bat,利用 -d 参数可以使用守护模式启动服务。

./start.sh -d

测试接口:

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.

简介

这不是一个框架,而是一个基于 Vert.x 的 OpenAPI 服务模板,用于快速构建微服务网关 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/ParkJun/vertx-gateway-template.git
git@gitee.com:ParkJun/vertx-gateway-template.git
ParkJun
vertx-gateway-template
vertx-gateway-template
main

搜索帮助