TypeGoose与class-transformer集成指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_01051/article/details/148888487

TypeGoose与class-transformer集成指南

前言

在现代Node.js开发中，Mongoose是操作MongoDB最流行的ODM库之一。而TypeGoose作为Mongoose的TypeScript包装器，提供了基于装饰器的类定义方式。class-transformer则是处理类实例与普通对象之间转换的强大工具。本文将详细介绍如何在TypeGoose项目中集成class-transformer，实现更灵活的数据转换。

环境准备

在开始之前，请确保项目中已安装以下依赖：

@typegoose/typegoose@10.0.0或更高版本
class-transformer@0.5.1

可以通过包管理器安装class-transformer：

npm install --save class-transformer@~0.5.1

核心概念

为什么需要集成class-transformer？

数据转换控制：精确控制哪些属性应该暴露给客户端
权限管理：通过分组(groups)实现不同权限下的不同数据暴露
格式统一：确保前后端数据格式的一致性
安全考虑：避免敏感数据意外暴露

实现步骤

1. 创建基础文档类

由于Mongoose文档默认包含_id和__v等元数据字段，我们需要创建一个基础类来处理这些字段的转换：

import { Expose, Transform } from 'class-transformer';

class DocumentCT {
  @Expose()
  @Transform((value) => {
    if ('value' in value) {
      return value.obj[value.key].toString();
    }
    return 'unknown value';
  })
  public _id: string;

  @Expose()
  public __v: number;
}

这个类实现了：

将ObjectId转换为字符串
暴露版本控制字段__v
提供统一的转换处理

2. 定义业务模型

基于基础文档类，我们可以定义具体的业务模型：

import { Exclude, Expose } from 'class-transformer';
import { prop } from '@typegoose/typegoose';

@Exclude()
class Account extends DocumentCT {
  @prop()
  @Expose()
  public email: string;

  @prop()
  @Expose({ groups: ['admin'] })
  public password: string;
}

const AccountModel = getModelForClass(Account);

这个Account类展示了：

默认排除所有属性（@Exclude()）
显式暴露email字段
仅对admin分组用户暴露password字段

使用场景

场景1：使用lean()查询

import { plainToClass, instanceToPlain } from 'class-transformer';

// 获取POJO(普通JavaScript对象)
const pojo = await AccountModel.findById(id).orFail().lean().exec();

// 转换为Account类实例
const deserialized = plainToClass(Account, pojo);

// 应用转换规则后序列化
const serialized = instanceToPlain(deserialized);

场景2：查询完整文档

// 获取Mongoose文档对象
const mo = await AccountModel.findById(id).orFail().exec();

// 转换为Account类实例
const deserialized = plainToClass(Account, mo);

// 应用转换规则后序列化
const serialized = instanceToPlain(deserialized);