CherryPy Hello World

1 CherryPy 简介

CherryPy 是一个极简、Pythonic 的面向对象 Web 框架。它允许开发人员以构建任何其他面向对象 Python 程序的方式来构建 Web 应用程序，专注于简洁性和灵活性。

它以以下特点而闻名：

Pythonic 方式： 像常规 Python 对象一样构建 Web 应用程序。
简洁性： 最少的设置和样板代码。
稳定性： 自2002年以来一直存在，并且非常成熟。
强大： 开箱即用，支持会话、身份验证、静态内容服务等强大功能。
灵活性： 不强制使用特定的 ORM、模板引擎或组件架构。

准备好构建您的第一个 CherryPy 应用程序了吗？点击“下一步”开始！

2 先决条件：Python 和 Pip

在开始之前，请确保您的系统上已安装 Python 3.7+ 和 pip（Python 的包安装程序）。您可以通过在终端中运行以下命令来检查您的 Python 版本：

python --version

您应该会看到类似 Python 3.x.x 的输出。如果未安装 Python，请访问 python.org 下载并安装。

3 设置虚拟环境

为您的 Python 项目创建虚拟环境始终是一个好习惯。这可以将您项目的依赖项与其它项目和系统的全局 Python 包隔离开来。

首先，在终端中导航到您希望的项目目录并创建一个虚拟环境：

python -m venv .venv

接下来，激活您的虚拟环境：

# 在 macOS/Linux 上
source .venv/bin/activate

# 在 Windows 上（使用命令提示符）
.venv\Scripts\activate

当您在终端提示符前看到 (.venv) 时，就表示它已激活。

4 安装 CherryPy

激活虚拟环境后，是时候安装 CherryPy 了。我们将使用 pip 来完成：

pip install cherrypy

此命令将下载 CherryPy 及其依赖项并安装到您的虚拟环境中。

在运行 pip install 之前，请确保您的虚拟环境已激活！

5 创建您的“Hello World”应用程序

现在，让我们创建第一个 CherryPy 应用程序。在您的项目目录中，创建一个名为 app.py 的新文件并添加以下代码：

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hello World!"

if __name__ == '__main__':
    cherrypy.quickstart(HelloWorld())

这是最简单的 CherryPy 应用程序，访问时返回“Hello World!”。

6 理解您的 CherryPy 代码

让我们分解 app.py 文件：

import cherrypy: 导入 CherryPy 库。
class HelloWorld:: 在 CherryPy 中，Web 应用程序被构造为类。此类的每个方法都可以成为一个端点。
@cherrypy.expose: 这是一个装饰器，它使 index 方法可以通过 Web 浏览器访问。没有它，CherryPy 不会将此方法公开为 Web 端点。
def index(self):: 默认情况下，当用户访问应用程序的根 URL（例如 /）时，会调用名为 index 的方法。
return "Hello World!": 当调用 index 方法时，此内容将返回到浏览器。
if __name__ == '__main__':: 这个标准的 Python 构造确保 cherrypy.quickstart() 仅在脚本直接执行时才被调用。
cherrypy.quickstart(HelloWorld()): 这是神奇的一行，它启动 CherryPy Web 服务器并将我们的 HelloWorld 应用程序类挂载到根目录。

7 运行您的 CherryPy 应用程序

保存 app.py 文件后，您现在可以运行 CherryPy 应用程序了。打开您的终端（确保您的虚拟环境仍处于活动状态）并执行：

python app.py

您应该会看到类似以下的输出，表明 CherryPy 已启动其 Web 服务器：

[07/Dec/2023:10:00:00] ENGINE Listening for HTTP on 127.0.0.1:8080
[07/Dec/2023:10:00:00] ENGINE Bus STARTED

保持此终端窗口打开！CherryPy 在前台运行。

8 访问您的“Hello World”应用程序

您的 CherryPy 应用程序现在正在本地运行！打开您的网络浏览器并导航到：

http://127.0.0.1:8080/

您应该会在浏览器中看到文本“Hello World!”。恭喜，您已成功创建并运行了您的第一个 CherryPy 应用程序！

如果您看到“Hello World!”，那么您就走对了！如果没有，请仔细检查您的终端是否有错误，并确保您的虚拟环境处于活动状态。

9 添加更多端点

在 CherryPy 中创建更多端点就像向您的应用程序类添加更多方法并公开它们一样简单。让我们添加一个 /greet 端点。

修改您的 app.py，使其看起来像这样（请记住先用 Ctrl+C 停止服务器）：

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hello World!"

    @cherrypy.expose
    def greet(self):
        return "Greetings from CherryPy!"

if __name__ == '__main__':
    cherrypy.quickstart(HelloWorld())

保存文件，再次运行 python app.py，然后访问 http://127.0.0.1:8080/greet 在您的浏览器中。您应该会看到“Greetings from CherryPy!”。

10 处理查询参数

CherryPy 方法也可以直接接受参数，这些参数对应于 URL 查询参数。让我们个性化我们的问候消息。

停止您的服务器，更新 app.py：

import cherrypy

class HelloWorld:
    @cherrypy.expose
    def index(self):
        return "Hello World!"

    @cherrypy.expose
    def greet(self, name="Guest"): # 添加了一个带有默认值的“name”参数
        return f"Hello, {name}!" # 使用 f-string 进行个性化

if __name__ == '__main__':
    cherrypy.quickstart(HelloWorld())

保存，运行 python app.py，然后访问这些 URL：

http://127.0.0.1:8080/greet (输出：“Hello, Guest!”)
http://127.0.0.1:8080/greet?name=Alice (输出：“Hello, Alice!”)

这演示了 CherryPy 如何自动将 URL 查询参数映射到方法参数。

11 恭喜与后续步骤！

您已成功构建并扩展了您的第一个 CherryPy “Hello World”应用程序！您已学会如何：

设置您的开发环境。
安装 CherryPy。
创建一个带有公开方法的基本 CherryPy 应用程序。
运行 CherryPy 内置的 Web 服务器。
添加多个端点。
处理用于动态内容的 URL 查询参数。

这仅仅是个开始！CherryPy 提供了更多功能，包括处理静态文件、会话、Cookie、请求/响应对象以及更复杂的路由。要深入了解，请查阅 CherryPy 官方文档：

访问 CherryPy 文档

继续构建，编码愉快！

教程进度