MongoDAL实现IDataAccessLayer时遇WithId<Document>类型不兼容错误

我定义了如下接口：

export interface IDataAccessLayer<T> {
  ...
  insertOne(data: T): Promise<T> | null;
  ...
}

尝试用MongoDB实现该接口：

class MongoDAL<T extends WithId<Document>> implements IDataAccessLayer<T> {
...
  async insertOne(data: T): Promise<T> {
    return this.client
        .db(this.database)
        .collection<T>(this.collection)
        .insertOne(data).then((result) => { // <--- 此处出现类型错误
            data._id = result.insertedId;
            return data;
        });
  }
...
}

但在insertOne(data)行出现类型错误：

Type 'WithId<Document>' is not assignable to type 'OptionalUnlessRequiredId<T>'.

除了用insertOne(data as any)，不清楚如何合理规避这个错误，该问题和MongoDB的一个已知类型问题相关。

方案1：调整泛型约束适配MongoDB类型 #

修改MongoDAL的泛型定义，让T兼容MongoDB插入所需的OptionalUnlessRequiredId类型，同时对齐接口的泛型要求：

class MongoDAL<T extends Document> implements IDataAccessLayer<WithId<T>> {
  async insertOne(data: WithId<T>): Promise<WithId<T>> {
    const result = await this.client
      .db(this.database)
      .collection<T>(this.collection)
      .insertOne(data);
    data._id = result.insertedId;
    return data;
  }
}

这里把泛型T定为基础Document类型，接口实现的泛型用WithId<T>，既满足插入时_id可选的要求，又符合返回带_id数据的逻辑。

方案2：精准类型断言替代any #

不用any，而是断言为MongoDB要求的OptionalUnlessRequiredId<T>，保留大部分类型检查：

async insertOne(data: T): Promise<T> {
  return this.client
      .db(this.database)
      .collection<T>(this.collection)
      .insertOne(data as OptionalUnlessRequiredId<T>)
      .then((result) => {
          data._id = result.insertedId;
          return data;
      });
}

方案3：分离插入与返回的类型结构 #

既然插入时MongoDB允许不传入_id，可将插入参数改为移除_id的类型，插入后再补全_id返回：

async insertOne(data: Omit<T, '_id'>): Promise<T> {
  const result = await this.client
    .db(this.database)
    .collection<T>(this.collection)
    .insertOne(data);
  return { ...data, _id: result.insertedId } as T;
}

同时调整IDataAccessLayer接口的insertOne参数类型为Omit<T, '_id'>，更贴合MongoDB的实际插入逻辑。

方案4：显式声明插入数据类型 #

通过显式定义插入数据的类型，让TypeScript确认其符合要求：

class MongoDAL<T extends WithId<Document>> implements IDataAccessLayer<T> {
  async insertOne(data: T): Promise<T> {
    const insertData: OptionalUnlessRequiredId<T> = data;
    const result = await this.client
      .db(this.database)
      .collection<T>(this.collection)
      .insertOne(insertData);
    data._id = result.insertedId;
    return data;
  }
}

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