1、背景

最近有個(gè)項(xiàng)目，需要搭建一個(gè)socket服務(wù)器，一個(gè)web服務(wù)器，然后實(shí)現(xiàn)兩個(gè)服務(wù)器之間的通訊交互。剛開(kāi)始的方案是用Python中socket模塊實(shí)現(xiàn)一個(gè)多線(xiàn)程的socket服務(wù)器，然后用Flask實(shí)現(xiàn)一個(gè)web服務(wù)器，他們之前通過(guò)線(xiàn)程交互實(shí)現(xiàn)通訊。但是在我看來(lái)這個(gè)方案有例外一個(gè)更好的解決方法，就是用Torndao框架。鑒于網(wǎng)上用Tornado實(shí)現(xiàn)一個(gè)程序同時(shí)實(shí)現(xiàn)web服務(wù)和socket服務(wù)器并且實(shí)現(xiàn)交互的文章幾乎沒(méi)有，所以記錄一下。覺(jué)得寫(xiě)得好麻煩點(diǎn)個(gè)贊，寫(xiě)得不好請(qǐng)指出，有疑問(wèn)可以留言。

2、準(zhǔn)備

2.1、環(huán)境部署

2.2、目錄結(jié)構(gòu)

目錄結(jié)構(gòu)如上圖，這個(gè)目錄結(jié)構(gòu)包括文件命名只是我的個(gè)人習(xí)慣。其實(shí)目錄結(jié)構(gòu)不固定，只要合理就行。另外，原本項(xiàng)目是前后分離的只需要實(shí)現(xiàn)API接口，所以我這里就沒(méi)有涉及到HTML的東西。

3、服務(wù)器的實(shí)現(xiàn)

3.1、Socket服務(wù)器實(shí)現(xiàn)

socket服務(wù)器部分實(shí)現(xiàn)主要靠 Tornado中的TCPServer類(lèi)

3.1.1、 導(dǎo)入類(lèi)

socket_server.py:

from tornado.iostream import IOStream # 這句可以沒(méi)有，只是作為參數(shù)的代碼提示from tornado.tcpserver import TCPServer

3.1.2、 構(gòu)建一個(gè)Connecter類(lèi)

socket_server.py:

class Connecter: clients = set() # 存放連接的客戶(hù)端 async def init(self, stream: IOStream, address: tuple): ''' 注意這個(gè)不是構(gòu)造方法，這里不用構(gòu)造方法是為了方便后續(xù)的與web端相互通信 ''' self.stream, self.address = stream, address self.clients.add(self) print('{address} 上線(xiàn)!'.format(address=address)) self.stream.set_close_callback(self.onClose) # 客戶(hù)端離線(xiàn)的時(shí)候會(huì)被調(diào)用 await self.receive() # 接受消息 async def receive(self): ''' 接受消息 ''' while True: try: # 因?yàn)楫惒降脑颉？赡茉O(shè)備離線(xiàn)后還在接收消息，所以try一下，不讓錯(cuò)誤打印出來(lái)，其實(shí)打印了錯(cuò)誤也不影響程序運(yùn)行data = await self.stream.read_bytes(num_bytes=1024, partial=True) # num_bytes:每次最多接收字節(jié)，partial:數(shù)據(jù)中斷后視為接收完成print(data)# TODO:接收到數(shù)據(jù)的處理 except: pass def send(self, data): ''' 發(fā)送消息 :param data: 消息內(nèi)容 ''' self.stream.write(bytes(data.encode(’utf8’))) def onClose(self): ''' 客戶(hù)端離線(xiàn) ''' print('{address} 離線(xiàn)!'.format(address=self.address)) self.clients.remove(self) # 在clients內(nèi)刪掉該客戶(hù)端

3.1.3、 構(gòu)建一個(gè)SocketServer類(lèi)

socket_server.py:

class SocketServer(TCPServer): # 需要繼承TCPServer這個(gè)類(lèi) async def handle_stream(self, stream: IOStream, address: tuple): # 實(shí)現(xiàn)類(lèi)里面的handle_stream方法 await Connecter().init(stream, address) # 每次有客戶(hù)端連入都實(shí)例化一個(gè)Connecter類(lèi)

3.2、Web服務(wù)器實(shí)現(xiàn)

3.2.1、 實(shí)現(xiàn)一個(gè)requestHandler

web_test.py:

from tornado.web import RequestHandler # 導(dǎo)入RequestHandler類(lèi)class TestApiHandler(RequestHandler): # 繼承RequestHandler類(lèi) def get(self): # 實(shí)現(xiàn)GET方法，GET請(qǐng)求會(huì)執(zhí)行這個(gè)方法 pass def post(self): # 實(shí)現(xiàn)POST方法，POST請(qǐng)求會(huì)執(zhí)行這個(gè)方法 pass

3.2.2、 實(shí)現(xiàn)web app

web_server.py:

from tornado.web import Application # 導(dǎo)入Tornado的Application類(lèi)from .src.web_test import TestApiHandler # 導(dǎo)入我們自己寫(xiě)的TestApiHandler類(lèi)def webServerApp(): # 構(gòu)造出webApp return Application([ (r’/api_test/’, TestApiHandler), # 把/api_test/路由到TestApiHandler ])

3.3、程序入口

3.3.1、 導(dǎo)入web_server和socket_server,還有導(dǎo)入tornado的ioloop

main.py：

from web_server.web_server import webServerAppfrom socket_server.socket_server import SocketServerfrom tornado import ioloopfrom tornado.options import define, options

3.3.2、 定義默認(rèn)端口

main.py

