本文主要介绍使用python 进行tcp socket 网络编程,假设你已经具有初步的网络知识及python 基本语法知识。
tcp 是一种面向连接的传输层协议,tcp socket 是基于一种 client-server 的编程模型,服务端监听客户端的连接请求,一旦建立连接即可以进行传输数据。那么对 tcp socket 编程的介绍也分为客户端和服务端:
一、客户端编程
创建socket
首先要创建 socket,用 python 中 socket 模块的函数 socket 就可以完成:
#socket client example in python import socket #for sockets #create an af_inet, stream socket (tcp)s = socket.socket(socket.af_inet, socket.sock_stream) print 'socket created'
函数socket.socket 创建一个 socket,返回该 socket 的描述符,将在后面相关函数中使用。该函数带有两个参数:
address family:可以选择 af_inet(用于 internet 进程间通信) 或者 af_unix(用于同一台机器进程间通信)
type:套接字类型,可以是 socket_stream(流式套接字,主要用于 tcp 协议)或者socket_dgram(数据报套接字,主要用于 udp 协议)
注:由于本文主要概述一下 python socket 编程的过程,因此不会对相关函数参数、返回值进行详细介绍,需要了解的可以查看相关手册
错误处理
如果创建 socket 函数失败,会抛出一个 socket.error 的异常,需要捕获:
#handling errors in python socket programs import socket #for socketsimport sys #for exit try: #create an af_inet, stream socket (tcp) s = socket.socket(socket.af_inet, socket.sock_stream)except socket.error, msg: print 'failed to create socket. error code: ' + str(msg[0]) + ' , error message : ' + msg[1] sys.exit(); print 'socket created'
那么到目前为止已成功创建了 socket,接下来我们将用这个 socket 来连接某个服务器,就连 www.google.com 吧。
连接服务器
本文开始也提到了,socket 使用 (ip地址,协议,端口号) 来标识一个进程,那么我们要想和服务器进行通信,就需要知道它的 ip地址以及端口号。
获得远程主机的 ip 地址
python 提供了一个简单的函数 socket.gethostbyname 来获得远程主机的 ip 地址:
host = 'www.google.com'port = 80 try: remote_ip = socket.gethostbyname( host ) except socket.gaierror: #could not resolve print 'hostname could not be resolved. exiting' sys.exit() print 'ip address of ' + host + ' is ' + remote_ip
现在我们知道了服务器的 ip 地址,就可以使用连接函数 connect 连接到该 ip 的某个特定的端口上了,下面例子连接到 80 端口上(是 http 服务的默认端口):
#connect to remote servers.connect((remote_ip , port)) print 'socket connected to ' + host + ' on ip ' + remote_ip
运行该程序:
$ python client.pysocket createdip of remote host www.google.com is 173.194.38.145socket connected to www.google.com on ip 173.194.38.145
发送数据
上面说明连接到 www.google.com 已经成功了,接下面我们可以向服务器发送一些数据,例如发送字符串get / http/1.1\r\n\r\n,这是一个 http 请求网页内容的命令。
#send some data to remote servermessage = get / http/1.1\r\n\r\n try : #set the whole string s.sendall(message)except socket.error: #send failed print 'send failed' sys.exit() print 'message send successfully'
发送完数据之后,客户端还需要接受服务器的响应。
接收数据
函数 recv 可以用来接收 socket 的数据:
#now receive datareply = s.recv(4096) print reply
一起运行的结果如下:
socket createdip of remote host www.google.com is 173.194.38.145socket connected to www.google.com on ip 173.194.38.145message send successfullyhttp/1.1 302 foundcache-control: privatecontent-type: text/html; charset=utf-8location: http://www.google.com.sg/?gfe_rd=cr&ei=plqjvlcreovw8gff0og4cqcontent-length: 262date: thu, 11 dec 2014 08:47:58 gmtserver: gfe/2.0alternate-protocol: 80:quic,p=0.02302 moved302 movedthe document has movedhere.
关闭 socket
当我们不想再次请求服务器数据时,可以将该 socket 关闭,结束这次通信:
s.close()
小结
上面我们学到了如何:
创建 socket 连接到远程服务器 发送数据 接收数据 关闭 socket
当我们打开www.google.com 时,浏览器所做的就是这些,知道这些是非常有意义的。在 socket 中具有这种行为特征的被称为client,客户端主要是连接远程系统获取数据。
socket 中另一种行为称为server,服务器使用 socket 来接收连接以及提供数据,和客户端正好相反。所以 www.google.com 是服务器,你的浏览器是客户端,或者更准确地说,www.google.com 是 http 服务器,你的浏览器是 http 客户端。
那么上面介绍了客户端的编程,现在轮到服务器端如果使用 socket 了。
二、服务器端编程
服务器端主要做以下工作:
打开 socket 绑定到特定的地址以及端口上 监听连接 建立连接 接收/发送数据上面已经介绍了如何创建 socket 了,下面一步是绑定。
绑定socket
函数 bind 可以用来将 socket 绑定到特定的地址和端口上,它需要一个 sockaddr_in 结构作为参数:
import socketimport sys host = '' # symbolic name meaning all available interfacesport = 8888 # arbitrary non-privileged port s = socket.socket(socket.af_inet, socket.sock_stream)print 'socket created' try: s.bind((host, port))except socket.error , msg: print 'bind failed. error code : ' + str(msg[0]) + ' message ' + msg[1] sys.exit() print 'socket bind complete'
绑定完成之后,接下来就是监听连接了。
监听连接
函数 listen 可以将 socket 置于监听模式:
s.listen(10)print 'socket now listening'
该函数带有一个参数称为 backlog,用来控制连接的个数。如果设为 10,那么有 10 个连接正在等待处理,此时第 11 个请求过来时将会被拒绝。
接收连接
当有客户端向服务器发送连接请求时,服务器会接收连接:
#wait to accept a connection - blocking callconn, addr = s.accept() #display client informationprint 'connected with ' + addr[0] + ':' + str(addr[1])
运行该程序的,输出结果如下:
$ python server.pysocket createdsocket bind completesocket now listening
此时,该程序在 8888 端口上等待请求的到来。不要关掉这个程序,让它一直运行,现在客户端可以通过该端口连接到 socket。我们用 telnet 客户端来测试,打开一个终端,输入 telnet localhost 8888:
$ telnet localhost 8888trying 127.0.0.1...connected to localhost.escape character is '^]'.connection closed by foreign host.
这时服务端输出会显示:
$ python server.pysocket createdsocket bind completesocket now listeningconnected with 127.0.0.1:59954
我们观察到客户端已经连接上服务器了。在建立连接之后,我们可以用来与客户端进行通信。下面例子演示的是,服务器建立连接之后,接收客户端发送来的数据,并立即将数据发送回去,下面是完整的服务端程序:
import socketimport sys host = '' # symbolic name meaning all available interfacesport = 8888 # arbitrary non-privileged port s = socket.socket(socket.af_inet, socket.sock_stream)print 'socket created' try: s.bind((host, port))except socket.error , msg: print 'bind failed. error code : ' + str(msg[0]) + ' message ' + msg[1] sys.exit() print 'socket bind complete' s.listen(10)print 'socket now listening' #wait to accept a connection - blocking callconn, addr = s.accept() print 'connected with ' + addr[0] + ':' + str(addr[1]) #now keep talking with the clientdata = conn.recv(1024)conn.sendall(data) conn.close()s.close()
在一个终端中运行这个程序,打开另一个终端,使用 telnet 连接服务器,随便输入字符串,你会看到:
$ telnet localhost 8888trying 127.0.0.1...connected to localhost.escape character is '^]'.happyhappyconnection closed by foreign host.
客户端(telnet)接收了服务器的响应。
我们在完成一次响应之后服务器立即断开了连接,而像www.google.com 这样的服务器总是一直等待接收连接的。我们需要将上面的服务器程序改造成一直运行,最简单的办法是将accept 放到一个循环中,那么就可以一直接收连接了。
保持服务
我们可以将代码改成这样让服务器一直工作:
import socketimport sys host = '' # symbolic name meaning all available interfacesport = 5000 # arbitrary non-privileged port s = socket.socket(socket.af_inet, socket.sock_stream)print 'socket created' try: s.bind((host, port))except socket.error , msg: print 'bind failed. error code : ' + str(msg[0]) + ' message ' + msg[1] sys.exit() print 'socket bind complete' s.listen(10)print 'socket now listening' #now keep talking with the clientwhile 1: #wait to accept a connection - blocking call conn, addr = s.accept() print 'connected with ' + addr[0] + ':' + str(addr[1]) data = conn.recv(1024) reply = 'ok...' + data if not data: break conn.sendall(reply) conn.close()s.close()
现在在一个终端下运行上面的服务器程序,再开启三个终端,分别用 telnet 去连接,如果一个终端连接之后不输入数据其他终端是没办法进行连接的,而且每个终端只能服务一次就断开连接。这从代码上也是可以看出来的。
这显然也不是我们想要的,我们希望多个客户端可以随时建立连接,而且每个客户端可以跟服务器进行多次通信,这该怎么修改呢?
处理连接
为了处理每个连接,我们需要将处理的程序与主程序的接收连接分开。一种方法可以使用线程来实现,主服务程序接收连接,创建一个线程来处理该连接的通信,然后服务器回到接收其他连接的逻辑上来。
import socketimport sysfrom thread import * host = '' # symbolic name meaning all available interfacesport = 8888 # arbitrary non-privileged port s = socket.socket(socket.af_inet, socket.sock_stream)print 'socket created' #bind socket to local host and porttry: s.bind((host, port))except socket.error , msg: print 'bind failed. error code : ' + str(msg[0]) + ' message ' + msg[1] sys.exit() print 'socket bind complete' #start listening on sockets.listen(10)print 'socket now listening' #function for handling connections. this will be used to create threadsdef clientthread(conn): #sending message to connected client conn.send('welcome to the server. type something and hit enter\n') #send only takes string #infinite loop so that function do not terminate and thread do not end. while true: #receiving from client data = conn.recv(1024) reply = 'ok...' + data if not data: break conn.sendall(reply) #came out of loop conn.close() #now keep talking with the clientwhile 1: #wait to accept a connection - blocking call conn, addr = s.accept() print 'connected with ' + addr[0] + ':' + str(addr[1]) #start new thread takes 1st argument as a function name to be run, second is the tuple of arguments to the function. start_new_thread(clientthread ,(conn,)) s.close()
再次运行上面的程序,打开三个终端来与主服务器建立 telnet 连接,这时候三个客户端可以随时接入,而且每个客户端可以与主服务器进行多次通信。
telnet 终端下可能输出如下:
$ telnet localhost 8888trying 127.0.0.1...connected to localhost.escape character is '^]'.welcome to the server. type something and hit enterhiok...hiasdok...asdcvok...cv
要结束 telnet 的连接,按下 ctrl-] 键,再输入 close 命令。
服务器终端的输出可能是这样的:
$ python server.pysocket createdsocket bind completesocket now listeningconnected with 127.0.0.1:60730connected with 127.0.0.1:60731
到目前为止,我们学习了python 下基本的socket 编程,之后还有相关文章向大家介绍,不要走开。
