使用class-transformer处理JSON数据类型的强制转换

在TypeScript开发中，我们经常需要将JSON数据转换为类实例，或者将类实例序列化为JSON。class-transformer库提供了强大的功能来实现这种转换，但在实际应用中，我们可能会遇到API返回的数据类型与预期不符的情况。

问题背景

假设我们有一个Restaurant类，定义如下：

class Restaurant {
  accountNumber?: string;
  monthlyVolume?: number;
  printingTicketEnabled?: string;
  royalPartner?: boolean;
}

当API返回的JSON数据中，某些字段可能有不同的数据类型。例如，printingTicketEnabled字段可能返回字符串"true"/"false"，也可能直接返回布尔值true/false。我们希望将这些数据统一转换为类定义中指定的类型。

解决方案

class-transformer提供了装饰器来精确控制类型转换行为。我们可以使用@Type装饰器来强制指定字段的类型：

import { Type } from 'class-transformer';

class Restaurant {
  @Type(() => String)
  accountNumber?: string;
  
  @Type(() => Number)
  monthlyVolume?: number;
  
  @Type(() => String)
  printingTicketEnabled?: string;
  
  @Type(() => Boolean)
  royalPartner?: boolean;
}

类型转换装饰器详解

1. @Type(() => String)：强制将字段值转换为字符串类型

   • 如果原始值是布尔值true，将转换为"true"
   • 如果原始值是数字123，将转换为"123"

2. @Type(() => Number)：强制将字段值转换为数字类型

   • 字符串"123"将转换为数字123
   • 布尔值true将转换为1，false转换为0

3. @Type(() => Boolean)：强制将字段值转换为布尔类型

   • 字符串"true"将转换为true，其他字符串转换为false
   • 数字0转换为false，非零数字转换为true

高级用法

对于更复杂的转换需求，我们可以创建自定义转换器：

import { Transform } from 'class-transformer';

class Restaurant {
  @Transform(({ value }) => value === 'true' || value === true)
  printingTicketEnabled?: boolean;
}

这个转换器会将字符串"true"和布尔值true都转换为true，其他值转换为false。

最佳实践

1. 始终为类属性添加类型装饰器，确保数据一致性
2. 对于可能为null或undefined的字段，使用可选属性标记(?)
3. 考虑使用较新的plainToInstance和instanceToPlain方法替代已弃用的plainToClass和classToPlain
4. 对于数组转换，可以直接传递数组给转换方法，无需手动遍历

实际应用示例

import { plainToInstance } from 'class-transformer';

const jsonData = `[
  {"printingTicketEnabled": true, "royalPartner": "true"},
  {"printingTicketEnabled": "false", "royalPartner": 0}
]`;

const restaurants = plainToInstance(Restaurant, JSON.parse(jsonData));
// 现在restaurants数组中的实例都符合类型定义

通过合理使用class-transformer的类型转换功能，我们可以确保应用中的数据始终保持一致的类型，减少运行时类型错误，提高代码的健壮性。