doc[zfoo]: update doc

This commit is contained in:
sun committed 2023-09-12 15:40:12 +08:00
1 parent ad7e4f3481
commit 4ca6715860
7 files changed
+12 -12

No files matched your search

+4 -4
View File
@@ -21,7 +21,7 @@ Why is zfoo protocol ?
- The protocol currently supports C++ C# Go Java Javascript TypeScript Lua GDScript Python
- Universal distributed server protocol implementation, there are implementations in other languages, which can easily
implement RPC, servers, and microservices on other platforms
- The fastest custom format framework for Java binary serialization, with the fewest serialized bytes, more secure and
- Very fast custom format framework for Java binary serialization, with the fewest serialized bytes, more secure and
compatible
- In the single-threaded benchmark test, serialization and deserialization are 50% faster than Protobuf and 100% faster
than Kryo
@@ -30,7 +30,7 @@ Why is zfoo protocol ?
-----------
- **Extremely fast, asynchronous, Actor design pattern, lock-free design, RPC framework based on Spring MVC**
- **Fastest serialization and deserialization**,use [zfoo protocol](protocol/README.md) as a network protocol
- **Very fast serialization and deserialization**,use [zfoo protocol](protocol/README.md) as a network protocol
- **High scalability**,Single server deployment, microservice deployment, cluster deployment, gateway deployment
- **Can be used as a game server framework or website server framework.**
@@ -80,7 +80,7 @@ If you do not have JDK installed, the quick installation method is to download d
from Project Structure, Platform Settings, SDKs in the upper right corner of Idea
```
#### 2. [protocol](protocol/README.md) fastest serialization and deserialization
#### 2. [protocol](protocol/README.md) very fast serialization and deserialization
```
// zfoo protocol registration, can only be initialized once
@@ -93,7 +93,7 @@ ProtocolManager.write(byteBuf, complexObject);
var packet = ProtocolManager.read(byteBuf);
```
#### 3. [net](net/README.md) fastest RPC framework, supports tcp udp websocket http
#### 3. [net](net/README.md) very fast RPC framework, supports tcp udp websocket http
```
// Service provider, only need to add an annotation to the method, the interface will be automatically registered
+3 -3
View File
@@ -19,14 +19,14 @@ Why is zfoo protocol ?
- 协议原生支持 C++ C# Java Go Javascript TypeScript Lua GDScript Python
- 通用的分布式服务器协议实现,有其它语言的实现,可以轻易实现其它平台的的RPC,微服务
- 二进制序列化速度最快的自定义格式框架,并且为序列化字节最少的框架,更加安全,可前后兼容
- 二进制序列化速度极快的自定义格式框架,并且为序列化字节最少的框架,更加安全,可前后兼容
- 单线程的Benchmark测试中,序列化和反序列化速度比Protobuf快50%,比Kryo快100%
Ⅰ. zfoo简介🚩
-----------
- **极致性能,天生异步,Actor设计思想,无锁化设计,MVC式用法的万能RPC框架**
- **极致序列化**,原生集成目前二进制序列化和反序列化速度最快的 [zfoo protocol](protocol/README.md) 作为网络通讯协议
- **极致序列化**,原生集成目前二进制序列化和反序列化速度极快的 [zfoo protocol](protocol/README.md) 作为网络通讯协议
- **高可拓展性**,单台服务器部署,微服务部署,注册中心加集群部署,网关加集群部署,随意搭配
- **上能做游戏服务器框架,下能做应用网站服务器框架**
@@ -87,7 +87,7 @@ ProtocolManager.write(byteBuf, complexObject);
var packet = ProtocolManager.read(byteBuf);
```
#### 3. [net](net/README.md) 目前速度最快的RPC框架,支持 tcp udp websocket http
#### 3. [net](net/README.md) 目前速度极快的RPC框架,支持 tcp udp websocket http
```
// 服务提供者,只需要在方法上加个注解,则自动注册接口
+1 -1
View File
@@ -66,7 +66,7 @@ SignalAttachment的signalId就是用于RPC的同步和异步的信号,通过
#### zfoo的RPC协议格式为什么没有dubbo复杂
- duboo没有自己实现的比较好的协议所以要支持其它协议,zfoo有自己实现的协议已经最快,只需要专注自己的协议和protobuf,兼容就比较简单
- duboo没有自己实现的比较好的协议所以要支持其它协议,zfoo有自己实现的协议已经极快了,只需要专注自己的协议和protobuf,兼容就比较简单
- zfoo作为rpc协议是,length | packet | attachment,当作普通服务器协议就是,length | packet
- attachment能装很多东西,算是协议上的多态,就不需要dubbo那么复杂的设计了
+1 -1
View File
@@ -50,7 +50,7 @@ Some of them are listed below:
akka,Using Scala language, the learning cost is extremely high, just give up;
So I wrote a universal rpc framework, the code is lightweight, can be easily customized, with its own gateway, inherently asynchronous, and the tool chain is complete.
After subsequent continuous optimization, a serialization framework with the fastest speed in Java was also made, and then the speed took off directly.
After subsequent continuous optimization, a serialization framework with the very fast speed in Java was also made, and then the speed took off directly.
Later, I found out that it can be used not only for games, but also for rpc scenes with extreme performance requirements.
```
+1 -1
View File
@@ -42,7 +42,7 @@ Java生态的rpc框架非常多,但是很少有rpc框架能够契合到游戏
grpc,代码重量级,使用复杂,部署复杂,没有网关,很难自定义;
akka,用Scala语言,学习成本极高,直接放弃;
所以就写了一个万能的rpc框架,代码轻量级,可以方便的自定义,自带网关的,天生异步,工具链完整。
经过后续的不断优化,还做出了一个目前Java速度最快的序列化框架,然后速度就直接起飞了。
经过后续的不断优化,还做出了一个目前Java速度极快的序列化框架,然后速度就直接起飞了。
后来发现其实不仅仅能用来做游戏,只要有对性能有极致需求的rpc场景都能使用的上这个框架。
```
+1 -1
View File
@@ -3,7 +3,7 @@ English | [简体中文](./README_CN.md)
### Ⅰ. Introduction
- [zfoo protocol](https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md)
It is currently the fastest framework for binary serialization and deserialization in Java, and has the fewest
It is currently the very fast framework for binary serialization and deserialization in Java, and has the fewest
serialization bytes
- The protocol is currently natively supported **C++ Java Javascript C# Go Lua GDScript Pythont**,It's easy to do cross-platform
- The protocol can customize the private protocol format to make your protocol more secure, and supports adding fields
+1 -1
View File
@@ -3,7 +3,7 @@
### Ⅰ. 简介
- [zfoo protocol](https://github.com/zfoo-project/zfoo/blob/main/protocol/README.md)
是目前的Java二进制序列化和反序列化速度最快的框架,并且为序列化字节最少的框架
是目前的Java二进制序列化和反序列化速度极快的框架,并且为序列化字节最少的框架
- 协议目前原生支持 **C++ Java Javascript C# Go Lua GDScript Python**,可以轻易实现跨平台
- 协议可以自定义私有协议格式,让你的协议更加安全,支持增加字段和兼容前后版本协议
- 兼容protobuf,支持生成protobuf协议文件,提供从pojo到proto的生成方式