オゲネテガ?デネド著??

データの整合性を維持し、アプリケーションでの予期せぬ動(dòng)作を防ぐために、ユーザーまたはその他の外部ソースからのデータは事前??定義された構(gòu)造または形式に準(zhǔn)拠する必要があるため、スキーマ検証は本番環(huán)境に対応したアプリには必須です。

通常、開(kāi)発者は、ユーザーが Web サイトにフォームを送信するときの入力データ、または HTTP リクエスト経由で API に送信されるペイロードの検証を考え出す必要があります。ただし、この検証ロジックを手動(dòng)で記述するのは繰り返しが多く時(shí)間がかかるため、開(kāi)発者の生産性は良くありません。

幸いなことに、一般的な開(kāi)発タスク用のライブラリは JavaScript コミュニティ內(nèi)でほとんど問(wèn)題になっておらず、スキーマ検証も例外ではありません。

この記事では、VineJS と Zod の検証機(jī)能、パフォーマンス、ツールとの統(tǒng)合、エコシステムを評(píng)価して比較します。最後には、VineJS がパフォーマンスで優(yōu)れている一方で、Zod の多用途性と強(qiáng)力な TypeScript 統(tǒng)合により、ほとんどのプロジェクトにとって Zod がより包括的な選択肢となっていることがわかります。

VineJSとは何ですか?

VineJS は、軽量で使いやすく、パフォーマンスが高いように設(shè)計(jì)された最新の JavaScript/TypeScript スキーマ検証ライブラリです。

このプロジェクトは AdonisJS バリデーター コードベースから生まれ、アップグレードされ、スタンドアロン ライブラリとしてリリースされました。 VineJS は、Node.js サーバー側(cè)環(huán)境、特に API への受信リクエストを検証してペイロードが予期された形式であることを確認(rèn)してからさらに処理するようなシナリオで使用するために構(gòu)築されました。

VineJS の主な機(jī)能には次のようなものがあります。

• 軽量かつ高速 — ライブラリは、アプリケーションへのオーバーヘッドを最小限に抑えながらデータを効果的に検証できるよう軽量になるように設(shè)計(jì)されています
• TypeScript のサポート — VineJS は定義されたスキーマの型推論を提供するため、検証されたデータは正しく型付けされます
• カスタム エラー メッセージ — シンプルなメッセージ プロバイダー API を使用すると、エラー メッセージを明確かつコンテキスト固有になるようにカスタマイズできます
• 宣言構(gòu)文 — VineJS は、読みやすさとメンテナンスの容易さのために検証スキーマを定義する明確で簡(jiǎn)潔な方法も提供します
• スキーマのプリコンパイル — VineJS の傑出した機(jī)能の 1 つは、スキーマを最適化された JavaScript 関數(shù)にプリコンパイルして検証に再利用することでパフォーマンスを向上させる方法です
• 拡張性 — VineJS を使用すると、プロジェクトの特定のニーズを満たすカスタム スキーマ タイプと検証ルールを非常に簡(jiǎn)単に作成できます

次のセクションでは、これらの機(jī)能の一部がどのように機(jī)能するかを見(jiàn)ていきます。

VineJS を使用したスキーマ検証

VineJS のスキーマ検証機(jī)能のいくつかを見(jiàn)てみましょう。

基本的なデータ型

ユーザー入力や外部ソースからのデータを扱う場(chǎng)合、多くの場(chǎng)合、文字列、數(shù)値、ブール値などの基本的なデータ型を検証することが最初のステップとなります。 VineJS は、直感的な API を使用してこのプロセスを簡(jiǎn)素化します。

たとえば、ユーザーの年齢を検証してみましょう:

import vine, { errors } from "@vinejs/vine"; // NOTE: VineJS is ESM only

const ageSchema = vine.number().min(18).max(30);

try {
  const output = await vine.validate({ schema: ageSchema, data: 21 });
  console.log(output);
} catch (error) {
  if (error instanceof errors.E_VALIDATION_ERROR) {
    console.log("validation error: age is invalid");
  } else {
    console.log("an unexpected error occurred");
  }
}

この例では、入力が數(shù)値であることを確認(rèn)するための単純なスキーマを作成し、min メソッドと max メソッドを使用して入力が 18 から 30 の間にあることを確認(rèn)しました。VineJS は、検証をより正確にするために、これらの追加の検証ルールを提供します。

