Telnet回音服务器
Telnet协议是TCP/IP协议族中的一种。它允许用户(Telnet客户端)通过一个协商过程与一个远程设备进行通信。本例将使用一部分Telnet协议与服务器进行通信。
服务器的网络库为了完整展示自己的代码实现了完整的收发过程,一般比较倾向于使用发送任意封包返回原数据的逻辑。这个过程类似于对着大山高喊,大山把你的声音原样返回的过程。也就是回音(Echo)。本节使用Go语言中的socket、goroutine和通道编写一个简单的Telnet协议的回音服务器。
回音服务器的代码分为4个部分,分别是接受连接、会话处理、Telnet命令处理和程序入口。
1.接受连接
回音服务器能同时服务于多个连接。要接受连接就需要先创建侦听器,侦听器需要一个侦听地址和协议类型。就像你想卖东西,需要先确认卖什么东西,卖东西的类型就是协议类型,然后需要一个店面,店面位于街区的某个位置,这就是侦听器的地址。一个服务器可以开启多个侦听器,就像一个街区可以有多个店面。街区上的编号对应的就是地址中的端口号,如图1-2所示。
图1-2 IP和端口号
- 主机 IP:一般为一个 IP 地址或者域名,127.0.0.1 表示本机地址。
- 端口号:16 位无符号整型值,一共有 65536 个有效端口号。
通过地址和协议名创建侦听器后,可以使用侦听器响应客户端连接。响应连接是一个不断循环的过程,就像到银行办理业务时,一般是排队处理,前一个人办理完后,轮到下一个人办理。
我们把每个客户端连接处理业务的过程叫做会话。在会话中处理的操作和接受连接的业务并不冲突可以同时进行。就像银行有 3 个窗口,喊号器会将用户分配到不同的柜台。这里的喊号器就是 Accept 操作,窗口的数量就是 CPU 的处理能力。因此,使用 goroutine 可以轻松实现会话处理和接受连接的并发执行。
如图1-3清晰地展现了这一过程。
图1-3 socket处理过程
Go语言中可以根据实际会话数量创建多个goroutine,并自动的调度它们的处理。
server.go
package main import ( "fmt" "net" ) // 服务逻辑, 传入地址和退出的通道 func server(address string, exitChan chan int) { // 根据给定地址进行侦听 l, err := net.Listen("tcp", address) // 如果侦听发生错误, 打印错误并退出 if err != nil { fmt.Println(err.Error()) exitChan <- 1 } // 打印侦听地址, 表示侦听成功 fmt.Println("listen: " + address) // 延迟关闭侦听器 defer l.Close() // 侦听循环 for { // 新连接没有到来时, Accept是阻塞的 conn, err := l.Accept() // 发生任何的侦听错误, 打印错误并退出服务器 if err != nil { fmt.Println(err.Error()) continue } // 根据连接开启会话, 这个过程需要并行执行 go handleSession(conn, exitChan) } }
代码说明如下:
- 第9行,接受连接的入口,address为传入的地址,退出服务器使用exitChan的通道控制。往exitChan写入一个整型值时,进程将以整型值作为程序返回值来结束服务器。
- 第12行,使用net包的Listen()函数进行侦听。这个函数需要提供两个参数,第一个参数为协议类型,本例需要做的是TCP连接,因此填入“tcp”;address为地址,格式为“主机:端口号”。
- 第15行,如果侦听发生错误,通过第17行,往exitChan中写入非0值结束服务器,同时打印侦听错误。
- 第24行,使用defer,将侦听器的结束延迟调用。
- 第27行,侦听开始后,开始进行连接接受,每次接受连接后需要继续接受新的连接,周而复始。
- 第30行,服务器接受了一个连接。在没有连接时,Accept()函数调用后会一直阻塞。连接到来时,返回conn和错误变量,conn的类型是*tcp.Conn。
- 第33行,某些情况下,连接接受会发生错误,不影响服务器逻辑,这时重新进行新连接接受。
- 第39行,每个连接会生成一个会话。这个会话的处理与接受逻辑需要并行执行,彼此不干扰。
2.会话处理
每个连接的会话就是一个接收数据的循环。当没有数据时,调用reader.ReadString会发生阻塞,等待数据的到来。一旦数据到来,就可以进行各种逻辑处理。
回音服务器的基本逻辑是“收到什么返回什么”,reader.ReadString可以一直读取socket连接中的数据直到碰到期望的结尾符。这种期望的结尾符也叫定界符,一般用于将TCP封包中的逻辑数据拆分开。下例中使用的定界符是回车换行符(“\r\n”),HTTP协议也是使用同样的定界符。使用reader.ReadString()函数可以将封包简单地拆分开。
如图1-4所示为Telnet数据处理过程。
图1-4 Telnet数据处理过程
回音服务器需要将收到的有效数据通过socket发送回去。
session.go
package main import ( "bufio" "fmt" "net" "strings" ) // 连接的会话逻辑 func handleSession(conn net.Conn, exitChan chan int) { fmt.Println("Session started:") // 创建一个网络连接数据的读取器 reader := bufio.NewReader(conn) // 接收数据的循环 for { // 读取字符串, 直到碰到回车返回 str, err := reader.ReadString('\n') // 数据读取正确 if err == nil { // 去掉字符串尾部的回车 str = strings.TrimSpace(str) // 处理Telnet指令 if !processTelnetCommand(str, exitChan) { conn.Close() break } // Echo逻辑, 发什么数据, 原样返回 conn.Write([]byte(str + "\r\n")) } else { // 发生错误 fmt.Println("Session closed") conn.Close() break } } }
代码说明如下:
- 第11行是会话入口,传入连接和退出用的通道。handleSession()函数被并发执行。
- 第16行,使用bufio包的NewReader()方法,创建一个网络数据读取器,这个Reader将输入数据的读取过程进行封装,方便我们迅速获取到需要的数据。
- 第19行,会话处理开始时,从socket连接,通过reader读取器读取封包,处理封包后需要继续读取从网络发送过来的下一个封包,因此需要一个会话处理循环。
- 第22行,使用reader.ReadString()方法进行封包读取。内部会自动处理粘包过程,直到下一个回车符到达后返回数据。这里认为封包来自Telnet,每个指令以回车换行符(“\r\n”)结尾。
- 第25行,数据读取正常时,返回err为nil。如果发生连接断开、接收错误等网络错误时,err就不是nil了。
- 第28行,reader.ReadString读取返回的字符串尾部带有回车符,使用strings.TrimSpace()函数将尾部带的回车和空白符去掉。
- 第31行,将str字符串传入Telnet指令处理函数processTelnetCommand()中,同时传入退出控制通道exitChan。当这个函数返回false时,表示需要关闭当前连接。
- 第32行和第33行,关闭当前连接并退出会话接受循环。
- 第37行,将有效数据通过conn的Write()方法写入,同时在字符串尾部添加回车换行符(“\r\n”),数据将被socket发送给连接方。
- 第41~43行,处理当reader.ReadString()函数返回错误时,打印错误信息并关闭连接,退出会话并接收循环。
3.Telnet命令处理
Telnet是一种协议。在操作系统中可以在命令行使用Telnet命令发起TCP连接。我们一般用Telnet来连接TCP服务器,键盘输入一行字符回车后,即被发送到服务器上。
在下例中,定义了以下两个特殊控制指令,用以实现一些功能:
- 输入“@close”退出当前连接会话。
- 输入“@shutdown”终止服务器运行。
Telnet命令处理:
telnet.go
package main import ( "fmt" "strings" ) func processTelnetCommand(str string, exitChan chan int) bool { // @close指令表示终止本次会话 if strings.HasPrefix(str, "@close") { fmt.Println("Session closed") // 告诉外部需要断开连接 return false // @shutdown指令表示终止服务进程 } else if strings.HasPrefix(str, "@shutdown") { fmt.Println("Server shutdown") // 往通道中写入0, 阻塞等待接收方处理 exitChan <- 0 // 告诉外部需要断开连接 return false } // 打印输入的字符串 fmt.Println(str) return true }
代码说明如下:
- 第8行,处理Telnet命令的函数入口,传入有效字符并退出通道。
- 第11~16行,当输入字符串中包含“@close”前缀时,在第16行返回false,表示需要关闭当前会话。
- 第19~27行,当输入字符串中包含“@shutdown”前缀时,第24行将0写入exitChan,表示结束服务器。
- 第31行,没有特殊的控制字符时,打印输入的字符串。
4.程序入口
Telnet回音处理主流程:
main.go
package main import ( "os" ) func main() { // 创建一个程序结束码的通道 exitChan := make(chan int) // 将服务器并发运行 go server("127.0.0.1:7001", exitChan) // 通道阻塞,等待接收返回值 code := <-exitChan // 标记程序返回值,并退出 os.Exit(code) }
代码说明如下:
- 第10行,创建一个整型的无缓冲通道作为退出信号。
- 第13行,接受连接的过程可以并发操作,使用go将server()函数开启goroutine。
- 第16行,从exitChan中取出返回值。如果取不到数据就一直阻塞。
- 第19行,将程序返回值传入os.Exit()函数中并终止程序。
编译所有代码并运行,命令行提示如下:
listen: 127.0.0.1:7001
此时,socket侦听成功。在操作系统中的命令行中输入:
telnet 127.0.0.1 7001
尝试连接本地的7001端口。接下来进入测试服务器的流程。
5.测试输入字符串
在Telnet连接后,输入字符串hello,Telnet命令行显示如下:
$ telnet 127.0.0.1 7001 Trying 127.0.0.1... Connected to 127.0.0.1. Escape character is '^]'. hello hello
服务器显示如下:
listen: 127.0.0.1:7001 Session started: hello
客户端输入的字符串会在服务器中显示,同时客户端也会收到自己发给服务器的内容,这就是一次回音。
6.测试关闭会话
当输入@close时,Telnet命令行显示如下:
@close Connection closed by foreign host
服务器显示如下:
Session closed
此时,客户端Telnet与服务器断开连接。
7.测试关闭服务器
测试关闭服务器
当输入@shutdown时,Telnet命令行显示如下:
@shutdown Connection closed by foreign host.
服务器显示如下:
Server shutdown
此时服务器会自动关闭。