JavaScript 模块值对象：不可变数据建模

在现代 JavaScript 开发中，确保数据的完整性和可维护性至关重要。一种实现这一目标的强大技术是在模块化的 JavaScript 应用程序中利用值对象 (Value Objects)。值对象，特别是与不可变性相结合时，提供了一种强大的数据建模方法，可以带来更清晰、更可预测且更易于测试的代码。

什么是值对象？

值对象是一个小而简单的对象，代表一个概念上的值。与由其身份定义的实体 (Entity) 不同，值对象由其属性定义。如果两个值对象的属性相等，那么它们就被认为是相等的，无论它们的对象身份是否相同。常见的值对象示例包括：

• 货币 (Currency): 代表一个货币值（例如 10 美元, 5 欧元）。
• 日期范围 (Date Range): 代表一个开始日期和结束日期。
• 电子邮件地址 (Email Address): 代表一个有效的电子邮件地址。
• 邮政编码 (Postal Code): 代表特定区域的有效邮政编码。（例如，美国的 90210，英国的 SW1A 0AA，德国的 10115，日本的 〒100-0001）
• 电话号码 (Phone Number): 代表一个有效的电话号码。
• 坐标 (Coordinates): 代表一个地理位置（纬度和经度）。

值对象的关键特征是：

• 不可变性 (Immutability): 一旦创建，值对象的状态就不能被改变。这消除了意外副作用的风险。
• 基于值的相等性 (Equality based on value): 如果两个值对象的值相等，那么它们就是相等的，而不是因为它们是内存中的同一个对象。
• 封装性 (Encapsulation): 值的内部表示是隐藏的，通过方法提供访问。这允许进行验证并确保值的完整性。

为什么使用值对象？

在您的 JavaScript 应用程序中采用值对象会带来几个显著的优势：

• 提高数据完整性: 值对象可以在创建时强制执行约束和验证规则，确保只使用有效的数据。例如，一个 `EmailAddress` 值对象可以验证输入字符串确实是有效的电子邮件格式。这减少了错误在系统中传播的机会。
• 减少副作用: 不可变性消除了对值对象状态进行意外修改的可能性，从而使代码更具可预测性和可靠性。
• 简化测试: 由于值对象是不可变的，并且它们的相等性是基于值的，单元测试变得更加容易。您可以简单地创建具有已知值的值对象，并将它们与预期结果进行比较。
• 提高代码清晰度: 值对象通过明确表示领域概念，使您的代码更具表现力且更易于理解。您可以使用像 `Currency` 或 `PostalCode` 这样的值对象，而不是传递原始字符串或数字，这使您的代码意图更加清晰。
• 增强模块化: 值对象封装了与特定值相关的特定逻辑，促进了关注点分离，使您的代码更加模块化。
• 更好的协作: 使用标准的值对象可以促进团队间的共识。例如，每个人都明白“Currency”对象代表什么。

在 JavaScript 模块中实现值对象

让我们探讨如何使用 ES 模块在 JavaScript 中实现值对象，重点关注不可变性和正确的封装。

示例：EmailAddress 值对象

考虑一个简单的 `EmailAddress` 值对象。我们将使用正则表达式来验证电子邮件格式。

```javascript // email-address.js const EMAIL_REGEX = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/; class EmailAddress { constructor(value) { if (!EmailAddress.isValid(value)) { throw new Error('Invalid email address format.'); } // 私有属性（使用闭包） let _value = value; this.getValue = () => _value; // Getter 方法 // 防止从类外部修改 Object.freeze(this); } getValue() { return this.value; } toString() { return this.getValue(); } static isValid(value) { return EMAIL_REGEX.test(value); } equals(other) { if (!(other instanceof EmailAddress)) { return false; } return this.getValue() === other.getValue(); } } export default EmailAddress; ```

说明：

