CATEGORY

VeeValidateでVue.jsアプリのバリデーションを実装

「VeeValidate」は、Vue.jsアプリケーション用のバリデーションライブラリです。今回は、VeeValidateの導入手順と使い方について解説します。当記事の開発環境は以下の通り。

  • vue@2.7.4
  • vue-cli@5.0.8
  • vuetify@2.6.7

実装イメージ

今回は「従業員番号」「名前」「メールアドレス」を入力するような簡単なフォームのバリデーションを実装します。

バリデーション要件

項目バリデーションの内容
従業員番号4桁の数字、入力必須
名前入力必須
メールアドレスメールアドレス形式、入力必須

バリデーションエラーになった場合は、下記のような表示になります。

各項目ごとにエラーメッセージが表示され、送信ボタンは非活性のままです。全ての項目のバリデーションが通過したら、送信ボタンはアクティブになります。

実装

インストール

まずはプロジェクトディレクトリにVeeValidateをインストールします。

npm install vee-validate@3 --save

バリデーション実装

本解説では、コンポーネント(UI)とバリデーション(ロジック)は別々に管理したいという理由から、バリデーション定義用に「validate.js」を用意し、フォームのUIは「Validation.vue」に記述しています。

まずは完成系のコードは下記。

validate.js

import { ValidationProvider, ValidationObserver, extend, localize } from 'vee-validate';
import * as rules from 'vee-validate/dist/rules';
import ja_messages from 'vee-validate/dist/locale/ja.json';

// vee-validateのデフォルトルールをセット（https://vee-validate.logaretm.com/v3/guide/rules.html#rules）
Object.keys(rules).forEach(rule => {
    extend(rule, rules[rule]);
});

// カスタムルール
extend('positive', {
    message: "{_field_}は、0以上の奇数を入力してください",
    validate(value) {
        return value % 2 !== 0
    },
});

// メッセージの言語設定(各言語："vee-validate/dist/locale/")
// デフォルトはenなので、日本語化
localize("ja", ja_messages)

// グローバルコンポーネント
export default {
    components: {
        ValidationProvider,
        ValidationObserver
    },
    data: () => ({
        // 従業員番号
        max_employee_num: 4
    }),
    methods: {

    }
}

Validation.vue

<template>
    <v-app>
        <v-container>
            <validation-observer v-slot="{ invalid }" ref="observer">
                <validation-provider
                    name="数値"
                    :rules="{
                        required: {},
                        digits: max_employee_num
                    }"
                    v-slot="{ errors }"
                    tag="div"
                >
                    <v-text-field
                        label="従業員番号(4桁)"
                        v-model.trim="value"
                        type="text"
                        :color="errors.length > 0 ? 'red' : 'primary'"
                    ></v-text-field>
                    <div style="color: red;">{{ errors[0] }}</div>
                </validation-provider>
                <validation-provider
                    name="入力必須項目"
                    rules="required"
                    v-slot="{ errors }"
                    tag="div"
                >
                    <v-text-field
                        label="名前"
                        v-model.trim="value2"
                        type="text"
                    ></v-text-field>
                    <div style="color: red;">{{ errors[0] }}</div>
                </validation-provider>
                <validation-provider
                    name="メールアドレス(必須)"
                    rules="email|required"
                    v-slot="{ errors }"
                    tag="div"
                >
                    <v-text-field
                        label="メールアドレス"
                        v-model.trim="value3"
                        type="text"
                    ></v-text-field>
                    <div style="color: red;">{{ errors[0] }}</div>
                </validation-provider>
                <div class="mt-4">
                    <v-btn
                        outlined
                        :disabled="invalid"
                    >
                        送信
                    </v-btn>
                </div>
            </validation-observer>
        </v-container>
    </v-app>
</template>

<script>
export default {
    data: () => ({
        value: "",
        value2: "",
        value3: "",
    }),
    methods: {
        
    }
}
</script>

解説

ValidationObserverとValidationProvider

import { ValidationProvider, ValidationObserver} from 'vee-validate';
export default {
  components: {
    ValidationProvider,
    ValidationObserver
  }
};

VeeValidateを使用する上で、まず理解しておくべきことはValidationObserverとValidationProviderについてです。

まずValidationProviderは、各入力項目のバリデーションを実施します。

一方でValidationObserverは、個々のValidationProviderのバリデーションを監視し、全てのバリデーションが有効であるかどうかをチェックしています。

ValidationObserverとValidationProviderを登録しておくことで、下記のようにコンポーネントにバリデーションを組み込むことができます。

<validation-observer v-slot="{ invalid }" ref="observer">
<validation-provider
    name="入力必須項目"
    rules="required"
    v-slot="{ errors }"
>
    <v-text-field
        label="名前"
        v-model.trim="value2"
        type="text"
    ></v-text-field>
    <div>{{ errors[0] }}</div>
</validation-provider>
<div class="mt-4">
    <v-btn
        outlined
        :disabled="invalid"
    >
        送信
    </v-btn>
</div>
</validation-observer>

