??最近想研究一下關(guān)于長鏈接的相關(guān)內(nèi)容,在B站上看到了Zinx框架的視頻慰丛,是Golang語言的框架卓囚,本著更好的理解框架的內(nèi)容,按照整個Zinx課程的進度诅病,制作一個Python版本的Zinx框架哪亿。有關(guān)于Zinx框架的具體內(nèi)容,可以看框架作者的介紹贤笆。
??python版本的Zinx蝇棉,基于Gevent 22.10.2,使用協(xié)程功能苏潜。
??golang版本的Zinx項目银萍,項目中兩個文件夾,ziface和znet恤左。
- ziface主要是存放一些Zinx框架的全部模塊的抽象層接口類贴唇。
- znet模塊是zinx框架中網(wǎng)絡(luò)相關(guān)功能的實現(xiàn),所有網(wǎng)絡(luò)相關(guān)模塊都會定義在znet模塊中飞袋。
└── zinx
?├── ziface
?│??└──
?└── znet
????├──
??python中的關(guān)鍵字沒有interface戳气,但是可以使用抽象基類(abstract base class)和第三方庫來實現(xiàn)類似于接口的功能。在實際開發(fā)中巧鸭,我們可以根據(jù)具體需求選擇合適的實現(xiàn)方式瓶您。
??暫時使用抽象基類的形式模擬接口的實現(xiàn)。
??在第4節(jié)全局配置中纲仍,配置了一個參數(shù)MaxConn呀袱,表示最大鏈接數(shù)量。本節(jié)就將這個參數(shù)的作用進行實現(xiàn)郑叠。
??在ziface中夜赵,創(chuàng)建iconmanager,鏈接管理抽象層乡革。
# -*- coding: utf-8 -*-
from ziface.iconnection import IConnection
from abc import ABC, abstractmethod
class IConManager(ABC):
"""
連接管理抽象層
"""
@abstractmethod
def Add(self, Conn: IConnection):
"""
添加鏈接
:param Conn:
:return:
"""
pass
@abstractmethod
def Remove(self, Conn: IConnection):
"""
刪除連接
:param Conn:
:return:
"""
pass
@abstractmethod
def Get(self, connID: int) -> IConnection:
"""
利用ConnID獲取鏈接
:param connID:
:param Conn:
:return:
"""
pass
@abstractmethod
def Len(self) -> int:
"""
獲取當(dāng)前連接個數(shù)
:return:
"""
pass
@abstractmethod
def ClearConn(self):
"""
刪除并停止所有鏈接
:return:
"""
??在znet中創(chuàng)建conmanager實現(xiàn)一下寇僧。
# -*- coding: utf-8 -*-
from typing import Dict, Optional
from ziface.iconManager import IConManager
from ziface.iconnection import IConnection
class ConManager(IConManager):
"""
連接管理模塊
"""
def __init__(self):
self.connections: Dict[int, IConnection] = {}
def Add(self, Conn: IConnection):
"""
添加鏈接
:param Conn:
:return:
"""
self.connections[Conn.GetConnID()] = Conn
print("鏈接添加至鏈接管理成功摊腋,當(dāng)前數(shù)量 = ", self.Len())
def Remove(self, Conn: IConnection):
"""
刪除連接
:param Conn:
:return:
"""
del self.connections[Conn.GetConnID()]
print("鏈接移除成功ConnID=", Conn.GetConnID(), ",當(dāng)前數(shù)量 = ", self.Len())
def Get(self, connID: int) -> Optional[IConnection]:
"""
利用ConnID獲取鏈接
:param connID:
:return:
"""
if connID in self.connections.keys():
return self.connections[connID]
return None
def Len(self) -> int:
"""
獲取當(dāng)前連接個數(shù)
:return:
"""
return len(self.connections)
def ClearConn(self):
"""
刪除并停止所有鏈接
:return:
"""
# 當(dāng)進行key遍歷時嘁傀,如果dict被修改會拋出異常兴蒸,使用copy做一個副本進行解決
keys = self.connections.copy().keys()
for key in keys:
if key not in self.connections.keys():
continue
self.connections[key].Stop()
try:
del self.connections[key]
except:
continue
print("清除所有鏈接: 當(dāng)前數(shù)量 = ", self.Len())
# 創(chuàng)建一個鏈接管理
def NewConnManager() -> IConManager:
cm = ConManager()
return cm
??鏈接管理模塊封裝好了,接下來就是集成了细办。
??在Server中橙凳,添加一個成員變量connManager。
class Server(IServer):
def __init__(self, name: str, ip: str, port: int,
family: socket.AddressFamily = socket.AF_INET,
socket_kind: socket.SocketKind = socket.SOCK_STREAM):
self.name: str = name
self.family: socket.AddressFamily = family
self.socket_kind: socket.SocketKind = socket_kind
self.ip: str = ip
self.port: int = port
# self.Router: Optional[IRouter] = None
self.msgHandler: IMsgHandler = NewMsgHandler()
self.connManager: IConManager = NewConnManager()
??在IServer中蟹腾,添加一個成員函數(shù)GetConnMgr痕惋。
@abstractmethod
def GetConnMgr(self) -> IConManager:
"""
得到鏈接管理
:return:
"""
pass
??在Server中,實現(xiàn)一下GetConnMgr娃殖。
def GetConnMgr(self) -> IConManager:
"""
得到鏈接管理
:return:
"""
return self.connManager
??在Connection中值戳,添加Server屬性,為Connection提供connManager的使用權(quán)炉爆。在Connection初始化的時候堕虹,就添加到鏈接管理模塊中
class Connection(IConnection):
def __init__(self, tcp_server: IServer, conn: socket.socket, connID: int, remote_addr: tuple, msgHandler: IMsgHandler):
self.TCPServer = tcp_server
self.Conn: socket.socket = conn # 當(dāng)前鏈接的socket TCP套接字
self.ConnID: int = connID # 鏈接的ID
# self.HandlerAPI = handlerAPI # 當(dāng)前鏈接綁定的業(yè)務(wù)處理方法的API
self.is_closed: bool = False # 鏈接狀態(tài)
self.Remote_Addr: tuple = remote_addr # 地址
# self.Router: IRouter = router
self.msgHandler: IMsgHandler = msgHandler # 消息處理模塊
self.msgQueue: Queue = Queue() # 寫隊列
def NewConnection(tcp_server: IServer, conn: socket.socket, connID: int, remote_addr: tuple, msgHandler: IMsgHandler) -> IConnection:
c = Connection(tcp_server, conn, connID, remote_addr, msgHandler)
c.TcpServer.GetConnMgr().Add(c)
return c
??在Server的InitTCP中判斷一下是否達到最大鏈接數(shù)。
def InitTCP(self):
"""
初始化TCP鏈接
:return:
"""
# 1.獲取一個TCP的Addr
with socket.socket(self.family, self.socket_kind) as tcp:
# 2.監(jiān)聽服務(wù)器的地址
tcp.bind((self.ip, self.port))
tcp.listen(128)
print("[啟動] %s服務(wù)啟動成功芬首,監(jiān)聽中......" % self.name)
# 3.阻塞的等待客戶端鏈接赴捞,處理客戶端鏈接業(yè)務(wù)(讀寫)。
cid: int = 0
while True:
print("開啟接收")
remote_socket, remote_addr = tcp.accept()
if self.connManager.Len() >= GlobalObject.MaxConn:
remote_socket.close()
continue
dealConn = NewConnection(self, remote_socket, cid, remote_addr, self.msgHandler)
cid += 1
g2 = gevent.spawn(dealConn.Start())
GlobalGevents.append(g2)
??在Connection斷開鏈接的時候郁稍,移除當(dāng)前鏈接赦政。在Connection中Stop函數(shù)中移除。
def Stop(self):
"""
停止鏈接 結(jié)束當(dāng)前鏈接的工作
:return:
"""
print("鏈接關(guān)閉耀怜,ID=", self.ConnID)
if self.is_closed:
return
self.is_closed = True
# 關(guān)閉socket鏈接恢着,回收資源
self.Conn.close()
# 將鏈接從連接管理器中刪除
self.TcpServer.GetConnMgr().Remove(self)
??在Server停止的時候,移除當(dāng)前所有鏈接财破。在Server中Stop函數(shù)中移除掰派。
def Stop(self):
"""
停止服務(wù)器方法
:return:
"""
print("服務(wù)停止")
# 斷開所有鏈接,回收
self.connManager.ClearConn()
??服務(wù)接口做完了左痢。在demo\connmanager中做一個客戶端和服務(wù)端測試一下靡羡,代碼與demo\msghandler一樣即可。
??此時發(fā)送和接收都正常俊性。鏈接管理模塊完成略步。