• 模块导出: `EmailAddress` 类作为模块导出，使其可以在应用程序的不同部分重用。
• 验证: 构造函数使用正则表达式 (`EMAIL_REGEX`) 验证输入的电子邮件地址。如果电子邮件无效，则会抛出错误。这确保了只创建有效的 `EmailAddress` 对象。
• 不可变性: `Object.freeze(this)` 防止在 `EmailAddress` 对象创建后对其进行任何修改。尝试修改一个被冻结的对象将导致错误。我们还使用闭包来隐藏 `_value` 属性，使其无法从类外部直接访问。
• `getValue()` 方法: `getValue()` 方法提供了对底层电子邮件地址值的受控访问。
• `toString()` 方法: `toString()` 方法允许值对象轻松转换为字符串。
• `isValid()` 静态方法: 静态 `isValid()` 方法允许您在不创建类实例的情况下检查字符串是否为有效的电子邮件地址。
• `equals()` 方法: `equals()` 方法根据两个 `EmailAddress` 对象的值进行比较，确保相等性由内容决定，而不是对象身份。

使用示例

```javascript // main.js import EmailAddress from './email-address.js'; try { const email1 = new EmailAddress('test@example.com'); const email2 = new EmailAddress('test@example.com'); const email3 = new EmailAddress('invalid-email'); // 这将抛出一个错误 console.log(email1.getValue()); // 输出: test@example.com console.log(email1.toString()); // 输出: test@example.com console.log(email1.equals(email2)); // 输出: true // 尝试修改 email1 将抛出错误（需要在严格模式下） // email1.value = 'new-email@example.com'; // 错误: Cannot assign to read only property 'value' of object '#' } catch (error) { console.error(error.message); // 输出: Invalid email address format. } ```

所展示的优点

这个例子展示了值对象的核心原则：

• 验证: `EmailAddress` 构造函数强制执行电子邮件格式验证。
• 不可变性: `Object.freeze()` 调用阻止了修改。
• 基于值的相等性: `equals()` 方法根据电子邮件地址的值进行比较。

高级注意事项

TypeScript

虽然前面的例子使用的是纯 JavaScript，但 TypeScript 可以显著增强值对象的开发和健壮性。TypeScript 允许您为值对象定义类型，提供编译时类型检查并提高代码的可维护性。以下是使用 TypeScript 实现 `EmailAddress` 值对象的方法：

```typescript // email-address.ts const EMAIL_REGEX = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/; class EmailAddress { private readonly value: string; constructor(value: string) { if (!EmailAddress.isValid(value)) { throw new Error('Invalid email address format.'); } this.value = value; Object.freeze(this); } getValue(): string { return this.value; } toString(): string { return this.value; } static isValid(value: string): boolean { return EMAIL_REGEX.test(value); } equals(other: EmailAddress): boolean { return this.value === other.getValue(); } } export default EmailAddress; ```

使用 TypeScript 的主要改进：

• 类型安全: `value` 属性被明确地类型化为 `string`，并且构造函数强制只传递字符串。
• 只读属性: `readonly` 关键字确保 `value` 属性只能在构造函数中赋值，进一步增强了不可变性。
• 改进的代码补全和错误检测: TypeScript 提供了更好的代码补全功能，并有助于在开发过程中捕获与类型相关的错误。

函数式编程技术

您还可以使用函数式编程原则来实现值对象。这种方法通常涉及使用函数来创建和操作不可变的数据结构。

```javascript // currency.js import { isNil, isNumber, isString } from 'lodash-es'; function Currency(amount, code) { if (!isNumber(amount)) { throw new Error('Amount must be a number'); } if (!isString(code) || code.length !== 3) { throw new Error('Code must be a 3-letter string'); } const _amount = amount; const _code = code.toUpperCase(); return Object.freeze({ getAmount: () => _amount, getCode: () => _code, toString: () => `${_code} ${_amount}`, equals: (other) => { if (isNil(other) || typeof other.getAmount !== 'function' || typeof other.getCode !== 'function') { return false; } return other.getAmount() === _amount && other.getCode() === _code; } }); } export default Currency; // 示例 // const price = Currency(19.99, 'USD'); ```

