CODING 修炼小册

公共变量、私有变量、保护变量

# 公共变量、私有变量、保护变量

# 公共变量、方法

在 Python 的类里面，所有变量和方法默认都是公共的。

class Student(object):
    # 公共变量
    title = "学生"

    # 构造方法
    def __init__(self, name, age):
        self.name = name
        self.age = age

    # 公共方法
    def print_age(self):
        print('%s: %s' % (self.name, self.age))

s = Student("张三", 13)
print(s.title)
print(s.name)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

但 Python 也可以设置受保护、私有类型的变量或方法。

# 私有变量、方法

  • 在实际开发中，对象的某些变量或方法可能只希望在对象的内部被使用，而不希望在外部被访问到
  • 私有变量：就是对象不希望公开访问的变量
  • 私有方法：就是对象不希望公开访问的方法

# 定义方式

在 Java 语言中，有 private 关键字，可以将类的某些变量和方法设为私有，阻止外部访问。但是 Python 没有这个机制。

在 Python 中，定义私有变量和方法的方式是：在名字前加上两个下划线 __，这个成员就变成了一个私有成员（private）。私有成员只能在类的内部访问，外部无法访问。

并且，子类也无法访问父类的私有变量、方法，私有变量只有本类的内部能直接调用。

如下所示，在 Student 类中，title 可以在外部访问；而 __name 和 __age 由于加了两个下划线，已经变成了私有成员，只能在类的内部访问，外部访问时会报错。

class Student(object):
    title = "学生"

    def __init__(self, name, age):
        self.__name = name
        self.__age = age

    def print_age(self):
        print('%s: %s' % (self.__name, self.__age))

s = Student("张三", 13)
print(s.title)
print(s.__name) # 这里会报错
1
2
3
4
5
6
7
8
9
10
11
12
13

# 外部访问和修改私有成员

如果要在外部访问和修改类的私有成员，可以通过在类的内部创建 get 和 set 方法。这种设计思想在很多编程语言中都很常见。

如下代码所示：

class Student(object):
    title = "学生"

    def __init__(self, name, age):
        self.__name = name
        self.__age = age

    def print_age(self):
        print('%s: %s' % (self.__name, self.__age))

    def get_name(self):
        return self.__name

    def get_age(self):
        return self.__age

    def set_name(self, name):
        self.__name = name

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

s = Student("张三", 13)
s.get_name()
s.set_name("李四")
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

这样做，不但对数据进行了保护的同时也提供了外部访问的接口，而且在 get_name，set_name 这些方法中，可以额外添加对数据进行检测、处理、加工、包裹等等各种操作。

比如下面这个方法，会在设置年龄之前对参数进行检测，如果参数不是一个整数类型，则抛出异常。

def set_age(self, age):
    if isinstance(age, int):
        self.__age = age
    else:
        raise ValueError
1
2
3
4
5

# 私有成员的原理

其实 Python 中，并没有真正意义上的私有，为什么以双下划线开头的数据成员就不能从外部访问了呢？

以上面的代码为例，从内部机制原理讲，外部不能直接访问 __age 是因为 Python 解释器对外把 __age 变量改成了 _Student__age ，也就是 _类名__age（类名前是一个下划线）。因此，投机取巧的话，你可以通过 _Student__age 在类的外部访问 __age 变量。

知道了这样一个原理，我们就要规避这样一个问题：

s = Student("张三", 13)
s.__name = "李四"  # 注意这一行
1
2

注意上面第二行，千万不要写这样的代码，因为这相当于给 p 实例添加了一个新的实例变量 __name，而不是对原有私有成员 __name 重新赋值。

# 受保护的变量、方法

受保护的变量和方法在 Java 是用 protected 修饰的，而在 Python 中没有这个关键字。

在变量和方法前加一个下划线就是 protected 类型了，私有类型是两个下划线。

它的作用是：

  • 父类的 protected 变量，子类可以继承
  • 实例对象、类对象都能直接调用 protected 变量、方法

总的来说，和公共变量没有什么特别大的区别。

# 总结

无论是受保护型变量还是私有变量，其实在外部还是能访问的，所以并不能真正控制属性的访问权限。不过在代码可读性上，还是有帮助的。

下面总结下类的变量/方法与下划线：

  • _name、_name_、_name__：建议性的私有成员，不要在外部访问。
  • __name、 __name_：强制的私有成员，但是你依然可以蛮横地在外部危险访问。
  • __name__：特殊成员，与私有性质无关，尽量不要给自定义的成员这样命名，它们都是 Python 中具有特殊意义的魔法方法名。例如 __doc__。
  • name_、name__：没有任何特殊性，普通的标识符，但最好不要这么起名。

（完）

@property 装饰器