gtcp
模块提供了连接池的特性,由 gtcp.PoolConn
对象实现,连接池缓存固定存活时间为600秒,且内部实现了数据发送时的断开重连机制。连接池非常适合于频繁的短链接操作且连接并发量大的场景。我们接下来使用两个示例来演示一下连接池的作用。
使用方式:
import "github.com/gogf/gf/net/gtcp"
接口文档:
https://godoc.org/github.com/gogf/gf/net/gtcp
type PoolConn
func NewPoolConn(addr string, timeout ...int) (*PoolConn, error)
func (c *PoolConn) Close() error
func (c *PoolConn) Recv(length int, retry ...Retry) ([]byte, error)
func (c *PoolConn) RecvLine(retry ...Retry) ([]byte, error)
func (c *PoolConn) RecvPkg(option ...PkgOption) ([]byte, error)
func (c *PoolConn) RecvPkgWithTimeout(timeout time.Duration, option ...PkgOption) ([]byte, error)
func (c *PoolConn) RecvWithTimeout(length int, timeout time.Duration, retry ...Retry) (data []byte, err error)
func (c *PoolConn) Send(data []byte, retry ...Retry) error
func (c *PoolConn) SendPkg(data []byte, option ...PkgOption) (err error)
func (c *PoolConn) SendPkgWithTimeout(data []byte, timeout time.Duration, option ...PkgOption) error
func (c *PoolConn) SendRecv(data []byte, receive int, retry ...Retry) ([]byte, error)
func (c *PoolConn) SendRecvPkg(data []byte, option ...PkgOption) ([]byte, error)
func (c *PoolConn) SendRecvPkgWithTimeout(data []byte, timeout time.Duration, option ...PkgOption) ([]byte, error)
func (c *PoolConn) SendRecvWithTimeout(data []byte, receive int, timeout time.Duration, retry ...Retry) ([]byte, error)
func (c *PoolConn) SendWithTimeout(data []byte, timeout time.Duration, retry ...Retry) error
由于 gtcp.PoolConn
继承于 gtcp.Conn
因此同时也可以使用 gtcp.Conn
的方法。
示例1,基本使用
package main
import (
"fmt"
"time"
"github.com/gogf/gf/net/gtcp"
"github.com/gogf/gf/os/glog"
"github.com/gogf/gf/os/gtime"
)
func main() {
// Server
go gtcp.NewServer("127.0.0.1:8999", func(conn *gtcp.Conn) {
defer conn.Close()
for {
data, err := conn.Recv(-1)
if len(data) > 0 {
if err := conn.Send(append([]byte("> "), data...)); err != nil {
fmt.Println(err)
}
}
if err != nil {
break
}
}
}).Run()
time.Sleep(time.Second)
// Client
for {
if conn, err := gtcp.NewPoolConn("127.0.0.1:8999"); err == nil {
if b, err := conn.SendRecv([]byte(gtime.Datetime()), -1); err == nil {
fmt.Println(string(b), conn.LocalAddr(), conn.RemoteAddr())
} else {
fmt.Println(err)
}
conn.Close()
} else {
glog.Error(err)
}
time.Sleep(time.Second)
}
}
在这个示例中,Server创建新的goroutine异步运行,Client在main goroutine中执行。Server端是一个回显服务器,Client每隔1秒向Server端发送当前的时间,经过Server端回显返回后,在Client端打印出双方的连接端口信息。
执行后,结果如下:
> 2018-07-11 23:29:54 127.0.0.1:55876 127.0.0.1:8999
> 2018-07-11 23:29:55 127.0.0.1:55876 127.0.0.1:8999
> 2018-07-11 23:29:56 127.0.0.1:55876 127.0.0.1:8999
> 2018-07-11 23:29:57 127.0.0.1:55876 127.0.0.1:8999
> 2018-07-11 23:29:58 127.0.0.1:55876 127.0.0.1:8999
...
可以看到,Client的端口一直未变,每一次通过 gtcp.NewConn("127.0.0.1:8999")
获得的都是同一个 gtcp.Conn
对象,且每一次 conn.Close()
时并不是真正的关闭连接,而是将该 对象重新丢回到连接池里循环使用。
示例2,连接断开情况
这个例子是为了展示当服务端关闭连接后,该连接对象还是否有效的处理。
package main
import (
"fmt"
"time"
"github.com/gogf/gf/net/gtcp"
"github.com/gogf/gf/os/glog"
"github.com/gogf/gf/os/gtime"
)
func main() {
// Server
go gtcp.NewServer("127.0.0.1:8999", func(conn *gtcp.Conn) {
defer conn.Close()
for {
data, err := conn.Recv(-1)
if len(data) > 0 {
if err := conn.Send(append([]byte("> "), data...)); err != nil {
fmt.Println(err)
}
}
if err != nil {
break
}
return
}
}).Run()
time.Sleep(time.Second)
// Client
for {
if conn, err := gtcp.NewPoolConn("127.0.0.1:8999"); err == nil {
if b, err := conn.SendRecv([]byte(gtime.Datetime()), -1); err == nil {
fmt.Println(string(b), conn.LocalAddr(), conn.RemoteAddr())
} else {
fmt.Println(err)
}
conn.Close()
} else {
glog.Error(err)
}
time.Sleep(time.Second)
}
}
执行后,输出结果如下:
> 2018-07-20 12:56:15 127.0.0.1:59368 127.0.0.1:8999
EOF
> 2018-07-20 12:56:17 127.0.0.1:59376 127.0.0.1:8999
EOF
> 2018-07-20 12:56:19 127.0.0.1:59378 127.0.0.1:8999
EOF
...
在这个示例中,Server每处理完毕一条请求之后便关闭链接。Client在第一条请求发送完毕后,由于连接池的IO复用特性,下一次获取到的将是同一个连接对象,由于Server链接已主动关闭,第二次请求写入成功(其实并未成功发送到Server端,需要通过下一次的读取操作才能检测到链接错误),但是读取却失败了( EOF
表示目标连接关闭),因此这个时候Client执行 Close
时将会销毁该连接操作对象,而不是进一步复用。下一次再通过 gtcp.NewPoolConn
获得连接对象时,Client将会与Server创建一个新的连接进行数据通信。所以你看到Client的端口一直在变化,那是因为该 gtcp.Conn
对象已经是一个新的连接对象,之前的连接对象已经被销毁。
连接对象的IO复用涉及到十分微妙的连接状态变化问题,由于点对点网络通信本身是比较复杂的环境,连接对象的状态随时可能被动发生着变化,因此,在使用gtcp连接池特性时,需要注意当通信错误产生时的连接对象重建机制,一旦产生错误,立即丢弃( Close
)该对象( gtcp.PoolConn
)并重建( gtcp.NewPoolConn
)。