Python Socket編程入門教程

這是用來快速學習 Python Socket 通訊端編程的指南和教程。Python 的 Socket 編程跟 C 語言很像。
Python 官方關於 Socket 的函數請看 http://docs.python.org/library/socket.html
基本上，Socket 是任何一種電腦網路通訊中最基礎的內容。例如當你在瀏覽器地址欄中輸入 www.bitsCN.com 時，你會開啟一個通訊端，然後串連到 www.bitsCN.com 並讀取響應的頁面然後然後顯示出來。而其他一些聊天用戶端如 gtalk 和 skype 也是類似。任何網路通訊都是通過 Socket 來完成的。

寫在開頭

本教程假設你已經有一些基本的 Python 編程的知識。
讓我們開始 Socket 編程吧。

建立 Socket

首先要做的就是建立一個 Socket，socket 的 socket 函數可以實現，代碼如下：

代碼如下:

#Socket client example in python

import socket #for sockets

#create an AF_INET, STREAM socket (TCP)
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

print 'Socket Created'

函數 socket.socket 建立了一個 Socket，並返回 Socket 的描述符可用於其他 Socket 相關的函數。
上述代碼使用了下面兩個屬性來建立 Socket：
地址簇 : AF_INET (IPv4)
類型: SOCK_STREAM (使用 TCP 傳輸控制通訊協定)

錯誤處理

如果 socket 函數失敗了，python 將拋出一個名為 socket.error 的異常，這個異常必須予以處理：

代碼如下:

#handling errors in python socket programs

import socket #for sockets
import sys #for exit

try:
#create an AF_INET, STREAM socket (TCP)
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error, msg:
print 'Failed to create socket. Error code: ' + str(msg[0]) + ' , Error message : ' + msg[1]
sys.exit();

print 'Socket Created'

好了，假設你已經成功建立了 Socket，下一步該做什麼呢？接下來我們將使用這個 Socket 來串連到伺服器。

注意:

與 SOCK_STREAM 相對應的其他類型是 SOCK_DGRAM 用於 UDP 通訊協議，UDP 通訊是非串連 Socket，在這篇文章中我們只討論 SOCK_STREAM ，或者叫 TCP 。

串連到伺服器

串連到伺服器需要伺服器位址和連接埠號碼，這裡使用的是 www.bitsCN.com 和 80 連接埠。

首先擷取遠程主機的 IP 位址

串連到遠程主機之前，我們需要知道它的 IP 位址，在 Python 中，擷取 IP 位址是很簡單的：

代碼如下:

import socket #for sockets
import sys #for exit

try:
#create an AF_INET, STREAM socket (TCP)
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error, msg:
print 'Failed to create socket. Error code: ' + str(msg[0]) + ' , Error message : ' + msg[1]
sys.exit();

print 'Socket Created'

host = 'www.bitsCN.com'

try:
remote_ip = socket.gethostbyname( host )

except socket.gaierror:
#could not resolve
print 'Hostname could not be resolved. Exiting'
sys.exit()

print 'Ip address of ' + host + ' is ' + remote_ip

我們已經有 IP 位址了，接下來需要指定要串連的連接埠。
代碼：

代碼如下:

import socket #for sockets
import sys #for exit

try:
#create an AF_INET, STREAM socket (TCP)
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error, msg:
print 'Failed to create socket. Error code: ' + str(msg[0]) + ' , Error message : ' + msg[1]
sys.exit();

print 'Socket Created'

host = 'www.bitsCN.com'
port = 80

try:
remote_ip = socket.gethostbyname( host )

except socket.gaierror:
#could not resolve
print 'Hostname could not be resolved. Exiting'
sys.exit()

print 'Ip address of ' + host + ' is ' + remote_ip

#Connect to remote server
s.connect((remote_ip , port))

print 'Socket Connected to ' + host + ' on ip ' + remote_ip

現在運行程式

代碼如下:

$ python client.py
Socket Created
Ip address of www.bitsCN.com is 61.145.122.155
Socket Connected to www.bitsCN.com on ip 61.145.122.155

