3 Star 4 Fork 0

dqy000 / simple-rpc

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

avatar

作者 gitee Starts gitee Starts

SimpleRpc介绍

这是一个极简风格的远程调用类库,并且带有一个简单的注册中心,支持服务断线重连,注册中心负载均衡(注册中心存在多个一样的服务提供方时根据配置来选择调用策略),还支持基本的点对点调用。

组件介绍

core

核心模块,包含了服务端,客户端通信,基本类库,工具类

common

公共模块,包含通用编解码器,通用类

center

注册中心服务,提供服务注册,发现功能,掉线重连,以及软负载均衡功能

spring-boot-starter-simple-rpc

服务端,客户端 spring boot插件,开箱即用

spring-boot-starter-simple-rpc-center

注册中心的spring boot插件

架构图

avatar

分支介绍

LV1

最初版本分支,只支持点对点调用,无注册中心(不推荐!)

master

最新分支,目前具备注册中心,掉线重连,调用负载均很策略支持以及LV1分支的全部功能

快速开始(基于SpringBoot Starter快速开始)

启动注册中心

1.新建spring boot项目,引入注册中心插件POM:

<dependency>
    <groupId>org.example</groupId>
    <artifactId>spring-boot-starter-simple-rpc-center</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.启动类如下:

@EnableCenterServer     //开启注册中心
@SpringBootApplication
public class CenterApplication  {
    public static void main(String[] args) {
        SpringApplication.run(CenterApplication.class);
    }
}

3.yaml配置如下:

server:
  port: 12345

simple-rpc-center:
  worker-thread-pool-size: 10 #工作线程池大小
  port: 33333                 #注册中心服务端口
  lb-strategy: "polling"      #注册中心负载均衡策略,目前支持2种:随机,轮询     

4.启动注册中心项目,启动成功如下所示:
avatar

注册中心服务就启动完成了,接下来准备RPC服务提供方和调用方。

创建RPC服务提供方

1.新建spring boot项目,引入SimpleRpc插件POM:

<dependency>
    <groupId>org.example</groupId>
    <artifactId>spring-boot-starter-simple-rpc</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2.RPC服务提供方的启动类如下:

@Configuration
@SpringBootApplication
@EnableSimpleRpcServer    //开启RPC服务端
public class ApplicationMain1{
    public static void main(String[] args) {
        SpringApplication.run(ApplicationMain1.class);
    }
}

3.编写一个简单的Service:

@Service
@RemoteClass        //表示需要暴露的服务类
public class TestServiceImpl implements TestService {

    @Autowired
    AppConfig appConfig;

    @RemoteFunction  //需要暴露的服务具体方法
    @Override
    public Std find() {
        //注意:Std类请实现java序列化接口 由于服务调用方,服务提供方都需要使用到该类,所以请自己以公共包的形式放入自己项目
        return new Std(111111,1); 
    }
}

4.yaml配置如下:

server:
  port: 7788

simple-rpc:
  port: 11111                   #RPC服务本地监听端口
  scan-pack: com.app1           #注解扫描根目录
  reconnection-time: 10000      #如果断线,自动重连间隔
  enabled-reconnection: true    #开启断线自动重连
  enabled-spring-support: true  #开启spring支持
  center-addr: "192.168.10.101" #注册中心地址
  center-port: 33333            #注册中心端口

5.启动服务提供方,使其向注册中心注册服务,以供调用方调用,启动成功如下: avatar

创建RPC服务消费方

1.同样的创建Spring Boot项目,引入SimpleRpc插件POM,同上服务提供方步骤一样

2.编写服务消费方的启动类,如下:

@SpringBootApplication
@EnableSimpleRpcClient   //开启RPC客户端
public class ApplicationMain2 {
    public static void main(String[] args) {
        SpringApplication.run(ApplicationMain2.class);
    }
}

3.yaml配置如下(含义参考服务提供方):

server:
  port: 9999

simple-rpc:
  scan-pack: com.app2
  enabled-reconnection: true
  reconnection-time: 5555
  enabled-spring-support: true
  center-addr: "192.168.10.102"
  center-port: 33333

4.编写远程调用接口:

@Caller   //表示一个远程调用的服务接口
public interface TestService {
    public Std find();
}

5.编写Control测试

@RequestMapping("/app2")
@RestController
public class TestControl {

    TestService testService=ProxyFactory.getProxy(TestService.class,null); //手动为该接口生成代理

    @RequestMapping(value = "/test",method = RequestMethod.GET)
    public Std test(){
        return testService.find();
    }
}

6.启动服务消费方项目,PostMan访问服务消费方Control
avatar
调用成功!

启用多个服务提供方实列

1.重复上述服务提供方创建步骤,创建多个服务提供方,在注册中心yaml中配置负载均衡策略为轮询:

  lb-strategy: "polling"      #注册中心负载均衡策略,目前支持2种:随机,轮询     

2.启用3个服务提供方,PostMan调用多次,分别返回:
avatar avataravatar
可见多次调用返回总是111111,222222,333333,111111,222222,333333....循环
关闭其中一个服务提供方(333333),注册中心感知到服务3下线,日志输出:

 [nioEventLoopGroup-2-4] INFO  server.support.ServerInfoMap - 192.168.10.102:55897 机器已经与注册中心断开连接...

再次多次调用:只会得到111111,222222循环的返回了。

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.

简介

一个基于netty的RPC程式 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/dqy000/simple-rpc.git
git@gitee.com:dqy000/simple-rpc.git
dqy000
simple-rpc
simple-rpc
master

搜索帮助