装饰大师——装饰模式（Python实现）

news2024/9/20 5:59:59

大家好，今天我们继续来讲结构型设计模式，上一期我们介绍了组合模式，这个模式特别适合用于处理树形结构的问题，它能够让我们像处理单个对象一样来处理对象组合。

装饰模式（Decorator Pattern）是一种结构型设计模式，它允许向现有对象添加新的功能，同时又不改变其结构；本文将介绍装饰模式的定义、实现方法，并通过几个实际的案例展示如何在Python项目中应用装饰模式。

装饰模式概述

装饰模式的核心思想是将功能附加到对象上，而不是通过继承来实现，这种模式包含以下几个关键组成部分：

组件接口：定义基本功能；
具体组件：实现基本功能的类；
装饰器基类：实现组件接口，并包含一个指向组件对象的引用；
具体装饰器：扩展装饰器基类，实现额外的功能。

装饰模式与其他设计模式（如代理模式、适配器模式）不同之处在于，装饰模式注重动态地为对象添加职责，而不改变对象的接口。

模式结构

类图

示意图

装饰模式的Python实现

在Python中，装饰模式通常使用函数或类装饰器来实现，以下是几种常见的实现方式：

基本实现

以下是一个简单的装饰器例子，它为函数添加打印日志的功能：

def log_decorator(func):
    def wrapper(*args, **kwargs):
        print(f"Calling function {func.__name__}")
        result = func(*args, **kwargs)
        print(f"Function {func.__name__} finished")
        return result
    return wrapper

@log_decorator
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")

带参数的装饰器

装饰器还可以接受参数，从而更加灵活，以下是一个带参数的装饰器例子：

def repeat_decorator(times):
    def decorator(func):
        def wrapper(*args, **kwargs):
            for _ in range(times):
                func(*args, **kwargs)
        return wrapper
    return decorator

@repeat_decorator(3)
def say_hello(name):
    print(f"Hello, {name}!")

say_hello("Alice")

多层装饰器的使用

装饰器可以叠加使用，实现多层装饰：

def uppercase_decorator(func):
    def wrapper(*args, **kwargs):
        result = func(*args, **kwargs)
        return result.upper()
    return wrapper

@log_decorator
@uppercase_decorator
def greet(name):
    return f"Hello, {name}"

print(greet("Alice"))

实际应用案例

装饰模式在实际项目中有很多应用场景，例如日志记录、权限验证和性能监控等。

日志记录功能的装饰

通过装饰器为函数添加日志记录功能，可以避免在每个函数中重复写日志代码：

def log_decorator(func):
    def wrapper(*args, **kwargs):
        print(f"Calling function {func.__name__}")
        result = func(*args, **kwargs)
        print(f"Function {func.__name__} finished")
        return result
    return wrapper

@log_decorator
def process_data(data):
    # 模拟数据处理逻辑
    print("Processing data...")
    return data

process_data("Sample Data")

在上述例子中，每次调用 process_data 函数时，都会记录函数调用的开始和结束时间。

权限验证功能的装饰

通过装饰器为函数添加权限验证功能，可以在调用实际业务逻辑之前进行权限检查：

def permission_required(permission):
    def decorator(func):
        def wrapper(*args, **kwargs):
            if not has_permission(permission):
                raise PermissionError("Access denied")
            return func(*args, **kwargs)
        return wrapper
    return decorator

def has_permission(permission):
    # 模拟权限验证逻辑
    allowed_permissions = ["admin", "user"]
    return permission in allowed_permissions

@permission_required("admin")
def delete_user(user_id):
    # 模拟删除用户逻辑
    print(f"User {user_id} deleted.")

try:
    delete_user(123)
except PermissionError as e:
    print(e)

在上述例子中，只有当用户具有 “admin” 权限时，才允许删除用户。

性能监控功能的装饰

通过装饰器为函数添加性能监控功能，可以方便地记录函数的执行时间：

import time

def timing_decorator(func):
    def wrapper(*args, **kwargs):
        start_time = time.time()
        result = func(*args, **kwargs)
        end_time = time.time()
        print(f"{func.__name__} took {end_time - start_time} seconds")
        return result
    return wrapper

@timing_decorator
def perform_task():
    # 模拟任务执行逻辑
    time.sleep(2)
    print("Task completed.")

perform_task()