Ajv format校驗使用示例分析

Posted on by

初始化項目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)

運行分解

新建index.js文件

  • 導入ajv和對應的format插件庫
  • 定義對應的schema結構
  • 調用ajv.compile()方法，對schema進行編譯，返回一個待執行的校驗函數
  • 執行回調函數，並將我們需要判斷的data，當做參數傳遞
  • 判斷返回的結果
 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)

打開控制臺，運行node index.js。

分析

在這裡我們就可以利用vscode自帶的調試功能，進行代碼分析瞭。首先，我在19行打瞭斷點，這樣我們就可以觀察到函數的參數和調用情況瞭。不會調試的同學可以看看這篇文章 新手向：前端程序員必學基本技能——調試JS代碼 調試之後，就可以看到編譯之後的回調函數瞭。如下代碼

 (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;
   };
 });

通過以上文件我們可以看到，ajv對我們定義好的shcma進行編譯，編譯之後生成瞭一個回調函數。在回調函數中對，定義好的規則進行判斷處理。

首先是對type類型的判斷處理，然後是字符串類型的最大長度、最小長度和正則的校驗，最後是對format的規則校驗。

如果，其中的一項不滿足規則時，直接會走到errors裡邊，把錯誤信息進行處理輸出。

總結

瞭解Ajv的的判斷邏輯，先進行schema的定義，然後compile進行schema的編譯、生成回調函數，最後輸入data數據進行校驗。

在我們定義好schema之後，在string類型中，他會按照先type、字符串最大長度、最小長度、正則判斷和format的順序進行，data的校驗。

以上就是Ajv format校驗使用示例分析的詳細內容，更多關於Ajv format校驗的資料請關註WalkonNet其它相關文章！

推薦閱讀：