TypeScript使用Omit定义接口后仍返回被忽略字段的问题

我从数据库获取数据后，想用Omit<Entity.Entity, 'billing_country_id'>定义返回的接口，期望移除billing_country_id字段，但实际响应里该字段还是存在。

相关代码 #

type ITeste = Omit<Entity.Entity, 'billing_country_id'>;
    
@injectable()
export default class Find {
  constructor(
    @inject('DocumentHeaderRepository')
    private documentHeaderRepository: Entity.IRepository,
  ) {}
  
  public async execute(data: Entity.IFindRequest): Promise<ITeste[]> {
    const result = await this.documentHeaderRepository.find(data);
    return result;
  }
}

实际响应 #

"response":[
{
    "billing_country_id": "d3d2f794-9271-4205-80c8-5ea273d85f57",
    "billing_country_name": "Portugal",
    "billing_locality": "Pontes",
    "billing_postal_code": "2910-137"
}
]

期望响应 #

"response":[
{
    "billing_country_name": "Portugal",
    "billing_locality": "Pontes",
    "billing_postal_code": "2910-137"
}
]

原因说明 #

TypeScript是静态类型检查工具，只在编译阶段做类型校验，不会修改运行时的实际数据。Omit<Entity.Entity, 'billing_country_id'>只是告诉编译器「这个类型不包含billing_country_id字段」，但数据库查询返回的对象依然是完整的，所以运行时该字段会保留在响应里。

解决方案 #

1. 手动解构移除字段（最简单直接） #

在返回结果前，对每个对象做解构赋值，排除不需要的字段：

public async execute(data: Entity.IFindRequest): Promise<ITeste[]> {
  const result = await this.documentHeaderRepository.find(data);
  // 解构排除billing_country_id，返回剩余字段
  return result.map(({ billing_country_id, ...rest }) => rest);
}

2. 封装工具函数复用逻辑 #

如果需要在多个地方移除字段，可以写个通用工具函数：

// 通用工具函数：移除对象指定字段
function omit<T, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K> {
  const clonedObj = { ...obj };
  keys.forEach(key => delete clonedObj[key]);
  return clonedObj;
}

// 在execute方法里使用
public async execute(data: Entity.IFindRequest): Promise<ITeste[]> {
  const result = await this.documentHeaderRepository.find(data);
  return result.map(item => omit(item, 'billing_country_id'));
}

3. 从数据库层面过滤字段（最优解） #

如果你的数据库查询支持指定返回字段，直接修改Repository的find方法，只查询需要的字段，从源头避免返回多余数据，性能更优：

// 示例：假设Repository的find方法支持select参数
const result = await this.documentHeaderRepository.find({
  ...data,
  select: ['billing_country_name', 'billing_locality', 'billing_postal_code']
});

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