# xmlbuilder 中文文档

规范地址：https://npmcn.com/package/xmlbuilder/

版本：15\.1\.1
npm 元数据更新时间：2023-07-12T19:14:12.127Z
中文译文更新时间：2026-11-05T15:19:14.277Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/xmlbuilder
原文对照：https://npmcn.com/package/xmlbuilder/?lang=original
项目主页：http://github.com/oozcitak/xmlbuilder-js
源码仓库：https://github.com/oozcitak/xmlbuilder-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：321 kB，50 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=8\.0
- 运行依赖：0 个
- 首次发布：2010-12-28T13:44:59.957Z
- 最新版本发布：2020-04-08T22:47:03.171Z
- 近 30 天下载量：367375561（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：98（近 12 个月 0 个）

## 中文简介

一个用于节点.js的 XML 构建器

## 安装

```sh
npm install xmlbuilder
```

也可以使用：`pnpm add xmlbuilder`、`yarn add xmlbuilder`、`bun add xmlbuilder`

## README

# xmlbuilder-js 创建器

用于 XML 构建器 [节点.js](https://nodejs.org/) 类似 [java-xml 建设器](https://github.com/jmurty/java-xmlbuilder)。 。 。 .

[![License](http://img.shields.io/npm/l/xmlbuilder.svg?style=flat-square)](http://opensource.org/licenses/MIT) [![NPM Version](http://img.shields.io/npm/v/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder) [![NPM Downloads](https://img.shields.io/npm/dm/xmlbuilder.svg?style=flat-square)](https://npmjs.com/package/xmlbuilder)

[![Travis Build Status](http://img.shields.io/travis/oozcitak/xmlbuilder-js.svg?style=flat-square)](http://travis-ci.org/oozcitak/xmlbuilder-js) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/bf7odb20hj77isry?svg=true)](https://ci.appveyor.com/project/oozcitak/xmlbuilder-js) [![Dev Dependency Status](http://img.shields.io/david/dev/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://david-dm.org/oozcitak/xmlbuilder-js) [![Code Coverage](https://img.shields.io/coveralls/oozcitak/xmlbuilder-js.svg?style=flat-square)](https://coveralls.io/github/oozcitak/xmlbuilder-js)

### 宣告 `xmlbuilder2`数字 :

新发布的 `xmlbuilder` 备查 [`xmlbuilder2`](https://github.com/oozcitak/xmlbuilder2)来啊! `xmlbuilder2` 已经从地面重新设计,使其完全符合 [现代 DOM 规格](https://dom.spec.whatwg.org/)。它支持 XML 命名空间,为多种格式、收集功能和其他功能提供内置转换器。 请看 [从 xml 构建器升级](https://oozcitak.github.io/xmlbuilder2/upgrading-from-xmlbuilder.html) 在维基文库中.

新的发展将侧重于 `xmlbuilder2`· ; `xmlbuilder` 只接收关键错误修正.

### 安装 :

```sh
npm install xmlbuilder
```

### 用法 :

```js
var builder = require('xmlbuilder');

var xml = builder.create('root')
  .ele('xmlbuilder')
    .ele('repo', {'type': 'git'}, 'git://github.com/oozcitak/xmlbuilder-js.git')
  .end({ pretty: true});

console.log(xml);
```

将产生:

```xml
<?xml version="1.0"?>
<root>
  <xmlbuilder>
    <repo type="git">git://github.com/oozcitak/xmlbuilder-js.git</repo>
  </xmlbuilder>
</root>
```

也可以将对象转换为节点:

```js
var builder = require('xmlbuilder');

var obj = {
  root: {
    xmlbuilder: {
      repo: {
        '@type': 'git', // attributes start with @
        '#text': 'git://github.com/oozcitak/xmlbuilder-js.git' // text node
      }
    }
  }
};

var xml = builder.create(obj).end({ pretty: true});
console.log(xml);
```

如果你需要做一些处理:

```js
var builder = require('xmlbuilder');

var root = builder.create('squares');
root.com('f(x) = x^2');
for(var i = 1; i <= 5; i++)
{
  var item = root.ele('data');
  item.att('x', i);
  item.att('y', i * i);
}

var xml = root.end({ pretty: true});
console.log(xml);
```

这将产生:

```xml
<?xml version="1.0"?>
<squares>
  <!-- f(x) = x^2 -->
  <data x="1" y="1"/>
  <data x="2" y="4"/>
  <data x="3" y="9"/>
  <data x="4" y="16"/>
  <data x="5" y="25"/>
</squares>
```

见 [维基百科](https://github.com/oozcitak/xmlbuilder-js/wiki) 详细情况 [实例](https://github.com/oozcitak/xmlbuilder-js/wiki/Examples) 用于比较复杂的实例.

## 常见问题

### xmlbuilder 是什么？

一个用于节点\.js的 XML 构建器

### 如何安装 xmlbuilder？

在项目目录运行 npm install xmlbuilder，或使用 pnpm add / yarn add / bun add。

### xmlbuilder 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### xmlbuilder 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### xmlbuilder 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### xmlbuilder 可以商用吗？

xmlbuilder 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### xmlbuilder 的下载量有多少？

根据 npm 官方下载统计，xmlbuilder 在 2026/10/06 – 2026/11/04 这 30 天内被下载 367,375,561 次，日均约 12,245,852 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### xmlbuilder 还在维护吗？

最新版本 15\.1\.1 发布于 2020/04/09（6 年前）；至今共发布 98 个版本，其中过去 12 个月发布了 0 个；首次发布于 2010/12/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。