Python类中的装饰器@|极客教程

Python类中的装饰器@

1. 介绍

装饰器是Python语言中的一种特殊语法，用于修改或增强函数或类的功能。在Python中，装饰器以@符号开头，放置在函数定义或类定义之前。

装饰器在Python类中的使用非常常见，可以用于添加额外的行为，修改属性或方法，以及实现类的装饰。本文将详细介绍Python类中的装饰器的概念、用法和示例。

2. 装饰器的定义

装饰器是一个可调用的对象（函数、方法或类），它接受一个函数或方法作为参数，并返回一个经过包装或修改的新函数或方法。装饰器可以在不修改原函数或方法定义的情况下，为其添加额外的功能。

3. 装饰器的应用场景

在Python类中，装饰器的应用场景较多，比如：

修改类的属性或方法
添加日志记录或异常处理
实现权限控制或验证
实现类的装饰，比如单例模式

接下来会详细介绍这些常见的应用场景，并给出相应的示例代码和运行结果。

4. 修改类的属性或方法

装饰器可以用于修改一个类的属性或方法，使其具备额外的功能或行为。下面是一个示例代码：

def add_prefix(cls):
    cls.prefix = "Hello, "
    return cls

@add_prefix
class Greeting:
    def __init__(self, name):
        self.name = name

    def greet(self):
        print(cls.prefix + self.name)

# 创建实例并调用方法
greeting = Greeting("Alice")
greeting.greet()

运行结果：

Hello, Alice

上述代码中，通过add_prefix装饰器，给Greeting类添加了一个prefix属性，并在greet方法中使用了该属性。

5. 添加日志记录或异常处理

装饰器还可以用于添加额外的日志记录或异常处理功能，可以在不修改原有类的情况下，为其添加这些功能。

def log_exception(cls):
    def wrapper(*args, **kwargs):
        try:
            return cls(*args, **kwargs)
        except Exception as e:
            print(f"Exception in {cls.__name__}: {e}")
    return wrapper

@log_exception
class Calculator:
    def divide(self, a, b):
        return a / b

运行结果：

>>> calculator = Calculator()
>>> calculator.divide(10, 0)
Exception in Calculator: division by zero

上述代码中，通过log_exception装饰器为Calculator类的方法divide添加了异常处理逻辑，当除法运算出现异常时，会打印异常信息。

6. 实现权限控制或验证

装饰器还可以用于实现权限控制或验证功能。可以在不修改原有类的情况下，为其添加这些功能。

def require_login(cls):
    def wrapper(*args, **kwargs):
        if not cls.is_logged_in():
            raise ValueError("Login required")
        return cls(*args, **kwargs)
    return wrapper

class RestrictedArea:
    logged_in = False

    @classmethod
    def is_logged_in(cls):
        return cls.logged_in

    @require_login
    def restricted_method(self):
        print("This is a restricted method")

# 创建实例并调用方法
area = RestrictedArea()
area.restricted_method()

运行结果：

>>> area.restricted_method()
ValueError: Login required

上述代码中，通过require_login装饰器实现了对RestrictedArea类的方法restricted_method的权限控制，只有在登录状态下才能调用该方法。

7. 实现类的装饰

装饰器还可以用于实现类的装饰，比如单例模式。可以在不修改原有类的情况下，为其增加额外的功能。

def singleton(cls):
    instances = {}

    def wrapper(*args, **kwargs):
        if cls not in instances:
            instances[cls] = cls(*args, **kwargs)
        return instances[cls]
    return wrapper

@singleton
class Logger:
    def log(self, message):
        print(f"Logging: {message}")

# 创建多个实例并调用方法
logger1 = Logger()
logger2 = Logger()

logger1.log("Message 1")  # 输出：Logging: Message 1
logger2.log("Message 2")  # 输出：Logging: Message 1

运行结果：

>>> logger1.log("Message 1")
Logging: Message 1
>>> logger2.log("Message 2")
Logging: Message 1

上述代码中，通过singleton装饰器实现了Logger类的单例模式，确保只能创建到一个Logger实例。

8. 总结

本文介绍了在Python类中使用装饰器的概念、用法和常见应用场景。通过修改属性或方法、添加日志记录或异常处理、实现权限控制或验证、实现类的装饰等示例，展示了装饰器在类中的实际应用。

Python类中的装饰器@