【Zinx第二章-初識Zinx框架】Golang輕量級并發(fā)服務(wù)器框架

Zinx源代碼

github
https://github.com/aceld/zinx
gitee碼云
https://gitee.com/Aceld/zinx

在線開發(fā)教程

【B站】
zinx視頻教程-Golang輕量級TCP服務(wù)器框架-適合自學(xué)者

【YouTube】
zinx開發(fā)YouTube中國版

【Zinx教程目錄】
完整教程電子版(在線高清)-下載
Zinx框架視頻教程(框架篇)(完整版下載)鏈接在下面正文
Zinx框架視頻教程(應(yīng)用篇)(完整版下載)鏈接在下面正文
Zinx開發(fā)API文檔
Zinx第一章-引言
Zinx第二章-初識Zinx框架
Zinx第三章-基礎(chǔ)路由模塊
Zinx第四章-全局配置
Zinx第五章-消息封裝
Zinx第六章-多路由模式
Zinx第七章-讀寫分離模型
Zinx第八章-消息隊列及多任務(wù)
Zinx第九章-鏈接管理
Zinx第十章-連接屬性設(shè)置

【Zinx應(yīng)用案例-MMO多人在線游戲】
(1)案例介紹
(2)AOI興趣點算法
(3)數(shù)據(jù)傳輸協(xié)議protocol buffer
(4)Proto3協(xié)議定義
(5)構(gòu)建項目及用戶上線
(6)世界聊天
(7)上線位置信息同步
(8)移動位置與AOI廣播
(9)玩家下線
(10)模擬客戶端AI模塊

二、初識Zinx框架

? 這里先看一下Zinx最簡單的Server雛形。

1. Zinx-V0.1-基礎(chǔ)Server

? 為了更好的看到Zinx框架，首先Zinx構(gòu)建Zinx的最基本的兩個模塊ziface 和znet。

ziface主要是存放一些Zinx框架的全部模塊的抽象層接口類，Zinx框架的最基本的是服務(wù)類接口iserver，定義在ziface模塊中。

znet模塊是zinx框架中網(wǎng)絡(luò)相關(guān)功能的實現(xiàn)，所有網(wǎng)絡(luò)相關(guān)模塊都會定義在znet模塊中。

1.1 Zinx-V0.1 代碼實現(xiàn)

A) 創(chuàng)建zinx框架

? 在$GOPATH/src下創(chuàng)建zinx文件夾

B) 創(chuàng)建ziface、znet模塊

? 在zinx/下 創(chuàng)建ziface、znet文件夾, 使當(dāng)前的文件路徑如下：

└── zinx
    ├── ziface
    │   └── 
    └── znet
        ├──
C) 在ziface下創(chuàng)建服務(wù)模塊抽象層iserver.go

zinx/ziface/iserver.go

package ziface

//定義服務(wù)器接口
type IServer interface{
    //啟動服務(wù)器方法
    Start()
    //停止服務(wù)器方法
    Stop()
    //開啟業(yè)務(wù)服務(wù)方法
    Serve()
}
D) 在znet下實現(xiàn)服務(wù)模塊server.go
package znet

import (
    "fmt"
    "net"
    "time"
    "zinx/ziface"
)

//iServer 接口實現(xiàn)，定義一個Server服務(wù)類
type Server struct {
    //服務(wù)器的名稱
    Name string
    //tcp4 or other
    IPVersion string
    //服務(wù)綁定的IP地址
    IP string
    //服務(wù)綁定的端口
    Port int
}


//============== 實現(xiàn) ziface.IServer 里的全部接口方法 ========