這段程式建立了一個 Socket 並進行串連，試試使用其他一些不存在的連接埠（如81）會是怎樣？這個邏輯相當於構建了一個連接埠掃描器。
已經串連上了，接下來就是往伺服器上發送資料。

友情提示

使用 SOCK_STREAM/TCP 通訊端才有“串連”的概念。串連意味著可靠的資料流通訊機制，可以同時有多個資料流。可以想象成一個資料互不干擾的管道。另外一個重要的提示是：資料包的發送和接收是有順序的。
其他一些 Socket 如 UDP、ICMP 和 ARP 沒有“串連”的概念，它們是無串連通訊，意味著你可從任何人或者給任何人發送和接收資料包。

發送資料

sendall 函數用於簡單的發送資料，我們來向 oschina 發送一些資料：

代碼如下:

import socket #for sockets
import sys #for exit

try:
#create an AF_INET, STREAM socket (TCP)
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error, msg:
print 'Failed to create socket. Error code: ' + str(msg[0]) + ' , Error message : ' + msg[1]
sys.exit();

print 'Socket Created'

host = 'www.bitsCN.com'
port = 80

try:
remote_ip = socket.gethostbyname( host )

except socket.gaierror:
#could not resolve
print 'Hostname could not be resolved. Exiting'
sys.exit()

print 'Ip address of ' + host + ' is ' + remote_ip

#Connect to remote server
s.connect((remote_ip , port))

print 'Socket Connected to ' + host + ' on ip ' + remote_ip

#Send some data to remote server
message = "GET / HTTP/1.1\r\n\r\n"

try :
#Set the whole string
s.sendall(message)
except socket.error:
#Send failed
print 'Send failed'
sys.exit()

print 'Message send successfully'

上述例子中，首先串連到目標伺服器，然後發送字串資料 "GET / HTTP/1.1\r\n\r\n" ，這是一個 HTTP 協議的命令，用來擷取網站首頁的內容。

接下來需要讀取伺服器返回的資料。

接收資料

recv 函數用於從 socket 接收資料：

代碼如下:

#Socket client example in python

import socket #for sockets
import sys #for exit

#create an INET, STREAMing socket
try:
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
except socket.error:
print 'Failed to create socket'
sys.exit()

print 'Socket Created'

host = 'bitsCN.com';
port = 80;

try:
remote_ip = socket.gethostbyname( host )

except socket.gaierror:
#could not resolve
print 'Hostname could not be resolved. Exiting'
sys.exit()

#Connect to remote server
s.connect((remote_ip , port))

print 'Socket Connected to ' + host + ' on ip ' + remote_ip

#Send some data to remote server
message = "GET / HTTP/1.1\r\nHost: bitsCN.com\r\n\r\n"

try :
#Set the whole string
s.sendall(message)
except socket.error:
#Send failed
print 'Send failed'
sys.exit()

print 'Message send successfully'

#Now receive data
reply = s.recv(4096)

print reply

下面是上述程式執行的結果：

代碼如下:

$ python client.py
Socket Created
Ip address of bitsCN.com is 61.145.122.
Socket Connected to bitsCN.com on ip 61.145.122.155
Message send successfully
HTTP/1.1 301 Moved Permanently
Server: nginx
Date: Wed, 24 Oct 2012 13:26:46 GMT
Content-Type: text/html
Content-Length: 178
Connection: keep-alive
Keep-Alive: timeout=20
Location: http://www.bitsCN.com/

bitsCN.com 回應了我們所請求的 URL 的內容，很簡單。資料接收完了，可以關閉 Socket 了。

關閉 socket

close 函數用於關閉 Socket：

代碼如下:

s.close()

這就是了。

讓我們回顧一下

上述的樣本中我們學到了如何：
1. 建立 Socket
2. 串連到遠程伺服器
3. 發送資料
4. 接收回應

當你用瀏覽器開啟 www.bitsCN.com 時，其過程也是一樣。包含兩種類型，分別是用戶端和伺服器，用戶端串連到伺服器並讀取資料，伺服器使用 Socket 接收進入的串連並提供資料。因此在這裡 www.bitsCN.com 是伺服器端，而你的瀏覽器是用戶端。
接下來我們開始在伺服器端做點編碼。

