Node.js xml-writer：深度解析 XML 元素嵌套技巧与最佳实践

import { XMLWriter } from 'xml-writer';

/**
 * 创建一个空的 XML 文档，并添加一个根元素。
 * @param xw XMLWriter 实例。
 */
function createEmptyXML(xw: XMLWriter): void {
    xw.startDocument();
    // 创建 'Hello' 根元素并设置属性。
    // 注意：在这里我们尚未调用 endElement()，因为我们期望后续添加子标签。
    xw.startElement('Hello').writeAttribute('name', '_nameOfThePerson');
}

// 示例调用
const xw = new XMLWriter();
createEmptyXML(xw);
// 此时 XML 结构为：
// <?xml version="1.0"?>
// <Hello name="_nameOfThePerson"/>

/**
 * 向当前的 XMLWriter 上下文添加一个子标签。
 * @param xw XMLWriter 实例。
 * @param tagName 子标签的名称。
 * @param attrValue 子标签属性的值。
 */
function writeChildTag(xw: XMLWriter, tagName: string, attrValue: string): void {
    xw.startElement(tagName).writeAttribute('name', attrValue);
    // 同样，这里省略了 endElement()，期望在外部管理。
}

// 首次尝试：假设 xw 实例已经处于 'Hello' 标签的上下文中
// 调用 writeChildTag(xw, 'childTag', 'A');
// 期望输出：
// <?xml version="1.0"?>
// <Hello name="_nameOfThePerson">
//   <childTag name="A"/>
// </Hello>

// 第二次尝试：当再次调用 writeChildTag(xw, 'childTag', 'B'); 时，问题出现
// 实际输出可能变为：
// <?xml version="1.0"?>
// <Hello name="_nameOfThePerson">
//   <childTag name="A"/>
// </Hello>
// <childTag name="B"/>

import { XMLWriter } from 'xml-writer';

/**
 * 生成一个包含正确嵌套子标签的 XML 字符串。
 * @returns 生成的 XML 字符串。
 */
function generateXmlWithChildren(): string {
    const xw = new XMLWriter(true); // true 表示启用美化输出

    xw.startDocument();

    // 步骤2：创建父元素 'Hello' 并捕获其引用。
    // startElement() 方法返回当前元素实例，我们将其赋给 parentElement 变量。
    const parentElement = xw.startElement('Hello').writeAttribute('name', '_nameOfThePerson');

    // 步骤3：使用 parentElement 实例添加子元素。
    // 注意：在这里，我们直接在 parentElement 上调用 startElement()，
    // 并且为每个子元素调用 endElement() 以正确关闭标签。
    parentElement.startElement('childTag').writeAttribute('name', 'A').endElement();
    parentElement.startElement('childTag').writeAttribute('name', 'B').endElement();

    // 最后，确保关闭父元素和整个文档。
    parentElement.endElement(); // 关闭 'Hello' 标签
    xw.endDocument();           // 关闭文档

    return xw.toString();
}

const generatedXml = generateXmlWithChildren();
console.log(generatedXml);

<?xml version="1.0"?>
<Hello name="_nameOfThePerson">
    <childTag name="A"/>
    <childTag name="B"/>
</Hello>

import { XMLWriter } from 'xml-writer';

class XmlGeneratorService {
    private xw: XMLWriter;
    private currentParent: any; // 存储当前父元素的引用，可以是任何 XML 元素实例

    constructor() {
        this.xw = new XMLWriter(true); // 启用美化输出
    }

    /**
     * 初始化 XML 文档并创建根元素。
     */
    initializeXml(): void {
        this.xw.startDocument();
        // 创建根元素并存储其引用
        this.currentParent = this.xw.startElement('Hello').writeAttribute('name', '_nameOfThePerson');
    }

    /**
     * 向当前父元素添加一个子标签。
     * @param tagName 子标签的名称。
     * @param attrValue 子标签属性的值。
     */
    addChild(tagName: string, attrValue: string): void {
        if (!this.currentParent) {
            throw new Error('父元素未初始化。请先调用 initializeXml 方法。');
        }
        this.currentParent.startElement(tagName).writeAttribute('name', attrValue).endElement();
    }

    /**
     * 完成 XML 文档的生成并返回字符串。
     * @returns 最终生成的 XML 字符串。
     */
    finalizeXml(): string {
        if (this.currentParent) {
            this.currentParent.endElement(); // 关闭所有未关闭的父标签
        }
        this.xw.endDocument();
        return this.xw.toString();
    }
}

// 使用示例
const service = new XmlGeneratorService();
service.initializeXml();
service.addChild('childTag', 'A');
service.addChild('childTag', 'B');
const finalXml = service.finalizeXml();
console.log(finalXml);

import { XMLWriter } from 'xml-writer';

const xw = new XMLWriter(true);
xw.startDocument();

const helloElement = xw.startElement('Hello');
const parentChildElement = helloElement.startElement('ParentChild').writeAttribute('id', '1');
parentChildElement.startElement('Grandchild').writeAttribute('name', 'X').endElement();
parentChildElement.endElement(); // 关闭 ParentChild
helloElement.endElement(); // 关闭 Hello

xw.endDocument();
console.log(xw.toString());