كيف تبني وتبني

الخلفية

بعد أن اجتمعت في العديد من الأماكن في تطوير Javascript مع المواقف التي كان من الضروري فيها التحقق من القيم ، أصبح من الواضح أنه كان من الضروري حل هذه المشكلة بطريقة أو بأخرى. لهذا الغرض ، تم تعيين المهمة التالية:
تطوير مكتبة تمكن:

• التحقق من أنواع البيانات ؛
• تعيين القيم الافتراضية بدلاً من الحقول أو العناصر غير الصالحة ؛
• حذف أجزاء غير صالحة من كائن أو صفيف ؛
• تلقي رسالة خطأ

سيكون أساسها:

• سهل التعلم
• قراءة الرمز المستلم.
• سهولة تعديل الكود

لتحقيق هذه الأهداف ، تم تطوير مكتبة للتحقق من صحة الرباعية .

طوب التحقق الأساسي

في قلب معظم الأنظمة التي تم تصميمها لتكون قابلة للتطبيق في مجموعة واسعة من المهام هي أبسط العناصر : الإجراءات والبيانات والخوارزميات. بالإضافة إلى طرق تكوينها - من أجل تجميع شيء أكثر تعقيدًا من العناصر البسيطة لحل المشكلات الأكثر تعقيدًا.

مدقق

تعتمد مكتبة اللجنة الرباعية على مفهوم المدقق . المدققون في هذه المكتبة هم وظائف النموذج التالي

function validator( value: any, { key: string|int, parent: any }, { key: string|int, parent: any }, ... ): boolean 

هناك عدة أشياء في هذا التعريف يجب وصفها بمزيد من التفصيل:

function(...): boolean - تقول أن المدقق - يحسب نتيجة التحقق ، ونتيجة التحقق هي قيمة منطقية - صحيحة أو خاطئة ، على التوالي صالحة أو غير صالحة

value: any - تشير إلى أن المدقق - يحسب نتيجة التحقق من قيمة ، والتي يمكن أن تكون أي قيمة جافا سكريبت. يقوم المدقق إما بتعيين القيمة التي تم التحقق منها لتكون صالحة أو غير صالحة.

{ key: string|int, parent: any }, ... - يشير إلى أن القيمة التي تم التحقق منها يمكن أن تكون في سياقات مختلفة بناءً على مستوى تداخل القيمة. دعونا نظهر ذلك مع الأمثلة

قيمة المثال بدون أي سياق

 const value = 4; //         . //         : const isValueValid = validator(4) 

قيمة المثال في سياق صفيف

 //  0 1 2 3 4 const arr = [1, 2, 3, value, 5] //       (k): 3 //      : [1, 2, 3, value, 5] //    value -      const isValueValid = validator(4, { key: 3, parent: [1,2,3,4,5] }) 

قيمة المثال في سياق كائن

 const obj = { a: 1, b: 2, c: value, d: 8 } //        'c' //       : { a: 1, b: 2, c: 4, d: 8 } //    value -   //   : const isValueValid = validator(4, { key: 'c', parent: { a: 1, b: 2, c: 4, d: 8 } }) 

