如何用TypeScript导出Mongoose模型并避免OverwriteModelError？

问题现象 #

1. 多次导入Task模型时出现OverwriteModelError: Cannot overwrite 'Task' model once compiled错误，调整导出代码后仍未解决
2. 调用const tasks = await Task.find();时触发TypeScript错误：Each member of the union type... has signatures, but none of those signatures are compatible with each other

现有代码 #

Task模型文件 #

import { Schema, model, models } from 'mongoose';

export interface ITask {
    title: string;
    description: string;
}

const TaskSchema = new Schema<ITask>({ 
    title: {type: String},
    description: {type: String}
            
},
{
    timestamps: true,
    versionKey: false
}) 

export default  models['Task']<ITask>  ||  model<ITask>('Task', TaskSchema); 

dbConnect数据库连接代码 #

import { connect, connection, ConnectionStates } from "mongoose";
interface ConnectionInterface {
  isConnected: ConnectionStates;
}
const conn: ConnectionInterface = {
  isConnected: 0,
};
export async function dbConnect() {
  if (conn.isConnected === 1) return;
  const db = await connect(process.env.MONGODB_URI);
  conn.isConnected = db.connections[0].readyState;
  console.log("Connected to database", db.connection.db.databaseName);
}

解决方案 #

1. 修复模型导出的类型与重复编译问题 #

修改Task模型的导出逻辑，明确类型并优先复用已编译的模型：

import { Schema, model, models, Model } from 'mongoose';

export interface ITask {
    title: string;
    description: string;
}

const TaskSchema = new Schema<ITask>({ 
    title: {type: String},
    description: {type: String}
}, {
    timestamps: true,
    versionKey: false
});

// 优先复用已存在的模型，同时明确类型避免联合类型冲突
const Task: Model<ITask> = models.Task as Model<ITask> || model<ITask>('Task', TaskSchema);

export default Task;

说明

• Mongoose的models对象会缓存已编译的模型，直接复用即可避免重复编译错误
• 通过as Model<ITask>断言类型，消除TypeScript对联合类型的兼容性检查报错，因为models.Task和新创建的model<ITask>本质都是Model<ITask>类型

2. 确保API路由中正确加载模型 #

在pages/api/tasks/[id].ts和pages/api/tasks/index.ts中，保持先调用dbConnect再执行模型操作的顺序：

import dbConnect from '../../../utils/dbConnect';
import Task from '../../../models/Task';

export default async function handler(req, res) {
  await dbConnect();
  
  if (req.method === 'GET') {
    const tasks = await Task.find();
    res.status(200).json(tasks);
  }
  // 其他请求方法逻辑...
}

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