Python 構建 HTTP 服務器的8個步驟

作者：手把手PythonAI編程 2024-10-30 09:00:00

本文詳細介紹了如何使用 Python 構建一個基本的 HTTP 服務器，并逐步介紹了更高級的功能，包括處理靜態文件、POST 請求以及路由。

在當今互聯網時代，幾乎所有的應用程序都需要與服務器交互。Python 提供了多種方式來構建 HTTP 服務器，其中最簡單的方法是使用標準庫中的 http.server 模塊。本文將詳細介紹如何使用 Python 構建一個基本的 HTTP 服務器，并逐步介紹更高級的功能。

步驟1：安裝Python環境

前提條件：

確保你的計算機上已安裝 Python 3.x 版本。
可以訪問命令行工具（如 Windows 的 CMD 或 PowerShell，Mac 和 Linux 的 Terminal）。

驗證安裝：

python --version

輸出應類似于 Python 3.10.6。

步驟2：創建項目目錄

為了更好地組織代碼，建議為項目創建一個新的目錄：

mkdir my_http_server
cd my_http_server

步驟3：編寫基本HTTP服務器

我們將從一個非常簡單的 HTTP 服務器開始，它能接收請求并返回固定的響應。

創建文件 server.py：

from http.server import BaseHTTPRequestHandler, HTTPServer

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
    def do_GET(self):
        self.send_response(200)
        self.end_headers()
        message = "Hello, World!"
        self.wfile.write(message.encode())

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    print(f"Starting httpd server on {server_address[0]}:{server_address[1]}")
    httpd.serve_forever()

if __name__ == "__main__":
    run()

解釋：

導入模塊：從 http.server 導入 BaseHTTPRequestHandler 和 HTTPServer 類。
定義處理程序類：SimpleHTTPRequestHandler 繼承自 BaseHTTPRequestHandler。
實現 do_GET 方法：當接收到 GET 請求時執行。
發送響應：設置狀態碼為 200（表示成功），然后發送響應體。
運行服務器：run 函數初始化服務器并在端口 8000 上監聽。

步驟4：啟動服務器

在命令行中運行以下命令：

python server.py

你會看到類似下面的輸出：

Starting httpd server on 0.0.0.0:8000

現在，打開瀏覽器并訪問 http://localhost:8000，你應該能看到 “Hello, World!” 這個消息。

步驟5：處理靜態文件

目前我們的服務器只能返回固定的字符串。接下來，讓我們修改服務器，使其能夠處理靜態文件，例如 HTML、CSS 和 JavaScript 文件。

修改 server.py 文件：

import os
from http.server import BaseHTTPRequestHandler, HTTPServer

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
    def do_GET(self):
        if self.path == '/':
            filename = 'index.html'
        else:
            filename = self.path[1:]

        try:
            with open(filename, 'rb') as file:
                content = file.read()
                self.send_response(200)
                self.end_headers()
                self.wfile.write(content)
        except FileNotFoundError:
            self.send_error(404, "File Not Found")

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    print(f"Starting httpd server on {server_address[0]}:{server_address[1]}")
    httpd.serve_forever()

if __name__ == "__main__":
    run()

解釋：

處理路徑：如果路徑是 /，則默認返回 index.html 文件；否則，返回路徑后面的文件名。
讀取文件：嘗試打開指定路徑的文件，并讀取其內容。
發送響應：如果文件存在，則發送狀態碼 200 并返回文件內容；如果文件不存在，則發送狀態碼 404。

創建靜態文件：

在項目目錄中創建以下文件：

index.html
style.css
script.js

index.html 示例：

<!DOCTYPE html>
<html>
<head>
    <title>My Simple HTTP Server</title>
    <link rel="stylesheet" href="style.css">
</head>
<body>
    <h1>Hello, World!</h1>
    <p>Welcome to my simple HTTP server.</p>
    <script src="script.js"></script>
</body>
</html>

style.css 示例：

body {
    font-family: Arial, sans-serif;
    background-color: #f0f0f0;
}

h1 {
    color: blue;
}

script.js 示例：

console.log("This is a simple script.");

啟動服務器：

在命令行中運行以下命令：

python server.py

打開瀏覽器并訪問 http://localhost:8000，你應該能看到頁面顯示 “Hello, World!” 并且樣式和腳本也正常加載。

步驟6：處理 POST 請求

接下來，我們將讓服務器支持處理 POST 請求。這通常用于接收表單數據或其他用戶輸入。

修改 server.py 文件：

import os
from http.server import BaseHTTPRequestHandler, HTTPServer

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
    def do_GET(self):
        if self.path == '/':
            filename = 'index.html'
        else:
            filename = self.path[1:]

        try:
            with open(filename, 'rb') as file:
                content = file.read()
                self.send_response(200)
                self.end_headers()
                self.wfile.write(content)
        except FileNotFoundError:
            self.send_error(404, "File Not Found")

    def do_POST(self):
        content_length = int(self.headers['Content-Length'])
        post_data = self.rfile.read(content_length)
        self.send_response(200)
        self.end_headers()
        response = f"Received: {post_data.decode('utf-8')}"
        self.wfile.write(response.encode())

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    print(f"Starting httpd server on {server_address[0]}:{server_address[1]}")
    httpd.serve_forever()

