python实现一个简单的echo服务器

为熟悉python网络编程我们先简单的实现一个echo服务器,该服务器的功能是客户端发送数据给服务器,服务器带上时间戳原样返回给客户端

python socket简介

1、Socket 类型

套接字格式:

socket(family,type[,protocal]) 使用给定的地址族、套接字类型、协议编号(默认为0)来创建套接字。

socket类型 描述
socket.AF_UNIX 只能够用于单一的Unix系统进程间通信
socket.AF_INET 服务器之间网络通信
socket.AF_INET6 IPv6
socket.SOCK_STREAM 流式socket , for TCP
socket.SOCK_DGRAM 数据报式socket , for UDP
socket.SOCK_RAW 原始套接字,普通的套接字无法处理ICMP、IGMP等网络报文,而SOCK_RAW可以;其次,SOCK_RAW也可以处理特殊的IPv4报文;此外,利用原始套接字,可以通过IP_HDRINCL套接字选项由用户构造IP头。
socket.SOCK_SEQPACKET 可靠的连续数据包服务

2、Socket 函数

注意点:

1)TCP发送数据时,已建立好TCP连接,所以不需要指定地址。UDP是面向无连接的,每次发送要指定是发给谁。

2)服务端与客户端不能直接发送列表,元组,字典。需要字符串化repr(data)。

socket函数 描述
服务端socket函数
s.bind(address) 将套接字绑定到地址, 在AF_INET下,以元组(host,port)的形式表示地址.
s.listen(backlog) 开始监听TCP传入连接。backlog指定在拒绝连接之前,操作系统可以挂起的最大连接数量。该值至少为1,大部分应用程序设为5就可以了。
s.accept() 接受TCP连接并返回(conn,address),其中conn是新的套接字对象,可以用来接收和发送数据。address是连接客户端的地址。
客户端socket函数
s.connect(address) 连接到address处的套接字。一般address的格式为元组(hostname,port),如果连接出错,返回socket.error错误。
s.connect_ex(adddress) 功能与connect(address)相同,但是成功返回0,失败返回errno的值。
公共socket函数
s.recv(bufsize[,flag]) 接受TCP套接字的数据。数据以字符串形式返回,bufsize指定要接收的最大数据量。flag提供有关消息的其他信息,通常可以忽略。
s.send(string[,flag]) 发送TCP数据。将string中的数据发送到连接的套接字。返回值是要发送的字节数量,该数量可能小于string的字节大小。
s.sendall(string[,flag]) 完整发送TCP数据。将string中的数据发送到连接的套接字,但在返回之前会尝试发送所有数据。成功返回None,失败则抛出异常。
s.recvfrom(bufsize[.flag]) 接受UDP套接字的数据。与recv()类似,但返回值是(data,address)。其中data是包含接收数据的字符串,address是发送数据的套接字地址。
s.sendto(string[,flag],address) 发送UDP数据。将数据发送到套接字,address是形式为(ipaddr,port)的元组,指定远程地址。返回值是发送的字节数。
s.close() 关闭套接字。
s.getpeername() 返回连接套接字的远程地址。返回值通常是元组(ipaddr,port)。
s.getsockname() 返回套接字自己的地址。通常是一个元组(ipaddr,port)
s.setsockopt(level,optname,value) 设置给定套接字选项的值。
s.getsockopt(level,optname[.buflen]) 返回套接字选项的值。
s.settimeout(timeout) 设置套接字操作的超时期,timeout是一个浮点数,单位是秒。值为None表示没有超时期。一般,超时期应该在刚创建套接字时设置,因为它们可能用于连接的操作(如connect())
s.gettimeout() 返回当前超时期的值,单位是秒,如果没有设置超时期,则返回None。
s.fileno() 返回套接字的文件描述符。
s.setblocking(flag) 如果flag为0,则将套接字设为非阻塞模式,否则将套接字设为阻塞模式(默认值)。非阻塞模式下,如果调用recv()没有发现任何数据,或send()调用无法立即发送数据,那么将引起socket.error异常。
s.makefile() 创建一个与该套接字相关连的文件

3、socket编程思路

TCP服务端:

1 创建套接字,绑定套接字到本地IP与端口

# socket.socket(socket.AF_INET,socket.SOCK_STREAM) , s.bind()

