重构遗留代码：新希望

征程开启（“为什么”）我还记得第一次打开一个 2000 行的文件时……

Dev.to · Jul 30, 2026

征程开启（“为什么”）

我还记得第一次打开一个名叫 report_generator.py 的 2000 行文件时。它是一个被修修补补、调整、快速修复了多年的庞然大物。每次需要往 CSV 导出中添加新列时，我都得翻过无数 if/else 块、复制粘贴的片段，以及名为 tmp、data2、stuff 的变量。找了整整一个小时才找到日期格式化的地方，结果却引入了一个绕过测试的 bug，破坏了客户的发票。

那一刻感觉就像走进一个没有火把的漆黑洞穴。我知道代码“勉强”能用，但它脆弱、令人畏惧，每次改动都像拆弹。我问自己：怎样才能让这个怪物变得可维护，而不用从头重写？

答案不是什么花哨的框架或新语言，而是一个简单、可重复的习惯：提取小而专注的函数。

顿悟（洞见）

做法很简单：每当你看到一段代码在做一件逻辑上的事情——哪怕只有三行——就把它提取成一个独立的函数，并用描述它做什么而不是怎么做的名称来命名。

为什么这感觉像在废墟中找到光剑？

可读性飙升——函数名讲述故事，函数体提供细节。
测试变得简单——你可以单独对提取出来的部分进行单元测试。
未来修改更集中——如果日期格式发生变化，你只需要修改一个函数，而不是十处分散的代码。
重复减少——一旦提取，你会发现相同逻辑在其他地方也能复用。

如果你跳过这一步，就会得到“意大利面条代码”——一个职责被散落在多处。代价是什么？更多 bug、更长的 onboarding 时间，以及团队对碰触该文件的恐惧。我见过团队因为一次微小的改动需要运行全量回归测试而损失数周时间。

运用力量（代码与示例）

之前——挣扎

def generate_report(data):
    # 1. Filter active users
    active_users = []
    for u in data['users']:
        if u['status'] == 'active' and u['last_login'] > datetime.now() - timedelta(days=30):
            active_users.append(u)

    # 2. Compute totals
    total_sales = 0
    for u in active_users:
        for o in u['orders']:
            if o['date'].year == datetime.now().year:
                total_sales += o['amount']

    # 3. Format date for header
    header_date = datetime.now().strftime('%B %d, %Y')

    # 4. Build CSV lines
    lines = [f"Report generated on {header_date}"]
    lines.append("User ID, Name, Total Spent")
    for u in active_users:
        user_total = sum(o['amount'] for o in u['orders'] if o['date'].year == datetime.now().year)
        lines.append(f"{u['id']}, {u['name']}, {user_total:.2f}")

    lines.append(f"Grand Total Sales: {total_sales:.2f}")
    return "\n".join(lines)

Enter fullscreen mode Exit fullscreen mode

这里发生了什么？

该函数做了四件截然不同的事情：过滤、求和、格式化日期、组装 CSV 输出。
相同的年份检查逻辑出现了两次（一次用于销售额，一次用于每个用户）。
如果业务决定改变“活跃”定义（例如包含试用用户），你必须在两个循环中搜索，并可能遗漏某个位置。

之后——胜利

def _filter_active_users(users):
    """Return users who are active and logged in within the last 30 days."""
    cutoff = datetime.now() - timedelta(days=30)
    return [u for u in users if u['status'] == 'active' and u['last_login'] > cutoff]

def _yearly_total(orders):
    """Sum order amounts that fall in the current year."""
    now = datetime.now()
    return sum(o['amount'] for o in o['orders'] if o['date'].year == now.year)

def _format_header_date():
    return datetime.now().strftime('%B %d, %Y')

def generate_report(data):
    active_users = _filter_active_users(data['users'])
    header_date = _format_header_date()
    total_sales = _yearly_total([u['orders'] for u in active_users])  # flatten for simplicity

    lines = [f"Report generated on {header_date}"]
    lines.append("User ID, Name, Total Spent")
    for u in active_users:
        user_total = _yearly_total(u['orders'])
        lines.append(f"{u['id']}, {u['name']}, {user_total:.2f}")

    lines.append(f"Grand Total Sales: {total_sales:.2f}")
    return "\n".join(lines)

Enter fullscreen mode Exit fullscreen mode

发生了什么变化？

每个辅助函数只做一件事，并以该事命名。
年份过滤逻辑集中在 _yearly_total 中，如果规则变化只需修改一处。
主函数现在读起来像一份高层配方：过滤用户、获取表头、计算总额、构建行。
添加新列（例如“平均订单价值”）只需调用另一个小型辅助函数，无需深挖嵌套循环。

要避免的常见陷阱

过度提取：不要仅仅因为能提取就抽出一行；辅助函数应该增加清晰度，而不是噪音。
名称中泄露实现细节：get_data() 什么也没告诉我们；filter_active_users() 则准确说明了发生了什么。
忘记返回纯值：除非明确目的，辅助函数应避免副作用（如修改外部状态）。

当你遵守这些护栏时，提取出来的函数就成了可复用的积木——就像乐高积木，你可以在不破坏现有模型的情况下以新方式拼装。

为什么这种新力量很重要

在我开始严格提取方法之后，report_generator.py 文件从 2000 行缩减到约 650 行，团队信心大增。

缺陷率下降——因为每块代码都能在隔离状态下进行单元测试，我们在写入 CI 测试前就捕获了逻辑错误。
入职加速——新员工只需阅读顶层流程，就能了解模块的功能。
重构变得安全——我们可以通过修改单个函数，将日期格式化器换成支持时区的版本，所有调用者都会自动更新。

简而言之，提取方法将一个令人畏惧的遗留代码库变成了我真正享受修改的地方。这是一种每天都能带来回报的超能力。

轮到你了

在你当前的项目中挑选一个感觉像“上帝方法”的函数——那个做了一点所有事儿的函数。花十分钟把一块逻辑片段提取成命名良好的辅助函数。运行测试，看看清晰度如何提升，然后重复。

你打算重构的第一个函数是什么？在评论区分享你的前后对比片段——我很想听听你自己的“新希望”如何实现！🚀

Read the original source Next news