python自備的http模組詳解

挺久沒寫部落格了，因為部落客開始了今年另一段美好的實習經歷，學習加做項目，時間已排滿；很感謝今年這兩段經歷，讓我接觸了golang和python，學習不同語言，可以跳出之前學習c/c++思維的限制，學習golang和python的優秀特性以及了解在不同的場景，適用不同的語言；而之前學習linux和c/c++，也使我很快就上手golang和python;

我學習的習慣，除了學習如何使用，還喜歡研究源碼，學習運行機制，這樣用起來才會得心應手或者說，使用這些語言或框架，就和平時吃飯睡覺一樣，非常自然；因為最近有接觸到bottle和flask web框架，所以想看下這兩個的源碼，但是這兩個框架是基於python自帶的http，因此就有了這篇文章；

python http簡單範例

python http框架主要有server和handler組成，server主要是用來建立網路模型，例如利用epoll監聽socket ；handler用來處理各個就緒的socket；先來看下python http簡單的使用：

import sys
from http.server import HTTPServer,SimpleHTTPRequestHandler

ServerClass = HTTPServer
HandlerClass = SimpleHTTPRequestHandler

if__name__ =='__main__':
 port = int(sys.argv[2])
 server_address = (sys.argv[1],port)
 httpd = ServerClass(server_address,HandlerClass)

sa=httpd.socket.getsockname()
print("Serving HTTP on",sa[0],"port",sa[1],"...")

try:
 httpd.serve_forever()
 except KeyboardInterrupt:
print("\nKeyboard interrupt received, exiting.")
 httpd.server_close()
 sys.exit(0)

運行上述例子，可以得到如下：

python3 myhttp.py 127.0.0.1 9999

此時如果在目前資料夾新建一個index.html文件，就可以透過 http://127.0.0.1:9999/index.html 存取了index. html頁面了。

這個例子的server類別用的是HTTPServer，handler類別是SimpleHTTPRequestHandler，因此當HTTPServer監聽到有request到來時，就把這個request丟給SimpleHTTPRequestHandler類別求處理；ok，了解這些之後，我們開始分別分析下server和handler.

http之server

http模組的設計充分利用了物件導向的繼承多態性，因為之前看了會tfs文件系統的程式碼，所以再看python http時，沒那麼大的壓力；先給server的繼承關係

 +------------------+
+------------+| tcpserver基类 |
| BaseServer +-------->| 开启事件循环监听 |
+-----+------+ | 处理客户端请求 |
 | +------------------+
 v +-----------------+
+------------+| httpserver基类 |
| TCPServer +-------->+设置监听socket |
+-----+------+ | 开启监听 |
 | +-----------------+
 v
+------------+
| HTTPServer | 
+------------+

##繼承關係如上圖所示，其中BaseServer和TCPServer在檔案socketserver.py，HTTPServer在http/server.py；我們先看下來BaseServer；

BaseServer

#因為BaseServer是所有server的基類，因此BaseServer盡可能抽象化所有server的共通性，例如開啟事件監聽循環，這就是每個server的共通性，因此這也是BaseServer主要做的使;我們來看下BaseServer主要程式碼部分

#

defserve_forever(self, poll_interval=0.5):
 self.__is_shut_down.clear()
try:
with_ServerSelector()asselector:
 selector.register(self, selectors.EVENT_READ)

whilenotself.__shutdown_request:
 ready = selector.select(poll_interval)
ifready:
 self._handle_request_noblock()

 self.service_actions()
finally:
 self.__shutdown_request = False
 self.__is_shut_down.set()

程式碼中的selector其實就是封裝了select,poll,epoll等的io多路復用，然後將服務本身監聽的socket註冊到io多路復用，開啟事件監聽，當有客戶端連線時，此時會呼叫self._handle_request_noblock()來處理請求；接下來看下這個處理函數做了啥；

def_handle_request_noblock(self):
try:
 request, client_address = self.get_request()
exceptOSError:
return
ifself.verify_request(request, client_address):
try:
 self.process_request(request, client_address)
except:
 self.handle_error(request, client_address)
 self.shutdown_request(request)
else:
 self.shutdown_request(request)

_handle_request_noblock函數是一個內部函數，首先是接收客戶端連線請求，底層其實是封裝了系統呼叫accept函數，然後驗證請求，最後呼叫process_request來處理請求；其中get_request是屬於子類別的方法，因為tcp和udp接收客戶端請求是不一樣的(tcp有連接，udp無連接)

我們接下來再看下process_request具體做了什麼；