//開啟網(wǎng)絡(luò)服務(wù)
func (s *Server) Start() {
    fmt.Printf("[START] Server listenner at IP: %s, Port %d, is starting\n", s.IP, s.Port)

    //開啟一個go去做服務(wù)端Linster業(yè)務(wù)
    go func() {
        //1 獲取一個TCP的Addr
        addr, err := net.ResolveTCPAddr(s.IPVersion, fmt.Sprintf("%s:%d", s.IP, s.Port))
        if err != nil {
            fmt.Println("resolve tcp addr err: ", err)
            return
        }

        //2 監(jiān)聽服務(wù)器地址
        listenner, err:= net.ListenTCP(s.IPVersion, addr)
        if err != nil {
            fmt.Println("listen", s.IPVersion, "err", err)
            return
        }

        //已經(jīng)監(jiān)聽成功
        fmt.Println("start Zinx server  ", s.Name, " succ, now listenning...")

        //3 啟動server網(wǎng)絡(luò)連接業(yè)務(wù)
        for {
            //3.1 阻塞等待客戶端建立連接請求
            conn, err := listenner.AcceptTCP()
            if err != nil {
                fmt.Println("Accept err ", err)
                continue
            }

            //3.2 TODO Server.Start() 設(shè)置服務(wù)器最大連接控制,如果超過最大連接，那么則關(guān)閉此新的連接

            //3.3 TODO Server.Start() 處理該新連接請求的 業(yè)務(wù) 方法， 此時應(yīng)該有 handler 和 conn是綁定的

            //我們這里暫時做一個最大512字節(jié)的回顯服務(wù)
            go func () {
                //不斷的循環(huán)從客戶端獲取數(shù)據(jù)
                for  {
                    buf := make([]byte, 512)
                    cnt, err := conn.Read(buf)
                    if err != nil {
                        fmt.Println("recv buf err ", err)
                        continue
                    }
                    //回顯
                    if _, err := conn.Write(buf[:cnt]); err !=nil {
                        fmt.Println("write back buf err ", err)
                        continue
                    }
                }
            }()
        }
    }()
}

func (s *Server) Stop() {
    fmt.Println("[STOP] Zinx server , name " , s.Name)

    //TODO  Server.Stop() 將其他需要清理的連接信息或者其他信息 也要一并停止或者清理
}

func (s *Server) Serve() {
    s.Start()

    //TODO Server.Serve() 是否在啟動服務(wù)的時候 還要處理其他的事情呢 可以在這里添加


    //阻塞,否則主Go退出， listenner的go將會退出
    for {
        time.Sleep(10*time.Second)
    }
}


/*
  創(chuàng)建一個服務(wù)器句柄
 */
func NewServer (name string) ziface.IServer {
    s:= &Server {
        Name :name,
        IPVersion:"tcp4",
        IP:"0.0.0.0",
        Port:7777,
    }

    return s
}

好了，以上我們已經(jīng)完成了Zinx-V0.1的基本雛形了，雖然只是一個基本的回寫客戶端數(shù)據(jù)(我們之后會自定義處理客戶端業(yè)務(wù)方法)，那么接下來我們就應(yīng)該測試我們當(dāng)前的zinx-V0.1是否可以使用了。

1.2 Zinx框架單元測試樣例

? 理論上我們應(yīng)該可以現(xiàn)在導(dǎo)入zinx框架，然后寫一個服務(wù)端程序，再寫一個客戶端程序進行測試，但是我們可以通過Go的單元Test功能，進行單元測試

? 創(chuàng)建zinx/znet/server_test.go

package znet

import (
    "fmt"
    "net"
    "testing"
    "time"
)

/*
    模擬客戶端
 */
 func ClientTest() {

    fmt.Println("Client Test ... start")
    //3秒之后發(fā)起測試請求，給服務(wù)端開啟服務(wù)的機會
    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 {
        _, err := conn.Write([]byte("hello ZINX"))
        if err !=nil {
            fmt.Println("write error err ", err)
            return
        }

        buf :=make([]byte, 512)
        cnt, err := conn.Read(buf)
        if err != nil {
            fmt.Println("read buf error ")
            return
        }

        fmt.Printf(" server call back : %s, cnt = %d\n", buf,  cnt)

        time.Sleep(1*time.Second)
    }
 }

//Server 模塊的測試函數(shù)
func TestServer(t *testing.T) {

    /*
        服務(wù)端測試
    */
    //1 創(chuàng)建一個server 句柄 s
    s := NewServer("[zinx V0.1]")

    /*
        客戶端測試
    */
    go ClientTest()

    //2 開啟服務(wù)
    s.Serve()
}

? 在zinx/znet下執(zhí)行

$ go test

? 執(zhí)行結(jié)果，如下：

[START] Server listenner at IP: 0.0.0.0, Port 7777, is starting
Client Test ... start
listen tcp4 err listen tcp4 0.0.0.0:7777: bind: address already in use
 server call back : hello ZINX, cnt = 6
 server call back : hello ZINX, cnt = 6
 server call back : hello ZINX, cnt = 6
 server call back : hello ZINX, cnt = 6

? 說明我們的zinx框架已經(jīng)可以使用了。

1.3 使用Zinx-V0.1完成應(yīng)用程序

? 當(dāng)然，如果感覺go test 好麻煩，那么我們可以完全基于zinx寫兩個應(yīng)用程序，Server.go , Client.go