伺服器端編程

伺服器端編程主要包括下面幾步：
1. 開啟 socket
2. 綁定到一個地址和連接埠
3. 偵聽進來的串連
4. 接受串連
5. 讀寫資料
我們已經學習過如何開啟 Socket 了，下面是綁定到指定的地址和連接埠上。

綁定 Socket

bind 函數用於將 Socket 綁定到一個特定的地址和連接埠，它需要一個類似 connect 函數所需的 sockaddr_in 結構體。
範例程式碼：

代碼如下:

import socket
import sys

HOST = '' # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print 'Socket created'

try:
s.bind((HOST, PORT))
except socket.error , msg:
print 'Bind failed. Error Code : ' + str(msg[0]) + ' Message ' + msg[1]
sys.exit()

print 'Socket bind complete'

綁定完成後，就需要讓 Socket 開始偵聽串連。很顯然，你不能將兩個不同的 Socket 綁定到同一個連接埠之上。

串連偵聽

綁定 Socket 之後就可以開始偵聽串連，我們需要將 Socket 變成偵聽模式。socket 的 listen 函數用於實現偵聽模式：

代碼如下:

s.listen(10)
print 'Socket now listening'

listen 函數所需的參數成為 backlog，用來控製程序忙時可保持等待狀態的串連數。這裡我們傳遞的是 10，意味著如果已經有 10 個串連在等待處理，那麼第 11 個串連將會被拒絕。當檢查了 socket_accept 後這個會更加清晰。

接受串連
範例程式碼：

代碼如下:

import socket
import sys

HOST = '' # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print 'Socket created'

try:
s.bind((HOST, PORT))
except socket.error , msg:
print 'Bind failed. Error Code : ' + str(msg[0]) + ' Message ' + msg[1]
sys.exit()

print 'Socket bind complete'

s.listen(10)
print 'Socket now listening'

#wait to accept a connection - blocking call
conn, addr = s.accept()

#display client information
print 'Connected with ' + addr[0] + ':' + str(addr[1])

輸出
運行該程式將會顯示：

代碼如下:

$ python server.py
Socket created
Socket bind complete
Socket now listening

現在這個程式開始等待串連進入，連接埠是 8888，請不要關閉這個程式，我們來通過 telnet 程式來進行測試。
開啟命令列視窗並輸入：

代碼如下:

$ telnet localhost 8888

It will immediately show
$ telnet localhost 8888
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Connection closed by foreign host.

而伺服器端視窗顯示的是：

代碼如下:

$ python server.py
Socket created
Socket bind complete
Socket now listening
Connected with 127.0.0.1:59954

我們可看到用戶端已經成功串連到伺服器。
上面例子我們接收到串連並立即關閉，這樣的程式沒什麼實際的價值，串連建立後一般會有大量的事情需要處理，因此讓我們來給用戶端做出點回應吧。
sendall 函數可通過 Socket 給用戶端發送資料：

代碼如下:

import socket
import sys

HOST = '' # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print 'Socket created'

try:
s.bind((HOST, PORT))
except socket.error , msg:
print 'Bind failed. Error Code : ' + str(msg[0]) + ' Message ' + msg[1]
sys.exit()

print 'Socket bind complete'

s.listen(10)
print 'Socket now listening'

#wait to accept a connection - blocking call
conn, addr = s.accept()

print 'Connected with ' + addr[0] + ':' + str(addr[1])

#now keep talking with the client
data = conn.recv(1024)
conn.sendall(data)

conn.close()
s.close()

繼續運行上述代碼，然後開啟另外一個命令列視窗輸入下面命令：

代碼如下:

$ telnet localhost 8888
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
happy
happy
Connection closed by foreign host.

可看到用戶端接收到來自伺服器端的回應內容。
上面的例子還是一樣，伺服器端回應後就立即退出了。而一些真正的伺服器像 www.bitsCN.com 是一直在啟動並執行，時刻接受串連請求。
也就是說伺服器端應該一直處於運行狀態，否則就不能成為“服務”，因此我們要讓伺服器端一直運行，最簡單的方法就是把 accept 方法放在一個迴圈內。