نظرًا لأن الهياكل في كائن ما يمكن أن يكون لها تداخل أكبر ، فمن المنطقي التحدث عن مجموعة متنوعة من السياقات

 const arrOfObj = [{ a: 1, b: 2, c: value, d: 8 }, // ... ] //   c     'c' //    : { a: 1, b: 2, c: 4, d: 8 } //        arrOfObj, //       0. //    value -      const isValueValid = validator( 4, { key: 'c', parent: { a: 1, b: 2, c: 4, d: 8 } } { key: 0, parent: [{ a: 1, b: 2, c: 4, d: 8 }] } ) 

وهكذا دواليك.

ماذا يجب أن نبني منزل؟

لا يبرز الطوب الموصوف أعلاه من بين "الحلول الحجرية" الأخرى التي تقع على عكاز جافا سكريبت "الشاطئ" . لذلك ، دعونا نبني منهم ، شيء أكثر تماسكًا وإثارة للاهتمام. لهذا لدينا تكوين .

كيفية بناء ناطحة سحاب للتحقق من الكائن؟

أوافق ، سيكون من المناسب التحقق من الكائنات بطريقة تجعل وصف التحقق يتطابق مع وصف الكائن. لهذا سوف نستخدم تكوين كائن المصادقات . يبدو هذا:

 //    quartet const quartet = require('quartet') //    (v -  validator) const v = quartet() //      , //     const objectSchema = { a: a => typeof a ==='string', //   'string' b: b => typeof b === 'number', //   'number' // ... } const compositeObjValidator = v(objectSchema) const obj = { a: 'some text', b: 2 } const isObjValid = compositeObjValidator(obj) console.log(isObjValid) // => true 

كما ترون ، من طابوق المصادقة المختلفة المحددة لحقول معينة ، يمكننا تجميع مدقق الكائن - بعض "المباني الصغيرة" التي لا تزال ضيقة للغاية - ولكن أفضل من دونها. لهذا ، نستخدم مؤلف المدققين v . في كل مرة ، يلتقي الكائن بالحرف v في مكان المدقق ، سيعتبره تكوينًا للكائن ، ويحوله إلى مدقق كائن في حقوله.

في بعض الأحيان لا يمكننا وصف جميع الحقول . على سبيل المثال ، عندما يكون الكائن عبارة عن قاموس بيانات:

 const quartet = require('quartet') const v = quartet() const isStringValidator = name => typeof name === 'string' const keyValueValidator = (value, { key }) => value.length === 1 && key.length === 1 const dictionarySchema= { dictionaryName: isStringValidator, ...v.rest(keyValueValidator) } const compositeObjValidator = v(dictionarySchema) const obj = { dictionaryName: 'next letter', b: 'c', c: 'd' } const isObjValid = compositeObjValidator(obj) console.log(isObjValid) // => true const obj2 = { dictionaryName: 'next letter', b: 'a', a: 'invalid value', notValidKey: 'a' } const isObj2Valid = compositeObjValidator(obj2) console.log(isObj2Valid) // => false 

كيفية إعادة استخدام حلول البناء؟

كما رأينا أعلاه ، هناك حاجة إلى إعادة استخدام أدوات التحقق البسيطة. في هذه الأمثلة ، كان علينا بالفعل استخدام "مدقق نوع السلسلة" مرتين بالفعل.

من أجل تقصير السجل وزيادة قابليته للقراءة ، تستخدم مكتبة اللجنة الرباعية سلسلة مرادفات للمصادقين. عندما يصادف مؤلف المدقق سلسلة في المكان الذي يجب أن يكون فيه المدقق ، فإنه يبحث في القاموس عن مدققه ويستخدمه .

بشكل افتراضي ، يتم تحديد أدوات التحقق الأكثر شيوعًا بالفعل في المكتبة.

خذ بعين الاعتبار الأمثلة التالية:

 v('number')(1) // => true v('number')('1') // => false v('string')('1') // => true v('string')(null) // => false v('null')(null) // => true v('object')(null) // => true v('object!')(null) // => false // ... 

والعديد من الآخرين الموصوفة في الوثائق .

كل قوس له نوعه الخاص من الطوب؟

مؤلف المصدق (الوظيفة v ) هو أيضًا مصنع مصدق. بمعنى أنه يحتوي على العديد من الطرق المفيدة التي تعود

• المصادق وظيفة
• القيم التي سوف يدركها الملحن على أنها مخططات لإنشاء مدققين

على سبيل المثال ، دعنا نلقي نظرة على التحقق من صحة المصفوفة: غالبًا ما تتكون من التحقق من نوع المصفوفة والتحقق من جميع عناصره. سنستخدم طريقة v.arrayOf(elementValidator) لهذا الغرض. على سبيل المثال ، خذ مجموعة من النقاط مع الأسماء.

  const a = [ {x: 1, y: 1, name: 'A'}, {x: 2, y: 1, name: 'B'}, {x: -1, y: 2, name: 'C'}, {x: 1, y: 3, name: 'D'}, ] 

بما أن مصفوفة النقاط هي مصفوفة من الكائنات ، فمن المنطقي استخدام تكوين الكائن للتحقق من صحة عناصر الصفيف.

 const namedPointSchema = { x: 'number', // number -       y: 'number', name: 'string' // string -       } 

الآن ، باستخدام طريقة المصنع v.arrayOf ، قم بإنشاء مدقق للصفيف بأكمله.

 const isArrayValid = v.arrayOf({ x: 'number', y: 'number', name: 'string' }) 

دعونا نرى كيف يعمل هذا المدقق:

 isArrayValid(0) // => false isArrayValid(null) // => false isArrayValid([]) // => true isArrayValid([1, 2, 3]) // => false isArrayValid([ {x: 1, y: 1, name: 'A'}, {x: 2, y: 1, name: 'B'}, {x: -1, y: 2, name: 'C'}, {x: 1, y: 3, name: 'D'}, ]) // => true 

هذه مجرد واحدة من طرق المصنع ، كل منها موصوف في الوثائق.

كما رأيت أعلاه ، فإن v.rest أيضًا أسلوب مصنع يقوم بإرجاع تكوين كائن يتحقق من جميع الحقول غير المحددة في تكوين الكائن. وهذا يعني أنه يمكن تضمينها في تكوين كائن آخر باستخدام spread-operator .

دعونا نذكر كمثال على استخدام العديد منهم:

 //    quartet const quartet = require('quartet') //    (v -  validator) const v = quartet() //   ,    const max = { name: 'Maxim', sex: 'male', age: 34, status: 'grandpa', friends: [ { name: 'Dima', friendDuration: '1 year'}, { name: 'Semen', friendDuration: '3 months'} ], workExperience: 2 } //  ,   "" , // ""  , ""   -  const nameSchema = v.and( 'not-empty', 'string', //   name => name[0].toUpperCase() === name[0] // - ) const maxSchema = { name: nameSchema, //       sex: v.enum('male', 'female'), //  -   . //       "" age: v.and('non-negative', 'safe-integer'), status: v.enum('grandpa', 'non-grandpa'), friends: v.arrayOf({ name: nameSchema, //      friendDuration: v.regex(/^[1-9]\d? (years?|months?)$/) }), workExperience: v.and('non-negative', 'safe-integer') } console.log(v(maxSchema)(max)) // => true 

أكون أو لا أكون؟

غالبًا ما يحدث أن تأخذ البيانات الصالحة أشكالًا مختلفة ، على سبيل المثال:

• يمكن أن يكون الرقم رقمًا ، أو يمكن أن يكون سلسلة.
• قد يحتوي الكائن point أو لا يحتوي على بعض الإحداثيات ، اعتمادًا على البعد.
• والعديد من الحالات الأخرى.

لتنظيم التحقق من المتغيرات ، يتم توفير نوع منفصل من التكوين - تكوين متغير. ويمثلها مجموعة من المصدقين من الخيارات الممكنة. يعتبر الكائن صالحًا عندما يبلغ أحد المصدقين على الأقل عن صحته.

خذ بعين الاعتبار مثال مع التحقق من صحة المعرف:

  const isValidId = v([ v.and('not-empty', 'string'), //       v.and('positive', 'safe-integer') //    ]) isValidId('') // => false isValidId('asdba32bas321ab321adb321abds546ba98s7') // => true isValidId(0) // => false isValidId(1) // => true isValidId(1123124) // => true 

مثال للتحقق من النقطة:

 const isPointValid = v([ { //    -    x  dimension: v.enum(1), x: 'number', // v.rest    false // ,    -  ...v.rest(() => false) }, //   -    { dimension: v.enum(2), x: 'number', y: 'number', ...v.rest(() => false) }, //   - x, y  z { dimension: v.enum(3), x: 'number', y: 'number', z: 'number', ...v.rest(() => false) }, ]) // ,    ,      ,     -  -    isPointValid(1) // => false isPointValid(null) // => false isPointValid({ dimension: 1, x: 2 }) // => true isPointValid({ dimension: 1, x: 2, y: 3 //   }) // => false isPointValid({ dimension: 2, x: 2, y: 3 }) // => true isPointValid({ dimension: 3, x: 2, y: 3, z: 4 }) // => true // ... 

وبالتالي ، كلما رأى الملحن صفيفًا ، سيعتبره تكوينًا لعناصر التحقق من الصفيف بهذه الطريقة بحيث عندما يعتبر أحدهم القيمة صالحة ، سيتوقف حساب التحقق وسيتم الاعتراف بالقيمة على أنها صالحة.

كما نرى ، لا يعتبر المؤلف وظيفة المدقق مدققًا فحسب ، بل أيضًا كل ما يمكن أن يؤدي إلى وظيفة المدقق.

كل خيارات المدقق هذه صالحة ويمكن استخدامها في أي مكان داخل المخطط حيث يجب أن يكون المدقق.

ونتيجة لذلك ، يكون مخطط العمل دائمًا على هذا النحو: v(schema) يُرجع وظيفة التحقق من الصحة. بعد ذلك ، يتم استدعاء وظيفة التحقق من الصحة هذه على قيم محددة:
v(schema)(value[, ...parents])

هل تعرضت لأي حوادث في موقع البناء؟

- ليس بعد ، ولا واحد
- سيفعلون!

يحدث أن البيانات غير صالحة ويجب أن نكون قادرين على تحديد سبب عدم صلاحيتها.

لهذا ، توفر مكتبة الرباعية آلية تفسير . وهو يتألف من حقيقة أنه عندما يكتشف المدقق ، سواء كان داخليًا أو خارجيًا ، صحة البيانات التي تم التحقق منها ، فيجب عليه إرسال ملاحظة توضيحية .

لهذه الأغراض ، يتم استخدام الوسيطة الثانية لملحن المصدقين v . يضيف التأثير الجانبي لإرسال ملاحظة توضيحية إلى صفيف v.explanation في حالة البيانات غير الصالحة.

مثال ، دعنا نتحقق من مصفوفة ، ونريد معرفة أرقام جميع العناصر غير الصالحة وقيمتها:

  //   -     //   const getExplanation = (value, { key: index }) => ({ invalidValue: value, index }) // ,       . //         v.explanation //    const arrValidator = v.arrayOf( v( 'number', //   getExplanation //   "",   "" ) ) // ,     ""  //     ,     //         //   ,       const explainableArrValidator = v(arrValidator, 'this array is not valid') const arr = [1, 2, 3, 4, '5', '6', 7, '8'] explainableArrValidator(arr) // => false v.explanation // [ // { invalidValue: '5', index: 4 }, // { invalidValue: '6', index: 5 }, // { invalidValue: '8', index: 7 }, // 'this array is not valid' // ] 

كما ترى ، يعتمد اختيار الشرح على المهمة. في بعض الأحيان ليس من الضروري.

في بعض الأحيان نحتاج إلى القيام بشيء مع الحقول غير الصالحة. في مثل هذه الحالات ، من المنطقي استخدام اسم الحقل غير الصحيح كشرح :

 const objSchema = { a: v('number', 'a'), b: v('number', 'b'), c: v('string', 'c') } const isObjValid = v(objSchema) let invalidObj = { a: 1, b: '1', c: 3 } isObjValid(invalidObj) // => false v.explanation // ['b', 'c'] //     console.error(`${v.explanation.join(', ')} is not valid`) // => b, c is not valid //       (. ) invalidObj = v.omitInvalidProps(objSchema)(invalidObj) console.log(invalidObj) // => { a: 1 } 

باستخدام آلية التفسير هذه ، يمكنك تنفيذ أي سلوك مرتبط بنتائج التحقق.

يمكن أن يكون التفسير أي شيء:

• كائن يحتوي على المعلومات اللازمة ؛
• وظيفة تصحح الخطأ. ( getExplanation => function(invalid): valid ) ؛
• اسم الحقل أو فهرس العنصر غير الصالح ؛
• رمز الخطأ
• وكل هذا يكفي لخيالك.

ماذا تفعل عندما لا يتم بناء الأشياء؟

تصحيح أخطاء التحقق من الصحة ليست مهمة نادرة. لهذه الأغراض ، تستخدم المكتبة مدققين مع تأثير جانبي يتذكر مكان الخطأ وكيفية إصلاحه.

• v.default(validator, value) - إرجاع مدقق يتذكر قيمة غير صالحة ، وفي وقت استدعاء v.fix - يقوم بتعيين القيمة الافتراضية
• v.filter(validator) - إرجاع مدقق يتذكر قيمة غير صالحة ، وفي وقت استدعاء v.fix - يزيل هذه القيمة من الأصل
• v.addFix(validator, fixFunc) - يقوم بإرجاع المدقق الذي يتذكر قيمة غير صالحة ، وفي وقت استدعاء v.fix - يستدعي fixFunc بالمعلمات (القيمة ، {key ، mother} ، ...). fixFunc - يجب أن fixFunc أحد الشركاء - لتغيير القيمة

 const toPositive = (negativeValue, { key, parent }) => { parent[key] = -negativeValue } const objSchema = { a: v.default('number', 1), b: v.filter('string', ''), c: v.default('array', []), d: v.default('number', invalidValue => Number(invalidValue)), //    pos: v.and( v.default('number', 0), //     -  0 v.addFix('non-negative', toPositive) //     -   ) } const invalidObj = { a: 1, b: 2, c: 3, d: '4', pos: -3 } v.resetExplanation() //   v() v(objSchema)(invalidObj) // => false // v.hasFixes() => true const validObj = v.fix(invalidObj) console.log(validObj) // => { a: 1, b: '', c: [], d: 4 } 

الأعمال لا تزال في متناول اليد

هناك أيضًا طرق مساعدة لإجراءات التحقق في هذه المكتبة:

النتائج

تم حل المهام بالطرق التالية:

خاتمة

تم تصميم هذا الحل لإنشاء وظائف التحقق من الصحة بسرعة وسهولة مع القدرة على تضمين وظائف التحقق من الصحة المخصصة. لذلك ، إذا كان هناك أي تصحيحات ، انتقادات ، خيارات تحسين من أولئك الذين يقرؤون هذه المقالة ، نرحب بهم. شكرا لكم على اهتمامكم.