場(chǎng)合によっては、検証ルールを適用する前に入力データをフォーマットする必要があります。たとえば、検証前に入力文字列が確実に小文字に変換されるようにしたい場(chǎng)合は、スキーマ內(nèi)でこれを行うことができます:

const usernameSchema = vine
  .string()
  .toLowerCase()
  .minLength(3)
  .maxLength(15)
  .regex(/^[a-z0-9_]+$/);

console.log(vine.validate({schema: nameSchema, data: "Bruce_Wayne"})) // logs bruce wayne

このスキーマでは、ユーザー名は長(zhǎng)さと形式をチェックする前に小文字に変換されます。

オブジェクトと配列の検証

VineJS は基本的なスキーマ タイプに加えて、オブジェクトと配列の検証を提供するため、複數(shù)のフィールドを持つフォームや API ペイロードの検証に特に役立ちます。

ユーザーのプロフィールを表すオブジェクトを検証する方法を見(jiàn)てみましょう:

const userProfileSchema = vine.object({
  name: vine.string().minLength(3),
  email: vine.string().email(),
  age: vine.number().min(18).max(65).optional(),
});

const output = await vine.validate({
  schema: ageSchema,
  data: {
    name: "Jane Doe",
    email: "jane.doe@example.com",
    age: 29,
  },
}); // logs { name: 'Jane Doe', email: 'jane.doe@example.com', age: 29 }

この例では、名前、電子メール、年齢のフィールドを含むユーザー プロファイルのスキーマを設(shè)定しました。

vine.object() メソッドを使用すると、指定されたルールに従って各フィールドを検証できます。 vine.object 內(nèi)のすべてのフィールドはデフォルトで必須であるため、検証されるオブジェクト內(nèi)に存在する必要があります。ただし、optional() メソッドを使用して age フィールドをオプションとしてマークしているため、このフィールドが欠けていても検証は失敗しません。

配列も同様に処理できます:

const tagsSchema = vine
  .array(vine.string().minLength(2).maxLength(20))
  .minLength(1)
  .maxLength(10);

console.log(
  await vine.validate({
    schema: tagsSchema,
    data: ["tech", "news", "coding"],
  })
); // logs [ 'tech', 'news', 'coding' ]

この例では、スキーマにより、配列內(nèi)の各項(xiàng)目が 2 ～ 20 文字の長(zhǎng)さの文字列であることが保証され、配列自體には 1 ～ 10 個(gè)の要素が含まれている必要があります。これは、タグやカテゴリなどのリストを検証する場(chǎng)合に特に便利です。

スキーマのプリコンパイル

プリコンパイルは、スキーマを最適化された JavaScript 関數(shù)に変換する VineJS の重要な機(jī)能で、検証に再利用できるため、スキーマの解析と検証を繰り返すオーバーヘッドを削減できます。これは、実稼働環(huán)境でパフォーマンスを向上させるために非常に役立ちます。

スキーマをプリコンパイルするには、vine.compile() メソッドを使用できます。

const compiledSchema = vine.compile(
  vine.object({
    username: vine.string().minLength(3).maxLength(30),
    password: vine.string().minLength(8),
  })
);

// Use the compiled schema to validate data
console.log(
  await compiledSchema.validate({
    username: "janedoe",
    password: "password123",
  })
);

プリコンパイルは、トラフィックの多い API エンドポイントのスキーマなど、頻繁に検証が必要なスキーマに特に役立ちます。

スキーマは再利用可能な関數(shù)にコンパイルされるため、スキーマの解析と検証の繰り返しのプロセスが不要になり、VineJS が検証プロセスを高速化してアプリケーションの応答性を高めることができます。

カスタムエラーメッセージ

カスタム エラー メッセージを使用すると、ユーザーにより明確なフィードバックが提供され、間違いの特定と修正が容易になります。 VineJS は、組み込みの SimpleMessagesProvider API を使用して、エラー メッセージをキーと値のペアとして定義します。キーはルール名 (必須、文字列、または特定のフィールドとルールの組み合わせ) にすることができ、値は対応するエラー メッセージです。

SimpleMessagesProvider API は、グローバルに、スキーマごとのレベルで、または validate メソッドが呼び出されたときに構(gòu)成できます。以下のコード例では、API をグローバルに使用します。

たとえば、ユーザー名と電子メールフィールドのエラーメッセージをカスタマイズしたいとします。

import vine, { errors } from "@vinejs/vine"; // NOTE: VineJS is ESM only

const ageSchema = vine.number().min(18).max(30);

