• 首页
  • Python中的装饰器：你需要知道的事项

Python中的装饰器：你需要知道的事项

我记得第一次我在许多函数中添加相同的额外行为时遇到的困难。我需要在每个类方法上进行日志记录，因此我尝试了子类化或在各处添加 if 检查。我的代码变成了一张错综复杂的继承和标志的网络。然后一位同事向我展示了 装饰器 ——这让我大开眼界。装饰器就像给你的函数穿上一件特别的外衣：你在它周围包裹上额外的行为 而不改变其核心逻辑。正如一个教程所说，装饰器“允许你包装另一个函数——添加或修改其行为——而不改变原始函数的代码”。这感觉就像把礼物放在一个精美装饰的盒子里一样优雅。

考虑一个简单的蛋糕（你的原始函数）。添加糖霜和撒糖并不会改变蛋糕本身，但它却增强了蛋糕。同样，装饰器会接收你的函数并添加“糖霜”——额外的日志记录、计时、授权检查等。你仍然调用原始函数，但现在它看起来更华丽。事实上，Real Python 对此进行了很好的总结：“Python 装饰器允许你在不改变实际代码的情况下修改或扩展函数和方法的行为。”这个简单的想法——将一个函数包装在另一个函数内——是使你的代码更具可重用性和可读性的秘密所在。

这里有一个非常基本的例子：

def simple_decorator(func):
    def wrapper():
        print("调用函数之前")
        func()
        print("调用函数之后")
    return wrapper

@simple_decorator
def say_hello():
    print("Hello!")

say_hello()
# 输出：
# 调用函数之前
# Hello!
# 调用函数之后

@simple_decorator 这一行是语法糖。它替代了：
say_hello = simple_decorator(say_hello)

发生的事情是：当你调用 say_hello() 时，实际上你是在调用 wrapper()，而 wrapper() 又会运行原始的 say_hello()（打印“Hello!”），并在额外的打印语句中进行包装。注意我们并没有对 say_hello() 本身进行任何修改——我们只是添加了一个包装层。

编写你自己的装饰器

在底层，装饰器只是一个接受另一个函数并返回一个新函数（通常是一个包装器）的函数。因为 函数在Python中是第一类对象，你可以在其他函数之间传递它们并返回它们。要编写一个装饰器：

  • 定义一个函数，该函数接受一个函数（func）作为参数。
  • 在其中定义一个内部的 wrapper 函数，该函数将在调用 func 之前/之后添加新的行为。
  • 从装饰器返回包装器。

例如，一个简单的日志记录装饰器可能如下所示：

import functools

def logger(func):
    @functools.wraps(func)   # 保留 func 的元数据
    def wrapper(*args, **kwargs):

print(f"调用 {func.__name__}，参数={args}，关键字参数={kwargs}") result = func(*args, **kwargs) print(f"{func.__name__} 返回 {result}") return result return wrapper
@logger


def multiply(a, b):
return a * b multiply(4, 5) # 输出： # 调用 multiply，参数=(4, 5)，关键字参数={} # multiply 返回 20

注意以下几点：

  • 我们使用 @logger 装饰了 multiply()。现在每次调用 multiply() 时，都会首先打印其参数和返回值。
  • 装饰器的 wrapper 函数使用 *args 和 **kwargs 来接受任何参数（这是一个非常常见的模式）。
  • 我们在 wrapper 上方添加了 @functools.wraps(func)。这是一个小但重要的细节：它将原始函数的名称、文档字符串和其他元数据复制到包装器中。如果没有 @wraps，被装饰的函数将显示为“wrapper”，并失去其文档字符串。

简而言之，编写一个装饰器就像构建一个小型函数工厂，它将你的逻辑包裹在对原始函数的内部调用周围。

 

处理参数和多个装饰器

大多数实际的装饰器需要支持参数，因此你会经常看到 wrapper(*args, **kwargs)。例如，这里有一个只记录任何函数参数的装饰器：

def log_args(func):
    def wrapper(*args, **kwargs):

print(f"函数 {func.__name__} 被调用，参数为 {args}, {kwargs}") return func(*args, **kwargs) return wrapper

@log_args
def add(a, b):
return a + b

add(3, 5)
# 输出：
# 函数 add 被调用，参数为 (3, 5), {}
# 8

由于装饰器事先不知道被装饰函数将有多少个参数，因此它将所有参数捕获到 *args 和 **kwargs 中。这确保了你几乎可以装饰 任何 函数。

你还可以在一个函数上堆叠多个装饰器——它们就像多层糖霜一样相互包裹。例如：

def bold(func):
    def wrapper():

return f"<b>{func()}</b>" return wrapper

def italic(func):
def wrapper():
return f“<i>{func()}</i>“
return wrapper

@bold
@italic
def greet():
return “Hello“

print(greet()) # 输出: <b><i>Hello</i></b>

这里 greet 首先经过 italic，然后经过 bold。结果是同时具有粗体和斜体的 HTML。顺序很重要：交换 @bold 和 @italic 会改变嵌套。

functools.wraps 助手

一个微妙但重要的细节是保留原始函数的身份。如果你对一个包装的函数进行 introspect，你希望它的名称、文档字符串、注解等与原始函数匹配。这就是 functools.wraps 的作用。例如：

from functools import wraps
def shout(func): @wraps(func) def wrapper(*args, **kwargs): return func(*args, **kwargs).upper() return wrapper

@shout
def hello():
“””问候某人。“””
return “hello“

print(hello(), hello.__name__, hello.__doc__)


# 输出：HELLO hello '问候某人。'

因为我们使用了 @wraps(func)，所以 hello.__name__ 仍然是 "hello"，而不是 "wrapper"，并且文档字符串得以保留。如果没有它，调试工具、反射和文档都会因为错误的名称而感到困惑。

