From 2c83dac1bf8677865a7c1a740dfb6c379bdbb308 Mon Sep 17 00:00:00 2001 From: jaysunxiao Date: Tue, 6 Jul 2021 19:40:57 +0800 Subject: [PATCH] =?UTF-8?q?doc[zfoo]:=20=E6=9B=B4=E6=96=B0=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 +++++++++++++++--------------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index ea243e5c..0344e184 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -### Ⅰ. zfoo简介 +Ⅰ. zfoo简介 +----------- - **性能炸裂，天生异步，Actor设计思想，无锁化设计，基于Spring的MVC式用法的万能RPC框架** - **极致序列化**，原生集成的目前二进制序列化和反序列化速度最快的 [zfoo protocol](protocol/README.md) 作为网络通讯协议 @@ -14,9 +15,8 @@ - 事件总线 [event](event/src/test/java/com/zfoo/event/ApplicationTest.java) - 时间任务调度 [scheduler](scheduler/README.md) --------------------- - -### Ⅱ. 背景和适用项目 +Ⅱ. 背景和适用项目 +--------------- - 性能需求极高的项目，如游戏服务器框架，网站服务器框架，单服滚服，全球服，直播聊天，IM系统，实时推送 - 节省研发成本的项目，如想节省，开发，部署，运维成本 @@ -33,25 +33,22 @@ Java生态的rpc框架非常多，但是很少有rpc框架能够契合到游戏 后来发现其实不仅仅能用来做游戏，只要有对性能有极致需求的rpc场景都能使用的上这个框架。 ``` +Ⅲ. 完整的工程案例和视频教程 -------------------- -### Ⅲ. 完整的工程案例和视频教程 - - [zfoo 视频教程](./doc/视频教程.md)，持续更新中 - [tank-game-server](https://github.com/zfoo-project/tank-game-server) 网络游戏《进击的坦克（The Fight of Tanks）》，新手友好，难度2星 - [zapp](https://github.com/zfoo-project/zapp) 图片分享聊天网站，标准的https企业级网站，难度5星 --------------------- - -### Ⅳ. 问题 +Ⅳ. 问题 +------- - 有问题，先看 [FAQ](./doc/FAQ.md) - 每个工程目录的test文件夹下都有标准的demo展示和注释说明，可以直接运行 - 问题讨论群QQ: 876280300 --------------------- - -### Ⅴ. 安装和使用 +Ⅴ. 安装和使用 +------------ #### 1. 环境要求 @@ -152,9 +149,8 @@ public class StudentResource { } ``` --------------------- - -### Ⅵ. 为什么快 +Ⅵ. 为什么快 +---------- - 使用目前性能最好的 [zfoo protocol](protocol/README.md) 作为网关和RPC消息的序列化和反序列化协议 - 无锁化设计和优雅的线程池设计，用户的请求通过网关总能保证请求在同一台服务器的同一条线程去执行，所以就不需要用锁保证并发 @@ -164,9 +160,8 @@ public class StudentResource { - 服务器热更新和监控无需代码和额外工具，直接内置在程序里，解放运维生产力 - 使用MVC设计模式，规范开发，保证代码质量，高效执行 --------------------- - -### Ⅶ. 提交规范 +Ⅶ. 提交规范 +---------- - 欢迎喜欢这个项目的人来一起维护这个项目，提交代码的时候注意下面规范 - Java项目格式化代码的方式采用IntelliJ Idea默认的格式化 @@ -182,9 +177,8 @@ doc[module]: 增加了什么文档 del[module]: 删除了某些功能或者无用代码 ``` --------------------- - -### Ⅷ. License +Ⅷ. License +----------- zfoo使用 [Apache License Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)