try {
  const output = await vine.validate({ schema: ageSchema, data: 21 });
  console.log(output);
} catch (error) {
  if (error instanceof errors.E_VALIDATION_ERROR) {
    console.log("validation error: age is invalid");
  } else {
    console.log("an unexpected error occurred");
  }
}

ネストされたフィールドまたは配列要素のメッセージをカスタマイズすることもできます。ネストされたフィールドの場(chǎng)合は、ドット表記を使用します:

const usernameSchema = vine
  .string()
  .toLowerCase()
  .minLength(3)
  .maxLength(15)
  .regex(/^[a-z0-9_]+$/);

console.log(vine.validate({schema: nameSchema, data: "Bruce_Wayne"})) // logs bruce wayne

配列要素の場(chǎng)合、ワイルドカード (*) を使用してすべての項(xiàng)目をターゲットにするか、インデックスを指定できます。

const userProfileSchema = vine.object({
  name: vine.string().minLength(3),
  email: vine.string().email(),
  age: vine.number().min(18).max(65).optional(),
});

const output = await vine.validate({
  schema: ageSchema,
  data: {
    name: "Jane Doe",
    email: "jane.doe@example.com",
    age: 29,
  },
}); // logs { name: 'Jane Doe', email: 'jane.doe@example.com', age: 29 }

VineJS では、フィールド名をより使いやすいラベルに置き換えることもできます。これは、コード內(nèi)のフィールド名がユーザー向けメッセージに適していない場(chǎng)合に役立ちます:

const tagsSchema = vine
  .array(vine.string().minLength(2).maxLength(20))
  .minLength(1)
  .maxLength(10);

console.log(
  await vine.validate({
    schema: tagsSchema,
    data: ["tech", "news", "coding"],
  })
); // logs [ 'tech', 'news', 'coding' ]

カスタム検証ルール

VineJS では、組み込みルールが提供する機(jī)能を超えて、開(kāi)発者が特定のニーズを満たすカスタム検証ルールを作成できるようになります。これらのカスタム ルールをプロジェクトで使用するには、スタンドアロン関數(shù)として実裝するか、既存のスキーマ クラスに統(tǒng)合します。

VineJS では、カスタム ルールは単にフィールドの値を更新または検証する関數(shù)です。通常、関數(shù)には 3 つのパラメータ (検証される値、ルールに必要なオプション、およびフィールド コンテキスト) が渡されます。

たとえば、文字列が有効な MongoDB ObjectId かどうかをチェックする mongodbId というカスタム ルールを作成してみましょう。

const compiledSchema = vine.compile(
  vine.object({
    username: vine.string().minLength(3).maxLength(30),
    password: vine.string().minLength(8),
  })
);

// Use the compiled schema to validate data
console.log(
  await compiledSchema.validate({
    username: "janedoe",
    password: "password123",
  })
);

このルールを VineJS スキーマ內(nèi)で使用できるようにするには、まず vine.createRule メソッドを使用してルールを VineJS 互換のルールに変換する必要があります。

import vine, { SimpleMessagesProvider } from '@vinejs/vine';

vine.messagesProvider = new SimpleMessagesProvider({
  'required': 'You must provide a value for {{ field }}.',
  'email': '{{ field }} needs to be a valid email address.',
  'username.required': 'A username is required to continue.',
});

使用法をさらに簡(jiǎn)素化するには、mongodbId メソッドを VineString クラスに直接追加して、チェーン可能な API を活用するとよいでしょう。

ゾッドとは何ですか？

Zod は、シンプルかつ強(qiáng)力な TypeScript ファーストのスキーマ検証ライブラリです。これにより、データ構(gòu)造と検証ルールの定義と適用が容易になり、フロントエンド アプリケーションとバックエンド アプリケーションの両方でうまく機(jī)能します。

Zod は TypeScript 専用に設(shè)計(jì)されており、TypeScript プロジェクトのスムーズな統(tǒng)合と強(qiáng)力な型推論を保証します。

Zod の主な機(jī)能の一部は次のとおりです:

• TypeScript の統(tǒng)合 — Zod は TypeScript と完全に互換性があり、検証ルールが TypeScript の型と同期していることを確認(rèn)するための優(yōu)れた型推論を提供します
• カスタム エラー メッセージ — Zod では、ユーザーへの有意義なフィードバックとしてカスタム エラー メッセージを指定できます
• ユーティリティ関數(shù) — スキーマの結(jié)合やルールの調(diào)整など、スキーマの構(gòu)成と検証に役立つ関數(shù)が含まれています
• 不変性 — Zod スキーマは不変です。つまり、作成後に誤って変更することができません
• 依存関係なし — Zod npm パッケージは非常に軽量で、外部依存関係がありません
• ブラウザと Node.js の互換性 — Zod は、検証スキーマの再利用に最適であるため、Node.js と最新のブラウザの両方で動(dòng)作します

