Typegoose 入门教程

Typegoose 入门教程

typegooseTypegoose - Define Mongoose models using TypeScript classes.项目地址:https://gitcode.com/gh_mirrors/ty/typegoose

项目目录结构及介绍

Typegoose 是一个用于在 TypeScript 中定义 Mongoose 模型的库。典型的 Typegoose 项目目录结构可能如下所示：

my-typegoose-project/
├── src/
│   ├── models/            # 存放模型类文件
│   │   └── user.ts        # 示例：User 模型类
│   ├── schemas/           # 可选：存放非装饰器模式下的 Mongoose schema 文件
│   ├── utilities/         # 可选：存放通用工具函数
│   └── index.ts           # 应用入口文件
├── dist/                  # 编译后的 TypeScript 文件
├── package.json           # 项目包配置文件
└── tsconfig.json          # TypeScript 配置文件

• src/models/：存储使用 TypeScript 类定义的 Mongoose 模型。
• src/schemas/：可选，可以直接使用 Mongoose Schema 对象的地方。
• src/utilities/：可选，存放帮助函数或中间件等。
• index.ts：主应用入口，初始化数据库连接和模型。

项目的启动文件介绍

在 Typegoose 项目中，通常在 src/index.ts 或类似入口文件中设置 Mongoose 连接并加载模型。例如：

import * as mongoose from 'mongoose';
import { connectToDatabase } from './utilities/mongoUtils'; 
import { User } from './models/user';

async function bootstrap() {
  try {
    await connectToDatabase(); // 自定义的数据库连接方法
    
    // 注册模型，这里我们以 User 为例
    const UserModel = mongoose.model<User>(User.name, User.schema);

    console.log('Connected to MongoDB');
    // 这里可以进行其他操作，如数据迁移、测试查询等
  } catch (error) {
    console.error('Failed to connect to MongoDB:', error);
    process.exit(1);
  }
}

bootstrap();

connectToDatabase() 方法是你的自定义逻辑，用于建立到 MongoDB 的连接。一旦连接成功，你可以通过调用 mongoose.model() 并传递模型类（User）和它的 Mongoose schema 来注册模型。

项目的配置文件介绍

在 Typegoose 项目中，tsconfig.json 和 package.json 是两个主要的配置文件。

tsconfig.json

这是 TypeScript 编译器的配置文件，决定了如何编译 TypeScript 代码。一个基本的 tsconfig.json 文件可能会如下所示：

{
  "compilerOptions": {
    "target": "es2017",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "outDir": "./dist",
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "resolveJsonModule": true,
    "types": ["node", "@types/mongoose"]
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

确保包含了对 Mongoose 的类型定义 @types/mongoose，以便获得类型检查支持。

package.json

package.json 文件列出了项目依赖及其版本信息，启动脚本等。以下是一个示例：

{
  "name": "my-typegoose-app",
  "version": "1.0.0",
  "description": "A sample app using Typegoose",
  "main": "dist/index.js",
  "scripts": {
    "start": "node dist/index.js",
    "build": "tsc"
  },
  "dependencies": {
    "mongoose": "^6.5.x",
    "typegoose": "^12.6.x"
  },
  "devDependencies": {
    "@types/mongoose": "^6.5.x",
    "typescript": "^4.8.x"
  },
  "author": "Your Name",
  "license": "MIT"
}

scripts 字段定义了运行命令，比如 npm run build 用来编译 TypeScript 代码，而 npm start 则是用来启动应用。

通过以上步骤，你应该能够了解 Typegoose 项目的基础结构和配置，从而开始构建自己的 TypeScript 和 MongoDB 应用。记得根据实际项目需求调整这些配置。

typegooseTypegoose - Define Mongoose models using TypeScript classes.项目地址:https://gitcode.com/gh_mirrors/ty/typegoose