Nest.js入門

ピン留めされたアイテム

minateru

学習用メモ

バリデーションと例外処理
- DTO
- バリデーション
  - Class Validator
    - 一覧
  - Pipes
  - Get uuidに対するバリデーションはいつ行うべきか
    - ParseUUIDPipeか、@IsUUID
- 例外処理
Logger
テスト
ストアドプロシージャー
- 略：ストアド、プロシージャー、sp
- 一度のDB接続でOK
SQLインジェクション
typedSQL
- 参考記事
Custom providers

minateru

リクエストからレスポンスまでの順序

ざっくり要約

クライアントがリクエストを送信。
コントローラーがリクエストを受け取り、ユースケースに処理を依頼。
ユースケースが、リポジトリインターフェースを介してデータ取得をリポジトリに依頼。
リポジトリは、データベースからデータを取得し、モデルにマッピング。
モデルがユースケースにデータを返し、ユースケースがそのデータをコントローラーに返す。
コントローラーがレスポンスをクライアントに返す。

1. クライアントからリクエスト

クライアント（ブラウザ、Postman、フロントエンドアプリなど）からHTTPリクエストを送信します。
例：GET /services/123 のようなリクエスト

2.コントローラー（Controller）

リクエストがNext.jsのアプリケーションに到達すると、対応するコントローラーがそのリクエストを受け取ります。
コントローラーは、リクエストの内容（パラメータやボディ）を読み取り、必要な処理をユースケース（またはリポジトリ層）に依頼します。
- ServiceController は、ServiceUsecase へリクエストを転送
例：ServiceControllerのgetServiceById()メソッドがserviceIdをパラメータとして受け取ります

⭐️メモ：確認↓

@Get(':id')
async getServiceById(@Param('id') id: string) {
    return this.serviceUsecase.findById(id);
}

3.ユースケース（Usecase）

コントローラーからのリクエストを受け取ったユースケースは、ビジネスロジックを実行します。
ユースケースは、IServiceRepository インターフェースを介して、データベースにアクセスするリポジトリ層にデータ取得を依頼します。
- これにより、データベース操作をビジネスロジックから切り離し、ユースケースがリポジトリの具体的な実装に依存しないようにします。
例：ServiceUsecaseのfindById()メソッドがリポジトリを使ってサービス情報を取得します。

export class ServicesUsecase {
    private readonly serviceRepository: IServiceRepository;
    constructor(serviceRepository: IServiceRepository){
        this.serviceRepository = serviceRepository;
    }

    findById = (id: string): Promise<Service> => {
        return this.serviceRepository.findById(id);
    }
}

4.リポジトリ（Repository）

ユースケースからの依頼を受けたリポジトリは、データベースにアクセスして必要なデータを取得します。リポジトリはIServiceRepositoryインターフェースを実装しているため、ユースケースはリポジトリの具体的な実装に依存せずに、リポジトリを利用できます。
ServicesRepositoryはIServiceRepositoryを実装し、findByIdメソッドを提供します。
リポジトリは、データベースから取得した情報をモデルにマッピングしてユースケースに返します。

⭐️メモ：確認↓

export class ServicesRepository implements IServiceRepository {
    constructor(private prisma: PrismaConnect) {}

    async findById(id: string): Promise<Service> {
        const data = await this.prisma.service.findUnique({
            select: { /* ...フィールド選択... */ }
            where: { serviceId: id },
        });
        return new Service(/* データをマッピング */);
    }
}

5.`IServiceRepository`インターフェース

IServiceRepositoryは、リポジトリに要求される処理（例：findById）に定義した抽象化された契約です。ユースケースは、このインターフェースを通してリポジトリとやりとりするため、リポジトリの実装に依存しません。

export interface IServiceRepository {
    findById(id: string): Promise<Service>;
}

6.モデル（Model）

リポジトリがデータベースから取得したデータは、Serviceというモデルにマッピングされます。このモデルはアプリケーションの中でサービスのデータを表すクラスです。
リポジトリはデータベースから取得した生データを、Serviceモデルに変換し、ユースケースに返します。これにより、ビジネスロジックやコンロとローラーはオブジェクト形式でデータを扱えるようになります。

⭐️メモ：確認↓

const service: Service = new Service(
    data.serviceId,
    data.userId,
    data.title,
    data.catchCopy,
    // 省略
);

7.ユースケースに戻る

リポジトリから取得したデータを受け取ったユースケースは、それをそのままコントローラーに返します。
ビジネスうロジックに基づいた追加の処理が必要な場合は、ここで実行します。（例えば、フィルタリングや追加ロジック）

8.コントローラーからレスポンスを返す

