当前位置：首页 > article >正文

前端的全栈混合之路Meteor篇（四）：支持自定义对象序列化的EJSON介绍

article 2024/10/8 8:29:57

简介

在Meteor框架中，EJSON（Extended JSON）是一个扩展了标准JSON的库，旨在支持更多的数据类型。标准JSON仅支持字符串、数字、布尔值、数组和对象等基本数据类型，而EJSON允许开发者在Meteor应用中传输更复杂的数据类型，例如Date、Binary数据，甚至是自定义对象。

EJSON的核心优势在于其可序列化和反序列化的能力，这使得Meteor在客户端和服务器之间传递复杂数据变得更加便捷和高效。

本文为Meteor全栈框架系列文之一，快速连接：

开发环境的搭建 -全局安装或使用docker镜像
浏览器端的数据库-MiniMongo
RPC方法注册及调用

在进行数据同步等时，往往需要向前端传递很多类型的数据，但对象的传输一般依赖于js runtime提供的JSON的stringify方法，但这个方法面对未定义toJSON方法的对象，例如Date时，会转化成一个字符串，反序列化parse时无法还原成Date，就可能存在一定的问题，或者每次都需要特殊处理。而Meteor则默认使用EJSON来序列化和反序列化，rpc返回的数据，调用rpc的参数等，都默认支持更多的类型-（例如二进制数据不需要转化成base64），所以了解下它的几个常用方法和如何自定义传输对象是很有用的–毕竟通过共享数据结构是可以提高开发效率的。

1 EJSON的接口

1.1 序列化`EJSON.stringify`

与标准的JSON.stringify类似，EJSON.stringify将EJSON对象序列化为字符串，但它能够处理更复杂的类型。
用法：

const obj = { name: "Meteor", date: new Date() };
const ejsonString = EJSON.stringify(obj);
console.log(ejsonString);

1.2 反序列化`EJSON.parse`

类似于JSON.parse，它从字符串中解析EJSON对象，支持对复杂类型的正确解析。
用法：

const ejsonString = '{"name":"Meteor","date":{"$date":1633029593494}}';
const parsedObj = EJSON.parse(ejsonString);
console.log(parsedObj);

1.3 对象克隆`EJSON.clone`

深度克隆一个EJSON对象，确保原始对象与副本完全独立。
用法：

const obj = { name: "Meteor", date: new Date() };
const clonedObj = EJSON.clone(obj);

1.4 对象比较`EJSON.equals`

用于比较两个EJSON对象，支持对日期、二进制数据等复杂数据类型的深度比较。
用法：

const obj1 = { name: "Meteor", date: new Date() };
const obj2 = EJSON.clone(obj1);
console.log(EJSON.equals(obj1, obj2)); // true

1.5 `EJSON.isBinary`

检查给定值是否为EJSON的二进制数据。
用法：

const binary = EJSON.newBinary(10);
console.log(EJSON.isBinary(binary)); // true

1.6 自定义类型注册`EJSON.addType`

用于定义和注册自定义类型，以便EJSON可以序列化和反序列化这些类型。
用法：

class CustomType {
  constructor(value) {
    this.value = value;
  }

  // 将自定义类型转换为普通对象
  toJSONValue() {
    return { value: this.value };
  }

  // 从普通对象恢复自定义类型
  static fromJSONValue(obj) {
    return new CustomType(obj.value);
  }
}

// 注册自定义类型
EJSON.addType('CustomType', CustomType);

2 自定义对象的传输

EJSON提供了内置的扩展机制，使得开发者可以轻松地定义自己的对象类型并在客户端与服务器之间传输。要实现自定义对象的传输，开发者需要遵循以下步骤：

2.1 创建自定义类型

创建一个自定义类，并实现两个核心方法：

toJSONValue()：将对象的实例转换为普通的JSON结构，便于传输。
fromJSONValue()：从普通的JSON结构重建对象实例。

class Point {
  constructor(x, y) {
    this.x = x;
    this.y = y;
  }

  // 序列化为JSON
  toJSONValue() {
    return { x: this.x, y: this.y };
  }

  // 反序列化为Point对象
  static fromJSONValue(obj) {
    return new Point(obj.x, obj.y);
  }
}

2.2 注册自定义类型

通过EJSON.addType将自定义类型注册到EJSON系统中。注册后的类型将自动支持序列化和反序列化。

EJSON.addType('Point', Point);

2.3 使用自定义对象传输

一旦自定义类型注册完成，开发者就可以像使用普通EJSON对象一样传输自定义对象。例如，在客户端创建一个Point对象并传输到服务器端。

// 客户端
const point = new Point(5, 10);
const ejsonString = EJSON.stringify(point);

// 服务器端
const receivedPoint = EJSON.parse(ejsonString);
console.log(receivedPoint instanceof Point); // true