# rpcf

**Repository Path**: zhiming999/rpcf

## Basic Information

- **Project Name**: rpcf
- **Description**: 这是一个基于C++的多语言，高可用，高并发，高安全的RPC和流服务框架。自带接口定义语言，可快速生成分布式应用程序。QQ交流群: 749044836
- **Primary Language**: C++
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/zhiming999/rpcf
- **GVP Project**: No

## Statistics

- **Stars**: 29
- **Forks**: 7
- **Created**: 2022-04-21
- **Last Updated**: 2026-09-08

## Categories & Tags

**Categories**: rpc

**Tags**: RPC开发框架, rpc, IOT

## README

[[English]](./README.md)
# rpc-frmwrk ![new badge](https://img.shields.io/badge/RPC-C%2B%2B%2CPython%2CJava%2CJS(0.9.0)-green)


## 概述
* `rpc-frmwrk`是一个用C++实现的，支持多语言的，完全异步和并发的RPC系统，专注于跨网络，跨平台的互联互通，同时兼具高吞吐量和高可靠性。本系统占用较少的系统资源，可以在嵌入式系统中运行。本项目目前支持C++, Python, Java, 和JavaScript。

* `rpc-frmwrk`提供接口描述语言和框架代码的生成器，可以帮助用户快速搭建业务系统，平滑新系统的学习曲线。

* `rpc-frmwrk`在架构上可以灵活定制，既可以生成分布式的微服务架构，也可以生成可热插拔的集中式服务进程。可分别应对强调业务隔离松耦合，或者强调性能吞吐量的不同应用场景。
* `rpc-frmwrk`在安全传输方面，支持国密(GmSSL)和OpenSSL两种安全传输协议. 在身份认证和访问控制方面，`rpc-frmwrk`支持简单的`SimpAuth`密码认证，亦可通过`Kerberos`或者`OAuth2`提供单点登陆(SSO)服务。
* 更详细的概念和名词解释请参考[rpc-frmwrk的概念和技术介绍](./Concept_cn.md)。

