重复逻辑提取后返回值没变,为什么还要数清副作用次数

本文通过Rust/Python风格的重构示例,探讨函数等价性不能仅依赖返回值一致,还需严格验证副作用(如事件记录)的次数、内容与顺序。构造了共享逻辑提取场景,指出错误提取将副作用混入纯函数导致重复记录,违反接口契约;强调测试必须断言事件列表长度、元素及发生序,尤其在成功与失败路径下保持行为一致性。

重构前后都返回hi,测试就能宣布等价吗?如果函数还会记录一条动作,重复记录也是行为变化。本文构造两个本地入口store与queue,共享去空白和非空检查;名字只表示教学分支,动作只是向传入列表追加元组,没有真实存储、消息投递或外部通知。这样能用最小例子观察副作用,而不借用虚构项目经历。

合同要求mode只在两个允许值中选择,raw必须是内置字符串且去首尾空白后非空。成功返回规范化文本,并且恰好追加一条(mode,文本)事件;失败抛ValueError,事件列表保持不变。错误字段和信息在这次重构中也保持一致。我们不添加自动重试、默认模式或吞异常返回空串,因为这些都不是“把重复代码提出来”的必要变化。

重构前的两个入口在示例中合并为一个按mode区分的原函数,重复的本质是每个调用都要先检查再规范化,再记录自己的动作。正确提取只把纯文本规则放进checked_note,入口仍负责一次事件记录。构造的错误改法让helper职责里也混入记录,调用方又照旧记录,于是同一次成功多出第二条完全相同的事件。

纯校验helper与一次事件记录的调用链

def checked_note(raw):
    if type(raw) is not str or not raw.strip():
        raise ValueError('nonempty string required')
    return raw.strip()

def original_note(mode, raw, events):
    if mode not in ('store', 'queue'):
        raise ValueError('unknown mode')
    if type(raw) is not str or not raw.strip():
        raise ValueError('nonempty string required')
    normalized = raw.strip()
    events.append((mode, normalized))
    return normalized

def refactored_note(mode, raw, events, wrong_double=False):
    if mode not in ('store', 'queue'):
        raise ValueError('unknown mode')
    normalized = checked_note(raw)
    if wrong_double:
        events.append((mode, normalized))  # misplaced helper-side effect
    events.append((mode, normalized))
    return normalized

for mode in ('store', 'queue'):
    for wrong in (True, False):
        events = []
        result = refactored_note(mode, ' hi ', events, wrong)
        print(mode, 'wrong' if wrong else 'correct', result, events)
events = []
try:
    refactored_note('store', '  ', events)
except ValueError as error:
    print('invalid:', type(error).__name__, 'events:', events)

本地实际输出:

store wrong hi [('store', 'hi'), ('store', 'hi')]
store correct hi [('store', 'hi')]
queue wrong hi [('queue', 'hi'), ('queue', 'hi')]
queue correct hi [('queue', 'hi')]
invalid: ValueError events: []

这份可运行示例把错误helper侧动作放在注释标明的一行,便于与纯helper分开比较。打印中wrong和correct都返回hi,但wrong的事件序列有两项。若测试只用assert result=='hi',两者都通过;必须另断言事件条数、内容和顺序。内容相同不代表重复无害,接口已经明确每次成功只记录一条,不能由实现者替调用方决定它是否能够去重。

失败路径同样要观察。传入全空白时,checked_note在追加前抛错,所以事件列表为空。若提取时把“开始处理”的记录提前写入公共helper,就会改变失败也有副作用的合同。这里没有禁止一切前置日志,而是说本接口原来承诺失败不记这类事件;若要增加审计记录,应先明确它属于另一条行为规则,再单独评审和测试。

独立比较把调用当成可观察对象:成功时记录返回值,失败时记录异常类型和信息,另外保存完整事件序列。对三个mode候选和七种raw候选做21组调用,包含有效文本、空串、空白、非字符串及未知模式,原实现与正确提取版逐项一致。每次创建新事件列表,不能让前一例留下的事件影响后一例的数量判断。

样本很小,主要职责是守住调用方能看到的行为,不是在证明任何函数重构工具都正确。有限对照没有涉及并发、真实队列重试或持久化失败。若以后事件存储本身可能抛错,还需要决定返回与记录谁先完成、错误怎样传播;当前内存列表让这个层次保持简单,避免用多余基础设施掩盖一次与两次的区别。

对长度m的字符串,去空白检查与规范化最多做常数次扫描,时间O(m),返回文本最坏占O(m);事件只新增一项,保存的是规范化字符串引用。提取后的性能不是本次评价重点,也没有测得收益。代码评审真正要问的是:哪些逻辑可以纯化,哪一层仍拥有副作用,入口有没有重复执行同一个动作。先回答这三个问题,才能让“公共helper更短”对应到行为保持,而不是只对应文件里的行数变化。

比较异常时保留类型和信息,是因为调用方可能根据错误信息定位参数;比较事件时保留原顺序,是因为排序后再比会丢掉动作发生次序。当前每次只应有一条事件,看似不需要顺序约束,但把观察格式固定下来,之后增加合法多步动作时就不会临时换一套宽松断言。成功、失败和副作用都应来自同一次调用,不能分开调用函数再拼接结果。

参考与核验:Python str.strip。示例合同、推导与有限验证范围均在正文明确。

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值