说明：

• 工厂函数: `Currency` 函数作为一个工厂，创建并返回一个不可变的对象。
• 闭包: `_amount` 和 `_code` 变量被封装在函数的作用域内，使它们成为私有的，无法从外部访问。
• 不可变性: `Object.freeze()` 确保返回的对象不能被修改。

序列化与反序列化

在使用值对象时，特别是在分布式系统或存储数据时，您通常需要将它们序列化（将其转换为像 JSON 这样的字符串格式）和反序列化（将其从字符串格式转换回值对象）。当使用 JSON 序列化时，您通常会得到代表值对象的原始值（`string` 表示、`number` 表示等）。

在反序列化时，请确保始终使用其构造函数重新创建值对象实例，以强制执行验证和不可变性。

```javascript // 序列化 const email = new EmailAddress('test@example.com'); const emailJSON = JSON.stringify(email.getValue()); // 序列化底层值 console.log(emailJSON); // 输出: "test@example.com" // 反序列化 const deserializedEmail = new EmailAddress(JSON.parse(emailJSON)); // 重新创建值对象 console.log(deserializedEmail.getValue()); // 输出: test@example.com ```

真实世界示例

值对象可以应用于各种场景：

• 电子商务: 使用 `Currency` 值对象表示产品价格，确保货币处理的一致性。使用 `SKU` 值对象验证产品 SKU。
• 金融应用: 使用 `Money` 和 `AccountNumber` 值对象处理货币金额和账号，强制执行验证规则并防止错误。
• 地理应用: 使用 `Coordinates` 值对象表示坐标，确保纬度和经度值在有效范围内。使用 `CountryCode` 值对象表示国家（例如，“US”、“GB”、“DE”、“JP”、“BR”）。
• 用户管理: 使用专用的值对象验证电子邮件地址、电话号码和邮政编码。
• 物流: 使用 `Address` 值对象处理送货地址，确保所有必填字段都存在且有效。

代码之外的好处

• 改善协作: 值对象在您的团队和项目中定义了共享的词汇表。当每个人都理解 `PostalCode` 或 `PhoneNumber` 代表什么时，协作会得到显著改善。
• 简化入职: 新团队成员可以通过理解每个值对象的目的和约束来快速掌握领域模型。
• 降低认知负荷: 通过将复杂的逻辑和验证封装在值对象中，您可以让开发人员专注于更高层次的业务逻辑。

值对象的最佳实践

• 保持小而专注: 一个值对象应该代表一个单一、明确定义的概念。
• 强制不可变性: 防止在创建后修改值对象的状态。
• 实现基于值的相等性: 确保如果两个值对象的值相等，则它们被认为是相等的。
• 提供 `toString()` 方法: 这使得将值对象表示为字符串以便于日志记录和调试变得更加容易。
• 编写全面的单元测试: 彻底测试值对象的验证、相等性和不可变性。
• 使用有意义的名称: 选择能够清晰反映值对象所代表概念的名称（例如 `EmailAddress`、`Currency`、`PostalCode`）。

结论

值对象为在 JavaScript 应用程序中进行数据建模提供了一种强大的方式。通过拥抱不可变性、验证和基于值的相等性，您可以创建更健壮、可维护和可测试的代码。无论您是在构建一个小型 Web 应用程序还是一个大规模的企业系统，将值对象整合到您的架构中都可以显著提高软件的质量和可靠性。通过使用模块来组织和导出这些对象，您可以创建高度可重用的组件，从而有助于构建一个更加模块化和结构良好的代码库。拥抱值对象是为全球用户构建更清晰、更可靠、更易于理解的 JavaScript 应用程序的重要一步。