如何写一个支持链式调用的类方法（return self）

  技术百科     |      2026-01-22 00:00
链式调用需方法返回self，仅修改状态的方法适用，查询方法应返回实际值；注意副作用、可读性与调试便利性。

让类方法支持链式调用，核心是每个方法最后 return self，使调用后仍返回当前实例对象，从而能继续调用其他方法。

基础写法：每个方法都返回 self

这是最直接的方式。只要方法不需返回其他语义结果（比如计算值），就统一返回 self：

  • 在方法末尾写 return self
  • 避免在中间 return 其他值（除非你明确要中断链式）
  • 注意：self 是当前实例，不是新对象，所以是“原对象上连续操作”

区分查询方法和修改方法

不是所有方法都适合链式。通常：

  • 修改类状态的方法（如设置属性、添加数据）可以返回 self，支持链式
  • 查询/获取结果的方法（如 get_name()、count()）应返回实际值，不参与链式
  • 如果想兼顾，可提供两个版本：例如 filter() 返回 self，filtered_list() 返回结果列表

注意可读性与副作用

链式调用虽简洁，但容易掩盖副作用或逻辑顺序：

  • 避免在链中做耗时或有外部依赖的操作（如网络请求、文件写入）
  • 方法名要清晰表达行为，比如 with_timeout(5).retry(3).execute() 比 set_t(5).set_r(3).

    run()     更易懂
  • 调试时，单步执行链式调用不如分步直观，必要时可拆开

一个简单示例

比如构建一个字符串处理器：

class StrBuilder:
    def __init__(self, text=""):
        self.text = text

def upper(self):
    self.text = self.text.upper()
    return self

def add(self, s):
    self.text += s
    return self

def len(self):  # 查询方法，不返回 self
    return len(self.text)
使用：


result = StrBuilder("hello").add(" world").upper().len()  # → 12