NewLife.Remoting
3.0.2024.625-beta1714
See the version list below for details.
dotnet add package NewLife.Remoting --version 3.0.2024.625-beta1714
NuGet\Install-Package NewLife.Remoting -Version 3.0.2024.625-beta1714
<PackageReference Include="NewLife.Remoting" Version="3.0.2024.625-beta1714" />
paket add NewLife.Remoting --version 3.0.2024.625-beta1714
#r "nuget: NewLife.Remoting, 3.0.2024.625-beta1714"
// Install NewLife.Remoting as a Cake Addin #addin nuget:?package=NewLife.Remoting&version=3.0.2024.625-beta1714&prerelease // Install NewLife.Remoting as a Cake Tool #tool nuget:?package=NewLife.Remoting&version=3.0.2024.625-beta1714&prerelease
NewLife.Remoting - 协议通信库
协议通信库，二进制封装，提供高吞吐低延迟的高性能RPC框架
源码： https://github.com/NewLifeX/NewLife.Remoting
Nuget：NewLife.Remoting / NewLife.Remoting.Extensions
组织架构
RPC框架
客户端：ApiClient
服务端：ApiServer
应用客户端：ClientBase
特点：
- 服务端根据Action把请求转发给各个Controller，用法跟WebApi一致。
- 简单高性能，网络库上来就是二进制序列化，中间没有任何损耗
- TCP/UDP长会话，支持主动下发
- 最高连接，单机400万TCP长连接
- 常见吞吐，单机10万TPS，最高2266万TPS
- 可寄宿于控制台、Web项目、桌面应用、IoT嵌入式应用
WebApi框架
客户端：ApiHttpClient
服务端：ASP.NET WebApi
应用客户端：ClientBase
应用服务端：BaseDeviceController
特点：
标准ASP.NET WebApi作为服务端，重用原有技术栈。
客户端ApiHttpClient是标准HttpClient的进一步封装，支持多服务端地址。
服务端提供BaseController基类，封装了令牌验证等鉴权机制
服务端提供BaseDeviceController基类，封装常见的登录、心跳和更新等接口
通过WebSocket长连接实现指令下发，心跳保活
常见吞吐，1万TPS
目标定位
在分布式系统中，RPC尤为重要。SRMP是新生命团队专门为了RPC框架而设计的通信协议，既支持内网高速通信，也能覆盖物联网嵌入式设备。
经过十多年实战经验积累以及多方共同讨论，新生命团队（https://newlifex.com）制订了一种简单而又具有较好扩展性的RPC（Remote Procedure Call）协议。
全称：简易远程消息交换协议，简称： SRMP（Simple Remote Messaging Protocol）
SRMP主要定位于以下场景：
- 内网高速通信，大吞吐量（>10万tps）、低延迟（<1ms）
- 外网远程通信，稳定可靠，海量连接（>10万）
- 物联网硬件设备，容易简单实现协议
- 支持TCP/UDP/串口/蓝牙BLE等多种通信方式
协议基础
消息结构
协议： 1 Flag + 1 Sequence + 2 Length + N Payload
- 1个字节标识位，标识请求、响应、错误、单向广播等；
- 1个字节序列号，用于请求响应包配对；
- 2个字节数据长度N，小端字节序，指示后续负载数据长度（不包含头部4个字节），解决粘包问题；
- N个字节负载数据，数据内容完全由业务决定，最大长度65534=64k-2。
长度扩展
数据中心内网通信中，负载数据大于等于64k时，数据长度字段填65535（0xFFFF），启用后续4字节扩展长度，最大长度4G（0xFFFFFFFF），此时头部总长度是8字节。
嵌入式物联网硬件设备建议直接忽略扩展长度，仅需支持4字节头部，限制负载数据小于64k。
采用固定2字节表示长度，方便任意语言接入，特别是嵌入式实现，在这一点上完胜变长的七位压缩编码整数。内网高速通信可实现8字节头部扩容，而物联网嵌入式设备则可以直接不考虑扩容。
1字节序列号，主要用于UDP通信、串口通信、无线通信等做请求与响应的匹配，这是多路复用的根基所在。
通信方式
本协议默认采用请求应答模式，此外还支持异常响应及单向广播，由协议标识位最高两位来定义。
- 客户端向服务端发起RPC请求（Flag=0x01），携带自增序列号Seq，异步等待响应。
- 服务端收到RPC请求后，处理业务并把结果打包成RPC响应（Flag=0x81），使用相同的Seq发回去给客户端。
- 客户端收到响应后，匹配Seq，返回给调用方。
- 服务端处理RPC请求出现异常时，打包RPC异常（Flag=0xC1），使用相同的Seq返回给客户端。
- 客户端收到异常响应后，匹配Seq，向调用方抛出异常。
- 客户端和服务端随时可以向对方发送单向广播（Flag=0x41），接收方无需回复。
- 客户端可以发起RPC请求以及单向广播，服务端仅能回复响应以及发送单向广播而不能主动发起RPC请求。
RPC报文
SRMP主要分为请求、响应、异常和单向广播几种报文。报文由协议头和负载数据体两大部分组成。
请求报文
RPC请求报文，数据体分为接口名称Action和请求参数Data两部分。1个字节表示名称长度，因此名称最大长度为255字符。4个字节表示请求参数的数据长度，最大4G。
如若有扩展需要，可在后面附加多个具有4字节长度的变长数据，整体格式不变。例如，某些场景需要Token令牌或者TraceId追踪，实际上可以作为请求参数一部分来整体封包。
请求参数默认采用Json序列化封包，高速接口支持直接以二进制Packet作为参数，绕开序列化的成本开支。强烈建议10000tps以上的接口采用高速Packet传参，此时接口入参只能有一个Packet参数。用户自己对参数进行二进制序列化。
在高并发大吞吐系统中，序列化成本占据整体通信耗时的70%以上，远远超过网络开支。
| 字节 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
|---|---|---|---|---|---|---|---|---|
| 1 Flag | 请求0 | 单向0 | 保留 | |||||
| 1 Seq | 序列号（0~255） | |||||||
| 2 Length | 数据长度（0~65534） | |||||||
| Body | 名称长度（1字节） | 接口名称（Action） | ||||||
| 数据长度（4字节） | 请求参数（Data） |
响应报文
RPC响应报文，数据体分为接口名称Action和结果数据Data两部分。1个字节表示名称长度，因此名称最大长度为255字符。4个字节表示结果数据的数据长度，最大4G。
如若有扩展需要，可在后面附加多个具有4字节长度的变长数据，整体格式不变。
响应数据默认采用Json序列化封包，高速接口支持直接以二进制Packet作为数据，绕开序列化的成本开支。强烈建议10000tps以上的接口采用Packet作为响应数据，此时接口返回类型必须是Packet。用户自己对数据进行二进制反序列化。
| 字节 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
|---|---|---|---|---|---|---|---|---|
| 1 Flag | 响应1 | 错误0 | 保留 | |||||
| 1 Seq | 序列号（0~255） | |||||||
| 2 Length | 数据长度（0~65534） | |||||||
| Body | 名称长度（1字节） | 接口名称（Action） | ||||||
| 数据长度（4字节） | 结果数据（Data） |
异常报文
RPC异常响应报文，数据体分为接口名Action、错误码Code和结果数据Data三部分。响应代码固定4字节整数，其它同响应报文。
| 字节 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
|---|---|---|---|---|---|---|---|---|
| 1 Flag | 响应1 | 错误1 | 保留 | |||||
| 1 Seq | 序列号（0~255） | |||||||
| 2 Length | 数据长度（0~65534） | |||||||
| Body | 名称长度（1字节） | 接口名称（Action） | ||||||
| 响应代码（Code）（4字节） | ||||||||
| 数据长度（4字节） | 结果数据（Data） |
单向广播
RPC单向广播报文，标记位高位填01，其它同请求报文。
| 字节 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
|---|---|---|---|---|---|---|---|---|
| 1 Flag | 请求0 | 单向1 | 保留 | |||||
| 1 Seq | 序列号（0~255） | |||||||
| 2 Length | 数据长度（0~65534） | |||||||
| Body | 名称长度（1字节） | 接口名称（Action） | ||||||
| 数据长度（4字节） | 请求参数（Data） |
参数封包
客户端请求和服务端响应，其中都有Data数据主体部分（请求参数和结果数据），根据使用场景不同，主要分为Json封包、二进制封包和基础类型封包等方式。SRMP协议强大之处在于，可以混合使用多种封包方式，简单接口使用Json封包和基础类型封包，文件和多媒体传输接口使用二进制封包。
请求参数对应接口入参，接口返回对应Invoke返回，一般要求两边类型对应。但也不尽然，只要一边能够解析另一边的数据就行。
封包原理
- 客户端发起Invoke调用时，接口名称Action和参数对象Data将封包成为请求报文。其中接口名称固定为字符串封包，而请求参数根据使用场景不同，使用不同的封包方式，最终都是二进制数据。
- 服务端接口入参，一般使用客户端请求参数相同类型，但也可以使用完全不同的类型，只要能够解析出来即可。例如，不管请求参数是什么类型，接口入参一定可以使用Byte[]或Packet，此时可就得自己解析二进制数据了。又如，请求参数是复杂对象，使用Json封包，而接口入参使用String，那么将会收到一段Json字符串。
- 服务端接口返回结果数据，一般使用强类型对象，使用Json封包或二进制封包返回，最终也都是二进制数据。
- 客户端Invoke收到服务端响应时，根据TResult解析结果数据Data，一般使用服务端接口的返回类型。也可以使用Byte[]/Packet/String/IDictionary<String,Object>等类型解析返回数据。
- 如果服务端接口抛出异常，将返回异常报文，并且把异常信息打包在Data中返回。客户端Invoke内部解析异常报文的Code和Data以后，抛出ApiException异常。
Json封包
请求参数或结果数据是复杂对象时，默认使用Json序列化。
await _Client.InvokeAsync<Object>("api/info", new { state="abcd", state2=1234 })
客户端使用以上代码，请求参数Data的封包就是：{"state":"abcd","state2":1234}，共30字节。
Json封包具有很好的可读性和兼容性，能够满足绝大多数应用场景。它的缺点就是性能损耗，频繁传输较大对象时，大部分时间都耗费在Json序列化之上。
二进制封包
请求参数或结果数据是极为复杂且需要自定义序列化的对象，或者干脆直接就是传输二进制数据时，使用二进制封包。
复杂对象支持IAccessor接口时，可通过该接口的Read/Write实现二进制序列化及反序列化；
参数或结果直接就是Byte[]或Packet时，直接封包；
await _Client.InvokeAsync<Object>("api/info", new MyAccessor{ state="abcd", state2=1234 })
客户端使用以上代码，请求参数Data的封包就是：0461626364D209，共7个字节，远比Json封包的30字节要小得多。
二进制封包具有极高的吞吐性能、极小的报文大小。它的缺点就是可读性很差，网络抓包后几乎识别不出来内容。例如文件传输和多媒体传输等场景，就可以优先使用二进制封包。
基础类型封包
请求参数和结果数据也支持使用简单类型，例如整数、小数、布尔型、时间日期和字符串等，此时统一按照字符串进行封包传输。
新生命项目矩阵
各项目默认支持net7.0/net7.0/netstandard2.1/netstandard2.0/net4.61，旧版（2022.1225）支持net4.5/net4.0/net2.0
| 项目 | 年份 | 说明 |
|---|---|---|
| 基础组件 | 支撑其它中间件以及产品项目 | |
| NewLife.Core | 2002 | 核心库，日志、配置、缓存、网络、序列化、APM性能追踪 |
| NewLife.XCode | 2005 | 大数据中间件，单表百亿级，MySql/SQLite/SqlServer/Oracle/TDengine/达梦，自动分表 |
| NewLife.Net | 2005 | 网络库，单机千万级吞吐率（2266万tps），单机百万级连接（400万Tcp） |
| NewLife.Remoting | 2011 | RPC通信框架，内网高吞吐或物联网硬件设备场景 |
| NewLife.Cube | 2010 | 魔方快速开发平台，集成了用户权限、SSO登录、OAuth服务端等，单表100亿级项目验证 |
| NewLife.Agent | 2008 | 服务管理组件，把应用安装成为操作系统守护进程，Windows服务、Linux的Systemd |
| NewLife.Zero | 2020 | Zero零代脚手架，基于NewLife组件生态的项目模板，Web、WebApi、Service |
| 中间件 | 对接知名中间件平台 | |
| NewLife.Redis | 2017 | Redis客户端，微秒级延迟，百万级吞吐，丰富的消息队列，百亿级数据量项目验证 |
| NewLife.RocketMQ | 2018 | RocketMQ纯托管客户端，支持Apache RocketMQ和阿里云消息队列，十亿级项目验 |
| NewLife.MQTT | 2019 | 物联网消息协议，MqttClient/MqttServer，客户端支持阿里云物联网 |
| NewLife.IoT | 2022 | IoT标准库，定义物联网领域的各种通信协议标准规范 |
| NewLife.Modbus | 2022 | ModbusTcp/ModbusRTU/ModbusASCII，基于IoT标准库实现，支持IoT平台和IoTEdge |
| NewLife.Siemens | 2022 | 西门子PLC协议，基于IoT标准库实现，支持IoT平台和IoTEdge |
| NewLife.Map | 2022 | 地图组件库，封装百度地图、高德地图和腾讯地图 |
| NewLife.IP | 2022 | IP地址库，IP地址转物理地址 |
| 产品平台 | 产品平台级，编译部署即用，个性化自定义 | |
| AntJob | 2019 | 蚂蚁调度，分布式大数据计算平台（实时/离线），蚂蚁搬家分片思想，万亿级数据量项目验证 |
| Stardust | 2018 | 星尘，分布式服务平台，节点管理、APM监控中心、配置中心、注册中心、发布中心 |
| NewLife.ERP | 2021 | 企业ERP，产品管理、客户管理、销售管理、供应商管理 |
| CrazyCoder | 2006 | 码神工具，众多开发者工具，网络、串口、加解密、正则表达式、Modbus |
| XProxy | 2005 | 产品级反向代理，NAT代理、Http代理 |
| HttpMeter | 2022 | Http压力测试工具 |
| GitCandy | 2015 | Git源代码管理系统 |
| SmartOS | 2014 | 嵌入式操作系统，完全独立自主，支持ARM Cortex-M芯片架构 |
| SmartA2 | 2019 | 嵌入式工业计算机，物联网边缘网关，高性能.NET6主机，应用于工业、农业、交通、医疗 |
| 菲凡物联FIoT | 2020 | 物联网整体解决方案，建筑、环保、农业，软硬件及大数据分析一体化，单机十万级点位项目验证 |
| NewLife.UWB | 2020 | 厘米级（10~20cm）高精度室内定位，软硬件一体化，与其它系统联动，大型展厅项目验证 |
新生命开发团队
新生命团队（NewLife）成立于2002年，是新时代物联网行业解决方案提供者，致力于提供软硬件应用方案咨询、系统架构规划与开发服务。
团队主导的开源NewLife系列组件已被广泛应用于各行业，Nuget累计下载量高达60余万次。
团队开发的大数据核心组件NewLife.XCode、蚂蚁调度计算平台AntJob、星尘分布式平台Stardust、缓存队列组件NewLife.Redis以及物联网平台NewLife.IoT，均成功应用于电力、高校、互联网、电信、交通、物流、工控、医疗、文博等行业，为客户提供了大量先进、可靠、安全、高质量、易扩展的产品和系统集成服务。
我们将不断通过服务的持续改进，成为客户长期信赖的合作伙伴，通过不断的创新和发展，成为国内优秀的IT服务供应商。
新生命团队始于2002年，部分开源项目具有20年以上漫长历史，源码库保留有2010年以来所有修改记录
网站：https://newlifex.com
开源：https://github.com/newlifex
QQ群：1600800/1600838
微信公众号：
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net40 is compatible. net403 was computed. net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.0
- NewLife.Core (>= 10.10.2024.623-net40)
-
.NETFramework 4.5
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
.NETFramework 4.6.1
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
.NETStandard 2.0
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
.NETStandard 2.1
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
net5.0
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
net6.0
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
net7.0
- NewLife.Core (>= 10.10.2024.625-beta1559)
-
net8.0
- NewLife.Core (>= 10.10.2024.625-beta1559)
NuGet packages (5)
Showing the top 5 NuGet packages that depend on NewLife.Remoting:
| Package | Downloads |
|---|---|
|
NewLife.Stardust
星尘，分布式服务框架。节点管理，监控中心，配置中心，发布中心，注册中心 |
|
|
NewLife.Net
网络通讯基础框架及各种协议实现。 |
|
|
NewLife.MQTT
流行的物联网通信协议MQTT，包括客户端、服务端 |
|
|
NewLife.AntJob
分布式任务调度系统，纯NET打造的重量级大数据实时计算平台，万亿级调度经验积累。 |
|
|
NewLife.Remoting.Extensions
提供WebApi应用级服务端 |
GitHub repositories (6)
Showing the top 5 popular GitHub repositories that depend on NewLife.Remoting:
| Repository | Stars |
|---|---|
|
RRQM/TouchSocket
TouchSocket is an integrated .NET networking framework that includes modules for socket, TCP, UDP, SSL, named pipes, HTTP, WebSocket, RPC, and more. It offers a one-stop solution for TCP packet issues and enables quick implementation of custom data message parsing using protocol templates.
|
|
|
NewLifeX/AntJob
分布式任务调度系统，纯NET打造的重量级大数据实时计算平台，万亿级调度经验积累！面向中小企业大数据分析场景。
|
|
|
NewLifeX/Stardust
星尘，轻量级分布式服务框架。配置中心、集群管理、远程自动发布、服务治理。服务自动注册和发现，负载均衡，动态伸缩，故障转移，性能监控。
|
|
|
NewLifeX/NewLife.Net
单机吞吐2266万tps的网络通信框架
|
|
|
NewLifeX/XCoder
新生命码神工具，代码生成、网络工具、API工具、串口工具、正则工具、图标工具、加解密工具、地图接口。
|
第三代协议通信库，增强RPC，引入主流Http/WebSockt/WebApi应用级封装