ここでいくつか気になる点が出てきているでしょう。

validation-providerの
・v-slot=”{ errors }”
・{{ errors[0] }}

validation-observerの
・v-slot=”{ invalid }”

この辺りが気になりますね。

ValidationProviderのv-slot=”{ errors }”は、バリデーションが通過しなかった場合のエラーメッセージデータが格納されます。そのためテンプレート構文{{ errors[0] }}を使って、エラーメッセージを表示できます。

ValidationObserverのv-slot=”{ invalid }”は、個々のValidationProviderのうち一つでも無効の場合、trueになります。送信ボタンに:disabled=”invalid”を記述しているのはそのためです。全てのバリデーションが通過しないと、ボタンを押せません。

<v-btn
    outlined
    :disabled="invalid"
>
    送信
</v-btn>

ルールの追加 extend

VeeValidateでは、extend(ルール名, ルールの内容)でバリデーションルールを定義できます。

import { ValidationProvider, ValidationObserver, extend, localize } from 'vee-validate';

// カスタムルール
extend('positive', {
    message: "{_field_}は、0以上の奇数を入力してください",
    validate(value) {
        return value % 2 !== 0
    },
});

エラーメッセージも独自に定義でき、extend()の第二引数のオブジェクトに、messageというkeyを定義すれば実現可能です。

コンポーネント側では下記のようにルールを定義します。

<validation-provider
   rules="positive"
   v-slot="{ errors }"
>
</validation-provider>

デフォルトで用意されたルール

VeeValidateは下記のようにデフォルトルールが豊富に用意されています。

ルール名ValidationProvider
alpharules="alpha"アルファベット
alpha_numrules="alpha_dash"英数字
alpha_dashrules="alpha_num"英数字とハイフン、アンダースコア
alpha_spacesrules="alpha_spaces"アルファベットと空白
betweenrules="between:1,11"{min}から{max}の間
confirmedrules="confirmed:confirmation"一致
digitsrules="digits:3"{length}桁の数字
dimensionsrules="dimensions:120,120"幅{width}px、高さ{height}px以内
emailrules="email"有効なメールアドレス
excludedrules="excluded:1,2"不正な値
extrules="ext:jpg,png"有効なファイル形式
imagerules="image"有効な画像形式
integerrules="integer"整数のみ
isrules="is:hello"一致
is_notrules="is_not:hello"無効
lengthrules="length:4"{length}文字
max_valuerules="max_value:4"{max}以下
maxrules="max:4"{length}文字以内
mimesrules="mimes:image/*"有効なファイル形式
min_valuerules="min_value:4"{min}以上
minrules="min:4"{length}文字以上
numericrules="numeric"数字のみ
oneOfrules="oneOf:1,2,3"有効な値
regex:rules="{ regex: /^[0-9]+$/ }"正規表現フォーマット
requiredrules="required"
:rules="{ required: {} }"		必須項目
required_ifrules="required_if:data,value"条件付き必須項目
sizerules="size:100"{size}KB以内
doublerules="double"フィールドは有効な10進数

公式ドキュメントを参照

これらの便利なルールを使わない手はありません。

下記の記述でVeeValidateのデフォルトのルールをインポートし、

import * as rules from ‘vee-validate/dist/rules’;

ループ処理で全てのルールをextend()で定義すれば、デフォルトのルールを全て使えるようになります。

import { ValidationProvider, ValidationObserver, extend, localize } from 'vee-validate';
import * as rules from 'vee-validate/dist/rules';

Object.keys(rules).forEach(rule => {
    extend(rule, rules[rule]);
});

ローカリゼーション

VeeValidateのデフォルトのルールを活用する場合、エラーメッセージは英語に設定されています。もしエラーメッセージを日本語化したい場合の方法を紹介します。

import { ValidationProvider, ValidationObserver, extend, localize } from 'vee-validate';
import * as rules from 'vee-validate/dist/rules';
import ja_messages from 'vee-validate/dist/locale/ja.json';

localize("ja", ja_messages)

VeeValidateは、英語以外にもさまざまな国の言語がサポートされているので、使用したい言語に合わせてカスタマイズが可能です。

node_modeles直下のライブラリファイルに定義されている、日本語メッセージファイルを読み込み、localize()で言語を定義すれば日本語のメッセージを使用できます。

import ja_messages from ‘vee-validate/dist/locale/ja.json’;
localize(“ja”, ja_messages)

【Vue.js】ApexChartsでグラフやチャートを生成する手順 前の記事 【Jest】非同期関数(Promise,async await)のテスト 次の記事

関連記事

  • Vue.js

個人的なVue.jsコンポーネント設計のベストプラクティス

Vue.jsを使ったフロントエンド開発において、コンポーネント設計は常に悩ましい課題です。単一責任の原則やAtomicデザイン、細かい分割の是非など、多くのアプローチがありますが、正解はありません。しかし、ルールがないとプロダクトの品質が低下するリスクがあるため、「指針」が求められます。

コメント

この記事へのコメントはありません。