Server.go

package main

import (
    "zinx/znet"
)

//Server 模塊的測試函數(shù)
func main() {

    //1 創(chuàng)建一個server 句柄 s
    s := znet.NewServer("[zinx V0.1]")

    //2 開啟服務(wù)
    s.Serve()
}

啟動Server.go

go run Server.go

Client.go

package main

import (
    "fmt"
    "net"
    "time"
)

func main() {

    fmt.Println("Client Test ... start")
    //3秒之后發(fā)起測試請求，給服務(wù)端開啟服務(wù)的機會
    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 {
        _, err := conn.Write([]byte("hahaha"))
        if err !=nil {
            fmt.Println("write error err ", err)
            return
        }

        buf :=make([]byte, 512)
        cnt, err := conn.Read(buf)
        if err != nil {
            fmt.Println("read buf error ")
            return
        }

        fmt.Printf(" server call back : %s, cnt = %d\n", buf,  cnt)

        time.Sleep(1*time.Second)
    }
}

啟動Client.go進行測試

go run Client.go

2.Zinx-V0.2-簡單的連接封裝與業(yè)務(wù)綁定

? V0.1版本我們已經(jīng)實現(xiàn)了一個基礎(chǔ)的Server框架，現(xiàn)在我們需要對客戶端鏈接和不同的客戶端鏈接所處理的不同業(yè)務(wù)再做一層接口封裝，當(dāng)然我們先是把架構(gòu)搭建起來。

? 現(xiàn)在在ziface下創(chuàng)建一個屬于鏈接的接口文件iconnection.go，當(dāng)然他的實現(xiàn)文件我們放在znet下的connection.go中。

2.1 Zinx-V0.2代碼實現(xiàn)

A) ziface創(chuàng)建iconnection.go

zinx/ziface/iconnection.go

package ziface

import "net"

//定義連接接口
type IConnection interface {
    //啟動連接，讓當(dāng)前連接開始工作
    Start()
    //停止連接，結(jié)束當(dāng)前連接狀態(tài)M
    Stop()
    //從當(dāng)前連接獲取原始的socket TCPConn
    GetTCPConnection() *net.TCPConn
    //獲取當(dāng)前連接ID
    GetConnID() uint32
    //獲取遠(yuǎn)程客戶端地址信息
    RemoteAddr() net.Addr
}

//定義一個統(tǒng)一處理鏈接業(yè)務(wù)的接口
type HandFunc func(*net.TCPConn, []byte, int) error

? 該接口的一些基礎(chǔ)方法，代碼注釋已經(jīng)介紹的很清楚，這里先簡單說明一個HandFunc這個函數(shù)類型，這個是所有conn鏈接在處理業(yè)務(wù)的函數(shù)接口，第一參數(shù)是socket原生鏈接，第二個參數(shù)是客戶端請求的數(shù)據(jù)，第三個參數(shù)是客戶端請求的數(shù)據(jù)長度。這樣，如果我們想要指定一個conn的處理業(yè)務(wù)，只要定義一個HandFunc類型的函數(shù)，然后和該鏈接綁定就可以了。

B) znet 創(chuàng)建iconnection.go

zinx/znet/connection.go

package znet

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

type Connection struct {
    //當(dāng)前連接的socket TCP套接字
    Conn *net.TCPConn
    //當(dāng)前連接的ID 也可以稱作為SessionID，ID全局唯一
    ConnID uint32
    //當(dāng)前連接的關(guān)閉狀態(tài)
    isClosed bool

    //該連接的處理方法api
    handleAPI ziface.HandFunc

    //告知該鏈接已經(jīng)退出/停止的channel
    ExitBuffChan chan bool
}


//創(chuàng)建連接的方法
func NewConntion(conn *net.TCPConn, connID uint32, callback_api ziface.HandFunc) *Connection{
    c := &Connection{
        Conn:     conn,
        ConnID:   connID,
        isClosed: false,
        handleAPI: callback_api,
        ExitBuffChan: make(chan bool, 1),
    }

    return c
}

