Python 2 HTTP 服务器基础与实践 – wiki大全

作者： /

Python 2 HTTP 服务器基础与实践

简介

HTTP (Hypertext Transfer Protocol) 是互联网上数据通信的基础协议。HTTP 服务器（也称为 Web 服务器）是接收客户端（如浏览器）请求并返回响应（如网页、图片、API 数据）的程序。在 Python 中，构建 HTTP 服务器一直是一个相对简单且直观的任务。Python 2 提供了一些内置模块，使得开发者可以快速搭建简单的 HTTP 服务器，无论是用于开发调试、文件共享还是实现基本的 API 服务。

本文将深入探讨 Python 2 中构建 HTTP 服务器的基础模块，并提供实践示例。

核心模块：SimpleHTTPServer 与 BaseHTTPServer

Python 2 主要通过以下两个模块来构建 HTTP 服务器：

  1. SimpleHTTPServer: 这是一个非常简单易用的模块，主要用于快速搭建一个提供当前目录静态文件服务的 HTTP 服务器。它基于 BaseHTTPServer 实现。
  2. BaseHTTPServer: 这是一个更底层的模块，提供了构建自定义 HTTP 服务器和处理程序所需的基础类。它允许你定义如何响应不同类型的 HTTP 请求（如 GET, POST 等）。

还有一个更底层的模块 SocketServer (在 Python 3 中改名为 socketserver)，BaseHTTPServer 实际上是建立在其之上的。SocketServer 提供了处理网络连接的通用框架。

1. SimpleHTTPServer：快速搭建静态文件服务器

SimpleHTTPServer 是 Python 2 中最简单的 HTTP 服务器。它不需要编写任何代码，只需在命令行中执行即可。

功能特点:

  • 服务当前目录: 默认情况下，它会将执行命令的目录作为 Web 根目录，服务该目录下的所有文件和子目录。
  • 文件列表: 如果请求的路径是一个目录，它会自动生成一个该目录下的文件和子目录列表。
  • 简单易用: 无需额外配置，开箱即用。

实践：

在你的终端中，导航到你想要作为 Web 根目录的文件夹，然后执行以下命令：

“`bash

Python 2

python -m SimpleHTTPServer 8000
“`

这会在本地 8000 端口启动一个 HTTP 服务器。现在，你可以在浏览器中访问 http://localhost:8000 来查看你当前目录的内容。

示例文件结构:

my_web_root/
├── index.html
├── style.css
└── images/
└── logo.png

启动服务器后：
* 访问 http://localhost:8000/index.html 将显示 index.html 的内容。
* 访问 http://localhost:8000/images/logo.png 将显示 logo.png 图片。
* 访问 http://localhost:8000/ 或 http://localhost:8000/images/ 将分别显示 my_web_root 或 images 目录下的文件列表。

2. BaseHTTPServer：构建自定义 HTTP 服务器

当 SimpleHTTPServer 无法满足需求，例如你需要处理动态请求、实现 API 接口或执行特定业务逻辑时，就需要使用 BaseHTTPServer。这个模块提供了两个关键类：

  • HTTPServer: 负责监听指定端口，接收客户端连接。
  • BaseHTTPRequestHandler: 这是一个基类，你需要继承它来创建自定义的请求处理程序。你可以在这个子类中定义 do_GET(), do_POST() 等方法来处理不同类型的 HTTP 请求。

自定义请求处理程序的核心方法:

  • do_GET(): 处理 HTTP GET 请求。
  • do_POST(): 处理 HTTP POST 请求。
  • do_HEAD(): 处理 HTTP HEAD 请求。
  • … (还有 do_PUT(), do_DELETE() 等，尽管不常用)

在这些方法内部，你可以访问请求的各个部分（如 self.path 获取请求路径，self.headers 获取请求头），并构建响应。

构建响应的关键步骤:

  1. 发送响应状态码: self.send_response(200) (例如 200 OK, 404 Not Found)。
  2. 发送响应头: self.send_header('Content-type', 'text/html')。可以发送多个头。
  3. 结束头部: self.end_headers()。
  4. 发送响应体: self.wfile.write("Hello, World!")。请注意 wfile 期望字节字符串。

实践：一个简单的 API 服务器

这个例子将创建一个服务器，可以：
* 响应 GET 请求，返回 “Hello from Python 2 Server!”
* 响应 POST 请求，读取请求体中的数据并返回。

