Python之HTTP servers模块详解

秒速五厘米 2022-05-15 02:19 384阅读 0赞

# 21.22. http.server - Http servers #

### 源码:[Lib/http/server.py][Lib_http_server.py] ###

### 这个模块定义了用以实现HTTP servers(Web servers)的类。 ###

### HTTPServer是一个socketserver.TCPServer的子类。这个类创建HTTP socket并监听，将请求分发给handler。创建并运行一个server的代码是下面这样的: ###

def run(server_class=HTTPServer, handler_class=BaseHTTPRequestHandler):
        server_address = ('', 8000)
        httpd = server_class(server_address, handler_class)
        httpd.serve_forever()

--------------------

### class http.server.**HTTPServer**(server\_address, RequestHandlerClass) ###

### 这个类基于TCPServer实现，将server地址以名为server\_name和server\_port的实例变量存储。通过handler的名为server实例变量，这个server可以被handler访问。 ###

### HTTPServer 初始化时必须被提供一个RequestHandlerClass。这个模块为HTTPServer提供了三个不同的变体: ###

### class http.server.**BaseHTTPRequestHandler**(request, client\_address, server) ###

### 这个类被用来处理到达server的HTTP请求。它自己不能响应任何HTTP请求；它必须被继承才能处理每个请求方法(例如GET或者POST)。 BaseHTTPRequestHandler 提供了一定数量的类变量和实例变量，和一些被子类使用的方法。 ###

### 这个handler会解析http请求和headers，然后调用对应于请求类型的方法去处理。方法名是从HTTP请求构造出的。例如，对于请求方法SPAM，do\_SPAM()方法将会被调用，不传入任何参数。所有的相关信息都存储在这个handler实例变量中。子类应当不需要去覆盖或者扩展\_\_init\_\_()方法。 ###

### BaseHTTPRequestHandler拥有下面这些实例变量： ###

client_address
    包含了一个(host,port)格式的元组，表示client的地址。
    
    server
    包含了server实例。
    
    close_connection
    布尔值，应当在handle_onr_request()返回前被设置，来指出是否应该处理下一个请求，或者关闭这个连接。 
    
    requestline
    包含了字符串表示的HTTP请求内容。作为终止的CRLF被去掉了。这个属性应该被handle_one_request()设置。如果没有有效的内容，它应当被设置为空值。
    
    command
    包含了请求类型，比如，‘GET’。
    
    path
    包含了请求路径。 
    
    request_version
    包含了请求的版本信息。比如，'HTTP/1.0'。
    
    headers
    维持一个被名为MessageClass类变量指定的类的实例。这个实例解析并管理请求中的headers信息。
    headers信息由http.client中的parse_headers解析，这个方法要求请求提供一个可用的RFC 2822规定的header。
    
    rfile
    包含了一个输入流，定位于可选的输入信息的开始位置。
    
    wfile
    包含了用于写入返回数据的流。写入时应当遵守HTTP协议。

### BaseHTTPRequestHandler拥有如下类变量： ###

server_version
    指定了服务器程序的版本。你可能希望重载它。格式是多个空格分割的字符串，其中的每个字符串都是name[/version]格式，比如，‘BaseHTTP/0.2’ 
    
    sys_version
    包含了Python的版本信息，格式和version_string以及server_version类变量使用的相同，比如，‘Python/1.4’。 
    
    error_message_format
    指定了用来生成返回给客户端的错误信息的格式。(后面的看不懂。。。) 
    
    error_content_type 
    指定了用于返回错误的HTTP header中的Content-Type。默认值是'text/html'。 
    
    protocol_version 
    这个变量指定了回复请求的HTTP的协议版本。如果被设置为'HTTP/1.1'，server会允许持久链接。然而，你的server必须在对client的所有请求中包含一个恰当的Content-Length header(使用send_header())。为了向后兼容，这个设置的默认值是'HTTP/1.0'。 
    
    MessageClass 
    指定了一个像email.message.Message的类用以解析HTTP headers。一般来说，它没被重载，默认值是http.client.HTTPMessage. 
    
    responses 
    这个变量包含了一个从错误码到错误信息的长短版本的映射。比如，{code: (shortmessage, longmessage)}。短消息通常被用于作为错误回复中的消息内容，长消息用于解释(参见error_message_format类变量)。

### BaseHTTPRequestHandler拥有如下方法: ###

handle() 
    调用handler_one_request()一次(如果可以使用持久链接，多次)来处理到来的HTTP请求。你应该永远都不需要重载它。作为替代，实现一个恰当的do_*()方法。 
    
    handle_one_request() 
    这个方法会将请求解析并分发到合适的do_*()方法。你应该永远都不需要重载它。 
    
    handler_expect_100() 
    当一个支持HTTP/1.1的server接收到一个包含Expect: 100-continue header的请求的时候，它返回一个100 Continue的header，接着是一个200 OK的header。这个方法可以被重载，以便于在server不像让client continue的时候引发一个错误。比如，server可以选择发送417 Expectation Failed作为返回头然后返回一个False。 
    
    send_error(code, message=None, explain=None) 
    发送并且记录一个完成的错误返回。code数字制定了HTTP错误码码，和一个可选的易于阅读的短消息涌来描述error。explain变量可以被用来提供关于这个error的更详细的信息。它会被类变量error_message_format制定的格式格式化，同时在header发出之后作为body返回。类变量responses保存了message和explain的默认值。对于未知的code，这两个字符串的默认值都是???。

## 未完待续。。。。。 ##

[Lib_http_server.py]: https://link.jianshu.com?t=https://hg.python.org/cpython/file/3.5/Lib/http/server.py