溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

Python使用socketServer包如何搭建服務(wù)器?

發(fā)布時間:2020-06-23 11:52:16 來源:億速云 閱讀:167 作者:清晨 欄目:開發(fā)技術(shù)

這篇文章將為大家詳細講解有關(guān)Python使用socketServer包如何搭建服務(wù)器?,小編覺得挺實用的,因此分享給大家做個參考,希望大家閱讀完這篇文章后可以有所收獲。

server類

socketserver包提供5個Server類,這些單獨使用這些Server類都只能完成同步的操作,他是一個單線程的,不能同時處理各個客戶端的請求,只能按照順序依次處理。

+------------+
| BaseServer |
+------------+
  |
  v
+-----------+    +------------------+
| TCPServer |------->| UnixStreamServer |
+-----------+    +------------------+
  |
  v
+-----------+    +--------------------+
| UDPServer |------->| UnixDatagramServer |
+-----------+    +--------------------+

兩個Mixin類

+--------------+    +----------------+
| ForkingMixIn |    | ThreadingMixIn |
+--------------+    +----------------+

各自實現(xiàn)了多進程和多線程的功能(ForkingMixIn在Windows不支持)

于是將這些同步類和Mixin類組合就實現(xiàn)了異步服務(wù)類的效果。

class ThreadingUDPServer(ThreadingMixIn, UDPServer): pass
class ThreadingTCPServer(ThreadingMixIn, TCPServer): pass

class ForkingUDPServer(ForkingMixIn, UDPServer): pass
class ForkingTCPServer(ForkingMixIn, TCPServer): pass

基本使用

由于server需要同時處理來自多個客戶端的請求,需要提供異步的支持,所以通常使用上面的異步類創(chuàng)建服務(wù)器。在Windows系統(tǒng)中沒有提供os.fork()接口,Windows無法使用多進程的ForkingUDPServer和ForkingTCPServer,只能使用ThreadingTCPServer或者ThreadingUDPServer;而Linux和Unix多線程和多進程版本都可以使用。

服務(wù)器主要負責(zé)接受客戶端的連接請求,當一個新的客戶端請求到來后,將分配一個新的線程去處理這個請求(異步服務(wù)器ThreadingTCPServer),而與客戶端信息的交互則交給了專門的請求處理類(RequestHandlerClass)處理。

import socketserver
# 創(chuàng)建一個基于TCP的server對象,并使用BaseRequestHandler處理客戶端發(fā)送的消息
server = socketserver.ThreadingTCPServer(("127.0.0.1", 8000), BaseRequestHandler) 
server.serve_forever() # 啟動服務(wù)器,

只需要上面兩行代碼就可以創(chuàng)建開啟一個服務(wù),運行上面代碼后常看本機8000端口,發(fā)現(xiàn)有程序正在監(jiān)聽。

C:\Users\user>netstat -anp tcp | findstr 8000
TCP 127.0.0.1:8000 0.0.0.0:0 LISTENING

ThreadingTCPServer可以對我們的請求進行接受,但是并不會進行處理請求,處理請求的類是上面指定BaseRequestHandler類,該類可以定義handle方法來處理接受的請求。

BaseRequestHandler的源碼

class BaseRequestHandler:

  def __init__(self, request, client_address, server):
    self.request = request
    self.client_address = client_address
    self.server = server
    self.setup()
    try:
      self.handle()
    finally:
      self.finish()
  def setup(self):
    pass

  def handle(self):
    pass

  def finish(self):
    pass

在server = socketserver.ThreadingTCPServer(("127.0.0.1", 8000), BaseRequestHandler)中,BaseRequestHandler將作為參數(shù)綁定到服務(wù)器的實例上,服務(wù)器啟動后,每當有一個新的客戶端接接入服務(wù)器,將會實例化一個請求處理對象,并傳入三個參數(shù),request(連接客戶端的socket)、client_address(遠程客戶端的地址)、server(服務(wù)器對象),執(zhí)行init方法,將這三個參數(shù)保存到對應(yīng)屬性上。這個請求處理對象便可以與客戶端交互了。