“`python

server.py (Python 2)

import urlparse
from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
import SocketServer # 用于 ThreadingMixIn

class MyHandler(BaseHTTPRequestHandler):
def _set_headers(self, content_type=’text/html’):
self.send_response(200)
self.send_header(‘Content-type’, content_type)
self.end_headers()

def do_GET(self):
    self._set_headers()
    # self.path 包含了请求的路径和查询参数
    # 例如：/hello?name=world
    parsed_path = urlparse.urlparse(self.path)
    path = parsed_path.path
    query = urlparse.parse_qs(parsed_path.query)

    self.wfile.write("<html><body><h1>Hello from Python 2 Server!</h1>")
    self.wfile.write("<p>You requested path: {}</p>".format(path))
    if query:
        self.wfile.write("<p>Query parameters: {}</p>".format(query))
    self.wfile.write("</body></html>")

def do_POST(self):
    # 获取 POST 请求体长度
    content_length = int(self.headers['Content-Length'])
    # 读取 POST 请求体数据
    post_data = self.rfile.read(content_length)

    self._set_headers(content_type='application/json')
    response_data = {
        "status": "success",
        "received_data": post_data.decode('utf-8'), # 尝试解码为 utf-8
        "message": "Data received successfully!"
    }
    import json
    self.wfile.write(json.dumps(response_data))

class ThreadedHTTPServer(SocketServer.ThreadingMixIn, HTTPServer):
“””Handle requests in a separate thread.”””
# 无需在 ThreadedHTTPServer 中添加额外的代码
# ThreadingMixIn 会自动处理多线程
pass

def run(server_class=HTTPServer, handler_class=MyHandler, port=8000):
server_address = (”, port)
httpd = server_class(server_address, handler_class)
print “Starting httpd on port %d…” % port
print “Access via http://localhost:%d” % port
httpd.serve_forever()

if name == “main“:
from sys import argv

if len(argv) == 2:
    run(port=int(argv[1]))
else:
    run()

“`

如何运行和测试：

  1. 将上述代码保存为 server.py。
  2. 在终端中运行：python server.py (默认端口 8000) 或 python server.py 8080 (指定端口)。
  3. 测试 GET 请求: 在浏览器中访问 http://localhost:8000/hello?param1=value1。

  4. 测试 POST 请求: 你可以使用 curl 命令或其他工具发送 POST 请求。

    bash
    curl -X POST -H "Content-Type: application/json" -d '{"key": "value", "name": "test"}' http://localhost:8000/

    或者，使用 Python 脚本：

    “`python

    client.py (Python 2)

    import httplib
    import json

    conn = httplib.HTTPConnection(“localhost:8000”)
    headers = {“Content-type”: “application/json”}
    body = json.dumps({“key”: “data”, “value”: 123})
    conn.request(“POST”, “/”, body, headers)
    response = conn.getresponse()
    print response.status, response.reason
    print response.read()
    “`

3. 多线程/多进程处理 (SocketServer.ThreadingMixIn)

默认的 HTTPServer 是单线程的，这意味着它一次只能处理一个请求。如果一个请求处理时间较长，其他请求将会被阻塞。在生产环境或需要处理并发请求时，这显然是不够的。

为了实现并发处理，可以使用 SocketServer 模块提供的 MixIn 类，特别是 ThreadingMixIn。通过将其与 HTTPServer 结合，可以创建一个多线程的 HTTP 服务器。

在上面的示例中，我们已经展示了如何使用 ThreadingMixIn：

“`python
class ThreadedHTTPServer(SocketServer.ThreadingMixIn, HTTPServer):
“””Handle requests in a separate thread.”””
pass

然后在 run 函数中使用它

httpd = server_class(server_address, handler_class) # server_class 此时是 ThreadedHTTPServer
“`

ThreadingMixIn 会为每个新的客户端连接创建一个新的线程来处理请求，从而实现并发。

Python 2 HTTP 服务器的局限性与注意事项

  1. 性能: Python 2 的内置 HTTP 服务器模块主要用于开发、测试和简单的内部工具。它们的性能不足以支撑高并发、大规模的生产环境。对于生产级别的应用，应考虑使用专门的 Web 框架（如 Django, Flask）配合生产级 WSGI 服务器（如 Gunicorn, uWSGI）和反向代理（如 Nginx）。
  2. 安全性:
    • 无 HTTPS: BaseHTTPServer 不直接支持 HTTPS (SSL/TLS)。实现 HTTPS 需要更复杂的配置或使用第三方库。
    • 认证与授权: 模块本身不提供用户认证或授权机制，需要手动实现或依赖更高级的框架。
  3. Unicode/编码: Python 2 对 Unicode 的处理不如 Python 3 直观和完善。在处理请求体、查询参数或响应体时，尤其是在包含非 ASCII 字符时，需要特别注意编码和解码，通常使用 .decode('utf-8') 或 .encode('utf-8')。
  4. 文件上传: BaseHTTPServer 不直接提供处理文件上传的功能，需要手动解析 multipart/form-data 请求。
  5. 生命周期结束: 最重要的一点：Python 2 已于 2020 年 1 月 1 日达到其生命周期终点 (End Of Life)。这意味着它不再接收官方的安全更新、bug 修复或新功能。在生产环境中使用 Python 2 存在严重的安全风险和兼容性问题。

结论与迁移建议

Python 2 中的 HTTP 服务器模块提供了一个了解 HTTP 协议和服务器工作原理的良好起点，并且在小型、临时性任务中非常方便。然而，考虑到其已 EOL 的状态，强烈建议：

  • 对于新项目: 坚决使用 Python 3。Python 3 提供了更现代、更安全、更高效的 http.server 和 socketserver 模块，以及更强大的 Web 框架。
  • 对于现有 Python 2 项目: 优先考虑将代码库迁移到 Python 3。这将带来性能提升、更好的 Unicode 支持、更丰富的标准库和更活跃的社区支持。

虽然 Python 2 已经成为历史，但理解其 HTTP 服务器的实现机制，对于掌握 Web 技术和 Python 语言的演进仍然具有重要的学习价值。

滚动至顶部