defprocess_request(self, request, client_address):
 self.finish_request(request, client_address)
 self.shutdown_request(request)
# -------------------------------------------------
deffinish_request(self, request, client_address):
 self.RequestHandlerClass(request, client_address, self)

defshutdown_request(self, request):
 self.close_request(request)

#process_request函數先是呼叫了finish_request來處理一個連接，處理結束之後，調用shutdown_request函數來關閉這個連接；而finish_request函數內部實例化了一個handler類，並把客戶端的socket和地址傳了進去，說明，handler類別在初始化結束的時候，就完成了請求處理，這個等後續分析handler時再細看；

以上就是BaseServer所做的事，這個BaseServer不能直接使用，因為有些函數還沒實現，只是作為tcp/udp的抽象層；總結下：

先是呼叫serve_forever開啟事件監聽；

然後當有客戶端請求到來時，將請求交給handler處理；

TCPServer

由上述BaseServer抽象化的功能，我們可以知道TCPServer或UDPServer應該完成的功能有，初始化監聽套接字，並綁定監聽，最後當有客戶端請求時，接收這個客戶端；我們來看下程式碼

###

BaseServer==>
def__init__(self, server_address, RequestHandlerClass):
"""Constructor. May be extended, do not override."""
 self.server_address = server_address
 self.RequestHandlerClass = RequestHandlerClass
 self.__is_shut_down = threading.Event()
 self.__shutdown_request = False
#--------------------------------------------------------------------------------
TCPServer==>
def__init__(self, server_address, RequestHandlerClass, bind_and_activate=True):
 BaseServer.__init__(self, server_address, RequestHandlerClass)
 self.socket = socket.socket(self.address_family,
 self.socket_type)
ifbind_and_activate:
try:
 self.server_bind()
 self.server_activate()
except:
 self.server_close()
raise

#########TCPServer初始化時先是呼叫基底類別BaseServer的初始化函數，初始化伺服器位址，handler類別等，然後初始化自身的監聽套接字，最後呼叫server_bind綁定套接字，server_activate監聽套接字#########

defserver_bind(self):
ifself.allow_reuse_address:
 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
 self.socket.bind(self.server_address)
 self.server_address = self.socket.getsockname()

defserver_activate(self):
 self.socket.listen(self.request_queue_size)

########## TCPServer也實作了另一個函數，那就是接收客戶端請求，#########

defget_request(self):
returnself.socket.accept()

#########之前如果有學過linux編程，那麼看這些程式碼應該會覺得很很熟悉，因為函數名稱和Linux提供的系統呼叫名一模一樣，這裡也不多說了；######TCPServer其實已經把基於tcp的伺服器主體框架搭起來了，因此HTTPServer在繼承TCPServer基礎上，只是重載了server_bind函數，設定reuse_address等；###

ok，这里分析下上述例子程序的开启过程；

httpd = ServerClass(server_address,HandlerClass)这行代码在初始化HTTPServer时，主要是调用基类TCPServer的初始化方法，初始化了监听的套接字，并绑定和监听；
httpd.serve_forever()这行代码调用的是基类BaseServer的serve_forever方法，开启监听循环，等待客户端的连接；
如果有看过redis或者一些后台组件的源码，对这种并发模型应该很熟悉；ok，分析了server之后，接下来看下handler是如何处理客户端请求的。

http之handler

handler类主要分析tcp层的handler和http应用层的handler,tcp层的handler是不能使用的，因为tcp层只负责传输字节，但是并不知对于接收到的字节要如何解析，如何处理等；因此应用层协议如该要使用TCP协议，必须继承TCP handler，然后实现handle函数即可;例如，http层的handler实现handle函数，解析http协议，处理业务请求以及结果返回给客户端；先来看下tcp层的handler

tcp层handler

tcp层handler主要有BaseRequestHandler和StreamRequestHandler(都在socketserver.py文件)，先看下BaseRequestHandler代码，

classBaseRequestHandler:
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()

defsetup(self):
pass

defhandle(self):
pass

deffinish(self):
pass

之前在看server时，知道处理客户端请求就是在handler类的初始化函数中完成；由这个基类初始化函数，我们知道处理请求大概经历三个过程：

1. setup对客户端的socket做一些设置；

2. handle真正处理请求的函数；

3. finish关闭socket读写请求；
   

这个BaseRequestHandler是handler top level 基类，只是抽象出handler整体框架，并没有实际的处理；我们看下tcp handler，

classStreamRequestHandler(BaseRequestHandler):
 timeout = None
 disable_nagle_algorithm = False