簡單示例

import socketserver
import threading 

class MyRequestHandler(socketserver.BaseRequestHandler):
  """ BaseRequestHandler的實例化方法中,獲得了三個屬性
  self.request = request  # 該線程中與客戶端交互的 socket 對象。
  self.client_address   # 該線程處理的客戶端地址
  self.server = server   # 服務(wù)器對象
  """

  def handle(self):
    while True:
      msg = self.request.recv()  # 接受客戶端的數(shù)據(jù)
      if msg == b"quit" or msg == "": # 退出
        break

      print(msg.decode())
      self.request.send(msg) # 將消息發(fā)送回客戶端
  def finish(self):
    self.request.close()    # 關(guān)閉套接字
if __name__ == "__main__":
  # 創(chuàng)建一個基于TCP的server對象,并使用BaseRequestHandler處理客戶端發(fā)送的消息
  server = socketserver.ThreadingTCPServer(("127.0.0.1", 8000), MyRequestHandler)

  server.serve_forever()  # 啟動服務(wù)器

我們創(chuàng)建了一個ThreadingTCPServer服務(wù)器,然后在傳入的處理類MyRequestHandler,并在handle方法中提供與客戶端消息交互的業(yè)務(wù)邏輯,此處只是將客戶端的消息返回客戶端。最后我們在finish方法中關(guān)閉資源,finish方法使用了finally機制,保證了這些代碼一定會執(zhí)行。

上一篇使用socket實現(xiàn)了一個群聊服務(wù)器,這個里使用socketServer將更加方便的實現(xiàn)

class MyRequestHandle(BaseRequestHandler):
  clients = {} # 在類屬性中記錄所有與客戶端連接socket。
  lock = threading.Lock() # 互斥鎖,各個線程共用

  def setup(self): # 新的用戶連接時,預(yù)處理,將這個新的連接加入到clients中,考慮線程安全,需要加鎖
    with self.lock:
      self.clients[self.client_address] = self.request

  def handle(self): # 處理客戶端的請求主邏輯
    while True:
      data = self.request.recv(1024).strip()  # 接受數(shù)據(jù)

      if data == b"quit" or data == b"": # 客戶端退出
        with self.lock:
          self.server.clients.pop(self.client_address)
          self.request.close()
          break

      print("{}-{}: {}".format(*self.client_address, data.decode()))

      with self.lock:
        for _, c in self.server.clients.items(): # 群發(fā)
          c.send(data)
  def finish(self):
    with server.lock:
      for _, c in server.clients.items():
        c.close()
    server.server_close()def main():
  server = ThreadingTCPServer(("127.0.0.1", 8000), MyRequestHandle)
  # 將創(chuàng)建的所有線程設(shè)置為daemon線程,這樣控臺主程序退出時,這個服務(wù)器的所有線程將會被結(jié)束
  server.daemon_threads = True 

if __name__ == "__main__":
  main()

上面requestHandlerclass中的handle方法和finish方式對應(yīng)了上一篇中TCP服務(wù)器的recv方法和stop方法,他們處理請求的邏輯是相同的。只是上面使用了socketserver的代碼變少了,處理的邏輯也變少了,TCPserver幫我們完成了大量的工作,這利于軟件的快速開發(fā)。

內(nèi)置的兩個RequestHandlerClass

StreamHandlerRequest

StreamHandlerRequest顧名思義是一種流式的求情處理類,對應(yīng)TCP協(xié)議的面向字節(jié)流的傳輸形式。我們從源代碼分析。(去除了一些次要代碼)