一直在啟動並執行伺服器

對上述代碼稍作改動：

代碼如下:

import socket
import sys

HOST = '' # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print 'Socket created'

try:
s.bind((HOST, PORT))
except socket.error , msg:
print 'Bind failed. Error Code : ' + str(msg[0]) + ' Message ' + msg[1]
sys.exit()

print 'Socket bind complete'

s.listen(10)
print 'Socket now listening'

#now keep talking with the client
while 1:
#wait to accept a connection - blocking call
conn, addr = s.accept()
print 'Connected with ' + addr[0] + ':' + str(addr[1])

data = conn.recv(1024)
reply = 'OK...' + data
if not data:
break

conn.sendall(reply)

conn.close()
s.close()

很簡單只是加多一個 while 1 語句而已。
繼續運行伺服器，然後開啟另外三個命令列視窗。每個視窗都使用 telnet 命令串連到伺服器：

代碼如下:

$ telnet localhost 5000
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
happy
OK .. happy
Connection closed by foreign host.

伺服器所在的終端視窗顯示的是：

代碼如下:

$ python server.py
Socket created
Socket bind complete
Socket now listening
Connected with 127.0.0.1:60225
Connected with 127.0.0.1:60237
Connected with 127.0.0.1:60239

你看伺服器再也不退出了，好吧，用 Ctrl+C 關閉伺服器，所有的 telnet 終端將會顯示 "Connection closed by foreign host."
已經很不錯了，但是這樣的通訊效率太低了，伺服器程式使用迴圈來接受串連並發送回應，這相當於是一次最多處理一個用戶端的請求，而我們要求伺服器可同時處理多個請求。

處理多個串連

為了處理多個串連，我們需要一個獨立的處理代碼在主伺服器接收到串連時運行。一種方法是使用線程，伺服器接收到串連然後建立一個線程來處理串連收發資料，然後主伺服器程式返回去接收新的串連。
下面是我們使用線程來處理串連請求：

代碼如下:

import socket
import sys
from thread import *

HOST = '' # Symbolic name meaning all available interfaces
PORT = 8888 # Arbitrary non-privileged port

s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
print 'Socket created'

#Bind socket to local host and port
try:
s.bind((HOST, PORT))
except socket.error , msg:
print 'Bind failed. Error Code : ' + str(msg[0]) + ' Message ' + msg[1]
sys.exit()

print 'Socket bind complete'

#Start listening on socket
s.listen(10)
print 'Socket now listening'

#Function for handling connections. This will be used to create threads
def clientthread(conn):
#Sending message to connected client
conn.send('Welcome to the server. Type something and hit enter\n') #send only takes string

#infinite loop so that function do not terminate and thread do not end.
while True:

#Receiving from client
data = conn.recv(1024)
reply = 'OK...' + data
if not data:
break

conn.sendall(reply)

#came out of loop
conn.close()

#now keep talking with the client
while 1:
#wait to accept a connection - blocking call
conn, addr = s.accept()
print 'Connected with ' + addr[0] + ':' + str(addr[1])

#start new thread takes 1st argument as a function name to be run, second is the tuple of arguments to the function.
start_new_thread(clientthread ,(conn,))

s.close()

運行上述服務端程式，然後像之前一樣開啟三個終端視窗並執行 telent 命令：

代碼如下:

$ telnet localhost 8888
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Welcome to the server. Type something and hit enter
hi
OK...hi
asd
OK...asd
cv
OK...cv

伺服器端所在終端視窗輸出資訊如下：

代碼如下:

$ python server.py
Socket created
Socket bind complete
Socket now listening
Connected with 127.0.0.1:60730
Connected with 127.0.0.1:60731

線程接管了串連並返回相應資料給用戶端。
這便是我們所要介紹的伺服器端編程。

結論

到這裡為止，你已經學習了 Python 的 Socket 基本編程，你可自己動手編寫一些例子來強化這些知識。
你可能會遇見一些問題：Bind failed. Error Code : 98 Message Address already in use，碰見這種問題只需要簡單更改伺服器連接埠即可。

