简介
在使用 Python 类时，定义一个清晰且有效的公共接口至关重要。在本教程中，我们将探讨设计公共接口的关键原则，帮助你创建更易于维护且健壮的 Python 代码。
理解类接口
在 Python 中，类是创建对象的基本构建块。类定义了对象的结构和行为，包括它可以保存的数据以及它可以执行的操作。类的接口是指对外公开的公共方法和属性，允许代码的其他部分与该类进行交互。
理解类接口对于编写可维护和可扩展的 Python 代码至关重要。通过定义清晰且设计良好的接口，你可以隐藏类的实现细节，从而在不影响使用该类的代码的情况下更轻松地更改内部逻辑。
封装与信息隐藏
封装是面向对象编程（OOP）中的一个基本概念，有助于实现信息隐藏。通过封装类的内部实现细节，你可以保护数据，并确保只能通过定义的接口来访问和修改它。
在 Python 中，你可以使用访问修饰符的概念来实现封装。虽然 Python 不像其他一些编程语言那样具有严格的 public、private 和 protected 访问修饰符，但你可以使用命名约定来指示预期的可访问性级别。
class MyClass:
def __init__(self):
self._internal_attribute = "这是一个内部属性。"
self.public_attribute = "这是一个公共属性。"
def _internal_method(self):
print("这是一个内部方法。")
def public_method(self):
print("这是一个公共方法。")
self._internal_method()在上面的示例中，_internal_attribute 和 _internal_method() 被视为内部实现细节，应该仅在类内部或子类中访问。public_attribute 和 public_method() 是类公共接口的一部分，任何使用 MyClass 对象的代码都可以访问它们。
定义公共接口
类的公共接口是代码的其他部分打算使用的方法和属性的集合。这些是你希望对外公开并可供与类进行交互的元素。
在定义公共接口时，请考虑以下准则：
- 确定核心功能：确定类应执行的主要任务和操作，并将它们公开为公共方法。
- 使用清晰且有意义的名称：为公共方法和属性选择直观且描述性强的名称，使其目的一目了然。
- 提供适当的文档：使用文档字符串和注释来解释公共方法的目的、预期输入和预期输出。
- 避免暴露内部实现细节：将类的内部实现细节隐藏起来，仅通过公共接口进行访问。
- 考虑接口的稳定性：在对类进行更改时，尽量保持公共接口的稳定性，以避免破坏依赖它的现有代码。
通过遵循这些原则，你可以创建一个设计良好的公共接口，使代码的其他部分能够以可预测和可维护的方式与你的类进行交互。
定义公共方法
公共方法是类公共接口的核心。它们是与类进行交互并执行其预期功能的入口点。在定义公共方法时，考虑以下准则很重要：
确定核心功能
仔细检查类的目的和职责，并确定应作为公共方法公开的关键操作。这些方法应代表类旨在提供的核心功能。
class BankAccount:
def __init__(self, account_number, balance):
self._account_number = account_number
self._balance = balance
def deposit(self, amount):
"""
向账户存入指定金额。
参数：
amount (float)：要存入的金额。
返回：
float：更新后的账户余额。
"""
self._balance += amount
return self._balance
def withdraw(self, amount):
"""
从账户中取出指定金额。
参数：
amount (float)：要取出的金额。
返回：
float：更新后的账户余额。
"""
if self._balance >= amount:
self._balance -= amount
return self._balance
else:
return self._balance在上面的示例中，deposit() 和 withdraw() 方法代表了 BankAccount 类的核心功能，允许用户管理他们的账户余额。
使用清晰且有意义的名称
为公共方法选择直观且描述性强的名称，使其目的一目了然。避免使用可能会使类的使用者感到困惑的缩写或隐晦名称。
class Rectangle:
def __init__(self, width, height):
self._width = width
self._height = height
def get_area(self):
"""
计算并返回矩形的面积。
返回：
float：矩形的面积。
"""
return self._width * self._height
def get_perimeter(self):
"""
计算并返回矩形的周长。
返回：
float：矩形的周长。
"""
return 2 * (self._width + self._height)在上面的示例中，get_area() 和 get_perimeter() 方法清楚地表明了它们的目的，使用户很容易理解如何与 Rectangle 类进行交互。
提供适当的文档
使用文档字符串和注释来解释公共方法的目的、预期输入和预期输出。此文档将帮助类的使用者了解如何正确使用这些方法。
class Person:
def __init__(self, name, age):
self._name = name
self._age = age
def get_name(self):
"""
获取此人的姓名。
返回：
str：此人的姓名。
"""
return self._name
def get_age(self):
"""
获取此人的年龄。
返回：
int：此人的年龄。
"""
return self._age
def set_age(self, new_age):
"""
更新此人的年龄。
参数：
new_age (int)：要设置的新年龄。
"""
self._age = new_age在上面的示例中，文档字符串清楚地解释了公共方法的目的、输入和输出，使用户更容易理解如何与 Person 类进行交互。
通过遵循这些准则，你可以为你的 Python 类定义一个设计良好的公共接口，使其更直观、更易于维护且更易于使用。
隐藏实现细节
隐藏类的实现细节是定义公共接口的一个关键方面。通过封装类的内部工作原理，你可以保护数据，并确保只能通过定义的公共接口来访问和修改它。
封装与数据隐藏
封装是面向对象编程的一个基本原则，有助于实现数据隐藏。它涉及将数据以及操作该数据的方法捆绑在一个单元（即类）中。
在 Python 中，你可以使用命名约定来指示类成员的预期可访问性级别。按照惯例，以单个前导下划线（_）开头的属性和方法被视为内部实现细节，应该仅在类内部或子类中访问。
class BankAccount:
def __init__(self, account_number, balance):
self._account_number = account_number
self._balance = balance
def deposit(self, amount):
"""
向账户存入指定金额。
参数：
amount (float)：要存入的金额。
返回：
float：更新后的账户余额。
"""
self._balance += amount
return self._balance
def withdraw(self, amount):
"""
从账户中取出指定金额。
参数：
amount (float)：要取出的金额。
返回：
float：更新后的账户余额。
"""
if self._balance >= amount:
self._balance -= amount
return self._balance
else:
return self._balance在上面的示例中，_account_number 和 _balance 属性以及 _update_balance() 方法被视为内部实现细节，不应从 BankAccount 类外部直接访问。
保护内部数据和方法
通过隐藏类的实现细节，你可以确保内部状态和逻辑只能通过定义的公共接口访问。这带来了几个好处：
- 数据完整性：限制对内部属性的直接访问可防止意外修改，确保数据保持有效状态。
- 灵活性：隐藏实现细节使你能够在不影响使用该类的代码的情况下更改类的内部逻辑，只要公共接口保持稳定即可。
- 可维护性：通过封装类的内部工作原理，你可以使代码在未来更易于理解、调试和修改。
class Rectangle:
def __init__(self, width, height):
self._width = width
self._height = height
def get_area(self):
"""
计算并返回矩形的面积。
返回：
float：矩形的面积。
"""
return self._width * self._height
def get_perimeter(self):
"""
计算并返回矩形的周长。
返回：
float：矩形的周长。
"""
return 2 * (self._width + self._height)
def _validate_dimensions(self):
"""
验证矩形的宽度和高度。
引发：
ValueError：如果宽度或高度为非正值。
"""
if self._width <= 0 or self._height <= 0:
raise ValueError("Width and height must be positive values.")在上面的示例中，_validate_dimensions() 方法是一个内部实现细节，用于确保 Rectangle 对象尺寸的完整性。通过隐藏此方法，你可以防止对内部状态的直接访问和操作，使类更健壮且易于维护。
通过仔细隐藏类的实现细节，你可以创建一个设计良好的公共接口，使代码的其他部分能够以可预测和可靠的方式与你的类进行交互。
总结
在本教程结束时，你将对如何为你的 Python 类定义公共接口有扎实的理解。你将学会只公开必要的方法，隐藏实现细节，并确保你的类易于使用和扩展。这些知识将帮助你编写更具模块化、可测试性和可扩展性的 Python 应用程序。