defsetup(self):
 self.connection = self.request
ifself.timeoutisnotNone:
 self.connection.settimeout(self.timeout)
ifself.disable_nagle_algorithm:
 self.connection.setsockopt(socket.IPPROTO_TCP,
 socket.TCP_NODELAY, True)
 self.rfile = self.connection.makefile('rb', self.rbufsize)
 self.wfile = self.connection.makefile('wb', self.wbufsize)

deffinish(self):
ifnotself.wfile.closed:
try:
 self.wfile.flush()
exceptsocket.error:
pass
 self.wfile.close()
 self.rfile.close()

tcp handler实现了setup和finish函数，setup函数设置超时时间，开启nagle算法以及设置socket读写缓存；finish函数关闭socket读写；

由上述两个tcp层的handler可知，要实现一个基于http的服务器handler，只需要继承StreamRequestHandler类，并实现handle函数即可；因此这也是http层handler主要做的事；

http层handler

由之前tcp层handler的介绍，我们知道http层handler在继承tcp层handler基础上，主要是实现了handle函数处理客户端的请求；还是直接看代码吧；

defhandle(self):
 self.close_connection = True

 self.handle_one_request()
whilenotself.close_connection:
 self.handle_one_request()

这就是BaseHTTPRequestHandler的handle函数，在handle函数会调用handle_one_request函数处理一次请求；默认情况下是短链接，因此在执行了一次请求之后，就不会进入while循环在同一个连接上处理下一个请求，但是在handle_one_request函数内部会进行判断，如果请求头中的connection为keep_alive或者http版本大于等于1.1，则可以保持长链接；接下来看下handle_one_request函数是如何处理；

defhandle_one_request(self):
try:
self.raw_requestline =self.rfile.readline(65537)
iflen(self.raw_requestline) >65536:
self.requestline =''
self.request_version =''
self.command =''
self.send_error(HTTPStatus.REQUEST_URI_TOO_LONG)
return
ifnotself.raw_requestline:
self.close_connection = True
return
ifnotself.parse_request():
return
 mname = 'do_'+self.command
ifnothasattr(self, mname):
self.send_error(
 HTTPStatus.NOT_IMPLEMENTED,
"Unsupported method (%r)"%self.command)
return
 method = getattr(self, mname)
 method()
self.wfile.flush()
 except socket.timeout as e:
self.log_error("Request timed out: %r", e)
self.close_connection = True
return

这个handle_one_request执行过程如下：

1. 先是调用parse_request解析客户端http请求内容

2. 通过"do_"+command构造出请求所对于的函数method

3. 调用method函数，处理业务并将response返回给客户端
   

这个BaseHTTPRequestHandler是http handler基类，因此也是无法直接使用，因为它没有定义请求处理函数，即method函数；好在python为我们提供了一个简单的SimpleHTTPRequestHandler，该类继承了BaseHTTPRequestHandler，并实现了请求函数；我们看下get函数：

# SimpleHTTPRequestHandler
# ---------------------------------------------
defdo_GET(self):
"""Serve a GET request."""
 f = self.send_head()
iff:
try:
 self.copyfile(f, self.wfile)
finally:
 f.close()

这个get函数先是调用do_GET函数给客户端返回response头部，并返回请求的文件，最后调用copyfile函数将请求文件通过连接返回给客户端；

以上就是http模块最基础的内容，最后，总结下例子程序handler部分：

1. server把请求传给SimpleHTTPRequestHandler初始化函数；

2. SimpleHTTPRequestHandler在初始化部分，对这个客户端connection进行一些设置；

3. 接着调用handle函数处理请求；

4. 在handle函数接着调用handle_one_request处理请求；

5. 在handle_one_request函数内部，解析请求，找到请求处理函数；

6. 我之前的访问属于get访问，因此直接调用do_GET函数将index.html文件返回给客户端；
   

python http模組到此已經分析結束；不知道大家有沒發現，python自帶的http模組使用起來不是很方便，因為它是透過請求方法來呼叫請求函數，這樣當同一方法呼叫次數非常多時，例如get和post方法，會導致這個請求函數異常龐大，程式碼不好寫，各種情況判斷；當然SimpleHTTPRequestHandler只是python提供的一個簡單例子而已；

#當然， python官方提供了一個針對http更好用的框架，即wsgi server和wsgi application；接下來文章先分析python自帶的wsgiref模組以及bottle，後面再分析flask;

更多python自帶的http模組詳解相關文章請關注PHP中文網！