## 功能列表   
1. `同步异步请求的发送和处理`   
2. `主动/被动取消已经发出的请求`   
3. `服务器主动推送事件`   
4. `长请求的保活功能`   
5. `对服务器的访问可以同时来自互联网, 不同进程，或者同一进程` 
6. `通信双方上线/下线的检测和通知`
7. `同一网络端口可以支持数目不限的多个服务端`
8. [`带有全双工流控的流通道`](./Concept_cn.md#流Streaming)
9. [`OpenSSL的支持`](./rpc/sslport/Readme.md)
10. [`Websocket支持`](./rpc/wsport/Readme.md)
11. [`基于multihop技术的Object访问`](https://github.com/zhiming99/rpc-frmwrk/wiki/Introduction-of-Multihop-support)
12. [`支持Kerberos, OAuth2和SimpAuth三种认证机制`](./rpc/security/README_cn.md)
13. [`自动生成C++，Python，Java或者JavaScript的框架代码`](./ridl/README_cn.md)
14. [`rpc-frmwrk的图形配置工具`](./tools/README_cn.md)
16. [`支持国密TLS13(SM2+SM4+GCM)`](./rpc/gmsslport/README_cn.md)
17. [`rpc-frwmrk监控器`](./monitor/client/js/appmoncli/README_cn.md)

## 开发RPC应用程序
通过`rpc-frmwrk`的接口描述语言(`ridl`)和编译器(`ridlc`), `rpc-frmwrk`提供四种语言(C++, Python, Java, JavaScript)的两种模式的`RPC`应用程序的开发.
1. `微服务模式`： `rpc-frmwrk`最早支持的的架构，用户通过运用`rpc-frmwrk`运行库提供的接口，和各种内建的工具类，执行同步，异步，超时，取消，以及`流`传输等功能，从而实现高性能的业务逻辑。`微服务模式`的可以动态的启停各个微服务，不需要中断其他的线上服务。
2. `紧凑模式`：如果对性能要求较高，你也可以使用`ridlc`生成传统的C/S架构，服务器和客户端，是两个单独的程序，特点是延迟小，吞吐量大，扩展性灵活性稍弱。
3. 对`rpc-frmwrk`的开发和技术细节感兴趣的读者，可以更进一步阅读[rpc-frmwrk的开发教程](./docs/Tut-Index.md)。
4. 关于`ridl`详细信息请参考这篇[文章](./ridl/README_cn.md)

## 编译, 配置和运行`rpc-frmwrk`   
1. 编译`rpc-frmwrk`请参考[如何编译rpc-frmwrk](./docs/Tut-HowToBuild_cn-9.md#速通编译rpc-frmwrk).
2. 在用户服务器运行之前，你需要配置`rpc-frwmrk`一些关键信息。`rpcfg.py`是`rpc-frmwrk`的图形界面配置工具。`rpcfg.py`功能强大，大部分`rpc-frmwrk`的运行参数，均可通过`rpcfg.py`进行设置。有关`rpcfg.py`的详细说明，可以参考其[使用说明](./tools/README_cn.md).
3. 配置完成后, 启动服务器端的守护进程，如`rpcrouter -dr 2`和客户端的守护进程，如`rpcrouter -dr 1`.  有关守护进程的详细信息请参考这篇[文章](./rpc/router/README_cn.md).
5. 连通性测试。可运行系统自带的测试程序来验证当前设置是否正确. 先在服务器端启动服务器程序`/usr/local/bin/rpcf/hwsvrsmk`, 然后在客户端启动`/usr/local/bin/rpcf/hwclismk`.根据`hwclismk`的输出进行验证。这篇[wiki](https://github.com/zhiming99/rpc-frmwrk/wiki/How-to-get-Helloworld-run)有更详细的介绍.
4. 待一切就绪后，分别启动用户服务器和客户端。

### 部署
* 多数情况下，开发主机和目标主机是不同的主机，针对这种情况，`rpcfg.py`和`rpcfctl`可以生成目标机器的`安装包`。`安装包`安装`rpc-frwmwrk`的运行库并执行系统一级的设置。设置内容包括`rpc-frmwrk`的运行参数，`Apache`或者`Nginx`web服务器的设置，SSL密钥分发，以及认证所需的必要信息。详细说明请参考`rpcfg.py`的[使用说明](./tools/README_cn.md)有关安装包的部分. 
* 在没有图形界面的环境下，可以使用`rpcfctl`可以完成相关的配置任务。有关`rpcfctl`的详细信息请参考这篇[文章](./monitor/appmon/rpcfctl_cn.md)。

## 监控
`rpc-frmwrk`提供一个网页版的监控程序，可以方便的从各种平台对`rpc-frmwrk`服务器进行监视并设置运行参数。
* 监控程序具有访问控制功能，对于不同的用户，所能访问到的内容会有区别。访问控制可以方便的进行定制。
* 监控系统可以在后台对感兴趣的设置点开启日志功能，从而可以提供更详细的历史数据以供分析和优化。
* 监控程序可以监控`rpc-frmwrk`的系统程序，也可以通过注册的方式，监控用户开发的`rpc-frmwrk`服务器程序。
* 有关监控功能的搭建可参考这篇[文章](./monitor/client/js/appmoncli/README_cn.md)。

## 第三方依赖  
1. `dbus-1.0 (dbus-devel)`
2. `libjson-cpp (jsoncpp-devel)` 
3. `lz4 (lz4-devel)`   
4. `cppunit-1 用于测试用例的代码中`   
5. `openssl-1.1用于支持SSL的连接.`（可选）
6. `MIT krb5 用于用户认证.`（可选）
7. `C++11 和 GCC 5.x+.`
8. `Python 3.5+.`
9. `Java OpenJDK 8+.`（可选）
10. `npm 9.0 and webpack`（可选）
11. `FUSE-3`
12. `GmSSL 3.0`（可选）
## 文档和教程
  文档索引见[Index](./docs/index_cn.md) ![new](./pics/new.png)