npm 包 json-stringify 使用教程

在前端开发中，常常需要将 JavaScript 对象转换成字符串进行传输或保存。而 JSON 格式是一种常见的字符串格式，因此在前端开发中使用 JSON 的地方也非常普遍。json-stringify 就是一个非常好用的 npm 包，可以方便地将 JavaScript 对象转换成 JSON 格式的字符串。

安装

使用 npm 安装：

npm install json-stringify --save

使用方法

引入 json-stringify 包：

const stringify = require('json-stringify');

简单使用

const data = {name: 'Tom', age: 18};
const jsonStr = stringify(data);
console.log(jsonStr);
// 输出：{"name":"Tom","age":18}

其他选项

除了简单的对象转 JSON 字符串，json-stringify 支持多种选项以及复杂对象的转换。

缩进

如果想让输出的 JSON 字符串更加美观，可以设置缩进：

const data = {name: 'Tom', age: 18};
const jsonStr = stringify(data, null, 2);
console.log(jsonStr);
// 输出：
// {
//   "name": "Tom",
//   "age": 18
// }

可以传入第二个参数 null 表示不使用 replacer 函数，第三个参数表示缩进的空格数。

字符串转义

默认情况下，stringify 不会对字符串进行转义。如果需要对字符串进行转义，可以使用 quote 选项：

const data = {name: 'To"m', age: 18};
const jsonStr = stringify(data, null, null, {quote: true});
console.log(jsonStr);
// 输出：{"name":"To\"m","age":18}

可以传入第四个参数 quote 为 true，表示要转义字符串。

排序

默认情况下，stringify 会按照对象属性的添加顺序输出。如果需要按照属性名称排序，可以使用 sort 选项：

const data = {name: 'Tom', age: 18, someProp: 'someValue'};
const jsonStr = stringify(data, null, null, {sort: true});
console.log(jsonStr);
// 输出：{"age":18,"name":"Tom","someProp":"someValue"}

可以传入第四个参数 sort 为 true，表示要按照属性名称排序。

复杂对象

如果遇到复杂的对象，可以使用 replacer 函数进行定制化处理。

例如，有一个包括函数的对象：

const data = {
  name: 'Tom',
  age: 18,
  func: function() {console.log('Hello world!')}
};

如果直接用 stringify 转换会出错，可以通过自定义 replacer 函数来解决：

-- -------------------- ---- -------
----- ------- - --------------- ----- ------ -- -
  -- ------- ----- --- ----------- -
    ------ -----------------
  - ---- -
    ------ ------
  -
-- ---
---------------------
-- ---
-- -
--   ------- ------
--   ------ ---
--   ------- --------- -- ------------------- ----------
-- -

在 replacer 函数中，可以对于需要特殊处理的属性进行定制化，返回值将会转换为 JSON 字符串。

总结

json-stringify 是一个非常方便好用的 npm 包，可以方便地将 JavaScript 对象转换成 JSON 字符串。同时，json-stringify 还支持多种选项以及复杂对象的转换。在前端开发中，使用 json-stringify 可以帮助开发者更加方便地进行数据的传输、存储等操作。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/77813