【TypeScript】カレー作りで理解するZodライブラリ

はじめに

Zodライブラリは、TypeScriptの型安全を保証するために、データの構造を定義し、それが正しいかどうかを検証するためのツールです。このライブラリは、型定義とバリデーションを簡潔に行うことができ、特にAPIとのやり取りやフォーム入力の検証に役立ちます。

今回は、Zodを使ってバリデーションを行う方法について、カレー作りの例を交えながら説明します。

プログラミングは料理と同じ

料理をしたことがない人に、いきなり「フランス料理を作って」と言われても、それを実現するのはとても難しいでしょう。料理では、まず基本的な技術や知識を学ぶことが大切です。食材の切り方、調味料の使い方、火加減の調整など、一つひとつの要素を理解していくことで、徐々に複雑な料理にも挑戦できるようになります。

プログラミングも同じです。クラスや関数など、多くの概念を一度に理解するのは難しく感じるかもしれません。しかし、基本的な構文やロジック、ツールの使い方などを少しずつ学んでいくことで、次第に複雑なアプリケーションやシステムを構築できるようになります。

料理もプログラミングも、基礎を積み重ねることが成功の鍵です。一つひとつの要素を丁寧に学び、経験を積むことで、自分の手で創造的な成果を生み出せるようになるのです。焦らず、着実に取り組んでいきましょう！

Zodライブラリとは

Zodは、TypeScriptで使用されるスキーマバリデーションライブラリです。Zodを使用すると、オブジェクトの構造やデータ型を事前に定義して、そのデータが正しいかどうかを簡単に検証できます。これにより、アプリケーションのエラーを減らし、開発効率を向上させることができます。

Zodの主な機能は以下の通りです：

• 型安全なバリデーション
• 複雑なデータ構造の定義
• エラーハンドリングの簡素化

Zodを使うことで、データの検証が簡単かつ効率的に行え、プログラムが予期しない動作をするリスクを減らすことができます。

そもそもスキーマとは・・・

スキーマは、データの構造やルールを事前に定義する設計図のようなものです。プログラムでは、データが所定の形式に従っているかを検証するためにスキーマを使用します。例えば、ユーザーの入力内容が正しいかどうかをチェックする際に、スキーマを使って「このフィールドは文字列でなければならない」とか「このフィールドは必須である」といったルールを設定します。

スキーマを使うことで、データが期待通りの形になっているかを事前に確認でき、後でエラーが発生するリスクを減らせます。これが、特に大規模なアプリケーションや複数のシステム間でデータをやり取りする際に非常に重要になります。

カレー作りで例えると・・・

Zodライブラリを使用した場合と使用しない場合の違いをカレー作りにたとえて説明してみます。

Zodを使わない場合: 鍋に入れた後に気づく

材料を確認しないままカレー作りを進めてしまうイメージです。

1. 食材を鍋に投入し、煮込んでから「これ、じゃがいもじゃなくてサツマイモだった！」と気づく。
2. 調味料を入れた後に「塩じゃなくて砂糖を入れてしまった…」と発覚。
3. 煮込みが進んでから、「肉が鶏肉ではなく、魚だった」と判明する。

このように、バリデーションを行わないと、エラーに気づくのが工程の後半になり、修正が難しくなることがあります。結果として、カレーそのものが台無しになる可能性が高まります。

Zodを使った場合: 鍋に入れる前に事前にチェック

Zodを使うことで、材料を鍋に入れる前にリストを確認し、問題がないことを事前にチェックするイメージです。

1. 鍋に入れる前に「じゃがいもであること」「肉が鶏肉・牛肉・豚肉のいずれかであること」を手作業で確認。
2. スパイスを加える前に、「これは塩だな」「これが適切なカレー用スパイスだな」と確認。
3. 全ての材料がチェック済みなので、安心してカレー作りを進められる。

以下は、実際のコード例です。

import { z } from 'zod';

const currySchema = z.object({
  meat: z.enum(['chicken', 'beef', 'pork']),
  vegetables: z.array(z.string()).nonempty(),
  curryRue: z.string(),
});

// 材料データ
const ingredients = {
  meat: 'fish', // 不正なデータ
  vegetables: ['potato', 'carrot', 'onion'],
  curryRue: 'mild',
};

// チェック実行
const result = currySchema.safeParse(ingredients);

if (result.success) {
  console.log('材料はすべてOK！カレーを作り始めましょう。');
} else {
  console.log('材料に不備があります:', result.error.errors);
}

コード解説

1. currySchemaの定義

   • z.object()を使って、材料の条件をオブジェクト形式で定義しています。
   • meatは3種類（chicken, beef, pork）のいずれかである必要があります。
   • vegetablesは文字列の配列で、空でないことをチェックしています。
   • curry文字列であることを指定しています。

2. 材料データの作成

   • ingredientsオブジェクトは実際のデータです。この例では、meatに誤った値（fish）が入っています。

3. バリデーションの実行

   • safeParseを使用して、ingredientsがcurrySchemaに合致するか確認します。
   • result.successがtrueなら条件を満たしており、問題なく作業を進められます。
   • 失敗した場合（result.successがfalse）、エラーの内容がresult.error.errorsに格納されます。

4. エラーハンドリング

   • 条件に合わない場合、エラー内容が表示され、適切な修正が可能になります。

まとめ

スキーマは、データが適切かどうかをチェックするためのルールや枠組みを提供します。これにより、問題の早期発見が可能になり、後工程でのエラーやトラブルを未然に防ぐことができます。プログラミングにおいても、スキーマを活用することでコードの信頼性を高め、効率的な開発が実現します。