/* 處理conn讀數(shù)據(jù)的Goroutine */
func (c *Connection) StartReader() {
    fmt.Println("Reader Goroutine is  running")
    defer fmt.Println(c.RemoteAddr().String(), " conn reader exit!")
    defer c.Stop()

    for  {
        //讀取我們最大的數(shù)據(jù)到buf中
        buf := make([]byte, 512)
        cnt, err := c.Conn.Read(buf)
        if err != nil {
            fmt.Println("recv buf err ", err)
            c.ExitBuffChan <- true
            continue
        }
        //調(diào)用當(dāng)前鏈接業(yè)務(wù)(這里執(zhí)行的是當(dāng)前conn的綁定的handle方法)
        if err := c.handleAPI(c.Conn, buf, cnt); err !=nil {
            fmt.Println("connID ", c.ConnID, " handle is error")
            c.ExitBuffChan <- true
            return
        }
    }
}

//啟動連接，讓當(dāng)前連接開始工作
func (c *Connection) Start() {

    //開啟處理該鏈接讀取到客戶端數(shù)據(jù)之后的請求業(yè)務(wù)
    go c.StartReader()

    for {
        select {
        case <- c.ExitBuffChan:
            //得到退出消息，不再阻塞
            return
        }
    }
}

//停止連接，結(jié)束當(dāng)前連接狀態(tài)M
func (c *Connection) Stop() {
    //1. 如果當(dāng)前鏈接已經(jīng)關(guān)閉
    if c.isClosed == true {
        return
    }
    c.isClosed = true

    //TODO Connection Stop() 如果用戶注冊了該鏈接的關(guān)閉回調(diào)業(yè)務(wù)，那么在此刻應(yīng)該顯示調(diào)用

    // 關(guān)閉socket鏈接
    c.Conn.Close()

    //通知從緩沖隊列讀數(shù)據(jù)的業(yè)務(wù)，該鏈接已經(jīng)關(guān)閉
    c.ExitBuffChan <- true

    //關(guān)閉該鏈接全部管道
    close(c.ExitBuffChan)
}

//從當(dāng)前連接獲取原始的socket TCPConn
func (c *Connection) GetTCPConnection() *net.TCPConn {
    return c.Conn
}

//獲取當(dāng)前連接ID
func (c *Connection) GetConnID() uint32{
    return c.ConnID
}

//獲取遠(yuǎn)程客戶端地址信息
func (c *Connection) RemoteAddr() net.Addr {
    return c.Conn.RemoteAddr()
}
C) 重新更正一下Server.go中 處理conn的連接業(yè)務(wù)

zinx/znet/server.go

package znet

import (
    "errors"
    "fmt"
    "net"
    "time"
    "zinx/ziface"
)

//iServer 接口實現(xiàn)，定義一個Server服務(wù)類
type Server struct {
    //服務(wù)器的名稱
    Name string
    //tcp4 or other
    IPVersion string
    //服務(wù)綁定的IP地址
    IP string
    //服務(wù)綁定的端口
    Port int
}

//============== 定義當(dāng)前客戶端鏈接的handle api ===========
func CallBackToClient(conn *net.TCPConn, data []byte, cnt int) error {
    //回顯業(yè)務(wù)
    fmt.Println("[Conn Handle] CallBackToClient ... ")
    if _, err := conn.Write(data[:cnt]); err !=nil {
        fmt.Println("write back buf err ", err)
        return errors.New("CallBackToClient error")
    }
    return nil
}

//============== 實現(xiàn) ziface.IServer 里的全部接口方法 ========

//開啟網(wǎng)絡(luò)服務(wù)
func (s *Server) Start() {
    fmt.Printf("[START] Server listenner at IP: %s, Port %d, is starting\n", s.IP, s.Port)

    //開啟一個go去做服務(wù)端Linster業(yè)務(wù)
    go func() {
        //1 獲取一個TCP的Addr
        addr, err := net.ResolveTCPAddr(s.IPVersion, fmt.Sprintf("%s:%d", s.IP, s.Port))
        if err != nil {
            fmt.Println("resolve tcp addr err: ", err)
            return
        }

        //2 監(jiān)聽服務(wù)器地址
        listenner, err:= net.ListenTCP(s.IPVersion, addr)
        if err != nil {
            fmt.Println("listen", s.IPVersion, "err", err)
            return
        }

        //已經(jīng)監(jiān)聽成功
        fmt.Println("start Zinx server  ", s.Name, " succ, now listenning...")

        //TODO server.go 應(yīng)該有一個自動生成ID的方法
        var cid uint32
        cid = 0

        //3 啟動server網(wǎng)絡(luò)連接業(yè)務(wù)
        for {
            //3.1 阻塞等待客戶端建立連接請求
            conn, err := listenner.AcceptTCP()
            if err != nil {
                fmt.Println("Accept err ", err)
                continue
            }

            //3.2 TODO Server.Start() 設(shè)置服務(wù)器最大連接控制,如果超過最大連接，那么則關(guān)閉此新的連接

            //3.3 處理該新連接請求的 業(yè)務(wù) 方法， 此時應(yīng)該有 handler 和 conn是綁定的
            dealConn := NewConntion(conn, cid, CallBackToClient)
            cid ++

            //3.4 啟動當(dāng)前鏈接的處理業(yè)務(wù)
            go dealConn.Start()
        }
    }()
}

