使用class-transformer从JSON转换对象返回undefined求助

常见原因及对应解决方案 #

1. 未将JSON字符串解析为JS对象 #

plainToInstance接收的是普通JS对象/数组，不是原始JSON字符串。读取文件后必须先通过JSON.parse()解析：

import { plainToInstance } from 'class-transformer';
import * as fs from 'fs';

class Product {
  id: number;
  name: string;
  price: number;
}

// 正确流程：读取字符串 → 解析为对象 → 转换实例
const jsonStr = fs.readFileSync('./products.json', 'utf-8');
const plainData = JSON.parse(jsonStr);
const product = plainToInstance(Product, plainData);

2. 类属性与JSON字段不匹配 #

如果JSON字段名、类型和类属性不一致，需要用装饰器明确映射规则：

import { plainToInstance, Expose, Type } from 'class-transformer';

class Product {
  // 映射JSON里的product_id到类的id属性
  @Expose({ name: 'product_id' })
  id: number;
  
  name: string;

  // 强制将JSON中字符串类型的price转为数字
  @Type(() => Number)
  price: number;
}

3. JSON文件读取失败或内容为空 #

检查文件路径是否正确，或文件内容是否为空，建议加错误捕获排查：

try {
  const jsonStr = fs.readFileSync('./products.json', 'utf-8');
  if (!jsonStr.trim()) {
    console.log('JSON文件内容为空');
    return;
  }
  const plainData = JSON.parse(jsonStr);
  const product = plainToInstance(Product, plainData);
} catch (err) {
  console.error('读取/解析JSON出错:', err);
}

4. 处理JSON数组的情况 #

如果JSON文件是数组格式（比如[{"id":1}, {"id":2}]），直接传解析后的数组给plainToInstance即可生成实例数组：

const plainArray = JSON.parse(jsonStr);
const productList = plainToInstance(Product, plainArray);

内容的提问来源于stack exchange，提问作者BreenDeen