2 开始监听连接                   #s.listen()

3 进入循环,不断接受客户端的连接请求              #s.accept()

4 然后接收传来的数据,并发送给对方数据         #s.recv() , s.sendall()

5 传输完毕后,关闭套接字                     #s.close()

TCP客户端:

1 创建套接字,连接远端地址

# socket.socket(socket.AF_INET,socket.SOCK_STREAM) , s.connect()

2 连接后发送数据和接收数据          # s.sendall(), s.recv()

3 传输完毕后,关闭套接字          #s.close()

客户端代码

下面给出实现:

[python]
# -*- coding: utf-8 -*-
from socket import *
import time
import threading
BUFSIZ = 1024

def clientFunc(con):
data = con.recv(BUFSIZ) # 接受服务器端的数据
if data:
print data

print "start connect the server"
HOST = ‘main.yinyst.com’ #服务器域名地址
PORT = 8888 #同一个连接端口

ADDR = (HOST, PORT)

tcpCliSock = socket(AF_INET, SOCK_STREAM) #同样的TCP套接字
tcpCliSock.connect(ADDR) # 连接相应的地址,初始化TCP服务器的连接

while True:

data = raw_input(‘>’)
if not data:
break
tcpCliSock.send(data) # 向服务器传输数据
print("send")
clientFunc(tcpCliSock)

tcpCliSock.close()
[/python]

服务器代码

1.简单的实现

[python]
import socket

HOST = ” # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.bind((HOST, PORT))
s.listen(1)
conn, addr = s.accept()
print ‘Connected by’, addr
while 1:
data = conn.recv(1024)
if not data: break
conn.sendall(data)
conn.close()
[/python]

这是个简单的echo服务器,一次只能处理一个连接,必须当前的连接处理完了断开后,才能处理下一个请求的连接,下面我们调整一下,加入线程处理这样的门就可以同时处理多个连接了,下面给出改进后的服务器版本:

[python]
# -*- coding: utf-8 -*-
import socket
import sys
import threading
from time import ctime

class ThreadFunc(object):

def __init__(self, func, args, name = ”):
self.name = name
self.func = func
self.args = args

def __call__(self):
self.func(*self.args)

HOST = ” # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print (‘Socket created’)

#Bind socket to local host and port
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’)

#Start listening on socket
s.listen(10)
print (‘Socket now listening’)

#Function for handling connections. This will be used to create threads
def clientthread(conn):
#Sending message to connected client
while True:

#Receiving from client
data = conn.recv(1024)
if not data:
break

conn.send((‘[%s] %s’ % (ctime(), data)).encode())

#came out of loop
print("conn close")
conn.close()

#now keep talking with the client
while 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.
t = threading.Thread(target = ThreadFunc(clientthread ,(conn,),clientthread.__name__))
t.start()

s.close()
[/python]

上面我们对线程的封装有点不伦不类,一般不推荐这样实现,下面我么实现一个对线程继承的封装写法,

[python]
# -*- coding: utf-8 -*-
import socket
import sys
import threading
from time import ctime

class myThread(threading.Thread):

def __init__(self, func, args, name = ”):
threading.Thread.__init__(self)
self.name = name
self.func = func
self.args = args

def run(self):
self.func(*self.args)

def setCallFunc(self,func):
self.func = func

def setConnect(self,con):
self.args = con

HOST = ” # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print (‘Socket created’)

#Bind socket to local host and port
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’)

#Start listening on socket
s.listen(10)
print (‘Socket now listening’)

#Function for handling connections. This will be used to create threads
def clientthread(conn):
#Sending message to connected client
while True:

#Receiving from client
data = conn.recv(1024)
if not data:
break

conn.send((‘[%s] %s’ % (ctime(), data)).encode())

#came out of loop
print("conn close")
conn.close()

#now keep talking with the client
while 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.
t = myThread(None ,None,clientthread.__name__)
t.setCallFunc(clientthread)
t.setConnect((conn,))
t.start()

s.close()
[/python]

这个版本的我们就可以同时处理多个连接的请求,但是没有一个请求我就会创建一个线程,这样迟早会出现问题,我们可以实现一个线程池版本的,由于篇幅的问题,我这里给出代码的连接python线程池select echo服务器