概要

Drizzleは、Node.jsでのデータベース操作を効率化するシンプルなORMですが、型安全なバリデーションが求められる場合にはTypeBoxとの統合が便利です。TypeBoxは、TypeScriptでの型情報を基に、スキーマ定義とバリデーションを行えるライブラリで、データの型と構造を明確にしながら安全性を高められるのが特徴です。 TypeBoxを使ってDrizzle ORMでデータベース操作を行うと、型チェックとデータ整合性の確保が容易になります。本記事では、TypeBoxの基本的な使用方法とDrizzle ORMとの統合によるバリデーションの設定手順について解説します。

TypeBoxとは？

TypeBoxは、TypeScriptでの型定義を活用しつつ、JSONスキーマを基にしたバリデーションが行えるライブラリです。TypeBoxを使用すると、TypeScriptの型情報をJSONスキーマに変換し、APIデータの型安全なバリデーションが可能になります。

TypeBoxの主な機能

  • 型定義とバリデーションの統一：TypeScriptの型情報を直接利用してバリデーションが行えるため、スキーマ定義が一貫します。
  • JSONスキーマに基づくバリデーション：TypeBoxはJSONスキーマを生成できるため、標準的なJSONデータのバリデーションにも対応します。
  • データ整合性の確保：入力データが正しい型と構造を満たしているかを事前に確認できるため、データベース操作の信頼性が向上します。

Drizzle ORMとTypeBoxの統合によるメリット

TypeBoxをDrizzle ORMと組み合わせることで、データベースに保存するデータが事前に型チェックされ、コード補完やエラー検出が効率化されます。これにより、以下のメリットが得られます。

  1. 型安全性の向上：コード内での型の一貫性が保たれ、データの信頼性が向上します。
  2. コード補完機能の活用：型情報が明確になることで、エディタの補完機能が有効になり、コーディングの効率が向上します。
  3. エラーの未然防止：バリデーションで不適切なデータが検出されるため、予期しないエラーが未然に防止されます。

TypeBoxの基本的なスキーマ定義方法

まず、TypeBoxを使用してデータのスキーマを定義します。以下は、ユーザーデータを例にしたスキーマ定義です。

インストール

はじめに、TypeBoxをプロジェクトにインストールします。

npm install @sinclair/typebox

TypeBoxでのスキーマ定義

TypeBoxでは、スキーマを定義する際にTypeオブジェクトを使います。

import { Type } from '@sinclair/typebox';
const UserSchema = Type.Object({
    id: Type.Number(),
    name: Type.String({ minLength: 1 }),
    email: Type.String({ format: 'email' }),
    age: Type.Optional(Type.Number())
});

スキーマの各プロパティについて

  • id：数値型で、必須項目。
  • name：最小1文字の文字列型で、必須項目。
  • email：メールフォーマットを持つ文字列型で、必須項目。
  • age：オプションの数値型で、存在しなくても問題ない設定です。 このようにTypeBoxを使用すると、TypeScriptの型とスキーマバリデーションを統一して定義できます。

Drizzle ORMでTypeBoxを使用したデータバリデーションの適用

TypeBoxでデータを検証してからデータベースに挿入

Drizzle ORMでTypeBoxを使ってデータを保存する前に、スキーマに基づいてデータを検証します。以下は、ユーザーデータをデータベースに挿入する前にTypeBoxで検証する例です。

import { drizzle } from 'drizzle-orm';
import { UserSchema } from './schemas';
import { dbConnection } from './dbConnection';
import { Value, TypeCompiler } from '@sinclair/typebox/compiler';
const db = drizzle(dbConnection);
// TypeBoxでコンパイル済みのバリデーションを使用
const validateUser = TypeCompiler.Compile(UserSchema);
async function createUser(userData) {
    if (!validateUser.Check(userData)) {
        throw new Error('バリデーションエラー: ユーザーのデータが不正です');
    }
    // バリデーションを通過したデータをデータベースに挿入
    await db.insert('users').values(userData);
    console.log('ユーザーが正常に作成されました');
}

コードの解説

  1. スキーマのコンパイル：TypeCompiler.Compile()でコンパイル済みのバリデーション関数を生成し、効率的なチェックが可能になります。
  2. バリデーションの実行：validateUser.Check(userData)でuserDataがスキーマを満たしているかをチェックし、不正データの場合はエラーをスローします。
  3. データの挿入：バリデーションを通過したデータだけがデータベースに挿入されるため、データ整合性が確保されます。

エラーハンドリング

TypeBoxでのバリデーションが失敗した場合、エラーをキャッチして適切な処理を行います。以下は、エラーメッセージを表示する例です。

async function createUserWithValidation(userData) {
    try {
        if (!validateUser.Check(userData)) {
            throw new Error('バリデーションエラー: ユーザーのデータが不正です');
        }
        await db.insert('users').values(userData);
        console.log('ユーザーが正常に作成されました');
    } catch (error) {
        console.error('エラー:', error.message);
    }
}

エラーハンドリングのポイント

  • エラーメッセージの表示：バリデーションエラーのメッセージをerror.messageで表示し、ユーザーにフィードバックを提供します。
  • データ整合性の維持：バリデーションエラーが発生した場合には、データベースへの挿入を中止するため、データの不整合を防ぎます。

よく使われるTypeBoxバリデーションのパターン

TypeBoxを使ってDrizzle ORMでバリデーションを行う際 には、さまざまなバリデーションパターンを使用できます。以下に、よく使われるバリデーションの例をいくつか紹介します。

配列のバリデーション

配列のバリデーションを行う場合、Type.Array()を使ってスキーマを定義します。

const TagsSchema = Type.Array(Type.String({ minLength: 1 }));

ネストされたオブジェクトのバリデーション

ネストされたデータ構造を持つオブジェクトも、TypeBoxで簡単にバリデーションできます。

const AddressSchema = Type.Object({
    street: Type.String(),
    city: Type.String(),
    zipCode: Type.String({ minLength: 5 })
});
const UserWithAddressSchema = Type.Object({
    id: Type.Number(),
    name: Type.String(),
    address: AddressSchema
});

カスタムバリデーション

TypeBoxは、独自のバリデーションロジックを追加するための拡張もサポートしています。例えば、特定のパターンや条件に基づいたチェックを行いたい場合に便利です。

const PasswordSchema = Type.String({ minLength: 8 }).WithConstraint((val) => /[A-Z]/.test(val), {
    message: 'パスワードは少なくとも1つの大文字を含む必要があります'
});

Drizzle ORMとTypeBoxを組み合わせるメリットまとめ

Drizzle ORMとTypeBoxの統合により、型安全で信頼性の高いデータ管理が実現します。TypeBoxでスキーマを定義してバリデーションを行うことで、コードの一貫性が保たれ、バグやデータ不整合の発生リスクが軽減されます。また、TypeScriptの型情報をそのまま活用できるため、コード補完やエラー検出が効率化され、開発スピードも向上します。Drizzle ORMを活用したプロジェクトにTypeBoxを導入し、より安全で効率的なデータベース操作を目指しましょう。

参照:

TypeBox integration | `Drizzle` ORM