class StreamRequestHandler(BaseRequestHandler):
  rbufsize = -1 # 讀緩存
  wbufsize = 0  # 寫緩存
  timeout = None # 超時時間
  # IP/TCP擁塞控制的Nagle算法算法。
  disable_nagle_algorithm = False

  def setup(self): # 實現(xiàn)了setup,
    self.connection = self.request
    if self.timeout is not None:
      self.connection.settimeout(self.timeout)
    if self.disable_nagle_algorithm:
      self.connection.setsockopt(socket.IPPROTO_TCP,
                    socket.TCP_NODELAY, True)
    
    # 使用 makefile方法獲得了一個只讀文件對象 rfile
    self.rfile = self.connection.makefile('rb', self.rbufsize)
    
    # 獲得一個只寫的文件對象 wfile
    if self.wbufsize == 0:
      self.wfile = _SocketWriter(self.connection)
    else:
      self.wfile = self.connection.makefile('wb', self.wbufsize)

  def finish(self): # 負責(zé)將這個 wfile 和 rfile方法關(guān)閉。
    if not self.wfile.closed: 
      try:
        self.wfile.flush()
      except socket.error:
        pass
    self.wfile.close()
    self.rfile.close()

使用StreamRequestHandler方法可以將這個socket包裝成一個類文件對象,方便我們使用一套文件對象的方法處理這個socket,它沒有實現(xiàn)handle方法,我仍然需要我們實現(xiàn)。我們可以這樣使用它

class MyHandle(StreamRequestHandler):
  # 如果需要使用setup和finish方法,需要調(diào)用父類方法,否則該方法將會被覆蓋。
  def setup(self):
    super().setup()
    # 添加自己的需求
  def handle(self):
    # 這里我們可以使用wfile和rfile來處理socket消息了,例如之前使用self.request.recv()方法等同于self.rfile.read()
    # 而 self.wfile.write 等同于 self.request.send(),在handle方法中完成業(yè)務(wù)邏輯即可

  def finish(self):
    super().finish()

server = ThreadingTCPServer("127.0.0.1", MyHandle)
server.serve_forever()

StreamRequestHandler主要定義了兩個新的 wfile對象和rfile對象,來分別對這個socket進行讀寫操作,當我們業(yè)務(wù)需要時,比如需要使用文件接口方法時,選擇繼承于StreamRequestHandler構(gòu)建我們自己處理請求類來完成業(yè)務(wù)邏輯將會更加的方便。

DatagramRequestHandler

DatagramRequestHandler字面意思是數(shù)據(jù)報請求處理,也就是基于UDPServer的服務(wù)器才能使用該請求處理類

class DatagramRequestHandler(BaseRequestHandler):

  def setup(self):
    from io import BytesIO
    # udp的self.request包含兩部分(data,socket)它來自于
    # data, client_addr = self.socket.recvfrom(self.max_packet_size)
    #   return (data, self.socket), client_addr
    # (data, self.socket)就是這個self.request,在這里將其解構(gòu),data為recvfrom接收的數(shù)據(jù)
    self.packet, self.socket = self.request
    
    # 該數(shù)據(jù)包封裝為 BytesIO,同樣為一個類文件對象。
    self.rfile = BytesIO(self.packet)
    self.wfile = BytesIO()

  def finish(self):
    self.socket.sendto(self.wfile.getvalue(), self.client_address)

從源碼可以看出,DatagramRequestHandler將數(shù)據(jù)包封裝為一個rfile,并實例化一個ByteIO對象用于寫入數(shù)據(jù),寫入的數(shù)據(jù)可以通過self.socket這個套接字發(fā)送。這樣可以使用rfile和wfile這兩個類文件對象的read或者write接口來進行一些IO方面的操作。

關(guān)于Python使用socketServer包如何搭建服務(wù)器?就分享到這里了,希望以上內(nèi)容可以對大家有一定的幫助,可以學(xué)到更多知識。如果覺得文章不錯,可以把它分享出去讓更多的人看到。

向AI問一下細節(jié)

免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關(guān)證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI