Python中如何使用@property装饰器实现属性封装？

本文共计1338个文字，预计阅读时间需要6分钟。

通常，当我们需要对对象的敏感属性或不愿外部直接访问的属性进行私有化处理时，但又需要在某些情况下对这些私有属性进行修改，可以采用以下几种方法：

1. 封装（Encapsulation）：通过将属性设置为私有（private），在类中提供公共（public）的方法来访问和修改这些属性，以控制对属性的访问。

2. getter和setter方法：为私有属性提供getter和setter方法，允许外部代码以受控的方式读取和修改属性值。

3. 访问修饰符：使用protected修饰符，使得属性在类及其子类中可见，但对外部类不可见。

4. 组合（Composition）：将私有属性作为其他对象的成员，通过这些对象的方法来间接访问和修改属性。

5. 代理（Proxy）：创建一个代理类来封装对私有属性的访问，代理类可以添加额外的逻辑，如日志记录、权限检查等。

以下是一个简化的示例：

pythonclass Person: def __init__(self, name, age): self._name=name # 使用单下划线表示属性是受保护的 self.__age=age # 使用双下划线表示属性是私有的

# Getter方法 def get_age(self): return self.__age

# Setter方法 def set_age(self, age): if age > 0: self.__age=age else: raise ValueError(Age must be positive)

# 公共方法 def display_info(self): print(fName: {self._name}, Age: {self.get_age()})

在这个例子中，`_name` 是受保护的属性，可以在类内部直接访问，而 `__age` 是私有属性，只能通过 `get_age` 和 `set_age` 方法访问和修改。

通常，当我们需要对对象的敏感属性或者不希望外部直接访问的属性进行私有化，但是某些时候我们又需要对这些私有属性进行修改，该怎么处理呢？

几个概念

• _a(前置单下划线)，这种属性仅表示约定的私有，非真正的私有。
• __a(前置双下划线)，这种属性表示私有，无法在外部访问。
• __ a __(前后双下划线)，这种属性标识系统属性。(可选)
• a_(后置单下划线)，这种属性是为了避免和保留关键字冲突。(可选)

举个例子

​定义一个类：​

class Student(object):

_sex='male'

__age=0

​执行：（私有属性无法在外部访问）​

>>> stu = Student()
>>> stu._sex
'male'
>>> stu.__age
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: 'Student' object has no attribute '__age'
>>>

解决问题

​从上面的类中我们可以看到，私有属性无法在类实例中访问，怎么办呢？当我们需要对类的私有属性__age进行查询和修改的时候，我们可以定义get_age和set_age去实现。​

class Student(object):

_sex='male'

__age=0

def get_age(self):
return self.__age

def set_age(self,age):
self.__age = age

​执行：​

>>> stu = Student()
>>> stu.get_age()
0
>>> stu.set_age(18)
>>> stu.get_age()
18
>>>

换个方法

​但是上面的这种方式略显复杂，如果在私有属性较多的类中就不太适用了，所以我们期望寻求一种更简单的方式去解决这个问题，比如将这个私有属性转化为另一个属性。告诉你个好消息，Python已经帮我们实现了，这就是@property。​

class Student(object):

_sex='male'

__age=0

def get_age(self):
return self.__age

def set_age(self,age):
self.__age = age

@property
def age(self):
return self.__age

​执行：​

>>> from payhlib import Student
>>> s = Student()
>>> s.age
0
>>> s.set_age(19)
>>> s.age
19
>>

​在上面我们将__age私有属性转换为了age属性，你可能会想，既然私有属性转换为了属性，那我们是不是可以直接修改它呢？答案是不行，因为property虽然将__age转换为了属性，但是其不具备setter功能，需要我们去添加。​

>>> from payhlib import Student
>>> s = Student()
>>> s.age
0
>>> s.age=20
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
AttributeError: can't set attribute
>>>

​添加setter方法​

class Student(object):

_sex='male'

__age=0

def get_age(self):
return self.__age

def set_age(self,age):
self.__age = age

@property
def age(self):
return self.__age

@age.setter
def age(self,value):
self.__age=value

​执行：​

>>> from payhlib import Student
>>> s = Student()
>>> s.age
0
>>> s.age=20
>>> s.age
20
>>>

到此，@peoperty分享完毕，关于它的实现原理你可以查看源码进行研究。

更多内容详见微信公众号：Python研究所