1 Star 0 Fork 6

wqgalex / iRpc

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

iRpc

介绍

iRpc为一款基于Nio通信实现的轻量级高性能rpc框架,支持单机及leader-follower部署模式,配置简单,通信效率高。 提供同步和异步(callBack模式)等多种消息发送方式,不依赖于第三方注册中心即可实现服务端自主选举(选举模块基于dleger源码改造),

启动类

ServerStarter 启动类

  • 构造方法
构造方法 作用
ServerStarter() 默认加载配置文件名为"application.yml"的配置文件,加载位置默认为resources目录下
ServerStarter(String pathName) 指定配置yml文件名称,格式为xxx.yml
ServerStarter(IRpcServerProperty property) 通过javaBean方式配置服务端信息
... 带扩展
  • server端yml配置信息详解

    参数名称 含义
    iRpcServer iRpc服务端配置信息
    serverPort 服务端监听端口
    heartbeat 服务端监测客户端心跳周期-暂未使用
    nodeName 当前服务节点名称,为ClusterNode-node值
    ClusterNode leader-flower集群模式节点信息,集群模式下多个节点的ClusterNode信息一样
    node 节点名称(建议使用:n0-nx,沿用的是dleger的模式),
    ip iRpcServer节点ip地址(或域名)
    port iRpcServer节点服务端口
  • yml配置信息模版

## iRpc服务端配置信息
iRpcServer:
  serverPort: 10916
  heartbeat: 60 # iRpc服务端检测iRpc客户端连接状态的最大心跳周期。
  nodeName: n0
  ClusterNode: #如果使用单机,则不配置该项,node从n1开始,n0属于localhost
    - node: n0
      ip: 127.0.0.1
      port: 10916
    - node: n1
      ip: 127.0.0.1
      port: 10917
    - node: n2
      ip: 127.0.0.1
      port: 10918

ClientStarter 启动类

  • 构造方法
构造方法 作用
ClientStarter() 默认加载配置文件名为"application.yml"的配置文件,加载位置默认为resources目录下
ClientStarter(String pathName) 指定配置yml文件名称,格式为xxx.yml
ClientStarter(IRpcClientProperty property) 通过javaBean实例化配置信息启动客户端
... 带扩展
  • 配置参数详解

    参数名称 含义
    iRpcClient iRpc客户端配置信息
    retryTimes serverNode节点网络连接失败重试次数,默认为3次
    serverModCluster true/false 服务端是否为leader-flower模式
    serverNode iRpc server端节点信息
    ip iRpcServer节点ip地址(或域名)
    port iRpcServer节点服务端口
  • yml配置信息模版

#iRpc客户端配置信息
iRpcClient:
  retryTimes: 3
  serverModCluster: true
  serverNode:
    - ip: 127.0.0.1 # 指定iRpc客户端连接的iRpc服务端节点信息,默认与第一个节点建立连接。
      port: 10916
    - ip: 127.0.0.1
      port: 10917
    - ip: 127.0.0.1
      port: 10918

消息发送

消息发送核心类为iRpc.base.messageDeal.MessageSender

方法名称 发送模式 返回结果
synBaseMsgSend 同步 ResponseData对象,returncode != 200 发送失败
asynBaseMsgSend 异步 boolean,发布成功或失败,通过回调方式异步处理方法执行结果

客户端消息发送流程图

启动流程

流程

如何引入

iRpc发行版本已同步到maven中央仓库,因此根据项目实际情况选择合适版本引入即可

<dependency>
  <groupId>io.github.brianapple</groupId>
  <artifactId>iRpc</artifactId>
  <version>2.0.1-Release</version>
</dependency>

版本

  • 1.0.2.Release 修复了1.0.1及之前版本,客户端无法正常启动的异常。
  • 2.0.1 支持集群动态扩展,支持配置信息通过javaBean方式配置
  • 2.0.3 完善集群扩展功能,支持"AB + C(A) -> ABC"、"AB + C(AB) -> ABC"等动态扩容模式。测试方法见iRpc.serverTest包中测试类

客户端demo

public class Test {
	public static void main(String[] args) {
		ServerRpc();
	}
	/**
	 * rpc服务端
	 */
	public static void ServerRpc(){
		ClientStarter clientStarter = new ClientStarter();
		try {
			Thread.sleep(6000);
		} catch (InterruptedException e) {
			e.printStackTrace();
		}
		while(true) {
			/**
			 * 同步消息发送
			 */
			Class<? >[] classType = new Class[]{String.class};
			Object[] argsData = new Object[]{"world"};
			ResponseData ret = MessageSender.synBaseMsgSend(false,
					"iRpc.rpcService.RPCExportServiceImpl",
					"test",
					classType,
					argsData,
					5000);

			System.out.println("客户端同步收到数据:"+ret.getData());
			//控制台输出:客户端同步收到数据:hello world
		}
	}

}

集群选举及扩容功能

raft选举

基本集群基于raft选举算法实现节点自举,当前选举模式下,节点包含当前集群下所有节点信息

raft选举

集群扩容-选举过程依然基于raft

扩容节点和原集群groupName必须一致,且iRpc不支持两个存在leader节点的集群合并扩容

AB + C(A) 或 AB + C(B) -> ABC

AB基于raft算法自举选出leader,C节点只携带AB集群中的一部分节点信息参与扩容,最终达成选举一致。 AB + C(A) 或  AB + C(B) -> ABC

AB + C(AB) -> ABC

AB基于raft算法自举选出leader,C节点携带原集群所有节点信息且groupName一致,参与集群扩容 AB + C(AB) -> ABC

系列教程

感谢

Netty 项目及作者,项目地址: https://github.com/netty/netty dledger 项目及作者,项目地址: https://github.com/openmessaging/openmessaging-storage-dledger IOTGate 项目及作者,项目地址:https://gitee.com/willbeahero/IOTGate

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request
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.

简介

iRpc为一款基于NIO技术实现的轻量级高性能rpc框架,支持基于raft选举算法不依赖第三方实现自主选举leader-follower节点, 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

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

搜索帮助