@property 和 @setter 是 Python 中的 装饰器 (decorators)，用来实现对物件属性的更方便且受控的访问与修改。它们经常搭配使用，可以让类别中的方法表现得像属性一样（使用点语法，而不是方法调用）。

  • @property把一个方法转换成一个唯读属性。使方法能够像属性一样被访问，并且可以在方法内添加逻辑，控制属性值的计算或取得。语法

    • class MyClass:
    @property
    def my_attribute(self):
    # 返回计算或取得的值
    return some_value

    class Circle:
    def __init__(self, radius):
    self._radius = radius # 私有属性，外部不直接访问

    @property
    def radius(self):
    # 允许通过 .radius 获取半径
    return self._radius

    @property
    def area(self):
    # 允许通过 .area 获取计算的面积
    return 3.14159 * (self._radius ** 2)

    circle = Circle(5)
    print(circle.radius) # 5
    print(circle.area) # 78.53975

  • @<property_name>.setter
    • @property 和 @property.setter 是配套使用的装饰器，允许为属性提供读取和写入的功能。
    • 定义对属性的修改方法，让属性可以被设置，并在设置时执行额外的逻辑或验证。语法

    class MyClass:
    @property
    def my_attribute(self):
    return self._value

    @my_attribute.setter
    def my_attribute(self, value):
    # 自定义逻辑来设置属性值
    self._value = value

    范例

    class Circle:
    def __init__(self, radius):
    self._radius = radius # 私有属性

    @property
    def radius(self):
    return self._radius

    @radius.setter
    def radius(self, value):
    if value <= 0:
    raise ValueError("半径必须大于 0")
    self._radius = value

    circle = Circle(5)
    print(circle.radius) # 5

    circle.radius = 10 # 修改半径
    print(circle.radius) # 10

    # circle.radius = -3 # 会抛出 ValueError: 半径必须大于 0

  • 为什么使用 @property 和 @setter？优点3-1 封装性
    • 属性可以设为私有，外部只能通过 @property 和 @setter 访问，保持物件内部逻辑的完整性。
    • 在需要时加入检查逻辑，而无需修改外部调用程式码。3-2 易于理解的 API
    • 使用点语法访问属性，符合直觉，让物件更易于使用。3-3 灵活性
    • 可以根据需要调整属性值的逻辑，而不影响外部程式码。
  • @property 和 @setter 的完整范例

    • class Rectangle:
    def __init__(self, width, height):
    self._width = width
    self._height = height

    @property
    def width(self):
    return self._width

    @width.setter
    def width(self, value):
    if value <= 0:
    raise ValueError("宽度必须大于 0")
    self._width = value

    @property
    def height(self):
    return self._height

    @height.setter
    def height(self, value):
    if value <= 0:
    raise ValueError("高度必须大于 0")
    self._height = value

    @property
    def area(self):
    # 面积是只读属性，无法直接修改
    return self._width * self._height

    使用范例

    rect = Rectangle(4, 5)
    print(rect.width) # 4
    print(rect.height) # 5
    print(rect.area) # 20

    rect.width = 10
    rect.height = 2
    print(rect.area) # 20 -> 10*2 = 20

    # rect.area = 50 # AttributeError: can\'t set attribute

    总结

    @property 将方法变成属性，可以用来封装属性逻辑。@setter 定义属性的设置逻辑，对属性修改进行控制和检查。它们提高了物件的封装性和可用性，同时保留灵活性，是 Python 中强大的特性之一。

    Python 的装饰器（Decorator）目录其他Python 的装饰器（Decorator文章： Python 装饰器 (decorator): @classmethod Python 装饰器 (decorator): @staticmethodPython 装饰器 (decorator) @abstractmethod