15.1 tcp服務器 · Go入門指南

這部分我們將使用TCP協議和在14章講到的協程范式編寫一個簡單的客戶端-服務器應用，一個（web）服務器應用需要響應眾多客戶端的并發請求：go會為每一個客戶端產生一個協程用來處理請求。我們需要使用net包中網絡通信的功能。它包含了用于TCP/IP以及UDP協議、域名解析等方法。服務器代碼，單獨的一個文件：示例 15.1?[server.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/server.go) ~~~ package main import ( "fmt" "net" ) func main() { fmt.Println("Starting the server ...") // 創建 listener listener, err := net.Listen("tcp", "localhost:50000") if err != nil { fmt.Println("Error listening", err.Error()) return //終止程序 } // 監聽并接受來自客戶端的連接 for { conn, err := listener.Accept() if err != nil { fmt.Println("Error accepting", err.Error()) return // 終止程序 } go doServerStuff(conn) } } func doServerStuff(conn net.Conn) { for { buf := make([]byte, 512) _, err := conn.Read(buf) if err != nil { fmt.Println("Error reading", err.Error()) return //終止程序 } fmt.Printf("Received data: %v", string(buf)) } } ~~~ 我們在`main()`創建了一個`net.Listener`的變量，他是一個服務器的基本函數：用來監聽和接收來自客戶端的請求（來自localhost即IP地址為127.0.0.1端口為50000基于TCP協議）。這個`Listen()`函數可以返回一個`error`類型的錯誤變量。用一個無限for循環的`listener.Accept()`來等待客戶端的請求。客戶端的請求將產生一個`net.Conn`類型的連接變量。然后一個獨立的攜程使用這個連接執行`doServerStuff()`，開始使用一個512字節的緩沖`data`來讀取客戶端發送來的數據并且把它們打印到服務器的終端；當客戶端發送的所有數據都被讀取完成時，攜程就結束了。這段程序會為每一個客戶端連接創建一個獨立的攜程。必須先運行服務器代碼，再運行客戶端代碼。客戶端代碼寫在另外一個文件client.go中：示例 15.2?[client.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/client.go) ~~~ package main import ( "bufio" "fmt" "net" "os" "strings" ) func main() { //打開連接: conn, err := net.Dial("tcp", "localhost:50000") if err != nil { //由于目標計算機積極拒絕而無法創建連接 fmt.Println("Error dialing", err.Error()) return // 終止程序 } inputReader := bufio.NewReader(os.Stdin) fmt.Println("First, what is your name?") clientName, _ := inputReader.ReadString('\n') // fmt.Printf("CLIENTNAME %s", clientName) trimmedClient := strings.Trim(clientName, "\r\n") // Windows 平臺下用 "\r\n"，Linux平臺下使用 "\n" // 給服務器發送信息直到程序退出： for { fmt.Println("What to send to the server? Type Q to quit.") input, _ := inputReader.ReadString('\n') trimmedInput := strings.Trim(input, "\r\n") // fmt.Printf("input:--s%--", input) // fmt.Printf("trimmedInput:--s%--", trimmedInput) if trimmedInput == "Q" { return } _, err = conn.Write([]byte(trimmedClient + " says: " + trimmedInput)) } } ~~~ 客戶端通過`net.Dial`創建了一個和服務器之間的連接它通過無限循環中的os.Stdin接收來自鍵盤的輸入直到輸入了“Q”。注意使用`\r`和`\n`換行符分割字符串（在windows平臺下使用`\r\n`）。接下來分割后的輸入通過`connection`的`Write`方法被發送到服務器。當然，服務器必須先啟動好，如果服務器并未開始監聽，客戶端是無法成功連接的。如果在服務器沒有開始監聽的情況下運行客戶端程序，客戶端會停止并打印出以下錯誤信息：`對tcp 127.0.0.1:50000發起連接時產生錯誤：由于目標計算機的積極拒絕而無法創建連接`。打開控制臺并轉到服務器和客戶端可執行程序所在的目錄，Windows系統下輸入server.exe（或者只輸入server），Linux系統下輸入./server。接下來控制臺出現以下信息：`Starting the server ...` 在Windows系統中，我們可以通過CTRL/C停止程序。然后開啟2個或者3個獨立的控制臺窗口，然后分別輸入client回車啟動客戶端程序以下是服務器的輸出（在移除掉512字節的字符串中內容為空的區域后）： ~~~ Starting the Server ... Received data: IVO says: Hi Server, what's up ? Received data: CHRIS says: Are you busy server ? Received data: MARC says: Don't forget our appointment tomorrow ! ~~~ 當客戶端輸入 Q 并結束程序時，服務器會輸出以下信息： ~~~ Error reading WSARecv tcp 127.0.0.1:50000: The specified network name is no longer available. ~~~ 在網絡編程中`net.Dial`函數是非常重要的，一旦你連接到遠程系統，就會返回一個Conn類型接口，我們可以用它發送和接收數據。`Dial`函數巧妙的抽象了網絡結構及傳輸。所以IPv4或者IPv6，TCP或者UDP都可以使用這個公用接口。下邊這個示例先使用TCP協議連接遠程80端口，然后使用UDP協議連接，最后使用TCP協議連接IPv6類型的地址：示例 15.3?[dial.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/dial.go) ~~~ // make a connection with www.example.org: package main import ( "fmt" "net" "os" ) func main() { conn, err := net.Dial("tcp", "192.0.32.10:80") // tcp ipv4 checkConnection(conn, err) conn, err = net.Dial("udp", "192.0.32.10:80") // udp checkConnection(conn, err) conn, err = net.Dial("tcp", "[2620:0:2d0:200::10]:80") // tcp ipv6 checkConnection(conn, err) } func checkConnection(conn net.Conn, err error) { if err != nil { fmt.Printf("error %v connecting!") os.Exit(1) } fmt.Println("Connection is made with %v", conn) } ~~~ 下邊也是一個使用net包從socket中打開，寫入，讀取數據的例子：示例 15.4?[socket.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/socket.go) ~~~ package main import ( "fmt" "io" "net" ) func main() { var ( host = "www.apache.org" port = "80" remote = host + ":" + port msg string = "GET / \n" data = make([]uint8, 4096) read = true count = 0 ) // 創建一個socket con, err := net.Dial("tcp", remote) // 發送我們的消息，一個http GET請求 io.WriteString(con, msg) // 讀取服務器的響應 for read { count, err = con.Read(data) read = (err == nil) fmt.Printf(string(data[0:count])) } con.Close() } ~~~ 練習 15.1?編寫新版本的客戶端和服務器（[client1.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/exercises/chapter_15/client1.go)?/?[server1.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/exercises/chapter_15/server1.go)）： * 增加一個檢查錯誤的函數`checkError(error)`；討論如下方案的利弊：為什么這個重構可能并沒有那么理想？看看在[示例15.14](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/template_validation.go)中它是如何被解決的 * 使客戶端可以通過發送一條命令SH來關閉服務器 * 讓服務器可以保存已經連接的客戶端列表（他們的名字）；當客戶端發送WHO指令的時候，服務器將顯示如下列表： ~~~ This is the client list: 1:active, 0=inactive User IVO is 1 User MARC is 1 User CHRIS is 1 ~~~ 注意：當服務器運行的時候，你無法編譯/連接同一個目錄下的源碼來產生一個新的版本，因為`server.exe`正在被操作系統使用而無法被替換成新的版本。下邊這個版本的 simple_tcp_server.go 從很多方面優化了第一個tcp服務器的示例 server.go 并且擁有更好的結構，它只用了80行代碼！示例 15.5?[simple_tcp_server.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/simple_tcp_server.go)： ~~~ // Simple multi-thread/multi-core TCP server. package main import ( "flag" "fmt" "net" "os" ) const maxRead = 25 func main() { flag.Parse() if flag.NArg() != 2 { panic("usage: host port") } hostAndPort := fmt.Sprintf("%s:%s", flag.Arg(0), flag.Arg(1)) listener := initServer(hostAndPort) for { conn, err := listener.Accept() checkError(err, "Accept: ") go connectionHandler(conn) } } func initServer(hostAndPort string) *net.TCPListener { serverAddr, err := net.ResolveTCPAddr("tcp", hostAndPort) checkError(err, "Resolving address:port failed: '"+hostAndPort+"'") listener, err := net.ListenTCP("tcp", serverAddr) checkError(err, "ListenTCP: ") println("Listening to: ", listener.Addr().String()) return listener } func connectionHandler(conn net.Conn) { connFrom := conn.RemoteAddr().String() println("Connection from: ", connFrom) sayHello(conn) for { var ibuf []byte = make([]byte, maxRead+1) length, err := conn.Read(ibuf[0:maxRead]) ibuf[maxRead] = 0 // to prevent overflow switch err { case nil: handleMsg(length, err, ibuf) case os.EAGAIN: // try again continue default: goto DISCONNECT } } DISCONNECT: err := conn.Close() println("Closed connection: ", connFrom) checkError(err, "Close: ") } func sayHello(to net.Conn) { obuf := []byte{'L', 'e', 't', '\'', 's', ' ', 'G', 'O', '!', '\n'} wrote, err := to.Write(obuf) checkError(err, "Write: wrote "+string(wrote)+" bytes.") } func handleMsg(length int, err error, msg []byte) { if length > 0 { print("<", length, ":") for i := 0; ; i++ { if msg[i] == 0 { break } fmt.Printf("%c", msg[i]) } print(">") } } func checkError(error error, info string) { if error != nil { panic("ERROR: " + info + " " + error.Error()) // terminate program } } ~~~ (譯者注：應該是由于go版本的更新，會提示os.EAGAIN undefined ,修改后的代碼：[simple_tcp_server_v1.go](https://github.com/Unknwon/the-way-to-go_ZH_CN/blob/master/eBook/examples/chapter_15/simple_tcp_server_v1.go)) 都有哪些改進？ * 服務器地址和端口不再是硬編碼，而是通過命令行傳入參數并通過`flag`包來讀取這些參數。這里使用了`flag.NArg()`檢查是否按照期望傳入了2個參數： ~~~ if flag.NArg() != 2{ panic("usage: host port") } ~~~ 傳入的參數通過`fmt.Sprintf`函數格式化成字符串 ~~~ hostAndPort := fmt.Sprintf("%s:%s", flag.Arg(0), flag.Arg(1)) ~~~ * 在`initServer`函數中通過`net.ResolveTCPAddr`指定了服務器地址和端口，這個函數最終返回了一個`*net.TCPListener` * 每一個連接都會以攜程的方式運行`connectionHandler`函數。這些開始于當通過`conn.RemoteAddr()`獲取到客戶端的地址 * 它使用`conn.Write`發送改進的go-message給客戶端 * 它使用一個25字節的緩沖讀取客戶端發送的數據并一一打印出來。如果讀取的過程中出現錯誤，代碼會進入`switch`語句的`default`分支關閉連接。如果是操作系統的`EAGAIN`錯誤，它會重試。 * 所有的錯誤檢查都被重構在獨立的函數'checkError'中，用來分發出現的上下文錯誤。在命令行中輸入`simple_tcp_server localhost 50000`來啟動服務器程序，然后在獨立的命令行窗口啟動一些client.go的客戶端。當有兩個客戶端連接的情況下服務器的典型輸出如下，這里我們可以看到每個客戶端都有自己的地址： ~~~ E:\Go\GoBoek\code examples\chapter 14>simple_tcp_server localhost 50000 Listening to: 127.0.0.1:50000 Connection from: 127.0.0.1:49346 <25:Ivo says: Hi server, do y><12:ou hear me ?> Connection from: 127.0.0.1:49347 <25:Marc says: Do you remembe><25:r our first meeting serve><2:r?> ~~~ net.Error：這個`net`包返回錯誤的錯誤類型，下邊是約定的寫法，不過`net.Error`接口還定義了一些其他的錯誤實現，有些額外的方法。 ~~~ package net type Error interface{ Timeout() bool // 錯誤是否超時 Temporary() bool // 是否是臨時錯誤 } ~~~ 通過類型斷言，客戶端代碼可以用來測試`net.Error`，從而區分哪些臨時發生的錯誤或者必然會出現的錯誤。舉例來說，一個網絡爬蟲程序在遇到臨時發生的錯誤時可能會休眠或者重試，如果是一個必然發生的錯誤，則他會放棄繼續執行。 ~~~ // in a loop - some function returns an error err if nerr, ok := err.(net.Error); ok && nerr.Temporary(){ time.Sleep(1e9) continue // try again } if err != nil{ log.Fatal(err) } ~~~