NestJSのはじめ方

Transcript

1. NestJSのはじめ方 2023/4/28
2. 自己紹介 • 名前：ak2ie • システムエンジニア • 好きなもの：コーヒー
3. NestJSとは • Node.js上で動くバックエンドフレームワーク • TypeScriptでかける • CLIでファイルを生成可能 • ある程度決められたフォーマットに従って書くので、複数人で開発しやすい NestJSを知らない方向けに、どんな機能があるのかご紹介します
4. Controller NestJSの処理の流れ Middleware ログ Guard 認証 Pipe データ変換 Filter エラー制御
5. リクエストを処理したい！
6. Controller NestJSの処理の流れ
7. コントローラー（Controller） 【用途】 • リクエストをメインで処理 【定義方法】 • classにデコレーターをつけてController を定義 • メソッドにデコレーターをつけて処理を定 義 /cats をGETメソッドで呼び出す @Controller('cats') export class CatsController { @Get() findAll(): string { return 'This action returns all cats'; } } Controllerを定義 処理を定義
8. Controller • WebhookなどPOSTで呼び出された場 合、デフォルトではHTTPステータスコー ド201を返す • 200を返したい場合 @Post(‘webhook’) @HttpCode(200) hoge() { ……. } 例：LINE Messaging API
9. ログをとるには？
10. Controller NestJSの処理の流れ Middleware ログ
11. ミドルウェア（Middleware） 【用途（例）】 • ログ 【定義方法】 • @Injectableをつける • configureメソッドでセットアップ • Expressのミドルウェアも使えます // 定義 @Injectable() export class LoggerMiddleware ... { } // 使い方 export class AppModule implements NestModule { configure(consumer: MiddlewareConsumer) { consumer .apply(LoggerMiddleware) .forRoutes('cats'); } }
12. 認証するには？
13. Controller NestJSの処理の流れ Guard 認証
14. ガード（Guard） 【用途】 • 認証 【定義方法】 • @Injectableをつける • CanActivateメソッドで、true/falseを返 す • @UseGuards()で使う @Injectable() export class AuthGuard implements CanActivate { canActivate( … ) { return true; } } @UseGuards(AuthGuard)
15. 送られてきたデータを変換す るには？
16. Controller NestJSの処理の流れ Pipe データ変換
17. パイプ（Pipe） 【用途（例）】 • 送られてきたデータの変換 【定義方法】 • 標準のPipeもある • @Injectableをつけて、transformメソッド を実装する • ParseIntPipe • ParseBoolPipe
18. エラー発生時のレスポンスを 変えたい！
19. Controller NestJSの処理の流れ Filter エラー制御
20. フィルタ（Filter） 【用途（例）】 • エラー発生時の返却値を制御 【実装方法】 • コントローラーでエラーをCatchして、 NestJSのHttpExceptionを投げる try { await this.service.findAll() } catch (error) { throw new HttpException({ status: HttpStatus.FORBIDDEN, error: 'This is a custom message', }, HttpStatus.FORBIDDEN, { cause: error }); }
21. テストはかけるよね？
22. テスト • テストの雛形を作成可能 • Jestなど好きなツールを利用可能 • DI（依存性の注入）によりテスト実行が容 易 // 準備 const moduleRef = await Test.createTestingModule({ // テスト用モジュール }).compile(); catsController = moduleRef.get(CatsController); // テスト expect(await catsController.findAll()).toBe(result);
23. ところで、API定義書が ほしいんだけど？
24. OpenAPI（Swagger） • 実装に沿ったAPI定義書を表示できる • デコレータでサンプルデータを書くと、 モックサーバのレスポンスを定義できる http://localhost:3000/api
25. NestJSまとめ • Node.js上で動くバックエンドフレームワーク • TypeScriptでかける • テストのサポート、API定義書表示 • Controller：デコレーターで対応するHTTPメソッド等を定義 • Middleware：ログ • Guard：認証 • Pipe：リクエストデータ変換 • Controller：処理 • Filter：エラーレスポンス変換