Azure SDK for C IoTHub客户端无法获取含冒号格式设备ID的ClientID

问题根源 #

Azure IoT Hub允许创建含冒号的设备ID，但在生成MQTT连接所需的用户名时，设备ID中的冒号属于URL特殊字符，必须进行URL编码（将:替换为%3A）。Azure SDK for C的az_iot_hub_client_get_user_name函数不会自动处理设备ID的URL编码，直接使用带冒号的MAC地址作为设备ID时，会导致用户名生成失败，进而引发MQTT连接问题。

解决方案 #

在将MAC地址作为设备ID传入SDK前，手动对其中的冒号进行URL编码：

修改后的代码示例 #

#include <string>

// 替换MAC地址中的冒号为URL编码的%3A
std::string encode_mac(const std::string& mac) {
    std::string encoded = mac;
    size_t pos = 0;
    while ((pos = encoded.find(':', pos)) != std::string::npos) {
        encoded.replace(pos, 1, "%3A");
        pos += 3; // 替换后偏移量增加3（"%3A"的长度）
    }
    return encoded;
}

// 使用编码后的MAC地址作为设备ID
std::string uuid = "11:11:11:11:11:11";
std::string encoded_device_id = encode_mac(uuid);
static const char* device_id = encoded_device_id.c_str();

验证步骤 #

1. 无需修改IoT Hub中已注册的设备（IoT Hub会自动匹配编码后的设备ID）。
2. 重新调用az_iot_hub_client_get_user_name，此时应能正常生成符合要求的MQTT用户名。
3. 执行MQTT连接逻辑，验证连接是否成功。

补充说明 #

用MAC地址作为设备ID是合理的唯一标识方案，但需注意：IoT Hub设备ID在用于MQTT、HTTP等协议交互时，所有URL特殊字符（如:、/、%等）都需要手动进行URL编码，SDK不会自动处理这类编码操作。

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