Zod によるスキーマ検証

Zod はスキーマ検証を簡(jiǎn)単かつ柔軟にし、さまざまなデータ型と検証ニーズを簡(jiǎn)単に処理できるようにします。以下のセクションでわかるように、その構(gòu)文は V??ineJS に非常に似ています。

基本的なデータ型

Zod は、文字列、數(shù)値、ブール値、日付などの基本的なデータ型を適切に処理します。

たとえば、文字列と數(shù)値を検証するための簡(jiǎn)単なスキーマを作成してみましょう。

import vine, { errors } from "@vinejs/vine"; // NOTE: VineJS is ESM only

const ageSchema = vine.number().min(18).max(30);

try {
  const output = await vine.validate({ schema: ageSchema, data: 21 });
  console.log(output);
} catch (error) {
  if (error instanceof errors.E_VALIDATION_ERROR) {
    console.log("validation error: age is invalid");
  } else {
    console.log("an unexpected error occurred");
  }
}

この例では、nameSchema は「Peter Parker」が文字列であることを検証して合格しますが、年齢が 18 歳未満であるため ageResult は失敗します。

オブジェクトと配列の検証

オブジェクトや配列を扱う場(chǎng)合、Zod を使用するとデータの形狀を簡(jiǎn)単に定義できます。たとえば、ユーザー オブジェクトとタグのリストの検証は次のように行うことができます:

const usernameSchema = vine
  .string()
  .toLowerCase()
  .minLength(3)
  .maxLength(15)
  .regex(/^[a-z0-9_]+$/);

console.log(vine.validate({schema: nameSchema, data: "Bruce_Wayne"})) // logs bruce wayne

上記の例では、userSchema はユーザー データを検証し、tagSchema は配列に文字列のみが含まれていることを確認(rèn)します。 123 は文字列ではないため、配列の検証は失敗します。

カスタムエラーメッセージ

検証フィードバックをより便利にし、エラーの認(rèn)識(shí)を簡(jiǎn)単にするために、Zod は構(gòu)成可能なエラー メッセージもサポートしています。

たとえば、年齢が 18 歳未満の場(chǎng)合は、パーソナライズされたメッセージを設(shè)定できます。

const userProfileSchema = vine.object({
  name: vine.string().minLength(3),
  email: vine.string().email(),
  age: vine.number().min(18).max(65).optional(),
});

const output = await vine.validate({
  schema: ageSchema,
  data: {
    name: "Jane Doe",
    email: "jane.doe@example.com",
    age: 29,
  },
}); // logs { name: 'Jane Doe', email: 'jane.doe@example.com', age: 29 }

ここでは、検証が失敗し、カスタム エラー メッセージ「18 歳以上である必要があります。」とともにエラーがスローされます。

カスタム検証

Zod は、refine メソッドを使用してカスタム検証ロジックを作成する柔軟性を提供します。これにより、基本的な型チェックを超えたルールを適用できます。

たとえば、16 進(jìn)數(shù)のカラー コードを検証するには、それが文字列であるかどうかを単に判斷するだけでは十分ではありません。また、特定のパターンに従う必要もあります。その方法は次のとおりです:

const tagsSchema = vine
  .array(vine.string().minLength(2).maxLength(20))
  .minLength(1)
  .maxLength(10);

console.log(
  await vine.validate({
    schema: tagsSchema,
    data: ["tech", "news", "coding"],
  })
); // logs [ 'tech', 'news', 'coding' ]

