使用 Simple Protocol
asyncio.BaseProtocol 類是asyncio模塊中協(xié)議接口(protocol interface)的一個常見的基類。asyncio.Protocolclass 繼承自asyncio.BaseProtocol 并為stream protocols提供了一個接口。下面的代碼演示了asyncio.Protocol 接口的一個簡單實現(xiàn)，它的行為1就像一個echo server，同時，它還會在Python的控制臺中輸出一些信息。SimpleEchoProtocol 繼承自asyncio.Protocol，并且實現(xiàn)了3個方法：connection_made, data_received 以及 andconnection_lost:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
import asyncio class SimpleEchoProtocol(asyncio.Protocol): def connection_made(self, transport): """ Called when a connection is made. The argument is the transport representing the pipe connection. To receive data, wait for data_received() calls. When the connection is closed, connection_lost() is called. """ print("Connection received!") self.transport = transport def data_received(self, data): """ Called when some data is received. The argument is a bytes object. """ print(data) self.transport.write(b'echo:') self.transport.write(data) def connection_lost(self, exc): """ Called when the connection is lost or closed. The argument is an exception object or None (the latter meaning a regular EOF is received or the connection was aborted or closed). """ print("Connection lost! Closing server...") server.close() loop = asyncio.get_event_loop()server = loop.run_until_complete(loop.create_server(SimpleEchoProtocol, 'localhost', 2222))loop.run_until_complete(server.wait_closed()) |
你可以通過運行一個telnet客戶端程序，并且連接到localhost的2222端口來測試這個echo server。如果你正在使用這個端口，你可以將這個端口號修改為任何其他可以使用的端口。如果你使用默認的值，你可以在Python的控制臺中運行上面的代碼，之后在命令提示符或終端中運行 telnet localhost 2222。你將會看到 Connection received! 的信息顯示在Python的控制臺中。接下來，你在telnet的控制臺中輸入的任何字符都會以echo:跟上輸入的字符的形式展示出來，同時，在Python的控制臺中會顯示出剛才新輸入的字符。當你退出telnet控制臺時，你會看到Connection lost! Closing server... 的信息展示在Python的控制臺中。
舉個例子，如果你在開啟telnet之后輸入 abc，你將會在telnet的窗口中看到下面的消息：
|
1
|
echo:abecho:bcecho:c |
此外，在Python的控制臺中會顯示下面的消息：
|
1
2
3
4
5
|
Connection received!b'a'b'b'b'c'Connection lost! Closing server... |
在創(chuàng)建了一個名為loop的事件循環(huán)之后，代碼將會調(diào)用loop.run_until_complete來運行l(wèi)oop.create_server這個協(xié)程(coroutine)。這個協(xié)程創(chuàng)建了一個TCP服務器并使用protocol的工廠類綁定到指定主機的指定端口（在這個例子中是localhost上的2222端口，使用的工廠類是SimpleEchoProtocol）并返回一個Server的對象，以便用來停止服務。代碼將這個實例賦值給server變量。用這種方式，當建立一個客戶端連接時，會創(chuàng)建一個新的SimpleEchoProtocol的實例并且該類中的方法會被執(zhí)行。
當成功的創(chuàng)建了一個連接之后，connection_made 方法里面的代碼輸出了一條消息，并將收到的內(nèi)容作為一個參數(shù)賦值給transport成員變量，以便稍后在另一個方法中使用。
當收到了傳來的數(shù)據(jù)時，data_received方面里面的代碼會將收到的數(shù)據(jù)字節(jié)輸出，并且通過調(diào)用兩次self.transport.write 方法將echo: 和收到數(shù)據(jù)發(fā)送給客戶端。當然了，也可以只調(diào)用一次self.transport.write將所有的數(shù)據(jù)返回，但是我想更清楚的將發(fā)送echo:的代碼和發(fā)送收到的數(shù)據(jù)的代碼區(qū)分開來。
當連接關掉或者斷開時，connection_lost方法中的代碼將會輸出一條消息，并且調(diào)用server.close()；此時，那個在服務器關閉前一直運行的循環(huán)停止了運行。
使用 Clients and Servers
在上面的例子中，telnet是一個客戶端。asyncio模塊提供了一個協(xié)程方便你很容易的使用stream reader 和 writer來編寫服務端和客戶端。下面的代碼演示了一個簡單的echo server，該server監(jiān)聽localhost上的2222端口。你可以在Python的控制臺中運行下面的代碼，之后在另一個Python的控制臺中運行客戶端的代碼作為客戶端。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
|
import asyncio @asyncio.coroutinedef simple_echo_server(): # Start a socket server, call back for each client connected. # The client_connected_handler coroutine will be automatically converted to a Task yield from asyncio.start_server(client_connected_handler, 'localhost', 2222) @asyncio.coroutinedef client_connected_handler(client_reader, client_writer): # Runs for each client connected # client_reader is a StreamReader object # client_writer is a StreamWriter object print("Connection received!") while True: data = yield from client_reader.read(8192) if not data: break print(data) client_writer.write(data) loop = asyncio.get_event_loop()loop.run_until_complete(simple_echo_server())try: loop.run_forever()finally: loop.close() |
下面的代碼演示了一個客戶端程序連接了localhost上的2222端口，并且使用asyncio.StreamWriter對象寫了幾行數(shù)據(jù)，之后使用asyncio.StreamWriter對象讀取服務端返回的數(shù)據(jù)。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
import asyncio LASTLINE = b'Last line.\n' @asyncio.coroutine def simple_echo_client(): # Open a connection and write a few lines by using the StreamWriter object reader, writer = yield from asyncio.open_connection('localhost', 2222) # reader is a StreamReader object # writer is a StreamWriter object writer.write(b'First line.\n') writer.write(b'Second line.\n') writer.write(b'Third line.\n') writer.write(LASTLINE) # Now, read a few lines by using the StreamReader object print("Lines received") while True: line = yield from reader.readline() print(line) if line == LASTLINE or not line: break writer.close() loop = asyncio.get_event_loop()loop.run_until_complete(simple_echo_client()) |
你可以在不同的Python控制臺中執(zhí)行客戶端的代碼。如果服務端正在運行，控制臺中會輸出下面的內(nèi)容：
|
1
2
3
4
5
|
Lines receivedb'First line.\n'b'Second line.\n'b'Third line.\n'b'Last line.\n' |
執(zhí)行服務端代碼的Python控制臺會顯示下面的內(nèi)容：
|
1
2
|
Connection received!b'First line.\nSecond line.\nThird line.\nLast line.\n' |
首先，讓我們關注一下服務端的代碼。在創(chuàng)建完一個叫l(wèi)oop的事件循環(huán)之后，代碼會調(diào)用loop.run_until_complete來運行這個simple_echo_server協(xié)程。該協(xié)程調(diào)用asyncio.start_server協(xié)程來開啟一個socket服務器，綁定到指定的主機和端口號，之后，對每一個客戶端連接執(zhí)行作為參數(shù)傳入的回調(diào)函數(shù)——client_connected_handler。在這個例子中，client_connected_handler是另一個協(xié)程，并且不會被自動的轉換為一個Task。除了協(xié)程(coroutine)之外，你可以指定一個普通的回調(diào)函數(shù)。