if __name__ == "__main__":
    run()

解釋：

讀取 POST 數據：獲取請求頭中的 Content-Length 字段，然后讀取相應長度的數據。
發送響應：設置狀態碼為 200，并返回接收到的數據。

創建表單頁面：

修改 index.html 文件，添加一個簡單的表單：

<!DOCTYPE html>
<html>
<head>
    <title>My Simple HTTP Server</title>
    <link rel="stylesheet" href="style.css">
</head>
<body>
    <h1>Hello, World!</h1>
    <p>Welcome to my simple HTTP server.</p>
    <form action="/" method="POST">
        <label for="message">Message:</label>
        <input type="text" id="message" name="message">
        <button type="submit">Send</button>
    </form>
    <script src="script.js"></script>
</body>
</html>

啟動服務器：

在命令行中運行以下命令：

python server.py

打開瀏覽器并訪問 http://localhost:8000，填寫表單并提交，你會看到服務器返回的內容。

步驟7：處理路由

在實際應用中，我們需要根據不同的 URL 路徑來處理不同的請求。我們可以使用簡單的條件語句來實現這一點。

修改 server.py 文件：

import os
from http.server import BaseHTTPRequestHandler, HTTPServer

class SimpleHTTPRequestHandler(BaseHTTPRequestHandler):
    def do_GET(self):
        if self.path == '/':
            filename = 'index.html'
        elif self.path == '/about':
            filename = 'about.html'
        else:
            filename = self.path[1:]

        try:
            with open(filename, 'rb') as file:
                content = file.read()
                self.send_response(200)
                self.end_headers()
                self.wfile.write(content)
        except FileNotFoundError:
            self.send_error(404, "File Not Found")

    def do_POST(self):
        content_length = int(self.headers['Content-Length'])
        post_data = self.rfile.read(content_length)
        self.send_response(200)
        self.end_headers()
        response = f"Received: {post_data.decode('utf-8')}"
        self.wfile.write(response.encode())

def run(server_class=HTTPServer, handler_class=SimpleHTTPRequestHandler):
    server_address = ('', 8000)
    httpd = server_class(server_address, handler_class)
    print(f"Starting httpd server on {server_address[0]}:{server_address[1]}")
    httpd.serve_forever()

if __name__ == "__main__":
    run()

解釋：

處理路由：根據不同的路徑，返回不同的文件。這里添加了一個新的路徑 /about，返回 about.html 文件。

創建 about.html 文件：

<!DOCTYPE html>
<html>
<head>
    <title>About Us</title>
    <link rel="stylesheet" href="style.css">
</head>
<body>
    <h1>About Us</h1>
    <p>This is the about page of our simple HTTP server.</p>
    <script src="script.js"></script>
</body>
</html>

啟動服務器：

在命令行中運行以下命令：

python server.py

打開瀏覽器并訪問 http://localhost:8000/about，你會看到關于頁面的內容。

步驟8：使用框架簡化開發

雖然手動編寫 HTTP 服務器可以學習很多底層知識，但在實際開發中，我們通常會使用現成的框架來簡化開發過程。Flask 是一個非常流行的輕量級 Web 框架，非常適合快速開發。

安裝 Flask：

pip install flaskpip install flask

創建 Flask 應用：

創建一個名為 app.py 的新文件：

from flask import Flask, render_template, request

app = Flask(__name__)

@app.route('/')
def index():
    return render_template('index.html')

@app.route('/about')
def about():
    return render_template('about.html')

@app.route('/submit', methods=['POST'])
def submit():
    message = request.form.get('message')
    return f"Received: {message}"

if __name__ == '__main__':
    app.run(port=8000)

解釋：

導入模塊：從 Flask 導入 Flask、render_template 和 request。
定義路由：使用裝飾器 @app.route 來定義不同的路由。
渲染模板：使用 render_template 渲染 HTML 模板。
處理 POST 請求：使用 request.form 獲取表單數據。

啟動 Flask 服務器：

在命令行中運行以下命令：

python app.py

打開瀏覽器并訪問 http://localhost:8000，你會看到頁面內容。填寫表單并提交，你會看到服務器返回的內容。

總結

本文詳細介紹了如何使用 Python 構建一個基本的 HTTP 服務器，并逐步介紹了更高級的功能，包括處理靜態文件、POST 請求以及路由。最后，還展示了如何使用 Flask 框架簡化開發過程。通過這些步驟，讀者可以掌握構建 HTTP 服務器的基本方法，并了解如何進一步擴展其功能。

責任編輯：趙寧寧來源：手把手PythonAI編程