如何用API返回对象填充TypeScript模型类并优化代码结构

我从API响应中获取了一个大型User对象，希望用它来实例化一个模型类，以便通过类中的方法进行数据解析。API响应的对象接口如下：

interface User {
    id: number;
    username: string;
    email: string;
    age: number;
    isActive: boolean;
    address?: {
        street: string;
        city: string;
        postalCode: string;
    };
    roles: string[];
    createdAt: Date;
    updatedAt?: Date;
}

我已知两种实现方式，但都存在不足：

现有实现方式及问题 #

方式一：将User对象作为模型类的私有属性 #

class UserModel {
    private user: User;

    constructor(user: User) {
        this.user = user;
    }

    getUserId(): number {
        return this.user.id;
    }

    // ... other methods
}

这种方式每次访问属性都需要写this.user.[属性名]，较为繁琐。

方式二：构造函数中解构赋值到类的私有属性 #

class UserClass {
    private readonly id: number;
    private readonly username: string;
    private readonly email: string;
    private readonly age: number;
    private readonly isActive: boolean;
    private readonly address?: {
        street: string;
        city: string;
        postalCode: string;
    };
    private readonly roles: string[];
    private readonly createdAt: Date;
    private readonly updatedAt?: Date;

    constructor(user: User) {
        const {
            id,
            username,
            email,
            age,
            isActive,
            address,
            roles,
            createdAt,
            updatedAt
        } = user;

        this.id = id;
        this.username = username;
        this.email = email;
        this.age = age;
        this.isActive = isActive;
        this.address = address;
        this.roles = roles;
        this.createdAt = createdAt;
        this.updatedAt = updatedAt;
    }

    getUserId(): number {
        return this.id;
    }

    // ... other methods
}

这种方式可以直接用this.[属性名]访问，但类的代码过于冗余，属性声明和赋值重复度高。

优化方案 #

方案1：用Object.assign简化属性赋值 #

通过Object.assign一次性将User对象的所有属性赋值到类实例上，同时让类实现User接口保证类型一致性：

class UserModel implements User {
    private id: number;
    private username: string;
    private email: string;
    private age: number;
    private isActive: boolean;
    private address?: { street: string; city: string; postalCode: string };
    private roles: string[];
    private createdAt: Date;
    private updatedAt?: Date;

    constructor(user: User) {
        Object.assign(this, user);
    }

    getUserId(): number {
        return this.id;
    }

    // 自定义数据解析方法示例
    getFormattedCreatedDate(): string {
        return this.createdAt.toLocaleDateString();
    }
}

优点：省去了手动逐个赋值的冗余代码，保持直接访问this.[属性名]的便捷性，类型安全有保障。

方案2：用getter方法封装内部User对象 #

通过getter将内部user对象的属性映射为类实例的可访问属性，兼顾封装性和便捷性：

class UserModel {
    private user: User;

    constructor(user: User) {
        this.user = user;
    }

    // 自动生成所有属性的getter
    get id(): number { return this.user.id; }
    get username(): string { return this.user.username; }
    get email(): string { return this.user.email; }
    get age(): number { return this.user.age; }
    get isActive(): boolean { return this.user.isActive; }
    get address(): { street: string; city: string; postalCode: string } | undefined { return this.user.address; }
    get roles(): string[] { return this.user.roles; }
    get createdAt(): Date { return this.user.createdAt; }
    get updatedAt(): Date | undefined { return this.user.updatedAt; }

    getUserId(): number {
        return this.id; // 直接访问getter
    }

    // 数据解析方法示例
    getActiveRoles(): string[] {
        return this.isActive ? this.roles : [];
    }
}

优点：不需要重复声明大量类属性，内部仍持有完整的User对象，类内部可以直接用this.id等方式访问，编辑器通常支持自动生成getter代码，减少手动工作量。

方案3：代码生成或装饰器（进阶） #

如果项目中有大量这类模型类，可以借助工具减少重复代码：

• 装饰器：自定义或使用第三方装饰器（如@AutoMap）自动将User对象的属性映射到类实例
• 代码生成：利用TypeScript Compiler API编写脚本，从User接口自动生成包含属性声明或getter的模型类代码

这种方式适合大型项目，能极大提升开发效率。

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