この例では、文字列が 3 文字または 6 文字で構(gòu)成される有効な 16 進(jìn)カラー コード (#RGB または #RRGGBB) であるかどうかを判斷するために、refine メソッドを使用してカスタム検証ロジックが追加されます。

VineJS 対 Zod

パフォーマンス

VineJS ドキュメントのベンチマークは、VineJS が Node.js エコシステム內(nèi)で最も高速な検証ライブラリの 1 つであり、単純なオブジェクト検証やその他の検証において Yup や Zod を上回っていることを示しています。
VineJS ドキュメントに示されているとおり。

このグラフは、VineJS が優(yōu)れたパフォーマンスを提供し、高いパフォーマンスを必要とするバックエンド アプリケーションにとって優(yōu)れたソリューションであることを示しています。 Zod はうまく機(jī)能し、ほとんどのユースケースで十分な速度を示します。

TypeScript のサポート

TypeScript のサポートは両方とも優(yōu)れていますが、Zod は型推論をよりシームレスにするために TypeScript を念頭に置いて設(shè)計(jì)されました。 VineJS も TypeScript をサポートしていますが、それほど深く統(tǒng)合されていないため、TypeScript を多用するプロジェクトにとっては Zod がわずかに有利です。

生態(tài)系

より多くのリソース、チュートリアル、プラグインが利用できるため、Zod にはより大規(guī)模で確立されたコミュニティがあります。ただし、VineJS は新しく、リソースが少なく、コミュニティも小さいにもかかわらず、使いやすい API とパフォーマンス重視の設(shè)計(jì)により、さらに成長(zhǎng)すると予想されています。

制限事項(xiàng)

VineJS を使用する主な欠點(diǎn)は、VineJS がフロントエンド ランタイムで使用するように設(shè)計(jì)されていないことです。この制約のため、クライアント側(cè)の検証を必要とするアプリケーションにはあまり適していません。さらに、CommonJS はサポートされていないため、CommonJS を使用するプロジェクトでは問(wèn)題になる可能性があります。これは ECMAScript モジュール (ESM) でのみ機(jī)能します。

ただし、Zod はより汎用性が高く、2 つの主要な JavaScript モジュール システムをサポートしながら、コードを?qū)g行している環(huán)境に関係なく適切に動(dòng)作するため、フルスタック プロジェクトに適しています。

その他のスキーマ検証ライブラリ

VineJS と Zod 以外にも、スキーマ検証用の他のライブラリがいくつかあり、さまざまな使用例について言及する価値があります。

Yup はその使いやすさから好評(píng)で、特に React や Formik などのツールと組み合わせた場(chǎng)合に、フロントエンドの検証で頻繁に使用されます。 VineJS や Zod と比較すると、複雑な構(gòu)造ではうまく機(jī)能しない可能性がありますが、チェーン可能な API によりスキーマの開(kāi)発が簡(jiǎn)単になります。

Node.js バックエンドでよく使用される強(qiáng)力なライブラリは joi と呼ばれます。その API は VineJS や Zod の軽量アプローチよりも重く感じることがありますが、柔軟性が高く、深くネストされたオブジェクトの複雑な検証を管理します。高度な検証を必要とするサーバー側(cè)アプリには最適です。

速度と完全な JSON スキーマへの準(zhǔn)拠は、AJV の主な優(yōu)先事項(xiàng)です。 Zod や VineJS のようなユーザーフレンドリーな API はありませんが、特に API での JSON データの検証には最適です。ただし、巨大な JSON データセットの検証など、高い効率が必要なタスクには理想的です。

結(jié)論

VineJS と Zod は 2 つの優(yōu)れたスキーマ検証ツールであり、どちらを使用しても間違いはありませんが、異なる領(lǐng)域で優(yōu)れています。どちらを使用するかまだわからない場(chǎng)合は、小規(guī)模なプロジェクトで両方を試して、どちらが適切であるかを確認(rèn)してください。コーディングを楽しんでください!

---

LogRocket: コンテキストを理解することで JavaScript エラーをより簡(jiǎn)単にデバッグします

コードのデバッグは常に面倒な作業(yè)です。しかし、間違いを理解すればするほど、修正が容易になります。

LogRocket を使用すると、これらのエラーを新しい獨(dú)自の方法で理解できます。當(dāng)社のフロントエンド監(jiān)視ソリューションは、JavaScript フロントエンドに対するユーザーの関與を追跡し、エラーを引き起こしたユーザーの行動(dòng)を正確に確認(rèn)できるようにします。

LogRocket は、コンソール ログ、ページの読み込み時(shí)間、スタック トレース、ヘッダー本體を含む遅いネットワーク リクエスト/レスポンス、ブラウザーのメタデータ、カスタム ログを記録します。 JavaScript コードの影響を理解するのがこれまでになく簡(jiǎn)単になります!

無(wú)料でお試しください。

以上がスキーマ検証のための VineJS と Zodの詳細(xì)內(nèi)容です。詳細(xì)については、PHP 中國(guó)語(yǔ) Web サイトの他の関連記事を參照してください。