Ajv format校驗(yàn)使用示例分析

更新時(shí)間：2022年11月01日 11:50:32 作者：每天都是不一樣的太陽(yáng)

這篇文章主要為大家介紹了Ajv format校驗(yàn)使用示例分析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

初始化項(xiàng)目demo

 npm init -y

安裝 Ajv 版本 7

 npm install ajv

安裝ajv-formats插件

 // ESM/TypeScript import
 import Ajv from "ajv"
 import addFormats from "ajv-formats"
 // Node.js require:
 const Ajv = require("ajv")
 const addFormats = require("ajv-formats")
 const ajv = new Ajv()
 addFormats(ajv)

運(yùn)行分解

新建index.js文件

導(dǎo)入ajv和對(duì)應(yīng)的format插件庫(kù)
定義對(duì)應(yīng)的schema結(jié)構(gòu)
調(diào)用ajv.compile()方法，對(duì)schema進(jìn)行編譯，返回一個(gè)待執(zhí)行的校驗(yàn)函數(shù)
執(zhí)行回調(diào)函數(shù)，并將我們需要判斷的data，當(dāng)做參數(shù)傳遞
判斷返回的結(jié)果

 const Ajv = require("ajv")
 const addFormats = require("ajv-formats")
 const ajv = new Ajv()
 addFormats(ajv)
 const schema = {
   type: "string",
   format: 'email',
   minLength: 1,
   maxLength: 255,
   pattern: '/^[a-zA-Z]/'
 };
 const validate = ajv.compile(schema)
 const data = 'string'
 const valid = validate(data)
 console.log(valid)
 if (!valid) console.log(validate.errors)

打開(kāi)控制臺(tái)，運(yùn)行node index.js。

分析

在這里我們就可以利用vscode自帶的調(diào)試功能，進(jìn)行代碼分析了。首先，我在19行打了斷點(diǎn)，這樣我們就可以觀察到函數(shù)的參數(shù)和調(diào)用情況了。不會(huì)調(diào)試的同學(xué)可以看看這篇文章新手向：前端程序員必學(xué)基本技能——調(diào)試JS代碼調(diào)試之后，就可以看到編譯之后的回調(diào)函數(shù)了。如下代碼

 (function anonymous(self, scope) {
   const schema11 = scope.schema[6];
   const formats0 = scope.formats[0];
   const func2 = scope.func[1];
   const pattern0 = scope.pattern[0];
   return function validate10(data, {instancePath = "", parentData, parentDataProperty, rootData = data} = {}) {
     let vErrors = null;
     let errors = 0;
     if (errors === 0) {
       if (errors === 0) {
         if (typeof data === "string") {
           if (func2(data) > 255) {
             validate10.errors = [{
               instancePath,
               schemaPath: "#/maxLength",
               keyword: "maxLength",
               params: {
                 limit: 255
               },
               message: "must NOT have more than 255 characters"
             }];
             return false;
           } else {
             if (func2(data) < 1) {
               validate10.errors = [{
                 instancePath,
                 schemaPath: "#/minLength",
                 keyword: "minLength",
                 params: {
                   limit: 1
                 },
                 message: "must NOT have fewer than 1 characters"
               }];
               return false;
             } else {
               if (!pattern0.test(data)) {
                 validate10.errors = [{
                   instancePath,
                   schemaPath: "#/pattern",
                   keyword: "pattern",
                   params: {
                     pattern: "/^[a-zA-Z]/"
                   },
                   message: "must match pattern "" + "/^[a-zA-Z]/" + """
                 }];
                 return false;
               } else {
                 if (!formats0.test(data)) {
                   validate10.errors = [{
                     instancePath,
                     schemaPath: "#/format",
                     keyword: "format",
                     params: {
                       format: "email"
                     },
                     message: "must match format "" + "email" + """
                   }];
                   return false;
                 }
               }
             }
           }
         } else {
           validate10.errors = [{
             instancePath,
             schemaPath: "#/type",
             keyword: "type",
             params: {
               type: "string"
             },
             message: "must be string"
           }];
           return false;
         }
       }
     }
     validate10.errors = vErrors;
     return errors === 0;
   };
 });

通過(guò)以上文件我們可以看到，ajv對(duì)我們定義好的shcma進(jìn)行編譯，編譯之后生成了一個(gè)回調(diào)函數(shù)。在回調(diào)函數(shù)中對(duì)，定義好的規(guī)則進(jìn)行判斷處理。

首先是對(duì)type類(lèi)型的判斷處理，然后是字符串類(lèi)型的最大長(zhǎng)度、最小長(zhǎng)度和正則的校驗(yàn)，最后是對(duì)format的規(guī)則校驗(yàn)。

如果，其中的一項(xiàng)不滿(mǎn)足規(guī)則時(shí)，直接會(huì)走到errors里邊，把錯(cuò)誤信息進(jìn)行處理輸出。