GO語言網絡編程

1、序言

    Golang的主要 設計目標之一就是面向大規模後端服務程序，網絡通訊這塊是服務端 程序必不可少也是相當重要的一部分。在平常應用中，咱們也能夠看到Go中的net以及其subdirectories下的包均是「高頻+剛需」，而TCP socket則是網絡編程的主流，即使您沒有直接使用到net中有關TCP Socket方面的接口，但net/http老是用到了吧，http底層依舊是用tcp socket實現的。

    網絡編程方面，咱們最經常使用的就是tcp socket編程了，在posix標準出來後，socket在各大主流OS平臺上都獲得了很好的支持。關於tcp programming，最好的資料莫過於W. Richard Stevens 的網絡編程聖經《UNIX網絡 編程 卷1：套接字聯網API》了，書中關於tcp socket接口的各類使用、行爲模式、異常處理講解的十分細緻。Go是自帶runtime的跨平臺編程語言，Go中暴露給語言使用者的tcp socket api是創建OS原生tcp socket接口之上的。因爲Go runtime調度的須要，golang tcp socket接口在行爲特色與異常處理方面與OS原生接口有着一些差異。這篇博文的目標就是整理出關於Go tcp socket在各個場景下的使用方法、行爲特色以及注意事項。

 

2、模型

　　從tcp socket誕生後，網絡編程架構模型也幾經演化，大體是：「每進程一個鏈接」 –> 「每線程一個鏈接」 –> 「Non-Block + I/O多路複用(linux epoll/windows iocp/freebsd darwin kqueue/solaris Event Port)」。伴隨着模型的演化，服務程序越發強大，能夠支持更多的鏈接，得到更好的處理性能

       目前主流web server通常均採用的都是」Non-Block + I/O多路複用」（有的也結合了多線程、多進程）。不過I/O多路複用也給使用者帶來了不小的複雜度，以致於後續出現了許多高性能的I/O多路複用框架， 好比libevent、libev、libuv等，以幫助開發者簡化開發複雜性，下降心智負擔。不過Go的設計者彷佛認爲I/O多路複用的這種經過回調機制割裂控制流 的方式依舊複雜，且有悖於「通常邏輯」設計，爲此Go語言將該「複雜性」隱藏在Runtime中了：Go開發者無需關注socket是不是 non-block的，也無需親自注冊文件描述符的回調，只需在每一個鏈接對應的goroutine中以「block I/O」的方式對待socket處理便可，這能夠說大大下降了開發人員的心智負擔。一個典型的Go server端程序大體以下

//go-tcpsock/server.go
func HandleConn(conn net.Conn) {
    defer conn.Close()
    for {
        // read from the connection
        // ... ...
        // write to the connection
        //... ...
    }
}

func main() {
    listen, err := net.Listen("tcp", ":8888")
    if err != nil {
        fmt.Println("listen error: ", err)
        return
    }

    for {
        conn, err := listen.Accept()
        if err != nil {
            fmt.Println("accept error: ", err)
            break
        }
        // start a new goroutine to handle the new connection
        go HandleConn(conn)
    }
}

     用戶層眼中看到的goroutine中的「block socket」，其實是經過Go runtime中的netpoller經過Non-block socket + I/O多路複用機制「模擬」出來的，真實的underlying socket其實是non-block的，只是runtime攔截了底層socket系統調用的錯誤碼，並經過netpoller和goroutine 調度讓goroutine「阻塞」在用戶層獲得的Socket fd上。好比：當用戶層針對某個socket fd發起read操做時，若是該socket fd中尚無數據，那麼runtime會將該socket fd加入到netpoller中監聽，同時對應的goroutine被掛起，直到runtime收到socket fd 數據ready的通知，runtime纔會從新喚醒等待在該socket fd上準備read的那個Goroutine。而這個過程從Goroutine的視角來看，就像是read操做一直block在那個socket fd上似的。具體實現細節在後續場景中會有補充描述。

 

