Golang 轻量级TCP框架 Zinx

Posted by 小炒肉 on January 7, 2020

Zinx

  • Zinx 是一个基于Golang的轻量级并发服务器框架.

  • [Github] https://github.com/aceld/zinx

Zinx 架构图

ZinX

Zinx 使用

  1. 创建Server句柄

  2. 配置自定义Router路由以及定义业务功能

  3. 启动服务

Server 端

  • 例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"zinx/ziface"
	"zinx/znet"
)

// 自定义路由

// 1. 创建一个结构体
type PingRouter struct {
	// 要使用路由 首先继承 BaseRouter 这个结构体
	znet.BaseRouter
}

/* 
  2. 重写 Router 的方法 (1. PreHandle 2. Handle  3. PostHandle)
     初始PreHandle, Handle, PostHandle 方法没有实现任何业务。
     可重写任何一个方法, 完成指定的业务。
*/

// 3. 重写 Handle 方法
func (p *PingRouter) Handle(request ziface.IRequest) {
	// 读取客户端的数据
	fmt.Println("recv from client: msgId=", request.GetMsgID(), ", data=", string(request.GetData()))

        // 回写数据到服务端
        err := request.GetConnection().SendBuffMsg(0, []byte("ping...ping...ping"))
	if err != nil {
		fmt.Println(err)
	}
}

// 启动服务
func main() {

	// 1. 创建一个Server 句柄
	s := znet.NewServer()

	// 2. 配置自定义的 Router 路由
	s.AddRouter(0, &PingRouter{})

	// 3. 开启服务
	s.Serve()
}

Client

  • Zinx 的消息处理采用 [MsgLength][MsgID][Data] 的封包格式。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
package main

import (
	"fmt"
	"io"
	"net"
	"time"
	"zinx/znet"
)

/*
	模拟客户端
 */
func main() {

	fmt.Println("Client Start ...")

	// 等待 3 秒之后发起测试请求, 给服务端开启服务的机会
	time.Sleep(3 * time.Second)

	// 初始化连接 服务端的 conn 句柄 
	conn,err := net.Dial("tcp", "127.0.0.1:8888")
	if err != nil {
		fmt.Println("Client Start err, exit!")
		return
	}

	for i := 0; i < 3; i++ {
		// 发封包message消息
		dp := znet.NewDataPack()
                 
		msg, _ := dp.Pack(znet.NewMsgPackage(0, []byte("Zinx Client Test Message")))
		_, err := conn.Write(msg)
		if err !=nil {
			fmt.Println("write error err ", err)
			return
		}

		// 读取流中的 head 部分
		headData := make([]byte, dp.GetHeadLen())
                // ReadFull 会把msg填充满为止 
		_, err = io.ReadFull(conn, headData)
		if err != nil {
			fmt.Println("read head error")
			break
		}
		//将headData字节流 拆包到msg中
		msgHead, err := dp.Unpack(headData)
		if err != nil {
			fmt.Println("server unpack err:", err)
			return
		}

		if msgHead.GetDataLen() > 0 {
			//msg 是有data数据的,需要再次读取data数据
			msg := msgHead.(*znet.Message)
			msg.Data = make([]byte, msg.GetDataLen())

			//根据dataLen从io中读取字节流
			_, err := io.ReadFull(conn, msg.Data)
			if err != nil {
				fmt.Println("server unpack data err:", err)
				return
			}

			fmt.Println("==> Recv Msg: ID=", msg.Id, ", len=", msg.DataLen, ", data=", string(msg.Data))
		}

		time.Sleep(time.Second)
	}
}

Zinx 配置文件

1
2
3
4
5
6
7
8
9
10
{
  "Name":"zinx demoApp",
  "Host":"127.0.0.1",
  "TcpPort":8888,
  "MaxConn":3,
  "WorkerPoolSize":10,
  "LogDir": "./mylog",
  "LogFile":"zinx.log"
}

  • Name: 服务器应用名称

  • Host: 服务器IP

  • TcpPort: 服务器监听端口

  • MaxConn: 允许的客户端链接最大数量

  • WorkerPoolSize: 工作任务池最大工作Goroutine数量

  • LogDir: 日志文件夹

  • LogFile: 日志文件名称(如果不提供, 则日志信息打印到Stderr)