通过 Python 理解 Mixin 概念

Mixin 的概念

Mixin 即 Mix-in,常被译为“混入”,是一种编程模式,在 Python 等面向对象语言中,通常它是实现了某种功能单元的类,用于被其他子类继承,将功能组合到子类中。

利用 Python 的多重继承,子类可以继承不同功能的 Mixin 类,按需动态组合使用。

当多个类都实现了同一种功能时,这时应该考虑将该功能抽离成 Mixin 类。

举个例子

定义一个简单的类:

1
2
3
4
5
class Person:
def __init__(self, name, gender, age):
self.name = name
self.gender = gender
self.age = age

我们可以通过调用实例属性的方式来访问:

1
2
p = Person("小陈", "男", 18)
print(p.name) # "小陈"

然后我们定义一个 Mixin 类:

1
2
3
4
5
6
class MappingMixin:
def __getitem__(self, key):
return self.__dict__.get(key)

def __setitem__(self, key, value):
return self.__dict__.set(key, value)

这个类可以让子类拥有像 dict 一样调用属性的功能

我们将这个 Mixin 加入到 Person 类中:

1
2
3
4
5
class Person(MappingMixin):
def __init__(self, name, gender, age):
self.name = name
self.gender = gender
self.age = age

现在 Person 拥有另一种调用属性方式了:

1
2
3
p = Person("小陈", "男", 18)
print(p['name']) # "小陈"
print(p['age']) # 18

再定义一个 Mixin 类,这个类实现了 __repr__ 方法,能自动将属性与值拼接成字符串:

1
2
3
4
5
6
7
8
class ReprMixin:
def __repr__(self):
s = self.__class__.__name__ + '('
for k, v in self.__dict__.items():
if not k.startswith('_'):
s += '{}={}, '.format(k, v)
s = s.rstrip(', ') + ')' # 将最后一个逗号和空格换成括号
return s

利用 Python 的特性,一个类可以继承多个父类:

1
2
3
4
5
class Person(MappingMixin, ReprMixin):
def __init__(self, name, gender, age):
self.name = name
self.gender = gender
self.age = age

这样这个子类混入了两种功能:

1
2
3
p = Person("小陈", "男", 18)
print(p['name']) # "小陈"
print(p) # Person(name=小陈, gender=男, age=18)

总结

Mixin 实质上是利用语言特性,可以把它看作一种特殊的多重继承,所以它并不是 Python 独享,只要支持多重继承或者类似特性的都可以使用,比如 Ruby 中 include 语法,Vue 等前端领域也有 Mixin 的概念。

但 Mixin 终归不属于语言的语法,为了代码的可读性和可维护性,定义和使用 Mixin 类应该遵循几个原则:

  1. Mixin 实现的功能需要是通用的,并且是单一的,比如上例中两个 Mixin 类都适用于大部分子类,每个 Mixin 只实现一种功能,可按需继承。
  2. Mixin 只用于拓展子类的功能,不能影响子类的主要功能,子类也不能依赖 Mixin。比如上例中 Person 继承不同的 Mixin 只是增加了一些功能,并不影响自身的主要功能。如果是依赖关系,则是真正的基类,不应该用 Mixin 命名。
  3. Mixin 类自身不能进行实例化,仅用于被子类继承。

通过 Python 理解 Mixin 概念
https://zkqiang.cn/posts/d2d106a5/
作者
张凯强
发布于
2019年12月7日
许可协议