You need to enable JavaScript to run this app. TypeScript: 如何从复杂字段配置对象生成自定义映射类型
优惠活动
大模型
产品
解决方案
定价
更多

TypeScript: 如何从复杂字段配置对象生成自定义映射类型

兼容简单与复杂Schema配置的TypeScript强类型映射

原有基础版本实现

最初定义的类型辅助逻辑用于从Schema配置对象生成对应的强类型记录,核心的类型映射关系定义为:

type MapSchemaTypes = {
    string: string;
    number: number;
    integer: number;
    float: number;
    boolean: boolean;
};

type MapSchema<T extends Record<string, keyof MapSchemaTypes>> = {
    -readonly [K in keyof T]: MapSchemaTypes[T[K]]
}

这套定义在纯字符串枚举值的Schema场景下可正常工作,使用示例:

const TestModel1 = {
    id: "number",
    lastname: "string",
    firstname: "string",
    valid: "boolean"
} as const;
type TestRecord1 = MapSchema<typeof TestModel1>;

最终生成的类型完全符合预期:

type TestRecord1 = {
    id: number;
    lastname: string;
    firstname: string;
    valid: boolean;
}

场景升级后的兼容问题

当Schema配置升级为携带额外元信息的复杂结构时——每个字段不再是单纯的类型字符串,而是包含type/mapping/defaultValue等配置项的对象,原有定义会触发类型约束报错。对应复杂Schema示例:

const TestModel2 = {
    id: {
        type: "number",
        mapping: "_id",
        defaultValue: 0
    },
    lastname: {
        type: "string",
        mapping: "_lastname",
        defaultValue: ""
    },
    firstname: {
        type: "string",
        mapping: "_firstname",
        defaultValue: ""
    },
    valid: {
        type: "boolean",
        mapping: "_valid",
        defaultValue: false
    }
} as const;
type TestRecord2 = MapSchema<typeof TestModel2>;

原有MapSchema的泛型约束要求传入的Schema值必须是MapSchemaTypes的key(即纯字符串枚举),遇到对象形式的字段就会触发类型不匹配报错,最终映射生成的字段全为unknown:

type TestRecord2 = {
    id: unknown;
    lastname: unknown;
    firstname: unknown;
    valid: unknown;
}

此前的几版调整尝试均未成功:

  • 直接在映射逻辑中读取字段的type属性时,因为没有考虑字段可能是纯字符串的场景,TypeScript会抛出无法索引对应类型的报错
  • 调整索引取值的语法写法时,又会触发语法解析错误

最终可用的兼容实现

通过拆分字段类型定义、增加逐字段条件判断的方式,最终实现了同时支持纯字符串简单字段、对象形式复杂字段的映射能力,核心类型定义如下:

type MapSchemaTypes = {
    string: string;
    number: number;
    integer: number;
    float: number;
    boolean: boolean;
};
type MapSchemaDefaultValues = string | number | boolean | undefined | null;
// 简单字段:直接使用基础类型枚举值作为配置
type MapSchemaSimpleField   = keyof MapSchemaTypes;
// 复杂字段:带额外元信息的对象形式配置
type MapSchemaComplexField  = {
    type: MapSchemaSimpleField;
    mapping: string;
    defaultValue: MapSchemaDefaultValues
};
// 统一字段约束:支持简单字段、复杂字段两种形式
type MapSchemaField = MapSchemaSimpleField | MapSchemaComplexField;
// 整体Schema的结构约束
type MapSchemaDefinition = Record<string, MapSchemaField>;

type MapSchema<T extends MapSchemaDefinition> = {
    // 移除字段的readonly修饰,逐字段做类型映射
    -readonly [K in keyof T]: 
        // 若字段为带type属性的复杂结构,提取type值映射到对应TS基础类型
        T[K] extends { type: infer TypeName } 
            ? MapSchemaTypes[TypeName & MapSchemaSimpleField] 
            // 若字段为纯字符串简单配置,直接映射到对应TS基础类型
            : MapSchemaTypes[T[K] & MapSchemaSimpleField]
};

这套实现支持混合形式的Schema配置——也就是同一个Schema内可以同时存在简单字符串字段和复杂对象字段,使用示例:

const TestModel4 = {
    id: "number",
    lastname: {
        type: "string",
        mapping: "_lastname",
        defaultValue: ""
    },
    firstname: "string",
    valid: {
        type: "boolean",
        mapping: "_valid",
        defaultValue: false
    }
} as const;
type TestRecord4 = MapSchema<typeof TestModel4>;

最终生成的类型完全匹配预期:

type TestRecord4 = {
    id: number;
    lastname: string;
    firstname: string;
    valid: boolean;
}

内容的提问来源于stack exchange,提问作者Gabriel Hautclocq

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.20 13:15:03