#這里用define定義端口，可以方便使用命令行參數(shù)的形式修改端口define('socketPort', 8888, type=int) # socket默認(rèn)使用8888端口define('webPort', 8080, type=int) # web默認(rèn)使用8080端口

3.3.3、 啟動(dòng)代碼

main.py

def main(): socket_server = SocketServer() socket_server.listen(options.socketPort, ’0.0.0.0’) print('socket服務(wù)器啟動(dòng)，端口：{port}'.format(port=options.socketPort)) app = webServerApp() app.listen(options.webPort, ’0.0.0.0’) print('web服務(wù)器啟動(dòng)，端口：{port}'.format(port=options.webPort)) ioloop.IOLoop.current().start()if __name__ == ’__main__’: main()

4、服務(wù)器運(yùn)行效果

到此，一個(gè)混合型的socket+web服務(wù)器已經(jīng)搭建好了。我們我們運(yùn)行main.py文件可以看到打印的信息，socket和web都正常運(yùn)行。

我在這里簡(jiǎn)單地寫(xiě)了一個(gè)socket客戶(hù)端測(cè)試，代碼如下：

import socketimport datetimeclass Client: def __init__(self): with socket.create_connection(('127.0.0.1', 8888)) as sock: while True:msg = sock.recv(1024)if len(msg) > 0: print(msg) sock.send(bytes(str(datetime.datetime.now).encode(’utf8’)))msg = [] if __name__ == '__main__': Client()

可以看到tornado異步的形式實(shí)現(xiàn)了多客戶(hù)端同時(shí)接入socket。同時(shí)也可以測(cè)試web接口是正常的，如下圖：

5、Web服務(wù)器與Socket服務(wù)器交互

重點(diǎn)來(lái)了，web和socket怎樣實(shí)現(xiàn)交互呢？其實(shí)很簡(jiǎn)單。

5.2、 web >> socket

web_test.py -> TestApiHandler -> post:

5.2.1、 導(dǎo)入Connecter類(lèi)

from socket_server.socket_server import Connecter

5.2.2、 實(shí)現(xiàn)請(qǐng)求接口發(fā)送消息到socket客戶(hù)端

def post(self): # 實(shí)現(xiàn)POST方法，POST請(qǐng)求會(huì)執(zhí)行這個(gè)方法 msg = self.get_argument('msg') # 得到post請(qǐng)求中的msg的值 ip = self.get_argument(’ip’) # 得到要發(fā)送的ip c = Connecter() # 實(shí)例化Connecter類(lèi) counter = 0 # 記錄發(fā)送到客戶(hù)端的個(gè)數(shù) for client in c.clients: # type:Connecter if client.address[0] == ip: # 根據(jù)ip發(fā)送client.send(msg) # 發(fā)送消息counter += 1 # 計(jì)數(shù)加1 self.write('{’send_counter’:' + str(counter) + '}')

5.2.3、 效果

請(qǐng)求接口可以返回?cái)?shù)據(jù)，已經(jīng)成功發(fā)送一個(gè)客戶(hù)端

客戶(hù)端也能收到消息：

5.1、 socket >> web

其實(shí)socket發(fā)送的消息讓web馬上收到消息是不太現(xiàn)實(shí)的，但是我們可以把數(shù)據(jù)保存起來(lái)（可以是數(shù)據(jù)庫(kù)、全局變量、緩存……），然后通過(guò)api接口再把數(shù)據(jù)取出。另外還有一種方法是通過(guò)socket和websocket進(jìn)行交互通訊，這種方法是推薦的方法，同樣的也可以用Tornado去實(shí)現(xiàn)，感興趣可以去研究一下也很簡(jiǎn)單。如何有需要我提供socket、websocket、web三個(gè)端都互相交互的例子可以留言。這里為了簡(jiǎn)單一點(diǎn)，我使用一個(gè)類(lèi)作為全局變量來(lái)保存數(shù)據(jù)，然后用接口訪(fǎng)問(wèn)，拿出這個(gè)類(lèi)的值來(lái)演示一下效果。

5.1.1、 聲明類(lèi)作為全局變量

socket_data_processing.py

class SocketData: msg = ''

5.1.2、 接受到的消息保存到這個(gè)類(lèi)里面的msg

socket_server.py -> Connecter -> receive

async def receive(self): ''' 接受消息 ''' while True: try: # 因?yàn)楫惒降脑颉？赡茉O(shè)備離線(xiàn)后還在接收消息，所以try一下，不讓錯(cuò)誤打印出來(lái)，其實(shí)打印了錯(cuò)誤也不影響程序運(yùn)行data = await self.stream.read_bytes(num_bytes=1024, partial=True) # num_bytes:每次最多接收字節(jié)，partial:數(shù)據(jù)中斷后視為接收完成print(data)from .src.socket_data_processing import SocketDataSocketData.msg = data.decode(’utf8’) except:pass

5.1.3、 用get方法顯示socket顯示回來(lái)的數(shù)據(jù)

web_test.py -> TestApiHandler -> get:

def get(self): # 實(shí)現(xiàn)GET方法，GET請(qǐng)求會(huì)執(zhí)行這個(gè)方法 from socket_server.src.socket_data_processing import SocketData self.write(SocketData.msg)

5.1.4、 效果

可以看到，從socket傳過(guò)來(lái)的字符串，被我通過(guò)Api讀取到了。

6、完整代碼GitHub：https://github.com/JohnDoe1996/socket-web

到此這篇關(guān)于Python Tornado實(shí)現(xiàn)WEB服務(wù)器Socket服務(wù)器共存并實(shí)現(xiàn)交互的方法的文章就介紹到這了,更多相關(guān)Python WEB服務(wù)器Socket服務(wù)器共存交互內(nèi)容請(qǐng)搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)！