Zinx

框架源代码

https://github.com/aceld/zinx

![zinx 详细教程]( https://img.shields.io/badge/zinx 详细教程-简书-red.svg)

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

开发者

刘丹冰(@aceld)
张超(@zhngcho)

zinx(C++版本)

开发者

刘洋(@marklion)

一、写在前面

我们为什么要做 Zinx，Golang 目前在服务器的应用框架很多，但是应用在游戏领域或者其他长链接的领域的轻量级企业框架甚少。

设计 Zinx 的目的是我们可以通过 Zinx 框架来了解基于 Golang 编写一个 TCP 服务器的整体轮廓，让更多的 Golang 爱好者能深入浅出的去学习和认识这个领域。

Zinx 框架的项目制作采用编码和学习教程同步进行，将开发的全部递进和迭代思维带入教程中，而不是一下子给大家一个非常完整的框架去学习，让很多人一头雾水，不知道该如何学起。

教程会一个版本一个版本迭代，每个版本的添加功能都是微小的，让一个服务框架小白，循序渐进的曲线方式了解服务器框架的领域。

当然，最后希望 Zinx 会有更多的人加入，给我们提出宝贵的意见，让 Zinx 成为真正的解决企业的服务器框架！在此感谢您的关注！

二、初探 Zinx 架构

三、Zinx 详细教程(代码教程同步更新)

《 Zinx 框架教程-基于 Golang 的轻量级并发服务器》

四、Zinx 开发 API 文档

快速开始

server

基于 Zinx 框架开发的服务器应用，主函数步骤比较精简，最多主需要 3 步即可。

创建 server 句柄
配置自定义路由及业务
启动服务

func main() {
	//1 创建一个 server 句柄
	s := znet.NewServer()

	//2 配置路由
	s.AddRouter(0, &PingRouter{})

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

其中自定义路由及业务配置方式如下：

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

//ping test 自定义路由
type PingRouter struct {
	znet.BaseRouter
}

//Ping Handle
func (this *PingRouter) Handle(request ziface.IRequest) {
	//先读取客户端的数据
	fmt.Println("recv from client : msgId=", request.GetMsgID(), ", data=", string(request.GetData()))

    //再回写 ping...ping...ping
	err := request.GetConnection().SendBuffMsg(0, []byte("ping...ping...ping"))
	if err != nil {
		fmt.Println(err)
	}
}

client

Zinx 的消息处理采用，[MsgLength]|[MsgID]|[Data]的封包格式

package main

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

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

	fmt.Println("Client Test ... start")
	//3 秒之后发起测试请求，给服务端开启服务的机会
	time.Sleep(3 * time.Second)

	conn,err := net.Dial("tcp", "127.0.0.1:7777")
	if err != nil {
		fmt.Println("client start err, exit!")
		return
	}

	for n := 3; n >= 0; n-- {
		//发封包 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())
		_, err = io.ReadFull(conn, headData) //ReadFull 会把 msg 填充满为止
		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(1*time.Second)
	}
}

Zinx 配置文件

{
  "Name":"Zinx Game", 
  "Host":"0.0.0.0",
  "TcpPort":8999,
  "MaxConn":3000,
  "WorkerPoolSize":10
}

Name:服务器应用名称

Host:服务器 IP

TcpPort:服务器监听端口

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

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

I.服务器模块 Server

  func NewServer () ziface.IServer

创建一个 Zinx 服务器句柄，该句柄作为当前服务器应用程序的主枢纽，包括如下功能：

1)开启服务

  func (s *Server) Start()

2)停止服务

  func (s *Server) Stop()

3)运行服务

  func (s *Server) Serve()

4)注册路由

func (s *Server) AddRouter (msgId uint32, router ziface.IRouter)

5)注册链接创建 Hook 函数

func (s *Server) SetOnConnStart(hookFunc func (ziface.IConnection))

6)注册链接销毁 Hook 函数

func (s *Server) SetOnConnStop(hookFunc func (ziface.IConnection))

II.路由模块

//实现 router 时，先嵌入这个基类，然后根据需要对这个基类的方法进行重写
type BaseRouter struct {}

//这里之所以 BaseRouter 的方法都为空，
// 是因为有的 Router 不希望有 PreHandle 或 PostHandle
// 所以 Router 全部继承 BaseRouter 的好处是，不需要实现 PreHandle 和 PostHandle 也可以实例化
func (br *BaseRouter)PreHandle(req ziface.IRequest){}
func (br *BaseRouter)Handle(req ziface.IRequest){}
func (br *BaseRouter)PostHandle(req ziface.IRequest){}

III.链接模块

1)获取原始的 socket TCPConn

  func (c *Connection) GetTCPConnection() *net.TCPConn

2)获取链接 ID

  func (c *Connection) GetConnID() uint32

3)获取远程客户端地址信息

  func (c *Connection) RemoteAddr() net.Addr

4)发送消息

  func (c *Connection) SendMsg(msgId uint32, data []byte) error 
  func (c *Connection) SendBuffMsg(msgId uint32, data []byte) error

5)链接属性

//设置链接属性
func (c *Connection) SetProperty(key string, value interface{})

//获取链接属性
func (c *Connection) GetProperty(key string) (interface{}, error)

//移除链接属性
func (c *Connection) RemoveProperty(key string)

关于作者：

作者：Aceld(刘丹冰) 简书号：IT 无崖子

mail: danbing.at@gmail.com github: https://github.com/aceld 原创书籍 gitbook: http://legacy.gitbook.com/@aceld

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