Python 中的函数装饰器：理解 @property、Getter 和 Setter 方法- 技术经验 -卓越飞翔博客

python 中的函数装饰器：理解 @property、getter 和 setter 方法

在面向对象编程中，封装是一个基本概念，对于确保数据完整性和向用户隐藏实现细节至关重要。 python 以其简单性和可读性而闻名，它采用 getter 和 setter 作为封装的一部分。本文深入探讨了 python 中 getter 和 setter 的目的和实现，深入了解它们在管理数据访问和维护对象完整性方面的作用。特别是，我们将探索 python 中的 @property 装饰器如何简化这些概念，从而允许使用更 pythonic 的方法来访问和更新对象属性。

封装和私有变量的重要性
封装的核心在于数据隐藏的思想——控制对对象内部状态的访问以防止意外干扰或误用。这需要使用私有变量。在许多编程语言中，私有变量用于确保对象内的敏感数据在未经适当授权的情况下无法直接访问或修改，从而保留给定对象的完整性。
python 不像其他一些语言那样具有严格的私有变量，而是使用在属性前添加单下划线 () 或双下划线 (_) 的约定，以表明它供内部使用。让我们来分解一下这两个约定之间的区别。

python 中的单下划线 (_) 与双下划线 (__)

a. 单下划线 (_):

变量开头的单个下划线（例如 _price）是一种约定，用于指示该属性供内部使用。 python 并未严格强制执行该属性，这意味着该属性仍然可以从类外部访问（即，它不是私有的）。但是，它向其他开发人员发出信号，表明该属性受到“保护”，除非必要，否则不应直接访问。例子：

class product:
    def __init__(self, price):
        self._price = price  # protected attribute (convention)

product = product(10)
print(product._price)  # accessing is possible, but discouraged

b. 双下划线 (__):

立即学习“Python免费学习笔记（深入）”；

变量开头的双下划线（例如 __price）会触发名称修改。名称修改在内部更改属性的名称，以防止从类外部意外访问或修改。这使得该属性更难直接访问，尽管它仍然不是完全私有的 - python 在内部通过在属性前面加上 _classname 来重命名该属性，使其只能通过其损坏的名称（例如 _product__price）进行访问。例子：

class product:
    def __init__(self, price):
        self.__price = price  # name-mangled attribute

product = product(10)
# print(product.__price)  # this will raise an attributeerror
print(product._product__price)  # accessing the mangled attribute

当您想要避免意外覆盖子类中的属性或想要针对意外的外部访问提供更强的保护时，它们非常有用。

为什么使用私有属性？
私有属性，尤其是那些用单下划线 (_) 表示的属性，对于维护封装非常重要。它们通过阻止外部代码直接与对象交互来保护对象的内部状态，这有助于：

保持数据完整性：私有属性可防止敏感或关键内部数据的意外修改。
启用受控访问：通过使用 getter 和 setter 方法（或 @property 装饰器），对象控制如何以及何时访问或修改其属性，通常添加验证逻辑。
提高可维护性：由于隐藏了内部细节，您可以修改底层实现而不影响类的外部行为。

传统的 getter 和 setter 方法
在许多编程语言中，getter 和 setter 用于提供对私有变量的受控访问。请参阅下面的示例：

class product:
    def __init__(self, price):
        self._price = price  # protected attribute

    def get_price(self):
        return self._price

    def set_price(self, value):
        if value &gt;= 0:
            self._price = value
        else:
            raise valueerror("price cannot be negative")

product = product(10)
print(product.get_price())  # 10
product.set_price(20)
print(product.get_price())  # 20

在此示例中，getter (get_price()) 和 set_price()) 提供了一种访问和修改 _price 属性的方法，同时执行某些规则（例如确保价格不为负）。

@property 装饰器
python 使用 @property 装饰器提供了一种更优雅的方式来管理对私有属性的访问。这个装饰器允许您定义行为类似于属性的方法，使代码更具可读性和python风格，同时仍然允许受控访问。

使用 @property 装饰器进行 getter 和 setter
下面是使用 @property 重构的前面的示例，以简化语法并提高可读性：

class Product:
    def __init__(self, price):
        self._price = price

    @property
    def price(self):
        return self._price

    @price.setter
    def price(self, value):
        if value &gt;= 0:
            self._price = value
        else:
            raise ValueError("Price cannot be negative")

product = Product(10)
print(product.price)  # 10
product.price = 20
print(product.price)  # 20

在此重构版本中：

@property装饰器允许我们像属性一样访问price()，即product.price，而不必调用像product.get_price()这样的getter方法。
@price.setter 装饰器启用设置价格值的逻辑，允许我们将其设置为 product.price = 20，同时仍然执行验证规则。

为什么使用@property？
@property 装饰器使您的代码更干净且更易于使用，特别是在处理私有属性时。原因如下：

可读性：它允许自然地访问属性，同时隐藏验证或转换的底层逻辑。
封装：您可以强制执行如何访问或修改属性的规则，而无需暴露内部实现细节。
灵活性：您可以在不更改外部接口的情况下重构内部行为，这意味着代码库的其余部分不会受到影响。

结论
封装是面向对象编程的基石，python 对私有变量的使用以及 @property 装饰器提供了一种干净灵活的方式来管理对对象内部状态的访问。带有单下划线 (_) 的属性表明它们供内部使用，而带有双下划线 (__) 的属性通过名称修改提供更强的保护。 @property 装饰器允许您以 pythonic 和可读的方式实现对这些私有属性的受控访问，确保数据完整性，同时保持干净的公共接口。

参考文献

关于属性的 python 文档
pep 318：函数装饰器

相关推荐