将Mongoose模型作为Git子模块导入Express API的连接问题求助

核心问题根源 #

子模块中的模型如果单独引入mongoose包，会创建独立的Mongoose实例，无法复用主项目已建立的数据库连接。必须让子模块依赖主项目的Mongoose实例来定义模型。

具体实现方案 #

1. 主项目导出已连接的Mongoose实例 #

在主项目的数据库连接文件（比如db/connection.ts）中，完成连接后导出Mongoose实例：

// 主项目 db/connection.ts
import mongoose from 'mongoose';

// 建立连接逻辑
await mongoose.connect(process.env.MONGODB_URI!);
console.log('数据库连接成功');

// 导出已连接的实例
export default mongoose;

2. 子模块模型改为接收外部Mongoose实例 #

修改子模块中的模型文件，不再直接引入mongoose，而是通过函数参数接收主项目传入的实例：

// 子模块 models/Post.ts
export default function PostModel(mongoose: typeof import('mongoose')) {
  const postSchema = new mongoose.Schema({
    title: String,
    content: String,
    author: { type: mongoose.Schema.Types.ObjectId, ref: 'User' }
  });

  // 避免重复注册模型
  return mongoose.models.Post || mongoose.model('Post', postSchema);
}

3. 主项目中初始化子模块模型 #

在主项目需要使用模型的位置（如路由处理器），传入主项目的Mongoose实例初始化模型：

// 主项目 routes/posts.ts
import mongoose from '../db/connection';
import PostModel from '../../submodule-models/models/Post';

// 初始化模型
const Post = PostModel(mongoose);

// 路由示例
router.get('/', async (req, res) => {
  const posts = await Post.find().populate('author');
  res.json(posts);
});

4. 子模块依赖配置优化 #

在子模块的package.json中，将mongoose设为peerDependency，避免子模块单独安装不同版本的mongoose：

// 子模块 package.json
{
  "peerDependencies": {
    "mongoose": "^7.0.0" // 版本与主项目保持一致
  }
}

验证步骤 #

• 检查主项目和子模块的mongoose版本是否匹配，避免版本冲突
• 在模型初始化时添加日志，确认使用的是同一个Mongoose实例：

// 子模块模型中添加日志
export default function PostModel(mongoose: typeof import('mongoose')) {
  console.log('当前使用的Mongoose连接ID:', mongoose.connection.id);
  // ... 模型定义
}

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