コントローラーは、ユースケースから返されたデータを受け取り、それをHTTPレスポンスとしてクライアントに返します。
データはモデルとして整理されているため、クライアントに適切な形で返されます。

⭐️メモ：確認↓

@Get(':id')
async getServiceById(@Param('id') id: string) {
    return this.serviceUsecase.findById(id);
}

9. クライアントにレスポンスが届く

最終的に、クライアントはリクエストに対するレスポンスを受け取ります。
レスポンスは通常、JSON形式でデータを提供します。

minateru

 Nest.js でよく使われるデコレータ

カテゴリ
デコレータ


クラスに付与するデコレータ

@Controller(), @Injectable(), @Module(), @Inject()


HTTPメソッドに関連するデコレータ

@Get(), @Post(), @Put(), @Delete(), @Patch()


リクエストのデータを取得するデコレータ

@Param(), @Query(), @Body(), @Headers(), @Req(), @Res()


ガードやミドルウェアに関連するデコレータ

@UseGuards(), @UseInterceptors()


その他のデコレータ

@HttpCode(), @UsePipes()



 1. クラスに付与するデコレータ
 @Controller()

 役割このクラスがコントローラーであることを示し、特定のルートパスに関連づけます。

 使用例@Controller('users')
export class UsersController {
  // /users に対応するエンドポイント
}

 詳細上記の場合、引数に設定されている/usersというルートパスになり、コントローラー内の全てのエンドポイントが自動的に/usersから始まるパスにマッピングされます。

 @Injectable()

 役割このクラスがNest.jsの依存性注入システムによって管理されるプロバイダー（サービス、リポジトリ、ファクトリなど）であることを示します。

 使用例@Injectable()
export class UsersService {
  // ビジネスロジックを実装
}

 詳細
@Injectable()を使うと、このクラスを他のクラスに依存性としてちゅうにゅうできるようになります。サービスやリポジトリなど、ビジネスロジックやデータアクセスを担当するクラスに付与されます。

 @Module()

 役割クラスをNest.jsモジュールとして定義します。モジュールはアプリケーションの依存関係を管理するために使われます。

 @Inject()

 役割依存性を手動で注入したい場合に使用します。カスタムプロバイダや特定のインスタンスを注入する際に便利です。

 使用例constructor(@Inject('CUSTOM_TOKEN') private readonly customService: CustomService) {}

 2. HTTPメソッドに関連するデコレータ
 @Get() , @Post() , @Put() , @Delete() , @Patch()

 役割コントローラー内で、HTTPリクエストのメソッドを指定します。GET、POST、PUT、DELETE、PATCHなどのリクエストを処理するメソッドを定義する際に使います。

 使用例@Get(':id')
getUser(@Param('id') id: string) {
  // GETリクエストを処理
}

@Post()
createUser(@Body() createUserDto: CreateUserDto) {
  // POSTリクエストを処理
}

 詳細
@Get() ：リソースを取得するためのリクエスト（例：/users）

@Post()：新しいリソースを作成するリクエスト（例：/usesに新しいユーザーを作成）

@Put() ：リソースを完全に更新するリクエスト（例：/users/1のユーザーを更新）

@Delete()：リソースを削除するリクエスト（例：/users/1のユーザーを削除）

@Patch()：リソースを部分的に更新するリクエスト（例：/users/1のユーザー情報の一部を更新）

 3. リクエストのデータを取得するデコレータ
 @Param()

 役割リクエストのURLパラメータを取得します。

 使用例@Get(':id')
getUser(@Param('id') id: string) {
  return this.userService.findById(id);
}

 詳細
@Param('id') は、リクエストURL内の:idの値を取得します。エンドポイントの動的パスパラメータから値を取得したい場合に使います。

 @Query()

 役割クエリパラメータを取得します。例えば、GET /users?sort=asc のようなリクエストから sort の値を取得します。

 使用例@Get()
getUsers(@Query('sort') sort: string) {
  return this.userService.getAll(sort);
}

 詳細リクエストのペイロードからデータを取得します。例えば、フォームデータやJSONデータを処理するときに便利です。

 @Headers()

 役割リクエストヘッダーの値を取得します。

 使用例@Get()
getUserAgent(@Headers('user-agent') userAgent: string) {
  return userAgent;
}

 詳細リクエストヘッダーから特定の値（例えば、Authorization ヘッダーや User-Agent ヘッダー）を取得するために使用します。

 @Req() と @Res()

 役割リクエストやレスポンスオブジェクトに直接アクセスします。@Req() はリクエストオブジェクト、@Res() はレスポンスオブジェクトを取得します。

 使用例@Get()
