tcp/

README

一、快速启动

版本 Golang 1.17+

# 进入服务端样例目录
$ cd ./examples/tcp_server

# 服务端编译
$ make build

# 服务端容器化
$ make image

# 服务端启动
$ make run 

# 进入客户端样例目录
$ cd ../tcp_client

# 启动客户端进行测试
$ go run main.go 

二、架构

三、开发API文档

（1）快速开始

A. 示例演示

1. 编译demo示例，会在example/tcp_server下得到server, 在example/tcp_client下得到client.

$ cd tcp/
$ make

1. 启动Demo server, 该终端不要关闭

$ cd example/tcp_server
$ ./server 
                                        

[TCP] Version: V0.11, MaxConn: 3, MaxPacketSize: 4096
Add api msgId =  0
Add api msgId =  1
[START] Server name: TCP server Demo,listenner at IP: 127.0.0.1, Port 8999 is starting
Worker ID =  0  is started.
Worker ID =  1  is started.
Worker ID =  2  is started.
Worker ID =  3  is started.
Worker ID =  4  is started.
Worker ID =  7  is started.
Worker ID =  6  is started.
Worker ID =  8  is started.
Worker ID =  9  is started.
Worker ID =  5  is started.
start TCP server   TCP server Demo  succ, now listenning...
...

1. 再打开新终端，启动client Demo测试通信

$ cd example/tcp_client
$ ./client
==> 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 
==> Test Router:[Ping] Recv Msg: ID= 0 , len= 18 , data= ping...ping...ping
==> Test Router:[Ping] Recv Msg: ID= 0 , len= 18 , data= ping...ping...ping
...
t

B. server

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

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

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

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

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

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

import (
	"fmt"
	"gitee.com/xingnan/toolbox/tcp/iface"
	"gitee.com/xingnan/toolbox/tcp/net"
)

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

//Ping Handle
func (this *PingRouter) Handle(request iface.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)
	}
}

C. client

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

package main

import (
	"fmt"
	"io"
	"net"
	"time"
	n "gitee.com/xingnan/toolbox/tcp/net"
)

/*
	模拟客户端
 */
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 i := 3; i >= 0; i-- {
		//发封包message消息
		dp := n.NewDataPack()
		msg, _ := dp.Pack(n.NewMsgPackage(0,[]byte("Tcp 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.(*n.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)
	}
}

（2）配置文件

{
  "Name":"demoApp",
  "Host":"127.0.0.1",
  "TcpPort":7777,
  "MaxConn":3,
  "WorkerPoolSize":10,
  "LogDir": "./logs",
  "LogFile":"tcp.log"
}

Name:服务器应用名称

Host:服务器IP

TcpPort:服务器监听端口

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

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

LogDir: 日志文件夹

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

（3）服务器模块Server

  func NewServer () iface.IServer 

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

A. 开启服务

  func (s *Server) Start()

B. 停止服务

  func (s *Server) Stop()

C. 运行服务

  func (s *Server) Serve()

D. 注册路由

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

E. 注册链接创建Hook函数

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

F. 注册链接销毁Hook函数

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

（4）路由模块

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

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

（5）链接模块

A. 获取原始的socket TCPConn

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

B. 获取链接ID

  func (c *Connection) GetConnID() uint32 

C. 获取远程客户端地址信息

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

D. 发送消息

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

E. 链接属性

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

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

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

---