func (s *Server) Stop() {
    fmt.Println("[STOP] Zinx server , name " , s.Name)

    //TODO  Server.Stop() 將其他需要清理的連接信息或者其他信息 也要一并停止或者清理
}

func (s *Server) Serve() {
    s.Start()

    //TODO Server.Serve() 是否在啟動服務(wù)的時候 還要處理其他的事情呢 可以在這里添加

    //阻塞,否則主Go退出， listenner的go將會退出
    for {
        time.Sleep(10*time.Second)
    }
}

/*
  創(chuàng)建一個服務(wù)器句柄
 */
func NewServer (name string) ziface.IServer {
    s:= &Server {
        Name :name,
        IPVersion:"tcp4",
        IP:"0.0.0.0",
        Port:7777,
    }

    return s
}

? CallBackToClient是我們給當(dāng)前客戶端conn對象綁定的handle方法，當(dāng)然目前是server端強制綁定的回顯業(yè)務(wù)，我們之后會豐富框架，讓這個用戶可以讓用戶自定義指定handle。

? 在 start()方法中，我們主要做了如下的修改：

            //3.3 處理該新連接請求的 業(yè)務(wù) 方法， 此時應(yīng)該有 handler 和 conn是綁定的
            dealConn := NewConntion(conn, cid, CallBackToClient)
            cid ++

            //3.4 啟動當(dāng)前鏈接的處理業(yè)務(wù)
            go dealConn.Start()

好了，現(xiàn)在我們已經(jīng)將connection的連接和handle綁定了，下面我們在測試一下Zinx-V0.2的框架是否可以使用吧。

2.2 使用Zinx-V0.2完成應(yīng)用程序

實際上，目前Zinx框架的對外接口并未改變，所以V0.1的測試依然有效。

Server.go

package main

import (
    "zinx/znet"
)

//Server 模塊的測試函數(shù)
func main() {

    //1 創(chuàng)建一個server 句柄 s
    s := znet.NewServer("[zinx V0.1]")

    //2 開啟服務(wù)
    s.Serve()
}

啟動Server.go

go run Server.go

Client.go

package main

import (
    "fmt"
    "net"
    "time"
)

func main() {

    fmt.Println("Client Test ... start")
    //3秒之后發(fā)起測試請求，給服務(wù)端開啟服務(wù)的機會
    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 {
        _, err := conn.Write([]byte("hahaha"))
        if err !=nil {
            fmt.Println("write error err ", err)
            return
        }

        buf :=make([]byte, 512)
        cnt, err := conn.Read(buf)
        if err != nil {
            fmt.Println("read buf error ")
            return
        }

        fmt.Printf(" server call back : %s, cnt = %d\n", buf,  cnt)

        time.Sleep(1*time.Second)
    }
}

啟動Client.go進行測試

go run Client.go

現(xiàn)在我們已經(jīng)簡單初始了Zinx的雛形，但是目前離我們真正的框架還很遠(yuǎn)，接下來我們來改進zinx框架。

關(guān)于作者：

作者：Aceld(劉丹冰)

mail: danbing.at@gmail.com
github: https://github.com/aceld
原創(chuàng)書籍: https://www.kancloud.cn/@aceld

文章推薦

開源軟件作品

(原創(chuàng)開源)Zinx-基于Golang輕量級服務(wù)器并發(fā)框架[完整版(附教程視頻)]
(原創(chuàng)開源)Lars-基于C++負(fù)載均衡遠(yuǎn)程調(diào)度系統(tǒng)[完整版]

精選文章

使用Golang的interface接口設(shè)計原則
深入淺出Golang的協(xié)程池設(shè)計
Go語言構(gòu)建微服務(wù)一站式解決方案
Golang中的局部變量“何時棧?何時堆?”

原創(chuàng)聲明:未經(jīng)作者允許請勿轉(zhuǎn)載,或者轉(zhuǎn)載請注明出處!

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容