SOAP API调用时System.Net.WebException错误响应流出现BOM字符问题

问题原因分析 #

• 服务端返回逻辑差异：少数API在抛出异常时的错误响应本身就携带了UTF-8 BOM头（字节序列为0xEF 0xBB 0xBF），正常接口返回时服务端未加BOM，因此仅少数异常请求会出现该问题。多数服务端框架（如ASP.NET自定义错误页、Nginx默认错误响应）在返回错误内容时会默认携带BOM，正常业务接口返回则通常不会添加。
• 编码识别逻辑缺陷：你当前代码中固定使用Encoding.UTF8初始化StreamReader，如果服务端异常响应实际使用UTF-16/UTF-32编码且携带对应BOM，固定UTF8解码会导致BOM无法被识别为字节序标记，直接被当成普通内容字符解析到结果中。
• 处理逻辑差异导致的感知差异：正常请求的响应是直接通过CopyTo写入文件流，未做编码转字符串处理，即使响应携带BOM也会直接写入文件，不会被你感知到；而异常响应需要转成字符串读取，BOM就会以特殊字符的形式出现在字符串开头。
• 响应头编码不匹配：部分异常场景下服务端返回的Content-Type响应头未指定编码，或指定编码和实际返回的内容编码不一致，导致固定UTF8解码逻辑无法正确识别BOM标记。

修复方案 #

• 显式开启StreamReader的编码自动检测功能，修改初始化代码为：

using (var streamReader = new StreamReader(ex.Response.GetResponseStream(), Encoding.UTF8, detectEncodingFromByteOrderMarks: true))
{
    responseMessage = streamReader.ReadToEnd();
}

该配置会自动识别常见编码的BOM标记并自动跳过，不会将其解析为内容字符。

• 兜底手动去除BOM字符，拿到结果后添加处理逻辑：

// 去除所有UTF系列编码的BOM对应字符
responseMessage = responseMessage.TrimStart('\uFEFF');

• 优先从响应头Content-Type中提取编码信息，动态指定给StreamReader，避免固定编码导致的解析错误。

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