SQL转XML抛出‘未声明前缀’解析异常的原因及环境排查

开发C#命令行工具处理DELFOR消息文本文件，将数据存入SQL Server专用表后，调用自定义SQL函数ufn_delfor_message_to_xml(@message_reference_number, ...)将关联表数据转为XML格式存储时，抛出异常：

System.Data.SqlClient.SqlException: 'XML parsing: line 1, character 16, undeclared prefix'

该问题可脱离C#代码在SSMS中复现：

• 执行以下代码时正常：

DECLARE @message_reference_number varchar(55) = '1_022723.4443311'
DECLARE @xml_nad_info XML = '<delfor_nad_info><nad_info><party_identifier>0941B66333840</party_identifier><name>22723</name><street>xxxxxx</street><city>yyy</city><postal_code>08191</postal_code><country_identifier>ES</country_identifier><duns></duns><created>2022-09-06T20:02:46</created></nad_info></delfor_nad_info>'

DECLARE @x xml
SET @x = dbo.ufn_delfor_message_to_xml(@message_reference_number, @xml_nad_info)
SELECT @x

• 但直接执行SELECT dbo.ufn_delfor_message_to_xml(@message_reference_number, @xml_nad_info)时触发相同异常。

用户反馈旧环境下同类工具无此问题，需排查异常原因、新旧环境差异及新环境限制。完整SQL函数代码如下：

CREATE FUNCTION dbo.ufn_delfor_message_to_xml
    (@message_reference_number varchar(55),  -- grp+UNH+documentID
     @xml_nad_info XML)
RETURNS XML
AS
BEGIN
    DECLARE @xml_scheduling XML = (
    SELECT -- [message_reference_number],
           --,[document_id],
           --,[line_item_identifier],
           --[item_identifier_by_buyer],
           delivery_plan_commitment_level_code,
           datetime1,
           datetime1_function_code_qualifier,
           frequency_code,
           quantity,
           unit_code,
           datetime2_function_code_qualifier,
           datetime2
      FROM delfor_scheduling_data AS scheduling
     WHERE message_reference_number = @message_reference_number
     ORDER BY datetime1
       FOR XML AUTO, ELEMENTS)
    -- SELECT @xml_scheduling

    DECLARE @xml_result XML

    ;WITH XMLNAMESPACES ('http://schema.xxxxxxx.xx/dm/externalMessage' AS dat)
    SELECT @xml_result = (
    SELECT [interchange_sender],
           [interchange_recipient],
           [datetime_of_preparation],
           [interchange_control_reference_id],
           [dat:work_order].[message_reference_number],
           [dat:work_order].[document_id],
           [message_function_code],
           [document_issue_datetime],
           [type_of_instruction],
           [dat:work_order].grp,
           [dat:work_order].[seller_identifier],
           [dat:work_order].[shipfrom_identifier],
           [dat:work_order].[plant_identifier],
           [dat:work_order].[buyer_identifier],
           @xml_nad_info,
           [dat:detail].shipto_identifier,
           [dat:detail].[item_identifier_by_buyer],
           [dat:detail].[item_identifier_by_seller],
           [dat:detail].[engineering_change_number],
           [dat:detail].[other_material_characteristics],
           [dat:detail].[material_description],
           [dat:detail].[is_supply_for_consignment],
           [dat:detail].[location_of_discharge_code],
           [dat:detail].[purchase_order_number],
           [dat:detail].[document_line_identifier],
           [dat:detail].[transport_document_reference],
           [dat:detail].[new_delivery_schedule_number],
           [dat:detail].[new_delivery_instruction_date],
           [dat:detail].[previous_delivery_schedule_number],
           [dat:detail].[previous_delivery_instruction_date],
           [dat:detail].[planner_contact_employee_code],
           [dat:detail].[planner_contact_employee_name],
           [dat:detail].[cumulative_quantity_received],
           [dat:detail].[cumulative_quantity_received_unit_code],
           [dat:detail].[cumulative_quantity_received_date],
           [dat:detail].[cumulative_quantity_scheduled],
           [dat:detail].[cumulative_quantity_scheduled_unit_code],
           [dat:detail].[cumulative_quantity_scheduled_date],
           [dat:detail].[cumulative_quantity_received_and_accepted],
           [dat:detail].[cumulative_quantity_received_and_accepted_unit_code],
           [dat:detail].[last_received_delivery_note_number],
           [dat:detail].[last_received_delivery_note_date],
           @xml_scheduling AS [dat:address_info]
      FROM delfor_message_info AS [dat:work_order]

           JOIN delfor_scheduled_article_details AS [dat:detail]
           ON [dat:detail].message_reference_number = [dat:work_order].message_reference_number
              AND [dat:detail].document_id = [dat:work_order].document_id
              AND [dat:work_order].message_reference_number = @message_reference_number

       FOR XML AUTO, ELEMENTS
    )
    RETURN @xml_result
END

1. XML命名空间作用域问题 #

函数中用;WITH XMLNAMESPACES声明了dat前缀的命名空间，但直接执行SELECT函数返回值时，SQL Server会对返回的XML做即时解析验证。函数内部生成的XML中，dat前缀的命名空间仅在FOR XML语句的作用域内生效，生成的XML根节点并未包含该命名空间的声明，导致解析器无法识别dat前缀。

而通过SET @x = 函数调用再SELECT @x的方式，SQL Server先将XML结果存入变量，此时不会触发即时的命名空间验证（变量存储的是原始XML文本结构），后续查询仅展示内容，不会强制验证命名空间完整性。

2. 新旧环境差异 #

• SQL Server版本差异：旧环境可能使用SQL Server 2012及更早版本，这类版本对XML返回值的验证逻辑更宽松，不会强制检查顶级元素的命名空间声明；新环境使用SQL Server 2016+版本，XML验证规则更严格，会强制检查所有前缀对应的命名空间是否已声明。
• 数据库配置差异：新环境可能开启了SET XACT_ABORT ON或其他严格的XML解析选项，或数据库的COMPATIBILITY_LEVEL设置为更高级别，高兼容性级别会启用更严格的XML验证。

1. 确保XML根节点包含命名空间声明 #

修改函数中的FOR XML语句，明确指定根节点并包含命名空间，示例如下：

;WITH XMLNAMESPACES ('http://schema.xxxxxxx.xx/dm/externalMessage' AS dat)
SELECT @xml_result = (
SELECT 
    -- 保留原有字段列表
FOR XML AUTO, ELEMENTS, ROOT('dat:delfor_message')
)

生成的XML根节点会自带dat前缀的命名空间声明，解析器能正常识别所有dat前缀元素。

2. 规范嵌入XML变量的命名空间处理 #

对于@xml_nad_info和@xml_scheduling变量，若需要嵌入到带命名空间的XML中，可将它们转换为带命名空间的节点，或确保其结构不与外层命名空间冲突。例如，将无命名空间的@xml_nad_info嵌入时，可显式声明默认命名空间避免冲突。

3. 调整数据库兼容性级别（临时方案） #

若必须兼容旧环境逻辑，可尝试将数据库的COMPATIBILITY_LEVEL调整为旧环境对应的版本（如110对应SQL Server 2012），但不推荐长期使用，会影响新特性的支持。

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