如何在 Python 类中实现私有属性

简介

Python 的面向对象编程（OOP）特性为开发者提供了强大的工具，用于创建健壮且可维护的代码。OOP 的一个关键方面是数据封装概念，它允许你隐藏类的内部实现细节，并控制对其属性的访问。在本教程中，我们将探讨如何在 Python 类中实现私有属性，确保数据隐私并遵循最佳实践。

Skills Graph

理解 Python 的私有属性

在 Python 中，类可以有两种类型的属性：公共属性和私有属性。公共属性在类的内部和外部的任何地方都可以访问。另一方面，私有属性仅打算在类本身内部使用，不能从类外部直接访问。

Python 中的私有属性在属性名称前用一个前导下划线（_）表示。这是一种约定，而不是严格的语言规则，用于表明该属性应被视为私有属性。

class MyClass:
    def __init__(self):
        self._private_attr = "This is a private attribute."
        self.public_attr = "This is a public attribute."

在上面的示例中，_private_attr 是一个私有属性，而 public_attr 是一个公共属性。

虽然私有属性可以从类外部访问，但通常认为避免这样做是一种最佳实践。相反，你应该使用类方法来与私有属性进行交互，因为这样可以让你控制属性的使用和修改方式。

class MyClass:
    def __init__(self):
        self._private_attr = "This is a private attribute."
        self.public_attr = "This is a public attribute."

    def get_private_attr(self):
        return self._private_attr

    def set_private_attr(self, value):
        self._private_attr = value

在上面的示例中，get_private_attr() 和 set_private_attr() 方法提供了一种受控的方式来访问和修改私有属性 _private_attr。

通过使用私有属性并提供与之交互的类方法，你可以：

1. 封装类的内部实现细节。
2. 确保属性的使用方式与类的预期行为一致。
3. 简化类的公共接口，使用户更容易理解和使用。

总体而言，理解并正确使用私有属性是编写简洁、可维护且健壮的 Python 代码的一个重要方面。

在类中实现私有属性

私有属性的命名规范

如前所述，Python 中的惯例是在私有属性前加一个前导下划线（_）。这是一种被广泛接受的做法，但需要注意的是，这并不是严格的语言规则。Python 并没有真正“隐藏”属性使其无法被外部访问的方法，因为 Python 中的所有内容最终都是可访问的。

class MyClass:
    def __init__(self):
        self._private_attr = "This is a private attribute."
        self.public_attr = "This is a public attribute."

访问私有属性

虽然私有属性可以从类外部访问，但通常认为这样做是不好的做法。相反，你应该使用类方法来与私有属性进行交互。

class MyClass:
    def __init__(self):
        self._private_attr = "This is a private attribute."
        self.public_attr = "This is a public attribute."

    def get_private_attr(self):
        return self._private_attr

    def set_private_attr(self, value):
        self._private_attr = value

在上面的示例中，get_private_attr() 和 set_private_attr() 方法提供了一种受控的方式来访问和修改私有属性 _private_attr。

使用 __（双下划线）语法

Python 还提供了一种创建“名称改写”私有属性的方法，这种属性更能有效地防止外部访问。这是通过使用双下划线（__）前缀而不是单下划线来实现的。

class MyClass:
    def __init__(self):
        self.__private_attr = "This is a strongly private attribute."
        self.public_attr = "This is a public attribute."

    def get_private_attr(self):
        return self.__private_attr

    def set_private_attr(self, value):
        self.__private_attr = value

在这种情况下，私有属性 __private_attr 实际上会被 Python 解释器重命名为 _MyClass__private_attr，使得从类外部直接访问它变得更加困难。

通过使用私有属性并提供与之交互的类方法，你可以：

1. 封装类的内部实现细节。
2. 确保属性的使用方式与类的预期行为一致。
3. 简化类的公共接口，使用户更容易理解和使用。

私有属性使用的最佳实践

封装内部实现细节

使用私有属性的主要原因之一是封装类的内部实现细节。通过将这些细节隐藏在精心设计的公共接口后面，你可以使类更易于使用、维护和扩展。

class BankAccount:
    def __init__(self, balance):
        self.__balance = balance

    def deposit(self, amount):
        self.__balance += amount

    def withdraw(self, amount):
        if self.__balance >= amount:
            self.__balance -= amount
        else:
            print("Insufficient funds.")

    def get_balance(self):
        return self.__balance

在上面的示例中，__balance 属性是私有的，并且类提供了公共方法（deposit()、withdraw() 和 get_balance()）来与之交互。这使得类能够控制余额的访问和修改方式，确保账户的内部状态保持一致。

提供对私有属性的受控访问

如前所述，你应该使用类方法来提供对私有属性的受控访问。这使你能够实施任何必要的验证或业务逻辑，并确保属性的使用方式与类的预期行为一致。

class Employee:
    def __init__(self, name, salary):
        self.__name = name
        self.__salary = salary

    def get_name(self):
        return self.__name

    def get_salary(self):
        return self.__salary

    def set_salary(self, new_salary):
        if new_salary > 0:
            self.__salary = new_salary
        else:
            print("Invalid salary value.")

在上面的示例中，get_name()、get_salary() 和 set_salary() 方法提供了一种受控方式来访问和修改私有属性 __name 和 __salary。

记录私有属性的用途

使用私有属性时，记录它们的用途和预期用法很重要。这有助于其他开发者（以及未来的你自己）理解类的内部结构以及如何正确地与之交互。

你可以使用文档字符串或注释来提供此文档：

class BankAccount:
    """
    一个表示银行账户的类。

    属性：
        __balance (float)：账户的当前余额。
    """
    def __init__(self, balance):
        self.__balance = balance

    def deposit(self, amount):
        """
        向账户中存入指定金额。

        参数：
            amount (float)：要存入的金额。
        """
        self.__balance += amount

    ## 为简洁起见，省略了其他方法

通过遵循这些最佳实践，你可以创建具有精心设计、可维护且健壮的私有属性使用方式的类。

总结

在本教程结束时，你将全面了解如何在 Python 类中实现私有属性。你将学习各种可用的技术，例如名称改写和属性方法，以实现真正的数据隐私并遵循有效类设计的最佳实践。有了这些知识，你将能够编写更安全、更易于维护的 Python 代码，这些代码遵循数据封装的原则。