调用含自定义数据类型入参的open62541 Client方法失败排查

场景与环境 #

使用open62541客户端连接.NET OPC/UA服务器，尝试调用一个带有自定义结构体入参的方法，调用返回状态码2158690304，对应BadInvalidArgument。

方法与自定义类型定义 #

方法的XML定义：

<opc:Method SymbolicName="SetStatusMethodType" ModellingRule="Mandatory">
  <opc:InputArguments>
    <opc:Argument Name="Status" DataType="VisionStatusDataType" ValueRank="Scalar"/>
  </opc:InputArguments>
  <opc:OutputArguments />
</opc:Method>

自定义结构体VisionStatusDataType的XML定义：

<opc:DataType SymbolicName="VisionStatusDataType" BaseType="ua:Structure">
  <opc:ClassName>VisionStatus</opc:ClassName>
  <opc:Fields>
    <opc:Field Name="Camera" DataType="ua:Boolean" ValueRank="Scalar"/>
    <opc:Field Name="StrobeController" DataType="ua:Boolean" ValueRank="Scalar"/>
    <opc:Field Name="Server" DataType="ua:Boolean" ValueRank="Scalar"/>
  </opc:Fields>
</opc:DataType>

客户端编码与调用逻辑 #

当前将自定义结构体编码为UA_ExtensionObject再包装成UA_Variant的代码：

void encode(const QVariantList& vecqVar, size_t& nIdx, const DataType& dt, std::back_insert_iterator<std::vector<UAptr<UA_ByteString>>> itOut)
{
    if (dt.isSimple())
    {
        auto&& qVar = vecqVar.at(nIdx++);
        auto&& uaVar = convertToUaVar(qVar, dt.uaType());
        auto pOutBuf = create<UA_ByteString>();
        auto nStatus = UA_encodeBinary(uaVar.data, dt.uaType(), pOutBuf.get());
        statusCheck(nStatus);
        itOut = std::move(pOutBuf);
    }
    else
    {
        for (auto&& dtMember : dt.members())
            encode(vecqVar, nIdx, dtMember, itOut);
    }
}

UA_Variant ToUAVariant(const QVariant& qVar, const DataType& dt)
{
    if (dt.isSimple())
        return convertToUaVar(qVar, dt.uaType());
    else
    {
        std::vector<UAptr<UA_ByteString>> vecByteStr;
        auto&& qVarList = qVar.toList();
        size_t nIdx = 0UL;
        encode(qVarList, nIdx, dt, std::back_inserter(vecByteStr));

        auto pExtObj = UA_ExtensionObject_new();
        pExtObj->encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
        auto nSizeAll = std::accumulate(vecByteStr.cbegin(), vecByteStr.cend(), 0ULL, [](size_t nSize, const UAptr<UA_ByteString>& pByteStr) {
            return nSize + pByteStr->length;
        });
        auto&& uaEncoded = pExtObj->content.encoded;
        uaEncoded.typeId = dt.uaType()->typeId;
        uaEncoded.body.length = nSizeAll;
        auto pData = uaEncoded.body.data = new UA_Byte[nSizeAll];
        nIdx = 0UL;
        for (auto&& pByteStr : vecByteStr)
        {
            memcpy_s(pData + nIdx, nSizeAll - nIdx, pByteStr->data, pByteStr->length);
            nIdx += pByteStr->length;
        }

        UA_Variant uaVar;
        UA_Variant_init(&uaVar);
        UA_Variant_setScalar(&uaVar, pExtObj, &UA_TYPES[UA_TYPES_EXTENSIONOBJECT]);
        return uaVar;
    }
}

方法调用代码：

auto uavarInput = ToUAVariant(qvarArg, dtInput);
UA_Variant* pvarOut;
size_t nOutSize = 0UL;
auto nStatus = UA_Client_call(m_pClient, objNode.nodeId(), m_uaNodeId, 1UL, &uavarInput, &nOutSize, &pvarOut);

注：读取变量或处理输出参数时的反向解码逻辑可正常执行。

疑问 #

1. 方法入参的编码逻辑是否存在问题？应该传入ExtensionObject还是其他数据类型？
2. 使用.NET OPC/UA栈搭建的服务器是否可能存在配置错误？

问题排查与解决方案 #

1. 核心问题：自定义结构体编码逻辑错误 #

你的编码逻辑是将结构体成员逐个编码后拼接字节流，但OPC UA的结构体二进制编码要求是对整个结构体实例进行序列化，而非成员编码结果的简单拼接。

OPC UA结构体编码包含自身的类型标识、成员顺序对齐等规则，拆分成员编码再拼接的字节流不符合规范，服务器无法解析，因此返回BadInvalidArgument。

2. 正确的编码实现思路 #

对于自定义结构体，应直接构建结构体实例，再用对应的UA_DataType整体编码：

UA_Variant ToUAVariant(const QVariant& qVar, const DataType& dt) {
    if (dt.isSimple()) {
        return convertToUaVar(qVar, dt.uaType());
    } else {
        // 从QVariantList构建自定义结构体实例
        auto& qVarList = qVar.toList();
        UA_VisionStatusDataType status = UA_VisionStatusDataType_init();
        status.Camera = qVarList[0].toBool();
        status.StrobeController = qVarList[1].toBool();
        status.Server = qVarList[2].toBool();

        // 编码整个结构体实例
        UA_ByteString byteString = UA_BYTESTRING_NULL;
        UA_StatusCode encodeStatus = UA_encodeBinary(&status, dt.uaType(), &byteString);
        statusCheck(encodeStatus);

        // 构建ExtensionObject
        UA_ExtensionObject* extObj = UA_ExtensionObject_new();
        extObj->encoding = UA_EXTENSIONOBJECT_ENCODED_BYTESTRING;
        extObj->content.encoded.typeId = dt.uaType()->typeId;
        extObj->content.encoded.body = byteString;

        // 包装为Variant
        UA_Variant uaVar;
        UA_Variant_init(&uaVar);
        UA_Variant_setScalar(&uaVar, extObj, &UA_TYPES[UA_TYPES_EXTENSIONOBJECT]);
        return uaVar;
    }
}

3. ExtensionObject的使用正确性 #

对于自定义结构体类型，入参确实需要包装为UA_ExtensionObject再放入UA_Variant，这部分方向是对的，错误仅出在编码内容上。

4. .NET服务器的可能问题 #

如果修正编码后仍报错，需检查：

• 客户端使用的VisionStatusDataType节点ID（包括命名空间索引）与服务器端完全一致
• 服务器端方法的输入参数已正确绑定到VisionStatusDataType，无类型不匹配
• 服务器已显式注册该自定义类型，部分.NET OPC UA栈需手动注册自定义类型才能解析

5. 内存泄漏注意 #

调用完成后，需手动释放资源：

UA_Variant_delete(&uavarInput);
UA_ExtensionObject_delete((UA_ExtensionObject*)uavarInput.data);
UA_Variant_deleteArray(pvarOut, nOutSize);

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