getRequestData(@Req() req: Request) {
  console.log(req);
}

 詳細ExpressやFastifyのリクエスト・レスポンスオブジェクトに直接アクセスしたい場合に使います。標準的なNest.jsの方法を使わず、低レベルの操作を行いたいときに便利です。

 4.ガードやミドルウェアに関連するデコレータ
 @UseGuards()

 役割認証や認可などのガードを適用します。

 使用例@UseGuards(AuthGuard('jwt'))
@Get('profile')
getProfile(@Req() req) {
  return req.user;
}

 詳細
AuthGuard やカスタムガードを使って、特定のエンドポイントにアクセスする際の認証や認可を行います。

 @UseInterceptors()

 役割リクエストやレスポンスに対して、事前・事後処理を行うインターセプターを適用します。

 使用例@UseInterceptors(LoggingInterceptor)
@Get('data')
getData() {
  return { message: 'Hello, world!' };
}

 詳細インターセプターを使用して、リクエストやレスポンスのロギングやレスポンスのフォーマット変更などを行います。

 5.その他のよく使うデコレータ
 @HttpCode()

 役割認証や認可などのガードを適用します。

 使用例@HttpCode(204)
@Delete(':id')
deleteUser(@Param('id') id: string) {
  return this.userService.delete(id);
}

 詳細通常のHTTPメソッドに応じたデフォルトのステータスコード（200, 201など）を上書きしたい場合に使用します。

 @UsePipes()

 役割バリデーションや変換などのパイプを適用します。

 使用例@UsePipes(ValidationPipe)
@Post()
createUser(@Body() createUserDto: CreateUserDto) {
  return this.userService.create(createUserDto);
}

 詳細リクエストデータのバリデーションや型変換を行う際に使います。例えば、DTO（Data Transfer Object）を使ってバリデーションを行う場合に便利です。

カテゴリ	デコレータ
クラスに付与するデコレータ	`@Controller()`, `@Injectable()`, `@Module()`, `@Inject()`
HTTPメソッドに関連するデコレータ	`@Get()`, `@Post()`, `@Put()`, `@Delete()`, `@Patch()`
リクエストのデータを取得するデコレータ	`@Param()`, `@Query()`, `@Body()`, `@Headers()`, `@Req()`, `@Res()`
ガードやミドルウェアに関連するデコレータ	`@UseGuards()`, `@UseInterceptors()`
その他のデコレータ	`@HttpCode()`, `@UsePipes()`

minateru

 モデルモデルは「リクエストからレスポンスまでの順序」で記載の通り、

「モデルがユースケースにデータを返し、ユースケースがそのデータをコントローラーに返す」

という役割を果たしています。
ただ、これではモデルの説明が足りていないので補足します。
しかし、クリーンアーキテクチャにおけるモデルの役割はそれだけではありません。

モデルはドメインオブジェクトとして振る舞い、ビジネスロジックやドメインルールを具現化する重要な部分です。

特にDDD（ドメイン駆動設計）では、モデルがシステムの中心に位置し、ビジネスルールを反映するため、まずモデルを設計することが推奨されます。
モデルは、データベースからとってきたデータをクライアントが求めてるレスポンスのデータ形式に変える必要があるので、作成時は、どんなデータが必要か、レスポンスの形は適切か意識する必要があります。

minateru

 Nest.jsでのDTOの使い方を初心者向けに解説まず、Nest.jsは、Node.js向けの効率的で拡張性の高いサーバーサイドアプリケーションフレームワークです。

DTOは、一般的なデザインパターンであり、さまざまなプログラミング言語やフレームワークで使われています。

Nest.jsでは、DTOが特にAPI開発でよく使用されます。

コントローラーに送られてくるデータをDTOで受け取り、バリデーションを行い、ユースケースに渡すという使い方が一般的です。

この記事では、DTOの基本概念とNest.jsでの活用方法を解説します。

（個人的に視覚的に理解したいタイプなので図解も作りました！）

 目次DTOとは何か
DTOの役割
Nest.jsでのDTOの定義方法
DTOの使用例
データフローを図解
まとめ

 DTOとは何かDTO（Data Transfer Object）は、アプリケーション間やレイヤー間でデータを転送するためのオブジェクトです。主に以下の目的で使用されます：
データの構造を定義する
不要なデータの露出を防ぐ
データのバリデーションを容易にする

 DTOの役割
データ転送用:

DTOは、異なるレイヤー間（例えば、クライアントからサーバー、コントローラーからサービス、サービスからデータベースなど）でデータを転送するためのオブジェクトです。通常、HTTPリクエストやレスポンス、API呼び出しの際に使用されます。

データの整形・制限:

