Python 如何从Python类中暴露只读字段

在本文中，我们将介绍如何在Python类中暴露只读字段。只读字段是指不能被外部修改的类属性。有时候，我们希望某些属性只能被读取，而不能被修改。这在保护数据的完整性和提供可靠的编程接口方面非常有用。

1. 使用@property装饰器

@property装饰器是Python中用于定义只读属性的一种方式。它允许我们定义一个方法，该方法将作为属性的访问器。使用@property装饰器，我们可以将一个方法定义为属性，并在外部访问时以属性的方式调用该方法。

下面是一个使用@property装饰器定义只读属性的示例：

class Circle:
    def __init__(self, radius):
        self._radius = radius

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

    @property
    def area(self):
        return 3.14 * self._radius**2

circle = Circle(5)
print(circle.radius)  # 输出：5
print(circle.area)  # 输出：78.5
circle.radius = 10  # 报错：can't set attribute

在上面的示例中，我们定义了一个Circle类，其中包含一个只读属性radius和一个只读属性area。radius方法使用@property装饰器定义，它返回私有属性_radius的值。area方法也使用@property装饰器定义，它返回根据半径计算的圆的面积。

通过使用@property装饰器，我们可以将方法访问属性的方式隐藏起来，使其看起来像一个普通的属性访问。在外部访问时，我们只需要调用circle.radius和circle.area即可获得相应的值。

2. 使用getter方法

除了@property装饰器，我们还可以使用getter方法实现只读属性。getter方法是一个普通的方法，用于获取属性的值。通过定义一个getter方法，我们可以在外部通过调用该方法来获取属性的值。

下面是一个使用getter方法定义只读属性的示例：

class Rectangle:
    def __init__(self, length, width):
        self._length = length
        self._width = width

    def get_length(self):
        return self._length

    def get_width(self):
        return self._width

rectangle = Rectangle(4, 5)
print(rectangle.get_length())  # 输出：4
print(rectangle.get_width())  # 输出：5
rectangle.get_length = 6  # 报错：'Rectangle' object attribute 'get_length' is read-only

在上面的示例中，我们定义了一个Rectangle类，其中包含两个只读属性length和width。通过定义get_length和get_width方法，我们可以在外部调用这些方法来获取属性的值。

与@property装饰器不同，使用getter方法的好处是可以更灵活地控制属性的访问方式。我们可以在getter方法中添加一些逻辑，对获取属性的过程进行进一步处理。

3. 使用只读属性类

除了使用@property装饰器和getter方法外，我们还可以通过编写一个只读属性类来实现只读字段的功能。只读属性类是一个自定义的类，它封装了属性的读取过程，并提供了只读的接口。

下面是一个使用只读属性类实现只读字段的示例：

class ReadOnlyAttribute:
    def __init__(self, value):
        self._value = value

    def __get__(self, obj, objtype):
        return self._value

class Book:
    title = ReadOnlyAttribute("Python Hacks")
    author = ReadOnlyAttribute("David Ascher")

book = Book()
print(book.title)  # 输出：Python Hacks
print(book.author)  # 输出：David Ascher
book.title = "Python Cookbook"  # 报错：can't set attribute

在上面的示例中，我们定义了一个只读属性类ReadOnlyAttribute。该类包含一个__get__方法，用于获取属性的值。在Book类中，我们将title和author属性定义为只读属性，它们的值通过ReadOnlyAttribute类进行封装。

通过使用只读属性类，我们可以将只读字段的管理逻辑与实际的类分离，提高代码的可维护性和可重用性。