PyModbus中ModbusSlaveContext默认数据块共享问题解析

问题背景

在PyModbus项目中，当开发者创建多个ModbusSlaveContext实例时，可能会遇到一个隐蔽但重要的问题：默认情况下，这些实例会共享相同的数据块(DataBlock)。这意味着不同Modbus从站设备对寄存器的读写操作会相互干扰，导致数据不一致。

问题本质

这个问题的根源在于Python的函数默认参数特性。在Python中，函数的默认参数是在函数定义时(即解释器解析函数时)被求值并创建的，而不是在每次函数调用时。当默认参数是可变对象时，所有使用默认参数的调用都会共享同一个对象。

在ModbusSlaveContext的初始化方法中，di、co、ir和hr四个参数都使用了ModbusSequentialDataBlock.create()作为默认值。由于create()方法返回的是一个可变对象，因此所有未显式指定这些参数的ModbusSlaveContext实例都会共享相同的四个数据块实例。

问题重现

通过以下代码可以清晰地重现这个问题：

from pymodbus.datastore import ModbusSlaveContext

# 创建两个ModbusSlaveContext实例
context1 = ModbusSlaveContext()
context2 = ModbusSlaveContext()

# 检查它们是否共享相同的数据块
print(context1.store["d"] is context2.store["d"])  # 输出True

# 修改context1的数据会影响context2
context1.setValues(fc_as_hex=3, address=1, values=[1,1,1])
print(context2.getValues(fc_as_hex=3, address=1, count=3))  # 输出[1,1,1]

解决方案

要解决这个问题，可以采用以下几种方法：

1. 修改ModbusSlaveContext初始化方法：将默认参数改为None，然后在方法内部创建新的数据块实例。这是最彻底的解决方案。

def __init__(self, *_args,
                di: ModbusSequentialDataBlock=None,
                co: ModbusSequentialDataBlock=None,
                ir: ModbusSequentialDataBlock=None,
                hr: ModbusSequentialDataBlock=None,
                zero_mode=False):
    self.store = {
        "d": di or ModbusSequentialDataBlock.create(),
        "c": co or ModbusSequentialDataBlock.create(),
        "i": ir or ModbusSequentialDataBlock.create(),
        "h": hr or ModbusSequentialDataBlock.create()
    }
    self.zero_mode = zero_mode

2. 显式传递数据块参数：在创建ModbusSlaveContext实例时，显式地为每个参数创建新的数据块。

from pymodbus.datastore import ModbusSequentialDataBlock

context1 = ModbusSlaveContext(
    di=ModbusSequentialDataBlock.create(),
    co=ModbusSequentialDataBlock.create(),
    ir=ModbusSequentialDataBlock.create(),
    hr=ModbusSequentialDataBlock.create()
)

context2 = ModbusSlaveContext(
    di=ModbusSequentialDataBlock.create(),
    co=ModbusSequentialDataBlock.create(),
    ir=ModbusSequentialDataBlock.create(),
    hr=ModbusSequentialDataBlock.create()
)

最佳实践

在开发多设备Modbus服务器时，建议遵循以下最佳实践：

1. 始终为每个Modbus从站设备创建独立的数据块实例
2. 如果使用默认构造函数，确保了解其共享数据块的行为
3. 在需要隔离数据的场景下，显式创建并传递数据块参数
4. 考虑使用工厂模式来创建具有独立数据块的ModbusSlaveContext实例

总结

PyModbus中ModbusSlaveContext的默认数据块共享行为是一个典型的Python可变默认参数陷阱。理解这一行为对于开发可靠的Modbus多设备服务器至关重要。通过适当的初始化方式或修改库代码，可以确保每个Modbus从站设备拥有独立的数据存储空间，避免意外的数据共享问题。