XML转JSON后TypeScript接口断言返回undefined问题排查

问题描述 #

我有如下结构的JSON数据，已定义对应的TypeScript接口，但使用xml2js将XML转换为JSON后，将结果断言为Root接口时始终返回undefined，请问为何接口与数据不匹配？求示例解决方案。

JSON数据 #

{"root": {"park": [{"DateTime": ["2024-0822T20:34:46"],"Name": ["0"],"Status": ["Open"],"Free": ["523"],"Total": ["596"],"Present": ["73"]},{"DateTime": ["2024-0822T20:34:46"],"Name": ["1"],"Status": ["Open"],"Free": ["151"],"Total": ["200"],"Present": ["49"]}]}}

已定义的TypeScript接口 #

export interface Root {
    root: Root2
}

export interface Root2 {
    park: Park[]
}

export interface Park {
    DateTime: string[]
    Name: string[]
    Status: string[]
    Free: string[]
    Total: string[]
    Present: string[]
}

处理XML转换的函数 #

try {
    xml2js.parseString(xmlString, {trim: true}, (error, result) => {
        if(error) {
            console.log(error);
            return undefined;
        } else {
           console.log('JSON: ' + JSON.stringify(result)); 
           return result as Root;     
        }
    });
} catch (e) {
    console.log(e);
    return undefined;
}

问题原因 #

1. 回调函数返回值无效：xml2js.parseString采用异步回调模式，回调函数内的return无法作为外层函数的返回值。外层函数执行完parseString后直接返回undefined，这才是返回undefined的核心原因，和接口本身匹配无关。
2. 潜在结构匹配风险：虽然示例JSON结构和接口定义一致，但xml2js默认配置下，若XML中某个字段只有单个元素，会被转为对象而非数组，可能导致后续结构不匹配（不过当前示例中不存在这个问题）。

解决方案 #

方案1：改用Promise版本处理异步 #

使用xml2js提供的parseStringPromise将异步操作转为Promise，可正确获取转换结果并断言类型：

import { parseStringPromise } from 'xml2js';

async function convertXmlToJson(xmlString: string): Promise<Root | undefined> {
    try {
        // 显式配置explicitArray确保字段始终以数组返回，匹配接口定义
        const result = await parseStringPromise(xmlString, { trim: true, explicitArray: true });
        console.log('JSON: ' + JSON.stringify(result));
        
        // 可选结构验证，避免类型断言不安全
        if (result.root?.park?.every(item => 
            Array.isArray(item.DateTime) && Array.isArray(item.Name) &&
            Array.isArray(item.Status) && Array.isArray(item.Free) &&
            Array.isArray(item.Total) && Array.isArray(item.Present)
        )) {
            return result as Root;
        }
        
        console.error('转换后的JSON结构不符合Root接口');
        return undefined;
    } catch (e) {
        console.error(e);
        return undefined;
    }
}

// 使用示例
// convertXmlToJson(yourXmlString).then(result => { /* 处理结果 */ });

方案2：调整回调函数使用方式 #

若坚持使用回调模式，需通过回调传递结果，而非直接返回：

function convertXmlToJson(xmlString: string, callback: (result: Root | undefined) => void) {
    xml2js.parseString(xmlString, { trim: true, explicitArray: true }, (error, result) => {
        if (error) {
            console.error(error);
            callback(undefined);
            return;
        }
        
        console.log('JSON: ' + JSON.stringify(result));
        
        // 结构验证
        if (result.root?.park?.every(item => 
            Array.isArray(item.DateTime) && Array.isArray(item.Name) &&
            Array.isArray(item.Status) && Array.isArray(item.Free) &&
            Array.isArray(item.Total) && Array.isArray(item.Present)
        )) {
            callback(result as Root);
        } else {
            console.error('JSON结构与Root接口不匹配');
            callback(undefined);
        }
    });
}

// 使用示例
convertXmlToJson(yourXmlString, (result) => {
    if (result) {
        // 处理符合接口的数据
        console.log(result.root.park);
    }
});

关键配置说明 #

添加explicitArray: true配置（xml2js默认值为true，显式声明更稳妥），确保XML中的所有字段无论出现次数多少，都以数组形式输出，完全匹配接口中string[]的类型定义。

内容的提问来源于stack exchange，提问作者Pasi-Markus Mäkelä