3、TCP鏈接的創建

     衆所周知，TCP Socket的鏈接的創建須要經歷客戶端和服務端的三次握手的過程。鏈接創建過程當中，服務端是一個標準的Listen + Accept的結構(可參考上面的代碼)，而在客戶端Go語言使用net.Dial()或net.DialTimeout()進行鏈接創建

 

    conn, err := net.Dial("tcp", "www.baidu.com:80")
    if err != nil {
        //handle error
    }
    //read or write on conn

超時機制的Dial：

    conn, err := net.DialTimeout("tcp", "www.baidu.com:80", 2*time.Second)
    if err != nil {
        //handle error
    }
    //read or write on conn

 

對於客戶端而言，鏈接的創建會遇到以下幾種情形：

一、網絡不可達或對方服務未啓動 

若是傳給Dial的Addr是能夠當即判斷出網絡不可達，或者Addr中端口對應的服務沒有啓動，端口未被監聽，Dial會幾乎當即返回錯誤，好比：

//go-tcpsock/conn_establish/client1.go
... ...
func main() {
    log.Println("begin dial...")
    conn, err := net.Dial("tcp", ":8888")
    if err != nil {
        log.Println("dial error:", err)
        return
    }
    defer conn.Close()
    log.Println("dial ok")
}

若是本機8888端口未有服務程序監聽，那麼執行上面程序，Dial會很快返回錯誤：

$go run client1.go
2015/11/16 14:37:41 begin dial...
2015/11/16 14:37:41 dial error: dial tcp :8888: getsockopt: connection refused

二、對方服務的listen backlog滿 

