# 秘籍
## CRUD生成器
在一個項目的生命周期中,當我們新增特性的時候,我們通常需要在應用中添加新的資源。這些資源通常需要我們在每次新增資源的時候進行一些重復操作。
### 介紹
想象一下真實世界中的場景,我們需要通過兩個CRUD的終端暴露`User`和`Product`兩個實體。參考最佳時間,我們為每個實體進行以下操作。
- 生成一個模塊 (nest g mo) 來組織代碼,使其保持清晰的界限(將相關模塊分組)
- 生成一個控制器 (nest g co) 來定義CRUD路徑(或者GraphQL應用的查詢和變更)
- 生成一個服務 (nest g s) 來表示/隔離業務邏輯
- 生成一個實體類/接口來代表資源數據類型
- 生成數據轉換對象(或者`GraphQL`應用輸入)來決定數據如何通過網絡傳輸
很多步驟!
為了加速執行重復步驟,`Nest CLI`提供了一個生成器(`schematic(原理)`)可以自動生成所有的模板文件以減少上述步驟,同時讓開發者感覺更易用。
> 該`schematic`支持生成`HTTP`控制器,`微服務`控制器,`GraphQL`處理器(代碼優先或者原理優先),以及`WebSocket`網關等。
### 生成新資源
在項目根目錄下執行以下代碼來生成資源。
```bash
$ nest g resource
```
`nest g resource`命令不僅僅生成所有Nestjs構件模塊(模塊,服務,控制器類)也生成實體類,`DTO`類和測試(.spec)文件。
如下是一個生成的控制器 (`REST API`):
```TypeScript
@Controller('users')
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Post()
create(@Body() createUserDto: CreateUserDto) {
return this.usersService.create(createUserDto);
}
@Get()
findAll() {
return this.usersService.findAll();
}
@Get(':id')
findOne(@Param('id') id: string) {
return this.usersService.findOne(+id);
}
@Put(':id')
update(@Param('id') id: string, @Body() updateUserDto: UpdateUserDto) {
return this.usersService.update(+id, updateUserDto);
}
@Delete(':id')
remove(@Param('id') id: string) {
return this.usersService.remove(+id);
}
}
```
它也自動生成了所有CRUD終端占位符(REST API路徑,GraphQL查詢和編譯,微服務和WebSocket網關的消息訂閱器)--一鍵所有內容。
> 生成的資源類未與任何特定ORM(或者數據源)綁定,以在任何項目下通用。默認地,所有方法都包含了占位符,允許你用特定項目的數據源填充。類似地,如果你需要生成GraphQL應用的處理器,只要在傳輸層選擇GraphQL(代碼優先)或者GraphQL(原理優先)即可。
這里生成一個處理器類而不是一個REST API控制器:
```bash
$ nest g resource users
> ? What transport layer do you use? GraphQL (code first)
> ? Would you like to generate CRUD entry points? Yes
> CREATE src/users/users.module.ts (224 bytes)
> CREATE src/users/users.resolver.spec.ts (525 bytes)
> CREATE src/users/users.resolver.ts (1109 bytes)
> CREATE src/users/users.service.spec.ts (453 bytes)
> CREATE src/users/users.service.ts (625 bytes)
> CREATE src/users/dto/create-user.input.ts (195 bytes)
> CREATE src/users/dto/update-user.input.ts (281 bytes)
> CREATE src/users/entities/user.entity.ts (187 bytes)
> UPDATE src/app.module.ts (312 bytes)
```
> 像這樣傳遞`--no-spec`參數`nest g resource users --no-spec`來避免生成測試文件。
在下面我們可以看到,不僅生成了所有變更和查詢的樣板文件,也把他們綁定到了一起,我們可以使用`UsersService`, `User Entity`, 和`DTO`。
```TypeScript
import { Resolver, Query, Mutation, Args, Int } from '@nestjs/graphql';
import { UsersService } from './users.service';
import { User } from './entities/user.entity';
import { CreateUserInput } from './dto/create-user.input';
import { UpdateUserInput } from './dto/update-user.input';
@Resolver(() => User)
export class UsersResolver {
constructor(private readonly usersService: UsersService) {}
@Mutation(() => User)
createUser(@Args('createUserInput') createUserInput: CreateUserInput) {
return this.usersService.create(createUserInput);
}
@Query(() => [User], { name: 'users' })
findAll() {
return this.usersService.findAll();
}
@Query(() => User, { name: 'user' })
findOne(@Args('id', { type: () => Int }) id: number) {
return this.usersService.findOne(id);
}
@Mutation(() => User)
updateUser(@Args('updateUserInput') updateUserInput: UpdateUserInput) {
return this.usersService.update(updateUserInput.id, updateUserInput);
}
@Mutation(() => User)
removeUser(@Args('id', { type: () => Int }) id: number) {
return this.usersService.remove(id);
}
}
```
- 介紹
- 概述
- 第一步
- 控制器
- 提供者
- 模塊
- 中間件
- 異常過濾器
- 管道
- 守衛
- 攔截器
- 自定義裝飾器
- 基礎知識
- 自定義提供者
- 異步提供者
- 動態模塊
- 注入作用域
- 循環依賴
- 模塊參考
- 懶加載模塊
- 應用上下文
- 生命周期事件
- 跨平臺
- 測試
- 技術
- 數據庫
- 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?