何时使用装饰器

装饰器在处理“横切关注点”时表现出色：例如记录每次调用、强制访问规则、缓存结果或测量执行时间。与其在代码中到处散布这些细节或构建复杂的继承结构，不如使用装饰器来干净地添加这些行为。正如一位开发者所说，装饰器可以被认为是“比继承更灵活”的共享行为。例如，如果两个不相关的类需要相同的缓存逻辑，继承将迫使你创建ACached和BCached类，并重复代码。而使用装饰器，你只需编写一个缓存函数并将其应用于这两个类。

 

装饰器让你保持函数简洁且专注，然后仅在需要的地方进行包装。正如对装饰器好处的总结所说：装饰器就像是以可重用和干净的方式为你的代码添加功能层，使你的代码更加模块化和可维护。

认识ServBay：为你的Mac开发环境提供的“装饰器”

就像装饰器在不改变函数的情况下对其进行包装和扩展一样，ServBay 在不污染系统的情况下对您的 macOS 开发环境进行包装和扩展。ServBay 是一个免费的 GUI 工具，将所有网页开发者可能需要的工具（Python、数据库、服务器等）打包成一个包。想象一下，您拥有一个本地开发的瑞士军刀：它包含多个版本的Python、Node.js、PHP、Go、.NET、Ruby、Rust以及像MySQL、MariaDB、PostgreSQL、MongoDB、Redis、SQLite这样的数据库，所有这些都可以通过点击安装。（请参见上面的图片——ServBay 的生态系统。）

 

在 macOS 上使用 Python 常常令人头疼：系统自带一个 Python，Homebrew 又安装了另一个，管理符号链接或虚拟环境变成了一种 juggling 行为。ServBay 通过在项目级别管理版本来避免这一问题。在 ServBay 中，您可以为每个项目配置一个 .servbay.config 文件，以固定 Python 或 Node 版本，确保没有冲突。该工具甚至会将版本化的可执行文件如 python3.10 或 node-16.13 添加到您的 PATH 中，因此您可以调用特定版本，而无需调整全局链接。简而言之，您避免了常常困扰 Mac 开发者的版本冲突和符号链接的头痛问题。

 

ServBay 还使得安装和管理服务变得非常简单。想要在一个项目中使用 PostgreSQL 和 Redis，而在另一个项目中使用 MySQL 和 MongoDB？只需点击一下即可部署任意组合。它提供了一个图形用户界面，用于创建数据库、导入数据或运行命令——所有这些您通常需要通过 brew 或端口手动完成。例如，ServBay 的“丰富数据库支持”意味着您可以立即启动 MySQL、MariaDB 或 PostgreSQL，甚至可以并行运行多个版本。用户表示，这让他们“专注于编码，而不是无休止地调整和排除环境问题”。

 

另一个痛点是设置域名和 SSL。通常，您需要编辑 /etc/hosts 或运行脚本，并支付证书费用。ServBay 具有内置的 DNS 和 SSL 系统：您可以使用像 myapp.dev 这样的虚构域名（无需注册），ServBay 将自动为 HTTPS 颁发免费的证书。它确实 “不会污染系统”，通过以封闭的方式进行这些更改，因此您的 /etc/hosts 和钥匙串保持干净。

 

总之，ServBay 通过提供一个一体化的、图形驱动的环境，解决了所有常见的 Mac 开发难题——版本冲突、依赖地狱、数据库/服务器设置等等。它就像是为您的 Mac 提供了一个装饰器：它 增强 了您的开发体验，而不改变底层系统。

ServBay与传统设置

关注点 传统方法（自制、MAMP等） ServBay
语言/版本管理 单独安装语言/服务器（brew、Pyenv等），手动处理冲突。 内置多语言支持。轻松切换版本。项目特定配置避免冲突。
依赖关系与包 使用pip、brew或手动安装。可能导致全局pip冲突（依赖地狱）。 使用隔离环境和servbay可执行文件。按项目管理版本，避免全局冲突。
数据库与服务器 手动安装MySQL/Postgres/Mongo等，配置端口和访问权限。 点击安装MySQL、PostgreSQL、Redis等，带有图形管理界面。多版本数据库共存，无端口冲突。
域名与SSL 编辑/etc/hosts，运行本地服务器。手动使用虚拟域名并自行获取证书。 内置虚拟域名的DNS，自动为开发域名生成SSL证书。无需额外步骤。
系统污染 添加工具通常会修改 /usr/local 或系统 Python，可能会使操作系统环境变得混乱。 绿色解决方案：“不污染系统”。工具在 ServBay 的管理之下，易于备份或删除。
易用性 命令行操作较多；每个工具都有自己的配置。对于初学者来说，设置容易出错。 一个统一的图形用户界面。只需点击即可安装或切换软件包版本。一切都已集成并有文档说明。

正如表格所示，ServBay 解决了 macOS 上本地开发工作中的常见问题，方式与装饰器解决代码问题的精神相似：通过干净地添加所需内容而不干扰核心系统。

结论

装饰器和ServBay乍一看似乎没有关联，但它们有一个共同的理念：增强而不干扰。Python装饰器通过新的行为包装一个函数，而不改变原始代码。ServBay 为您的开发环境提供所有所需工具，保持系统的整洁。两者都促进了模块化和清晰性。正如一位指南所说，装饰器使您的代码变得更加“模块化、可维护和强大”——而ServBay也旨在为您的Mac开发环境实现同样的目标。换句话说，无论是您的代码还是您的机器，这些工具都帮助您保持事物的有序，以便您能够专注于真正重要的事情：解决问题和构建优秀的软件。

祝您编码（和开发）愉快！

更多

Weibo Weixin

京ICP备17072685号-4 © 2025 QPython.