還有一種場景就是對方服務器很忙，瞬間有大量client端鏈接嘗試向server創建，server端的listen backlog隊列滿，server accept不及時((即使不accept，那麼在backlog數量範疇裏面，connect都會是成功的，由於new conn已經加入到server side的listen queue中了，accept只是從queue中取出一個conn而已)，這將致使client端Dial阻塞。咱們仍是經過例子感覺Dial的行爲特色： 

服務端代碼：

 

//go-tcpsock/conn_establish/server2.go
... ...
func main() {
    l, err := net.Listen("tcp", ":8888")
    if err != nil {
        log.Println("error listen:", err)
        return
    }
    defer l.Close()
    log.Println("listen ok")

    var i int
    for {
        time.Sleep(time.Second * 10)
        if _, err := l.Accept(); err != nil {
            log.Println("accept error:", err)
            break
        }
        i++
        log.Printf("%d: accept a new connection\n", i)
    }
}

 

客戶端代碼：

//go-tcpsock/conn_establish/client2.go
... ...
func establishConn(i int) net.Conn {
    conn, err := net.Dial("tcp", ":8888")
    if err != nil {
        log.Printf("%d: dial error: %s", i, err)
        return nil
    }
    log.Println(i, ":connect to server ok")
    return conn
}

func main() {
    var sl []net.Conn
    for i := 1; i < 1000; i++ {
        conn := establishConn(i)
        if conn != nil {
            sl = append(sl, conn)
        }
    }

    time.Sleep(time.Second * 10000)
}

從程序能夠看出，服務端在listen成功後，每隔10s鍾accept一次。客戶端則是串行的嘗試創建鏈接。這兩個程序在Darwin下的執行 結果：

$go run server2.go
2015/11/16 21:55:41 listen ok
2015/11/16 21:55:51 1: accept a new connection
2015/11/16 21:56:01 2: accept a new connection
... ...

$go run client2.go
2015/11/16 21:55:44 1 :connect to server ok
2015/11/16 21:55:44 2 :connect to server ok
2015/11/16 21:55:44 3 :connect to server ok
... ...

2015/11/16 21:55:44 126 :connect to server ok
2015/11/16 21:55:44 127 :connect to server ok
2015/11/16 21:55:44 128 :connect to server ok

2015/11/16 21:55:52 129 :connect to server ok
2015/11/16 21:56:03 130 :connect to server ok
2015/11/16 21:56:14 131 :connect to server ok
... ...

能夠看出Client初始時成功地一次性創建了128個鏈接，而後後續每阻塞近10s才能成功創建一條鏈接。也就是說在server端 backlog滿時(未及時accept)，客戶端將阻塞在Dial上，直到server端進行一次accept。至於爲何是128，這與darwin 下的默認設置有關： 

若是我在ubuntu 14.04上運行上述server程序，咱們的client端初始能夠成功創建499條鏈接。

若是server一直不accept，client端會一直阻塞麼？咱們去掉accept後的結果是：在Darwin下，client端會阻塞大 約1分多鐘纔會返回timeout： 

而若是server運行在ubuntu 14.04上，client彷佛一直阻塞，我等了10多分鐘依舊沒有返回。 阻塞與否看來與server端的網絡實現和設置有關。

 

三、網絡延遲較大，Dial阻塞並超時 

若是網絡延遲較大，TCP握手過程將更加艱難坎坷（各類丟包），時間消耗的天然也會更長。Dial這時會阻塞，若是長時間依舊沒法創建鏈接，則Dial也會返回「 getsockopt: operation timed out」錯誤。

在鏈接創建階段，多數狀況下，Dial是能夠知足需求的，即使阻塞一小會兒。但對於某些程序而言，須要有嚴格的鏈接時間限定，若是必定時間內沒能成功創建鏈接，程序可能會須要執行一段「異常」處理邏輯，爲此咱們就須要DialTimeout了。下面的例子將Dial的最長阻塞時間限制在2s內，超出這個時長，Dial將返回timeout error：

 

//go-tcpsock/conn_establish/client3.go
... ...
func main() {
    log.Println("begin dial...")
    conn, err := net.DialTimeout("tcp", "104.236.176.96:80", 2*time.Second)
    if err != nil {
        log.Println("dial error:", err)
        return
    }
    defer conn.Close()
    log.Println("dial ok")
}

 

執行結果以下，須要模擬一個網絡延遲大的環境

$go run client3.go
2015/11/17 09:28:34 begin dial...
2015/11/17 09:28:36 dial error: dial tcp 104.236.176.96:80: i/o timeout

 

4、Socket讀寫

鏈接創建起來後，咱們就要在conn上進行讀寫，以完成業務邏輯。前面說過Go runtime隱藏了I/O多路複用的複雜性。語言使用者只需採用goroutine+Block I/O的模式便可知足大部分場景需求。Dial成功後，方法返回一個net.Conn接口類型變量值，這個接口變量的動態類型爲一個*TCPConn：

 

//$GOROOT/src/net/tcpsock_posix.go
type TCPConn struct {
    conn
}

 

TCPConn內嵌了一個unexported類型：conn，所以TCPConn」繼承」了conn的Read和Write方法，後續經過Dial返回值調用的Write和Read方法均是net.conn的方法：

//$GOROOT/src/net/net.go
type conn struct {
    fd *netFD
}

func (c *conn) ok() bool { return c != nil && c.fd != nil }

// Implementation of the Conn interface.

// Read implements the Conn Read method.
func (c *conn) Read(b []byte) (int, error) {
    if !c.ok() {
        return 0, syscall.EINVAL
    }
    n, err := c.fd.Read(b)
    if err != nil && err != io.EOF {
        err = &OpError{Op: "read", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
    }
    return n, err
}

// Write implements the Conn Write method.
func (c *conn) Write(b []byte) (int, error) {
    if !c.ok() {
        return 0, syscall.EINVAL
    }
    n, err := c.fd.Write(b)
    if err != nil {
        err = &OpError{Op: "write", Net: c.fd.net, Source: c.fd.laddr, Addr: c.fd.raddr, Err: err}
    }
    return n, err
}

一、conn.Read的行爲特色

1.一、Socket中無數據 

鏈接創建後，若是對方未發送數據到socket，接收方(Server)會阻塞在Read操做上，這和前面提到的「模型」原理是一致的。執行該Read操做的goroutine也會被掛起。runtime會監視該socket，直到其有數據纔會從新 。

調度該socket對應的Goroutine完成read。因爲篇幅緣由，這裏就不列代碼了，例子對應的代碼文件：go-tcpsock/read_write下的client1.go和server1.go。

1.二、Socket中有部分數據 

若是socket中有部分數據，且長度小於一次Read操做所指望讀出的數據長度，那麼Read將會成功讀出這部分數據並返回，而不是等待全部指望數據所有讀取後再返回。

1.三、Socket中有足夠數據 

若是socket中有數據，且長度大於等於一次Read操做所指望讀出的數據長度，那麼Read將會成功讀出這部分數據並返回。這個情景是最符合咱們對Read的期待的了：Read將用Socket中的數據將咱們傳入的slice填滿後返回：n = 10, err = nil

1.四、Socket關閉 

若是client端主動關閉了socket，那麼Server的Read將會讀到什麼呢？ 

這裏分爲「有數據關閉」和「無數據關閉」。

有數據關閉是指在client關閉時，socket中還有server端未讀取的數據。當client端close socket退出後，server依舊沒有開始Read，10s後第一次Read成功讀出了全部的數據，當第二次Read時，因爲client端 socket關閉，Read返回EOF error

無數據關閉情形下的結果，那就是Read直接返回EOF error

1.五、讀取操做超時 

有些場合對Read的阻塞時間有嚴格限制，在這種狀況下，Read的行爲究竟是什麼樣的呢？在返回超時錯誤時，是否也同時Read了一部分數據了呢？ 

不會出現「讀出部分數據且返回超時錯誤」的狀況

 

二、conn.Write的行爲特色

2.一、成功寫 

前面例子着重於Read，client端在Write時並未判斷Write的返回值。所謂「成功寫」指的就是Write調用返回的n與預期要寫入的數據長度相等，且error = nil。這是咱們在調用Write時遇到的最多見的情形，這裏再也不舉例了。

2.二、寫阻塞 

TCP鏈接通訊兩端的OS都會爲該鏈接保留數據緩衝，一端調用Write後，實際上數據是寫入到OS的協議棧的數據緩衝的。TCP是全雙工通訊，所以每一個方向都有獨立的數據緩衝。當發送方將對方的接收緩衝區以及自身的發送緩衝區寫滿後，Write就會阻塞。

2.三、寫入部分數據 

Write操做存在寫入部分數據的狀況。沒有按照預期的寫入全部數據。這時候循環寫入即是。

綜上例子，雖然Go給咱們提供了阻塞I/O的便利，但在調用Read和Write時依舊要綜合須要方法返回的n和err的結果，以作出正確處理。net.conn實現了io.Reader和io.Writer接口，所以能夠試用一些wrapper包進行socket讀寫，好比bufio包下面的Writer和Reader、io/ioutil下的函數等。

 

5、Goroutine safe

基於goroutine的網絡架構模型，存在在不一樣goroutine間共享conn的狀況，那麼conn的讀寫是不是goroutine safe的呢？在深刻這個問題以前，咱們先從應用意義上來看read操做和write操做的goroutine-safe必要性。

對於read操做而言，因爲TCP是面向字節流，conn.Read沒法正確區分數據的業務邊界，所以多個goroutine對同一個conn進行read的意義不大，goroutine讀到不完整的業務包反卻是增長了業務處理的難度。對與Write操做而言，卻是有多個goroutine併發寫的狀況。

每次Write操做都是受lock保護，直到這次數據所有write完。所以在應用層面，要想保證多個goroutine在一個conn上write操做的Safe，須要一次write完整寫入一個「業務包」；一旦將業務包的寫入拆分爲屢次write，那就沒法保證某個Goroutine的某「業務包」數據在conn發送的連續性。

同時也能夠看出即使是Read操做，也是lock保護的。多個Goroutine對同一conn的併發讀不會出現讀出內容重疊的狀況，但內容斷點是依 runtime調度來隨機肯定的。存在一個業務包數據，1/3內容被goroutine-1讀走，另外2/3被另一個goroutine-2讀 走的狀況。好比一個完整包：world，當goroutine的read slice size < 5時，存在可能：一個goroutine讀到 「worl」,另一個goroutine讀出」d」。

 

6、Socket屬性 

原生Socket API提供了豐富的sockopt設置接口，但Golang有本身的網絡架構模型，golang提供的socket options接口也是基於上述模型的必要的屬性設置。包括 

SetKeepAlive 

SetKeepAlivePeriod 

SetLinger 

SetNoDelay （默認no delay） 

SetWriteBuffer 

SetReadBuffer

不過上面的Method是TCPConn的，而不是Conn的，要使用上面的Method的，須要type assertion：

tcpConn, ok := conn.(*TCPConn)
if !ok {
    //error handle
}

tcpConn.SetNoDelay(true)

對於listener socket, golang默認採用了 SO_REUSEADDR，這樣當你重啓 listener程序時，不會由於address in use的錯誤而啓動失敗。而listen backlog的默認值是經過獲取系統的設置值獲得的。不一樣系統不一樣：mac 128, linux 512等

 

7、關閉鏈接 
和前面的方法相比，關閉鏈接算是最簡單的操做了。因爲socket是全雙工的，client和server端在己方已關閉的socket和對方關閉的socket上操做的結果有不一樣。看下面例子：

//go-tcpsock/conn_close/client1.go
... ...
func main() {
    log.Println("begin dial...")
    conn, err := net.Dial("tcp", ":8888")
    if err != nil {
        log.Println("dial error:", err)
        return
    }
    conn.Close()
    log.Println("close ok")

    var buf = make([]byte, 32)
    n, err := conn.Read(buf)
    if err != nil {
        log.Println("read error:", err)
    } else {
        log.Printf("read % bytes, content is %s\n", n, string(buf[:n]))
    }

    n, err = conn.Write(buf)
    if err != nil {
        log.Println("write error:", err)
    } else {
        log.Printf("write % bytes, content is %s\n", n, string(buf[:n]))
    }

    time.Sleep(time.Second * 1000)
}

//go-tcpsock/conn_close/server1.go
... ...
func handleConn(c net.Conn) {
    defer c.Close()

    // read from the connection
    var buf = make([]byte, 10)
    log.Println("start to read from conn")
    n, err := c.Read(buf)
    if err != nil {
        log.Println("conn read error:", err)
    } else {
        log.Printf("read %d bytes, content is %s\n", n, string(buf[:n]))
    }

    n, err = c.Write(buf)
    if err != nil {
        log.Println("conn write error:", err)
    } else {
        log.Printf("write %d bytes, content is %s\n", n, string(buf[:n]))
    }
}
... ...

執行結果以下

$go run server1.go
2015/11/17 17:00:51 accept a new connection
2015/11/17 17:00:51 start to read from conn
2015/11/17 17:00:51 conn read error: EOF
2015/11/17 17:00:51 write 10 bytes, content is

$go run client1.go
2015/11/17 17:00:51 begin dial...
2015/11/17 17:00:51 close ok
2015/11/17 17:00:51 read error: read tcp 127.0.0.1:64195->127.0.0.1:8888: use of closed network connection
2015/11/17 17:00:51 write error: write tcp 127.0.0.1:64195->127.0.0.1:8888: use of closed network connection

從client的結果來看，在己方已經關閉的socket上再進行read和write操做，會獲得」use of closed network connection」 error；

從server的執行結果來看，在對方關閉的socket上執行read操做會獲得EOF error，但write操做會成功，由於數據會成功寫入己方的內核socket緩衝區中，即使最終發不到對方socket緩衝區了，由於己方socket並未關閉。所以當發現對方socket關閉後，己方應該正確合理處理本身的socket，再繼續write已經無任何意義了。

 

8、小結 
本文比較基礎，但卻很重要，畢竟golang是面向大規模服務後端的，對通訊環節的細節的深刻理解會大有裨益。另外Go的goroutine+阻塞通訊的網絡通訊模型下降了開發者心智負擔，簡化了通訊的複雜性，這點尤其重要。

 

--------------------- 

做者：silentsharer 

來源：CSDN 

原文：https://blog.csdn.net/hacker00011000/article/details/53910367