フルスタックチャンネル
サインアップサインアップ
ログインログイン
利用規約プライバシーポリシーお問い合わせ
Copyright © All rights reserved | FullStackChannel
解決済
PrismaClientのインスタンス作成する際のコードを解説してください
Prisma
はる@講師
2023/11/08 09:50

実現したいこと

PrismaClientのインスタンス作成する際のコードを解説してください

ソースコード

import { PrismaClient } from "@prisma/client"

declare global {
  var prisma: PrismaClient | undefined
}

const client = globalThis.prisma || new PrismaClient()

if (process.env.NODE_ENV !== "production") {
  globalThis.prisma = client
}

export default client
回答 3件
login
回答するにはログインが必要です
はる@講師
1年以上前

このコードは、Node.js アプリケーションで PrismaClient のインスタンスを作成し、再利用するための一般的なパターンです。それぞれの部分が何をしているのかを分解してみましょう。

  1. PrismaClient のインポート:

    import { PrismaClient } from "@prisma/client"
    

    これは、PrismaClient クラスを Prisma ORM パッケージからインポートするためのコードです。これにより、データベース接続と操作のためのクライアントを作成できます。

  2. グローバル変数の宣言:

    declare global {
      var prisma: PrismaClient | undefined
    }
    

    TypeScript では、declare global ブロックを使用してグローバルスコープに新しい変数を追加できます。ここでは prisma という名前のグローバル変数を宣言し、その型を PrismaClient または undefined にしています。これは、アプリケーション全体で一つの PrismaClient インスタンスを再利用するために設定しています。

  3. PrismaClient インスタンスの作成と代入:

    const client = globalThis.prisma || new PrismaClient()
    

    globalThis.prisma が既に定義されている(つまり、前に作成された PrismaClient インスタンスがある)場合はそれを使用し、そうでない場合は新しい PrismaClient インスタンスを作成します。これにより、不必要に多くのインスタンスを作成することを避け、リソースの使用を最適化します。

  4. 開発環境でのグローバルインスタンスの設定:

    if (process.env.NODE_ENV !== "production") {
      globalThis.prisma = client
    }
    

    ここでは、環境が本番環境(production)ではない場合に限り、作成した client インスタンスを globalThis.prisma に割り当てています。これは、開発中にホットリロードなどの機能を使用しているときに、毎回新しいクライアントを作成するのを避けるためです。本番環境では、このような再代入は通常行われません。

  5. インスタンスのエクスポート:

    export default client
    

    最後に、作成したクライアントインスタンスをモジュールのデフォルトエクスポートとしてエクスポートしています。これにより、他のファイルからこのクライアントインスタンスを簡単にインポートして使用できます。

要約すると、このコードは開発時のリソース使用を最適化しつつ、アプリケーション全体で一つの PrismaClient インスタンスを共有するための効率的な手法を提供しています。また、本番環境では新しいインスタンスが必要になるたびに作成することで、ホットリロードなどの開発ツールによる不具合を防ぎます。

1
はる@講師
1年以上前

本番環境の場合は毎回新しいインスタンスを作成しているということですが、本番環境でも開発環境と同じように処理することでリソースの使用を最適化することはできないのでしょうか?

はる@講師
1年以上前

本番環境では、開発環境とは異なるいくつかの要因により、毎回新しい PrismaClient インスタンスを作成することが推奨される場合があります。

開発環境では、ホットリロードやライブリロードのような機能が頻繁に新しい PrismaClient インスタンスの作成を引き起こし、これによりメモリリークなどの問題が生じる可能性があります。そのため、グローバル変数にインスタンスを格納して再利用することで、この問題を回避できます。

しかし、本番環境では次のような理由で毎回新しいインスタンスを作成する方が適していることが多いです。

  1. サーバーレス環境:
    サーバーレス環境や自動スケーリングを利用する本番環境では、各関数呼び出しやリクエストに対して独立したコンテキストが与えられることが一般的です。グローバル状態を共有することは望ましくないため、それぞれの呼び出しで新しいインスタンスが生成されることになります。

  2. 安定性と可用性:
    新しいリクエストに対して新しいインスタンスを作成することで、万が一のエラーやリークがあった場合にも他のリクエストに影響を与えにくくなります。これにより、システムの安定性と可用性が向上します。

  3. メモリ管理:
    本番環境では、メモリ管理とリソースの清掃がより厳格に行われるため、グローバルインスタンスを使い回すよりも、リクエストごとにインスタンスを閉じて新しいものを作る方が、リークのリスクを減らすことができます。

ただし、これは一般的なガイドラインであり、実際のアプリケーションのニーズやインフラストラクチャーに応じて適切な戦略を選択する必要があります。一部の本番環境では、接続プールなどのメカニズムを使用して、再利用可能な PrismaClient インスタンスを効率的に管理することも可能です。重要なのは、本番環境の特性と要件に基づいて、最も効率的かつ安全なアプローチを選ぶことです。

1