Python http.server详解

1. 背景介绍

在开发 Web 应用程序时，我们通常需要一个能够运行在本地环境中的简易 HTTP 服务器来模拟服务器环境并测试应用程序的功能。Python 提供了一个内置的模块 http.server，它可以方便地创建一个简单的 HTTP 服务器，供我们使用。

本文将详细介绍如何使用 Python 的 http.server 模块创建和部署一个本地的 HTTP 服务器，并展示一些使用示例和常见问题的解决方案。

2. `http.server` 模块概览

http.server 模块是 Python 提供的一个简单的 HTTP 服务器模块，它基于核心标准库中的 http.server 模块，并提供了一些额外的功能和接口。在 Python 3 中，该模块被重命名为 http.server，而在 Python 2 中，它被称为 SimpleHTTPServer。

http.server 模块不仅可以用于模拟服务器环境进行开发和测试，还可以用于快速共享文件、搭建临时网站等多种场景。

3. 使用 `http.server` 模块创建 HTTP 服务器

下面我们将一步一步地介绍如何使用 Python 的 http.server 模块创建和运行一个 HTTP 服务器。

3.1 简单的 HTTP 服务器

我们首先来创建一个简单的 HTTP 服务器，它将会监听本地的默认端口 8000，并在收到请求时返回一个简单的 “Hello, World!” 消息。

# server.py
import http.server
import socketserver

class MyHandler(http.server.SimpleHTTPRequestHandler):
    def do_GET(self):
        self.send_response(200)
        self.send_header('Content-type', 'text/html')
        self.end_headers()
        self.wfile.write(b'Hello, World!')

if __name__ == '__main__':
    PORT = 8000

    with socketserver.TCPServer(("", PORT), MyHandler) as httpd:
        print("Server started at http://localhost:{}/".format(PORT))
        httpd.serve_forever()

在终端中执行 python server.py 命令，即可启动 HTTP 服务器。然后，在浏览器中访问 http://localhost:8000/，就可以看到 “Hello, World!” 的消息被返回。

3.2 自定义请求处理逻辑

http.server 模块提供了 BaseHTTPRequestHandler 类，我们可以通过继承该类并重写其中的 do_GET、do_POST 等方法来实现自定义的请求处理逻辑。

下面的示例演示了如何处理 GET 请求，并返回一个包含当前时间的 HTML 页面。

# server.py
import http.server
import socketserver
import time

class MyHandler(http.server.BaseHTTPRequestHandler):
    def do_GET(self):
        if self.path == '/':
            self.send_response(200)
            self.send_header('Content-type', 'text/html')
            self.end_headers()
            html = "<html><body><h1>Current Time: {}</h1></body></html>".format(time.ctime())
            self.wfile.write(html.encode())
        else:
            self.send_response(404)
            self.send_header('Content-type', 'text/plain')
            self.end_headers()
            self.wfile.write(b'404 Not Found')

if __name__ == '__main__':
    PORT = 8000

    with socketserver.TCPServer(("", PORT), MyHandler) as httpd:
        print("Server started at http://localhost:{}/".format(PORT))
        httpd.serve_forever()

启动服务器后，访问 http://localhost:8000/ 将返回一个包含当前时间的 HTML 页面。此外，对于其他路径下的请求，服务器将返回一个简单的 “404 Not Found” 页面。

4. 常见问题及解决方案

4.1 端口被占用的问题

在使用默认的端口号启动服务器时，如果该端口已经被其他程序占用，就会报错。我们可以通过指定其他未被占用的端口号来解决这个问题。

# server.py
import http.server
import socketserver

if __name__ == '__main__':
    PORT = 8888  # 指定一个未被占用的端口号

    with socketserver.TCPServer(("", PORT), http.server.SimpleHTTPRequestHandler) as httpd:
        print("Server started at http://localhost:{}/".format(PORT))
        httpd.serve_forever()

4.2 处理 POST 请求

通过继承 BaseHTTPRequestHandler 类，我们可以自定义处理 POST 请求的逻辑。

# server.py
import http.server
import socketserver

class MyHandler(http.server.BaseHTTPRequestHandler):
    def do_POST(self):
        content_length = int(self.headers['Content-Length'])
        post_data = self.rfile.read(content_length)
        # 处理 post_data，执行自定义的操作
        ...

if __name__ == '__main__':
    PORT = 8000

    with socketserver.TCPServer(("", PORT), MyHandler) as httpd:
        print("Server started at http://localhost:{}/".format(PORT))
        httpd.serve_forever()