V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
sanbenweiyang
V2EX  ›  程序员

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

  •  1
     
  •   sanbenweiyang · 2019-11-11 10:44:29 +08:00 · 2236 次点击
    这是一个创建于 1832 天前的主题,其中的信息可能已经有所发展或是发生改变。

    License Gitter ![zinx 详细教程]( https://img.shields.io/badge/zinx 详细教程-简书-red.svg) zinx 原创书籍下载

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

    说明:目前 zinx 已经在很多企业进行开发使用,具体使用领域包括:后端模块的消息中转、长链接游戏服务器、Web 框架中的消息处理插件等。zinx 的定位是代码简洁,让更多的开发者迅速的了解框架的内脏细节并且可以快速基于 zinx DIY 一款适合自己企业场景的模块。

    开发者

    zinx(C++版本)

    开发者


    Github

    Git: https://github.com/aceld/zinx

    码云(Gitee)

    Git: https://gitee.com/Aceld/zinx


    在线开发教程

    [B 站]

    zinx-视频教程 B 站

    [YouTube]

    zinx-youtube

    一、写在前面

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

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

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

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

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

    zinx 荣誉

    开源中国 GVP 年度最有价值开源项目

    GVP-zinx

    二、初探 Zinx 架构

    1-Zinx 框架.png

    zinx-start.gif

    三、Zinx 详细教程及文档

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

    四、Zinx 开发 API 文档

    快速开始

    server

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

    1. 创建 server 句柄
    2. 配置自定义路由及业务
    3. 启动服务
    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 v-0.10 demoApp",
      "Host":"127.0.0.1",
      "TcpPort":7777,
      "MaxConn":3,
      "WorkerPoolSize":10,
      "LogDir": "./mylog",
      "LogFile":"zinx.log"
    }
    

    Name:服务器应用名称

    Host:服务器 IP

    TcpPort:服务器监听端口

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

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

    LogDir: 日志文件夹

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

    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(刘丹冰)

    mail: [email protected] github: https://github.com/aceld 原创书籍 gitbook: http://legacy.gitbook.com/@aceld

    Zinx 技术讨论社区

    QQ 技术讨论群:

    gopool5.jpeg

    欢迎大家加入,获取更多相关学习资料

    4 条回复    2019-11-11 19:26:56 +08:00
    runningman
        1
    runningman  
       2019-11-11 11:41:40 +08:00
    好像很久没升级维护了?
    back0893
        2
    back0893  
       2019-11-11 13:06:08 +08:00
    @runningman 入门够了
    runningman
        3
    runningman  
       2019-11-11 14:14:51 +08:00
    @back0893 恩。可以用来学习,搞搞小项目。
    richzhu
        4
    richzhu  
       2019-11-11 19:26:56 +08:00
    👍传智播客·黑马程序员 出品
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   2598 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 30ms · UTC 04:55 · PVG 12:55 · LAX 20:55 · JFK 23:55
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.