You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

427 lines
12 KiB

6 years ago
6 years ago
6 years ago
5 years ago
5 years ago
6 years ago
5 years ago
6 years ago
5 years ago
5 years ago
6 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
4 years ago
5 years ago
5 years ago
4 years ago
5 years ago
6 years ago
6 years ago
6 years ago
6 years ago
5 years ago
6 years ago
6 years ago
5 years ago
6 years ago
5 years ago
5 years ago
5 years ago
5 years ago
6 years ago
6 years ago
4 years ago
6 years ago
4 years ago
6 years ago
6 years ago
5 years ago
4 years ago
6 years ago
5 years ago
4 years ago
5 years ago
4 years ago
6 years ago
  1. # <img width="80px" src="https://s2.ax1x.com/2019/10/09/u4yHo9.png" />
  2. [![License](https://img.shields.io/badge/License-GPL%203.0-blue.svg)](LICENSE) [![Gitter](https://img.shields.io/badge/在线交流-Gitter-green.svg)](https://gitter.im/zinx_go/community) [![zinx详细教程](https://img.shields.io/badge/zinx详细教程-简书-red.svg)](https://www.kancloud.cn/aceld/zinx) [![zinx原创书籍下载](https://img.shields.io/badge/原创书籍下载-KanCloud-black.svg)](https://www.kancloud.cn/@aceld)
  3. Zinx 是一个基于Golang的轻量级并发服务器框架
  4. > **说明**:目前zinx已经在很多企业进行开发使用,具体使用领域包括:后端模块的消息中转、长链接游戏服务器、Web框架中的消息处理插件等。zinx的定位是代码简洁,让更多的开发者迅速的了解框架的内脏细节并且可以快速基于zinx DIY一款适合自己企业场景的模块。
  5. #### 开发者
  6. - 刘丹冰([@aceld](https://github.com/aceld))
  7. - 张超([@zhngcho](https://github.com/zhngcho))
  8. - 高智辉Roger([@adsian](https://github.com/adsian))
  9. - 胡贵建([@huguijian](https://github.com/huguijian))
  10. - 张继瑀([@kstwoak](https://github.com/huguijian))
  11. ---
  12. [zinx(C++版本)](https://github.com/marklion/zinx)
  13. #### 开发者
  14. - 刘洋([@marklion](https://github.com/marklion))
  15. ---
  16. [zinx(Lua版本)](https://github.com/huqitt/zinx-lua)
  17. #### 开发者
  18. - 胡琪([@huqitt](https://github.com/huqitt))
  19. ---
  20. [zinx(websocket版本)](https://github.com/aceld/zinx/tree/wsserver)
  21. #### 开发者
  22. - 胡贵建([@huguijian](https://github.com/huguijian))
  23. ---
  24. ## zinx源码地址
  25. ### Github
  26. Git: https://github.com/aceld/zinx
  27. ### 码云(Gitee)
  28. Git: https://gitee.com/Aceld/zinx
  29. ---
  30. ## 在线开发教程
  31. ### [B站]
  32. [![zinx-视频教程B站](https://s2.ax1x.com/2019/10/13/uv340S.jpg)](https://www.bilibili.com/video/av71067087)
  33. ### [YouTube]
  34. [![zinx-youtube](https://s2.ax1x.com/2019/10/14/KSurCR.jpg)](https://www.youtube.com/watch?v=U95iF-HMWsU&list=PL_GrAPKmuajzeNI8HBTi-k5NQO1g0rM-A)
  35. > 注意:修正Github打不开图片方法 windows: https://zhuanlan.zhihu.com/p/107196957 , mac/Linux: 修改/etc/hosts文件即可
  36. ## Zinx详细教程及文档
  37. ### PC端文档
  38. [看云-《Zinx框架教程-基于Golang的轻量级并发服务器》](https://www.kancloud.cn/aceld/zinx)
  39. [简书-《Zinx框架教程-基于Golang的轻量级并发服务器》](https://www.jianshu.com/p/23d07c0a28e5)
  40. ### 移动端文档
  41. ![gongzhonghao](https://s1.ax1x.com/2020/07/07/UFyUdx.th.jpg)
  42. ## 一、写在前面
  43. 我们为什么要做Zinx,Golang目前在服务器的应用框架很多,但是应用在游戏领域或者其他长链接的领域的轻量级企业框架甚少。
  44. 设计Zinx的目的是我们可以通过Zinx框架来了解基于Golang编写一个TCP服务器的整体轮廓,让更多的Golang爱好者能深入浅出的去学习和认识这个领域。
  45. Zinx框架的项目制作采用编码和学习教程同步进行,将开发的全部递进和迭代思维带入教程中,而不是一下子给大家一个非常完整的框架去学习,让很多人一头雾水,不知道该如何学起。
  46. 教程会一个版本一个版本迭代,每个版本的添加功能都是微小的,让一个服务框架小白,循序渐进的曲线方式了解服务器框架的领域。
  47. 当然,最后希望Zinx会有更多的人加入,给我们提出宝贵的意见,让Zinx成为真正的解决企业的服务器框架!在此感谢您的关注!
  48. **zinx荣誉**
  49. #### 开源中国GVP年度最有价值开源项目
  50. ![GVP-zinx](https://s2.ax1x.com/2019/10/13/uvYVBV.jpg)
  51. #### Stargazers over time
  52. [![Stargazers over time](https://starchart.cc/aceld/zinx.svg)](https://starchart.cc/aceld/zinx)
  53. ## 二、快速启动
  54. ```
  55. # 克隆项目
  56. $ git clone https://github.com/aceld/zinx.git
  57. # 进入服务端样例目录
  58. $ cd ./zinx/examples/zinx_server
  59. # 服务端编译
  60. $ make build
  61. # 服务端容器化
  62. $ make image
  63. # 服务端启动
  64. $ make run
  65. # 进入客户端样例目录
  66. $ cd ../zinx_client
  67. # 启动客户端进行测试
  68. $ go run main.go
  69. ```
  70. ## 三、初探Zinx架构
  71. ![1-Zinx框架.png](https://camo.githubusercontent.com/903d1431358fa6f4634ebaae3b49a28d97e23d77/68747470733a2f2f75706c6f61642d696d616765732e6a69616e7368752e696f2f75706c6f61645f696d616765732f31313039333230352d633735666636383232333362323533362e706e673f696d6167654d6f6772322f6175746f2d6f7269656e742f7374726970253743696d61676556696577322f322f772f31323430)
  72. ![zinx-start.gif](https://camo.githubusercontent.com/16afabf00523abd556d918203d11f413c178472a/68747470733a2f2f75706c6f61642d696d616765732e6a69616e7368752e696f2f75706c6f61645f696d616765732f31313039333230352d343930623439303938616336336166362e6769663f696d6167654d6f6772322f6175746f2d6f7269656e742f7374726970)
  73. ## 三、Zinx开发API文档
  74. ### 快速开始
  75. #### 示例演示
  76. 1. 编译demo示例,会在`zinx/example/zinx_server`下得到`server`, 在`zinx/example/zinx_client`下得到`client`.
  77. ```bash
  78. $ cd zinx/
  79. $ make
  80. ```
  81. 2. 启动Demo server, 该终端不要关闭
  82. ```bash
  83. $ cd example/zinx_server
  84. $ ./server
  85. ██
  86. ▀▀
  87. ████████ ████ ██▄████▄ ▀██ ██▀
  88. ▄█▀ ██ ██▀ ██ ████
  89. ▄█▀ ██ ██ ██ ▄██▄
  90. ▄██▄▄▄▄▄ ▄▄▄██▄▄▄ ██ ██ ▄█▀▀█▄
  91. ▀▀▀▀▀▀▀▀ ▀▀▀▀▀▀▀▀ ▀▀ ▀▀ ▀▀▀ ▀▀▀
  92. ┌───────────────────────────────────────────────────┐
  93. │ [Github] https://github.com/aceld │
  94. │ [tutorial] https://www.kancloud.cn/aceld/zinx │
  95. └───────────────────────────────────────────────────┘
  96. [Zinx] Version: V0.11, MaxConn: 3, MaxPacketSize: 4096
  97. Add api msgId = 0
  98. Add api msgId = 1
  99. [START] Server name: zinx server Demo,listenner at IP: 127.0.0.1, Port 8999 is starting
  100. Worker ID = 0 is started.
  101. Worker ID = 1 is started.
  102. Worker ID = 2 is started.
  103. Worker ID = 3 is started.
  104. Worker ID = 4 is started.
  105. Worker ID = 7 is started.
  106. Worker ID = 6 is started.
  107. Worker ID = 8 is started.
  108. Worker ID = 9 is started.
  109. Worker ID = 5 is started.
  110. start Zinx server zinx server Demo succ, now listenning...
  111. ...
  112. ```
  113. 3. 再打开新终端,启动client Demo测试通信
  114. ```bash
  115. $ cd example/zinx_client
  116. $ ./client
  117. ==> Test Router:[Ping] Recv Msg: ID= 2 , len= 21 , data= DoConnection BEGIN... ==> Test Router:[Ping] Recv Msg: ID= 0 , len= 18 , data= ping...ping...ping
  118. ==> Test Router:[Ping] Recv Msg: ID= 0 , len= 18 , data= ping...ping...ping
  119. ==> Test Router:[Ping] Recv Msg: ID= 0 , len= 18 , data= ping...ping...ping
  120. ...
  121. t
  122. ```
  123. #### server
  124. 基于Zinx框架开发的服务器应用,主函数步骤比较精简,最多只需要3步即可。
  125. 1. 创建server句柄
  126. 2. 配置自定义路由及业务
  127. 3. 启动服务
  128. ```go
  129. func main() {
  130. //1 创建一个server句柄
  131. s := znet.NewServer()
  132. //2 配置路由
  133. s.AddRouter(0, &PingRouter{})
  134. //3 开启服务
  135. s.Serve()
  136. }
  137. ```
  138. 其中自定义路由及业务配置方式如下:
  139. ```go
  140. import (
  141. "fmt"
  142. "github.com/aceld/zinx/ziface"
  143. "github.com/aceld/zinx/znet"
  144. )
  145. //ping test 自定义路由
  146. type PingRouter struct {
  147. znet.BaseRouter
  148. }
  149. //Ping Handle
  150. func (this *PingRouter) Handle(request ziface.IRequest) {
  151. //先读取客户端的数据
  152. fmt.Println("recv from client : msgId=", request.GetMsgID(), ", data=", string(request.GetData()))
  153. //再回写ping...ping...ping
  154. err := request.GetConnection().SendBuffMsg(0, []byte("ping...ping...ping"))
  155. if err != nil {
  156. fmt.Println(err)
  157. }
  158. }
  159. ```
  160. #### client
  161. Zinx的消息处理采用,`[MsgLength]|[MsgID]|[Data]`的封包格式
  162. ```go
  163. package main
  164. import (
  165. "fmt"
  166. "io"
  167. "net"
  168. "time"
  169. "github.com/aceld/zinx/znet"
  170. )
  171. /*
  172. 模拟客户端
  173. */
  174. func main() {
  175. fmt.Println("Client Test ... start")
  176. //3秒之后发起测试请求,给服务端开启服务的机会
  177. time.Sleep(3 * time.Second)
  178. conn,err := net.Dial("tcp", "127.0.0.1:7777")
  179. if err != nil {
  180. fmt.Println("client start err, exit!")
  181. return
  182. }
  183. for n := 3; n >= 0; n-- {
  184. //发封包message消息
  185. dp := znet.NewDataPack()
  186. msg, _ := dp.Pack(znet.NewMsgPackage(0,[]byte("Zinx Client Test Message")))
  187. _, err := conn.Write(msg)
  188. if err !=nil {
  189. fmt.Println("write error err ", err)
  190. return
  191. }
  192. //先读出流中的head部分
  193. headData := make([]byte, dp.GetHeadLen())
  194. _, err = io.ReadFull(conn, headData) //ReadFull 会把msg填充满为止
  195. if err != nil {
  196. fmt.Println("read head error")
  197. break
  198. }
  199. //将headData字节流 拆包到msg中
  200. msgHead, err := dp.Unpack(headData)
  201. if err != nil {
  202. fmt.Println("server unpack err:", err)
  203. return
  204. }
  205. if msgHead.GetDataLen() > 0 {
  206. //msg 是有data数据的,需要再次读取data数据
  207. msg := msgHead.(*znet.Message)
  208. msg.Data = make([]byte, msg.GetDataLen())
  209. //根据dataLen从io中读取字节流
  210. _, err := io.ReadFull(conn, msg.Data)
  211. if err != nil {
  212. fmt.Println("server unpack data err:", err)
  213. return
  214. }
  215. fmt.Println("==> Recv Msg: ID=", msg.Id, ", len=", msg.DataLen, ", data=", string(msg.Data))
  216. }
  217. time.Sleep(1*time.Second)
  218. }
  219. }
  220. ```
  221. ### Zinx配置文件
  222. ```json
  223. {
  224. "Name":"zinx v-0.10 demoApp",
  225. "Host":"127.0.0.1",
  226. "TcpPort":7777,
  227. "MaxConn":3,
  228. "WorkerPoolSize":10,
  229. "LogDir": "./mylog",
  230. "LogFile":"zinx.log"
  231. }
  232. ```
  233. `Name`:服务器应用名称
  234. `Host`:服务器IP
  235. `TcpPort`:服务器监听端口
  236. `MaxConn`:允许的客户端链接最大数量
  237. `WorkerPoolSize`:工作任务池最大工作Goroutine数量
  238. `LogDir`: 日志文件夹
  239. `LogFile`: 日志文件名称(如果不提供,则日志信息打印到Stderr)
  240. ### I.服务器模块Server
  241. ```go
  242. func NewServer () ziface.IServer
  243. ```
  244. 创建一个Zinx服务器句柄,该句柄作为当前服务器应用程序的主枢纽,包括如下功能:
  245. #### 1)开启服务
  246. ```go
  247. func (s *Server) Start()
  248. ```
  249. #### 2)停止服务
  250. ```go
  251. func (s *Server) Stop()
  252. ```
  253. #### 3)运行服务
  254. ```go
  255. func (s *Server) Serve()
  256. ```
  257. #### 4)注册路由
  258. ```go
  259. func (s *Server) AddRouter (msgId uint32, router ziface.IRouter)
  260. ```
  261. #### 5)注册链接创建Hook函数
  262. ```go
  263. func (s *Server) SetOnConnStart(hookFunc func (ziface.IConnection))
  264. ```
  265. #### 6)注册链接销毁Hook函数
  266. ```go
  267. func (s *Server) SetOnConnStop(hookFunc func (ziface.IConnection))
  268. ```
  269. ### II.路由模块
  270. ```go
  271. //实现router时,先嵌入这个基类,然后根据需要对这个基类的方法进行重写
  272. type BaseRouter struct {}
  273. //这里之所以BaseRouter的方法都为空,
  274. // 是因为有的Router不希望有PreHandle或PostHandle
  275. // 所以Router全部继承BaseRouter的好处是,不需要实现PreHandle和PostHandle也可以实例化
  276. func (br *BaseRouter)PreHandle(req ziface.IRequest){}
  277. func (br *BaseRouter)Handle(req ziface.IRequest){}
  278. func (br *BaseRouter)PostHandle(req ziface.IRequest){}
  279. ```
  280. ### III.链接模块
  281. #### 1)获取原始的socket TCPConn
  282. ```go
  283. func (c *Connection) GetTCPConnection() *net.TCPConn
  284. ```
  285. #### 2)获取链接ID
  286. ```go
  287. func (c *Connection) GetConnID() uint32
  288. ```
  289. #### 3)获取远程客户端地址信息
  290. ```go
  291. func (c *Connection) RemoteAddr() net.Addr
  292. ```
  293. #### 4)发送消息
  294. ```go
  295. func (c *Connection) SendMsg(msgId uint32, data []byte) error
  296. func (c *Connection) SendBuffMsg(msgId uint32, data []byte) error
  297. ```
  298. #### 5)链接属性
  299. ```go
  300. //设置链接属性
  301. func (c *Connection) SetProperty(key string, value interface{})
  302. //获取链接属性
  303. func (c *Connection) GetProperty(key string) (interface{}, error)
  304. //移除链接属性
  305. func (c *Connection) RemoveProperty(key string)
  306. ```
  307. ---
  308. ### 关于作者:
  309. 作者:`Aceld(刘丹冰)`
  310. `mail`:
  311. [danbing.at@gmail.com](mailto:danbing.at@gmail.com)
  312. `github`:
  313. [https://github.com/aceld](https://github.com/aceld)
  314. `原创书籍`:
  315. [https://www.kancloud.cn/@aceld](https://www.kancloud.cn/@aceld)
  316. ### Zinx技术讨论社区
  317. ### **微信公众号**
  318. ![gongzhonghao](https://s1.ax1x.com/2020/07/07/UFyUdx.th.jpg)
  319. ### **QQ资源分享**
  320. ![qqqun](https://s1.ax1x.com/2020/07/07/UF6Y9S.th.png)
  321. ### **微信群**
  322. <img src="https://s1.ax1x.com/2020/07/07/UF6rNV.png" width = "200" height = "230" alt="weixin" />
  323. 欢迎大家加入,获取更多相关学习资料