DTOは必要なデータのみを含みます。例えば、クライアントから送信されたデータを受け取る際、不要なデータ（パスワードや内部IDなど）は含まれないようにすることができます。

バリデーションに使用:

DTOには、class-validatorなどを使ってバリデーションルールを定義することができます。これにより、受信したデータが正しいかどうかを検証するために使われます。

 Nest.jsでのDTOの定義方法Nest.jsでは、クラスを用いてDTOを定義します。また、class-validatorとclass-transformerパッケージを使用して、バリデーションとデータの変換を行います。

validation（Nest.js公式ドキュメント）
Class Validator（Nest.js公式ドキュメント）
Class Validatorの一覧（Github）
Class Transformerの一覧（Github）


 必要なパッケージのインストールnpm install class-validator class-transformer

 DTOの作成例えば、ユーザー登録用のDTOを作成してみましょう。

class-validatorとclass-transformerを組み合わせてバリデーションやデータ変換を行います。
// create-user.dto.ts
import { IsString, IsEmail, IsNotEmpty, MinLength } from 'class-validator';

export class CreateUserDto {
  @IsEmail()
  email: string;

  @IsString()
  @MinLength(6)
  password: string;

  @IsString()
  @IsNotEmpty()
  name: string;
}

 DTOの使用例
 コントローラーでの使用// users.controller.ts
import { Controller, Post, Body } from '@nestjs/common';
import { CreateUserDto } from './create-user.dto';

@Controller('users')
export class UsersController {
  @Post()
  async create(@Body() createUserDto: CreateUserDto) {
    // サービスにデータを渡す
    return 'User created';
  }
}

 バリデーションパイプの適用Nest.jsでは、グローバルにバリデーションパイプを適用することで、DTOに対するバリデーションを自動的に行えます。
// main.ts
import { ValidationPipe } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.useGlobalPipes(new ValidationPipe());
  await app.listen(3000);
}
bootstrap();

 データフローを図解以下の図は、クライアントからサーバーへのリクエストと、DTOを通じてサービスまでデータが渡る流れを示しています。

以下を想定。

フレームワーク: Nest.js

言語: TypeScript

ORM: Prisma

バリデーションライブラリ: class-validator, class-transformer

アーキテクチャ: クリーンアーキテクチャ

設計パターン: リポジトリパターン

ドメイン駆動設計（DDD）: ドメインオブジェクトやユースケースを使用

データ転送オブジェクト（DTO）: クライアントからのデータバリデーションとデータ構造管理

 まとめDTOは、データの受け渡しやバリデーションを効率的に行うための強力なツールです。

Nest.jsでは、クラスとデコレーターを用いて簡単にDTOを定義し、バリデーションを実装できます。

学習用メモ

リクエストからレスポンスまでの順序

ざっくり要約

1. クライアントからリクエスト

2.コントローラー（Controller）

3.ユースケース（Usecase）

4.リポジトリ（Repository）

5.IServiceRepositoryインターフェース

6.モデル（Model）

7.ユースケースに戻る

8.コントローラーからレスポンスを返す

9. クライアントにレスポンスが届く

Nest.js でよく使われるデコレータ

1. クラスに付与するデコレータ

@Controller()

役割

使用例

詳細

@Injectable()

役割

使用例

詳細

@Module()

役割

@Inject()

役割

使用例

2. HTTPメソッドに関連するデコレータ

@Get() , @Post() , @Put() , @Delete() , @Patch()

役割

使用例

詳細

3. リクエストのデータを取得するデコレータ

@Param()

役割

使用例

詳細

@Query()

役割

使用例

詳細

@Headers()

役割

使用例

詳細

@Req() と @Res()

役割

使用例

詳細

4.ガードやミドルウェアに関連するデコレータ

@UseGuards()

役割

使用例

詳細

@UseInterceptors()

役割

使用例

詳細

5.その他のよく使うデコレータ

@HttpCode()

役割

使用例

詳細

@UsePipes()

役割

使用例

詳細

モデル

Nest.jsでのDTOの使い方を初心者向けに解説

目次

DTOとは何か

DTOの役割

Nest.jsでのDTOの定義方法

必要なパッケージのインストール

DTOの作成

DTOの使用例

コントローラーでの使用

バリデーションパイプの適用

データフローを図解

まとめ

5.`IServiceRepository`インターフェース

`@Controller()`

`@Injectable()`

`@Module()`

`@Inject()`

`@Get() , @Post() , @Put() , @Delete() , @Patch()`

`@Param()`

`@Query()`

`@Headers()`

`@Req()` と `@Res()`

`@UseGuards()`

`@UseInterceptors()`

`@HttpCode()`

`@UsePipes()`