python socket基于TCP/IP协议实现多人聊天室

前言

所谓套接字(Socket)，就是对网络中不同主机上的应用进程之间进行双向通信的端点的抽象。一个套接字就是网络上进程通信的一端，提供了应用层进程利用网络协议交换数据的机制。从所处的地位来讲，套接字上联应用进程，下联网络协议栈，是应用程序通过网络协议进行通信的接口，是应用程序与网络协议根进行交互的接口。

socket 位于网络层以及传输层之间,它提供了三种类型的传输：

1. 流套接字(SOCK_STREAM)
2. 数据报套接字(SOCK_DGRAM)
3. 原始套接字(SOCK_RAW)

第一种使用了TCP协议进行数据的传输，在传输之前需要建立连接，第二种使用UDP协议，传输数据不需要建立连接，本文采用TCP协议，也就是流套接字。

一、实现原理

一对一聊天室:服务端建立连接，等待连接，客户端连接服务端，实现收发。注意，此时通讯为半双工通信

多用户聊天室:服务端建立连接，等待连接，客户端连接服务端，服务器为每个连接上的客户端开启子线程，同时监听每个客户端发送的消息，所有子线程监听到的客户端消息加入Queue队列，另外开启一个子线程用于监听队列消息，并转发给其它所有客户端，主线程用于监听总人数。同样地，客户端接收消息也单独开启一个子线程，用于同步接收。此时通讯为全双工通信

半双工：在某一时刻，只允许数据在单方向传输。也就是只能一边发一边收，发送的时候不能同时接收。

全双工: 允许数据同时在两个方向传输，即 发送的同时也可以接收，接收的同时也可以发送

二、queue队列

python 的queue 队列主要用于解决 两个问题：

1.线程对公共资源占用的问题。避免了A操作资源时候B同时进行操作，发生程序错误。

2.资源重复的问题，queue队列中的元素被取出后就不可重复取出。

import queue

q = queue.Queue()
for i in range(20):
    q.put(i)

for i in range(20):
    if q.empty()==False:
        print(q.get_nowait())

print(q.get_nowait())

上述代码，运行结果为:

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Traceback (most recent call last):
  File "c:\Python文件夹\空白测试.py", line 11, in <module>
    print(q.get_nowait())
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python39\lib\queue.py", line 199, in get_nowait
    return self.get(block=False)
  File "C:\Users\Administrator\AppData\Local\Programs\Python\Python39\lib\queue.py", line 168, in get
    raise Empty
_queue.Empty

结果可知，queue除了代替线程锁的功能，还避免了资源复制重复使用。

三、代码实现

服务端:

import socket
import queue
import threading
import time
#author : ali
#date : 2021年8月17日
serversocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 
host = socket.gethostname()
print(socket.gethostbyname(host))
serversocket.bind((host, 9090))
serversocket.listen(5)
#存放已连接的对象
clients = []
#存放公共消息的容器
public_message = dict()

#接收新的对象
def init():
    while True:    
        client,addr = serversocket.accept()  #阻塞线程
        if client in clients:
            print('老用户')
        else:
            print('新的用户加入:',end='')
            print(client.getpeername()[0])
            client.send(bytes('欢迎来到聊天室(匿名)!'.encode('utf-8')))
            clients.append(client)
            r = threading.Thread(target=receive_msg,args=(client,))
            r.start()
        

#接收消息
def receive_msg(client):
    while True:
        time.sleep(1)
        try:
            if client in clients:
                data = client.recv(1024).decode('utf-8')
                if data!='':
                    print(data)
                    public_message[client] = queue.Queue()
                    public_message[client].put(data)
                else:
                    if client in clients:
                        print("用户优雅的退出了")
                        clients.remove(client)
           
        except BaseException as error:

            print('用户强制中断了一个连接')
            # print('错误:',error)
            if client in clients:
                clients.remove(client)


#转发消息(非/阻塞)
def broadcast():
    while True:
        if len(clients)>1:
            public_message_clone = [i for i in public_message]   #解决字典迭代中操作报错的问题
            for client in clients:
                for i in public_message_clone:
                    if i!=client and public_message[i].empty()==False:
                        data = public_message[i].get_nowait()  #注意
                        if data !='':
                            client.send(bytes(data.encode('utf-8')))
                            print('服务器转发了消息')
         
                    
t1 = threading.Thread(target=init)
t2 = threading.Thread(target=broadcast)

t1.start()
t2.start()


#主线程监听在线人数
while (True):
    print("当前在线人数为:%d"%(len(clients)))
    time.sleep(5)

客户端:

import socket,threading
#客户端想要发消息和收消息同时进行,需要使用多线程达到并发效果

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 
host = socket.gethostname() 
s.connect((host, 9090))


def receive():
    while True:
        data = s.recv(1024).decode('utf-8')
        if data!='':
            print(data)
     
    
def send_msg():
    while (True):
        msg = input(':')
        if msg=='exit':
            s.close()
            break
        s.send(bytes(msg.encode('utf-8')))
        
t1 = threading.Thread(target=receive,daemon=True)
t1.start()

send_msg()

效果图：

四、需要注意的地方

由于queue队列在元素被取出后会自动删除元素，如果queue队列作为字典的value建立在一个字典的键值对中，那么需要提前复制这个字典的所有key给另一个变量，避免在字典循环中自动删除元素导致了程序报错。

五、总结

在实现多人聊天程序之前，一定要思路清晰，提前设计好思路方法，否则容易处处报错，以上如有不当之处欢迎批评指正。