## Mongoose
> 在本文中,您將學習如何使用自定義提供者機制從零開始創建基于 **Mongoose** 包的 `DatabaseModule`。由于該解決方案包含許多開銷,因此您可以使用開箱即用的 `@nestjs/mongoose` 軟件包。要了解更多信息,請參閱 [此處](https://docs.nestjs.com/techniques/mongodb)。
[Mongoose](http://mongoosejs.com/) 是最受歡迎的[MongoDB](https://www.mongodb.org/) 對象建模工具。
### 入門
在開始使用這個庫前,我們必須安裝所有必需的依賴關系
```bash
$ npm install --save mongoose
$ npm install --save-dev @types/mongoose
```
我們需要做的第一步是使用 `connect()` 函數建立與數據庫的連接。`connect()` 函數返回一個 `Promise`,因此我們必須創建一個 [異步提供者](/8/fundamentals.md?id=異步提供者 (Asynchronous providers))。
> database.providers.ts
```typescript
import * as mongoose from 'mongoose';
export const databaseProviders = [
{
provide: 'DATABASE_CONNECTION',
useFactory: (): Promise<typeof mongoose> =>
mongoose.connect('mongodb://localhost/nest'),
},
];
```
> 按照最佳實踐,我們在分離的文件中聲明了自定義提供者,該文件帶有 `*.providers.ts` 后綴。
然后,我們需要導出這些提供者,以便應用程序的其余部分可以 **訪問** 它們。
> database.module.ts
```typescript
import { Module } from '@nestjs/common';
import { databaseProviders } from './database.providers';
@Module({
providers: [...databaseProviders],
exports: [...databaseProviders],
})
export class DatabaseModule {}
```
現在我們可以使用 `@Inject()` 裝飾器注入 `Connection` 對象。依賴于 `Connection` 異步提供者的每個類都將等待 `Promise` 被解析。
### 模型注入
使用Mongoose,一切都來自[Schema](https://mongoosejs.com/docs/guide.html)。 讓我們定義 `CatSchema` :
> schemas/cats.schema.ts
```typescript
import * as mongoose from 'mongoose';
export const CatSchema = new mongoose.Schema({
name: String,
age: Number,
breed: String,
});
```
`CatsSchema` 屬于 `cats` 目錄。此目錄代表 `CatsModule` 。
現在,讓我們創建一個 **模型** 提供者:
> cats.providers.ts
```typescript
import { Connection } from 'mongoose';
import { CatSchema } from './schemas/cat.schema';
export const catsProviders = [
{
provide: 'CAT_MODEL',
useFactory: (connection: Connection) => connection.model('Cat', CatSchema),
inject: ['DATABASE_CONNECTION'],
},
];
```
> 請注意,在實際應用程序中,您應該避免使用魔術字符串。`CAT_MODEL` 和 `DATABASE_CONNECTION` 都應保存在分離的 `constants.ts` 文件中。
現在我們可以使用 `@Inject()` 裝飾器將 `CAT_MODEL` 注入到 `CatsService` 中:
> cats.service.ts
```typescript
import { Model } from 'mongoose';
import { Injectable, Inject } from '@nestjs/common';
import { Cat } from './interfaces/cat.interface';
import { CreateCatDto } from './dto/create-cat.dto';
@Injectable()
export class CatsService {
constructor(
@Inject('CAT_MODEL')
private catModel: Model<Cat>,
) {}
async create(createCatDto: CreateCatDto): Promise<Cat> {
const createdCat = new this.catModel(createCatDto);
return createdCat.save();
}
async findAll(): Promise<Cat[]> {
return this.catModel.find().exec();
}
}
```
在上面的例子中,我們使用了 `Cat` 接口。 此接口擴展了來自 `mongoose` 包的 `Document` :
```typescript
import { Document } from 'mongoose';
export interface Cat extends Document {
readonly name: string;
readonly age: number;
readonly breed: string;
}
```
數據庫連接是 **異步的**,但 `Nest` 使最終用戶完全看不到這個過程。`CatModel` 正在等待數據庫連接時,并且`CatsService` 會被延遲,直到存儲庫可以使用。整個應用程序可以在每個類實例化時啟動。
這是一個最終的 `CatsModule` :
> cats.module.ts
```typescript
import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';
import { catsProviders } from './cats.providers';
import { DatabaseModule } from '../database/database.module';
@Module({
imports: [DatabaseModule],
controllers: [CatsController],
providers: [
CatsService,
...catsProviders,
],
})
export class CatsModule {}
```
> 不要忘記將 `CatsModule` 導入到根 `ApplicationModule` 中。
- 介紹
- 概述
- 第一步
- 控制器
- 提供者
- 模塊
- 中間件
- 異常過濾器
- 管道
- 守衛
- 攔截器
- 自定義裝飾器
- 基礎知識
- 自定義提供者
- 異步提供者
- 動態模塊
- 注入作用域
- 循環依賴
- 模塊參考
- 懶加載模塊
- 應用上下文
- 生命周期事件
- 跨平臺
- 測試
- 技術
- 數據庫
- Mongo
- 配置
- 驗證
- 緩存
- 序列化
- 版本控制
- 定時任務
- 隊列
- 日志
- Cookies
- 事件
- 壓縮
- 文件上傳
- 流式處理文件
- HTTP模塊
- Session(會話)
- MVC
- 性能(Fastify)
- 服務器端事件發送
- 安全
- 認證(Authentication)
- 授權(Authorization)
- 加密和散列
- Helmet
- CORS(跨域請求)
- CSRF保護
- 限速
- GraphQL
- 快速開始
- 解析器(resolvers)
- 變更(Mutations)
- 訂閱(Subscriptions)
- 標量(Scalars)
- 指令(directives)
- 接口(Interfaces)
- 聯合類型
- 枚舉(Enums)
- 字段中間件
- 映射類型
- 插件
- 復雜性
- 擴展
- CLI插件
- 生成SDL
- 其他功能
- 聯合服務
- 遷移指南
- Websocket
- 網關
- 異常過濾器
- 管道
- 守衛
- 攔截器
- 適配器
- 微服務
- 概述
- Redis
- MQTT
- NATS
- RabbitMQ
- Kafka
- gRPC
- 自定義傳輸器
- 異常過濾器
- 管道
- 守衛
- 攔截器
- 獨立應用
- Cli
- 概述
- 工作空間
- 庫
- 用法
- 腳本
- Openapi
- 介紹
- 類型和參數
- 操作
- 安全
- 映射類型
- 裝飾器
- CLI插件
- 其他特性
- 遷移指南
- 秘籍
- CRUD 生成器
- 熱重載
- MikroORM
- TypeORM
- Mongoose
- 序列化
- 路由模塊
- Swagger
- 健康檢查
- CQRS
- 文檔
- Prisma
- 靜態服務
- Nest Commander
- 問答
- Serverless
- HTTP 適配器
- 全局路由前綴
- 混合應用
- HTTPS 和多服務器
- 請求生命周期
- 常見錯誤
- 實例
- 遷移指南
- 發現
- 誰在使用Nest?