Python3.8中无需大规模重构即可替代全局变量的计数方案

你可能忽略的潜在问题 #

• 可测试性差：单元测试B函数或者相关调用链路时，全局计数器会在多个测试用例间共享状态，测试结果会互相干扰，必须额外添加重置计数器的逻辑，遗漏就会导致用例结果不准确。
• 线程/协程不安全：如果后续项目需要引入多线程、协程并行执行逻辑，无锁保护的全局计数器会出现计数丢失、结果不准的问题，这类并发问题排查成本极高。
• 状态隐性不可见：B的函数签名没有任何信息表明它会修改全局状态，后续维护代码的开发者很难第一时间察觉到B的调用会影响计数器结果，调整调用逻辑时极易引入bug。
• 扩展性不足：如果后续需求变为需要统计不同业务链路下的B成功次数（比如单独统计A调用链路、单独调用D的链路的计数），全局计数器完全无法支持这类需求，到时重构的成本会比现在高得多。

低改造成本的替代方案 #

不用全量修改整个调用链路的参数和返回值，以下方案改动量和现有全局变量方案几乎一致，同时规避大部分裸全局变量的问题：

方案1：绑定函数属性（改动最小，仅修改3行左右代码） #

直接把计数器作为B函数自身的属性，不占用全局命名空间，状态和B强绑定，代码清晰：

def B():
    ...
    if success:
        B.counter += 1 
    ...
    
# 初始化计数器
B.counter = 0

# 读取计数的地方直接调用B.counter即可

不需要修改任何其他调用B的函数，也不需要global声明，成本极低。

方案2：封装独立计数类（扩展性最优） #

如果后续有扩展计数逻辑的需求，可以封装一个极简的计数类，所有计数逻辑收拢在类内部，方便后续加锁、添加多维度统计、重置逻辑等：

class SuccessCounter:
    _count = 0
    
    @classmethod
    def incr(cls):
        cls._count += 1
    
    @classmethod
    def get(cls):
        return cls._count
        
    # 后续要加测试用的重置逻辑也很方便
    @classmethod
    def reset(cls):
        cls._count = 0

B函数成功时调用SuccessCounter.incr()即可，读取计数时调用SuccessCounter.get()，同样不需要修改其他上层调用函数。

后续迭代建议 #

如果后续有重构计划、或者需要支持多链路独立计数的需求，再逐步改用依赖注入、返回值传递的方案即可，当前阶段用上面两种方案完全可以平衡开发成本和代码规范。

内容的提问来源于stack exchange，提问作者John McGreen