python网络编程

Posted by kevin on April 22, 2020

preface

在学习 TCP/IP 协议之前,一直对网络编程很陌生,懂得原理之后再看网络编程的代码就觉得十分熟悉,借这个机会来总结记录一下,socket 编程的一般流程如下图,我们应该要将这些流程都记熟,用的时候按照顺序写代码就行了。很多语言都提供了 socket 的库可以直接调用,这次就用 python 来写写吧。

process

简单的 C/S 连接

python 中网络编程用到 socket 库,直接 import 进来就可以用了,用以下命令创建一个 socket 套接字

s = socket.socket([family[, type[, proto]]])

family 指的是 socket 家族,有几种选择,最常用的是 socket.AF_INET 代表 ipv4

Family 描述
socket.AF_UNIX 只能够用于单一的Unix系统进程间通信
socket.AF_INET IPv4
socket.AF_INET6 IPv6

type 指的是 socket 的类型,TCP 或者 UDP,TCP 需要连接,UDP 面向无连接,大多数情况下都是建立的 TCP socket,因为它可靠,UDP 速度快,但是用起来不安全,默认的情况也是建立的 TCP socket

socket类型 描述
socket.SOCK_STREAM 流式socket , for TCP
socket.SOCK_DGRAM 数据报式socket , for UDP

建立好 socket 对象了然后就要用到 socket 对象的一些方法来实现通信了,socket 编程一般是实现一个客户端以及服务端,通过套接字让服务器和客户端进行连接,下面是 socket 套接字的一些方法(加粗为常用的方法)

服务器端方法  
s.bind() 绑定地址(host,port)到套接字,在AF_INET下,以元组(host,port)的形式表示地址。
s.listen(backlog) 开始监听。backlog 指定在拒绝连接之前,操作系统可以挂起的最大连接数量。该值至少为 1,大部分应用程序设为 5 就可以了。
s.accept() 被动接受客户端连接,(阻塞式)等待连接的到来,并返回(conn,address)二元元组,其中 conn 是一个通信对象,可以用来接收和发送数据。address 是连接客户端的地址。
客户端方法  
s.connect(address) 客户端向服务端发起连接。一般 address 的格式为元组(hostname,port),如果连接出错,返回 socket.error 错误。
公共方法  
s.recv(bufsize) 接收数据,数据以 bytes 类型返回,bufsize 指定要接收的最大数据量。
s.send() 发送数据。返回值是要发送的字节数量。
s.sendall() 完整发送数据。将数据发送到连接的套接字,但在返回之前会尝试发送所有数据。成功返回None,失败则抛出异常。
s.recvfrom() 接收 UDP 数据,与 recv() 类似,但返回值是(data,address)。其中 data 是包含接收的数据,address 是发送数据的套接字地址。
s.sendto(data,address) 发送 UDP 数据,将数据 data 发送到套接字,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异常。

注意事项

  1. python3 以后,socket 传递的都是 **bytes **类型的数据,字符串需要先转换一下,string.encode() 即可;另一端接收到的 bytes 数据想转换成字符串,只要 bytes.decode() 一下就可以。
  2. 在正常通信时,accept()recv() 方法都是阻塞的。所谓的阻塞,指的是程序会暂停在那,一直等到有数据过来,用 s.setblocking(flag) 可以改变阻塞模式
  3. 不能够发送空白的消息过去,否则服务器会以为客户端已经断开连接,然后服务器和客户端都卡死在那里

然后我们开始编写一个简单的服务器和客户端,捋一捋基本步骤:

服务端:

  1. 创建套接字,绑定套接字到本地IP与端口:socket.socket() , s.bind()
  2. 开始监听连接:s.listen()
  3. 进入循环,不断接受客户端的连接请求:s.accept()
  4. 接收传来的数据,或者发送数据给对方:s.recv() , s.sendall()
  5. 传输完毕后,关闭套接字:s.close()

客户端:

  1. 创建套接字,连接服务器地址:socket.socket() , s.connect()
  2. 连接后发送数据和接收数据:s.sendall(), s.recv()
  3. 传输完毕后,关闭套接字:s.close()

server

下面是服务器的代码,将服务器架设在本地,监听 6666 端口号,运行后就阻塞在 s.accept() 处,等待数据到来才会继续往下走:

import socket

HOST = '127.0.0.1'
PORT = 6666

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.bind((HOST, PORT))
s.listen(5)

print('[INFO] server start at : {}:{}'.format(HOST, PORT))
print('[INFO] waiting for connection...')

while True:
    conn, addr = s.accept()
    print('[INFO] connected by {}'.format(addr))

    while True:
        data = conn.recv(1024).decode()
        print('[INFO] reveiced from client: {}'.format(data))
        
        if data == 'q':
            print('[INFO] client qiuted!')
            break

        conn.send('[INFO] server has received your messages'.encode())
    conn.close()

client

这是客户端的代码,比较简单,直接就是连接服务器,首发数据就行了

import socket

HOST = '127.0.0.1'
PORT = 6666

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((HOST, PORT))

while True:
    cmd = input('Please input your message: ')

    if not cmd:
        print('Not allowed to send empty msg!')
        continue

    s.send(cmd.encode())

    if cmd == 'q':
        print('exit!')
        break

    data = s.recv(1024).decode()
    print(data)

s.close()

附上一张效果图,不过演示的时候我并没有让服务器的 socket 被关闭,这样的话下次客户端还是可以直接连接服务器的

workout

不过这样做的话就有个很关键的问题,那就是我们无法再进行其他的连接了,如果想要两个客户端都连接上服务器并进行数据收发的话,这种模型是做不到的,只能等到一个客户端退出去然后才会对另一个客户端收发信息。改进的方法就是使用多线程,来了一个连接就增加一个线程去处理,然后继续等待其他客户端连接(不过 node.js 做这种事情挺适合的,天生就是异步处理)

多线程版 C/S 连接

server

import socket
import threading

def conn_handler(conn, client):
    client = client[0] + ':' + str(client[1])
    while True:
        data = conn.recv(1024).decode()
        print('[INFO] reveiced from {}: {}'.format(client, data))
        
        if data == 'q':
            print('[INFO] client {} quited!'.format(client))
            break

        conn.send('[INFO] server has received your messages'.encode())
    # conn.close()

HOST = '127.0.0.1'
PORT = 6666

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.bind((HOST, PORT))
s.listen(5)

print('[INFO] server start at : {}:{}'.format(HOST, PORT))
print('[INFO] waiting for connection...')

while True:
    conn, addr = s.accept()
    print('[INFO] connected by {}:{}'.format(addr[0], addr[1]))

    t = threading.Thread(target=conn_handler, args=(conn, addr))
    t.start()

客户端代码和之前一样,不需要改变,这样的话服务器就可以支持多人同时连接了,放个效果图

multi-processing

socket 聊天室

TODO

reference

https://www.liujiangblog.com/course/python/76

https://www.cnblogs.com/Beyond-Ricky/p/8079602.html