مزينات (Decorators) JavaScript للتحقق من صحة المعلمات: ضمان سلامة البيانات

في تطوير JavaScript الحديث، يعد ضمان سلامة البيانات التي يتم تمريرها إلى الدوال والأساليب أمرًا بالغ الأهمية. إحدى التقنيات القوية لتحقيق ذلك هي من خلال استخدام المزينات (Decorators) للتحقق من صحة المعلمات. توفر المزينات، وهي ميزة متاحة في JavaScript من خلال Babel أو بشكل أصلي في TypeScript، طريقة نظيفة وأنيقة لإضافة وظائف إلى الدوال والأصناف والخصائص. تتعمق هذه المقالة في عالم مزينات JavaScript، مع التركيز بشكل خاص على تطبيقها في فحص الوسائط، وتقدم أمثلة عملية ورؤى للمطورين من جميع المستويات.

ما هي مزينات JavaScript؟

المزينات هي نمط تصميمي يسمح لك بإضافة سلوك إلى صنف أو دالة أو خاصية موجودة ديناميكيًا وثابتًا. في جوهرها، هي "تزين" الكود الموجود بوظائف جديدة دون تعديل الكود الأصلي نفسه. يلتزم هذا بمبدأ الفتح/الإغلاق (Open/Closed Principle) لتصميم SOLID، والذي ينص على أن كيانات البرامج (الأصناف، الوحدات، الدوال، إلخ) يجب أن تكون مفتوحة للتوسع، ولكن مغلقة للتعديل.

في JavaScript، المزينات هي نوع خاص من الإعلانات يمكن إرفاقها بإعلان صنف أو أسلوب أو مُوصِّل (accessor) أو خاصية أو معلمة. تستخدم صيغة @expression، حيث يجب أن يتم تقييم expression إلى دالة سيتم استدعاؤها في وقت التشغيل مع معلومات حول الإعلان المزخرف.

لاستخدام المزينات في JavaScript، تحتاج عادةً إلى استخدام مُحوِّل (transpiler) مثل Babel مع تمكين المكون الإضافي @babel/plugin-proposal-decorators. تدعم TypeScript المزينات بشكل أصلي.

فوائد استخدام المزينات للتحقق من صحة المعلمات

يوفر استخدام المزينات للتحقق من صحة المعلمات العديد من المزايا:

• تحسين قابلية قراءة الكود: توفر المزينات طريقة تعريفية للتعبير عن قواعد التحقق، مما يجعل الكود أسهل في الفهم والصيانة.
• تقليل الكود المتكرر (Boilerplate): بدلاً من تكرار منطق التحقق في دوال متعددة، تسمح لك المزينات بتعريفه مرة واحدة وتطبيقه عبر قاعدة الكود الخاصة بك.
• تعزيز قابلية إعادة استخدام الكود: يمكن إعادة استخدام المزينات عبر الأصناف والدوال المختلفة، مما يعزز إعادة استخدام الكود ويقلل من التكرار.
• فصل الاهتمامات (Separation of Concerns): يتم فصل منطق التحقق عن منطق العمل الأساسي للدالة، مما يؤدي إلى كود أنظف وأكثر نمطية.
• مركزية منطق التحقق: يتم تعريف جميع قواعد التحقق في مكان واحد، مما يسهل تحديثها وصيانتها.

تنفيذ التحقق من صحة المعلمات باستخدام المزينات

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

مثال أساسي: التحقق من معلمة من نوع سلسلة نصية (String)

لنفترض وجود دالة تتوقع معلمة من نوع سلسلة نصية. يمكننا إنشاء مزين لضمان أن المعلمة هي بالفعل سلسلة نصية.

function validateString(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => typeof value === 'string' });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is invalid`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

function validate(...validators: ((value: any) => boolean)[]) {
  return function (target: any, propertyKey: string | symbol, descriptor: PropertyDescriptor) {
    const originalMethod = descriptor.value;

    descriptor.value = function (...args: any[]) {
      for (let i = 0; i < validators.length; i++) {
        if (!validators[i](args[i])) {
          throw new Error(`Parameter at index ${i} is invalid`);
        }
      }
      return originalMethod.apply(this, args);
    };
  };
}


function isString(value: any): boolean {
  return typeof value === 'string';
}

class Example {
  @validate(isString)
  greet( @validateString name: string) {
    return `Hello, ${name}!`;
  }
}

const example = new Example();

try {
  console.log(example.greet("Alice")); // المخرج: Hello, Alice!
  // example.greet(123); // يطلق خطأ
} catch (error:any) {
  console.error(error.message);
}

الشرح:

• يتم تطبيق المزين validateString على المعلمة name للأسلوب greet.
• يستخدم Reflect.defineMetadata و Reflect.getOwnMetadata لتخزين واسترداد البيانات الوصفية للتحقق المرتبطة بالأسلوب.
• قبل استدعاء الأسلوب الأصلي، يقوم بالتكرار عبر البيانات الوصفية للتحقق وتطبيق دالة التحقق على كل معلمة.
• إذا فشلت أي معلمة في التحقق، يتم إطلاق خطأ.
• يوفر المزين validate طريقة أكثر عمومية وقابلية للتركيب لتطبيق أدوات التحقق على المعلمات، مما يسمح بتحديد أدوات تحقق متعددة لكل معلمة.
• الدالة isString هي أداة تحقق بسيطة تتحقق مما إذا كانت القيمة سلسلة نصية.
• يوضح الصنف Example كيفية استخدام المزينات للتحقق من صحة المعلمة name للأسلوب greet.

مثال متقدم: التحقق من تنسيق البريد الإلكتروني

دعنا ننشئ مزينًا للتحقق من أن معلمة السلسلة النصية هي عنوان بريد إلكتروني صالح.

function validateEmail(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => {
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    return typeof value === 'string' && emailRegex.test(value);
  } });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is not a valid email address`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

class User {
  register( @validateEmail email: string) {
    return `Registered with email: ${email}`; 
  }
}

const user = new User();

try {
  console.log(user.register("test@example.com")); // المخرج: Registered with email: test@example.com
  // user.register("invalid-email"); // يطلق خطأ
} catch (error:any) {
  console.error(error.message);
}

الشرح:

• يستخدم المزين validateEmail تعبيرًا نمطيًا (regular expression) للتحقق مما إذا كانت المعلمة عنوان بريد إلكتروني صالحًا.
• إذا لم تكن المعلمة عنوان بريد إلكتروني صالحًا، يتم إطلاق خطأ.

دمج عدة أدوات تحقق (Validators)

يمكنك دمج أدوات تحقق متعددة باستخدام المزين validate ودوال التحقق المخصصة.

function isNotEmptyString(value: any): boolean {
  return typeof value === 'string' && value.trim() !== '';
}

function isPositiveNumber(value: any): boolean {
  return typeof value === 'number' && value > 0;
}

class Product {
  @validate(isNotEmptyString, isPositiveNumber)
  create(name: string, price: number) {
    return `Product created: ${name} - $${price}`;  
  }
}

const product = new Product();

try {
  console.log(product.create("Laptop", 1200)); // المخرج: Product created: Laptop - $1200
  // product.create("", 0); // يطلق خطأ
} catch (error:any) {
  console.error(error.message);
}

الشرح:

• تتحقق أداة التحقق isNotEmptyString مما إذا كانت السلسلة النصية غير فارغة بعد إزالة المسافات البيضاء.
• تتحقق أداة التحقق isPositiveNumber مما إذا كانت القيمة رقمًا موجبًا.
• يستخدم المزين validate لتطبيق كلتا أداتي التحقق على الأسلوب create للصنف Product.

أفضل الممارسات لاستخدام المزينات في التحقق من صحة المعلمات

فيما يلي بعض أفضل الممارسات التي يجب مراعاتها عند استخدام المزينات للتحقق من صحة المعلمات:

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

أمثلة واقعية وحالات استخدام

فيما يلي بعض الأمثلة الواقعية لكيفية استخدام المزينات للتحقق من صحة المعلمات:

• التحقق من صحة طلبات API: يمكن استخدام المزينات للتحقق من صحة معلمات طلبات API الواردة، مما يضمن توافقها مع أنواع البيانات والتنسيقات المتوقعة. هذا يمنع السلوك غير المتوقع في منطق الواجهة الخلفية الخاص بك. ضع في اعتبارك سيناريو حيث تتوقع نقطة نهاية API طلب تسجيل مستخدم بمعلمات مثل username و email و password. يمكن استخدام المزينات للتحقق من وجود هذه المعلمات، وأنها من النوع الصحيح (سلسلة نصية)، وتتوافق مع تنسيقات محددة (مثل التحقق من صحة عنوان البريد الإلكتروني باستخدام تعبير نمطي).
• التحقق من صحة إدخالات النماذج: يمكن استخدام المزينات للتحقق من صحة حقول إدخال النماذج، مما يضمن إدخال المستخدمين لبيانات صالحة. على سبيل المثال، التحقق من أن حقل الرمز البريدي يحتوي على تنسيق رمز بريدي صالح لبلد معين.
• التحقق من صحة استعلامات قاعدة البيانات: يمكن استخدام المزينات للتحقق من صحة المعلمات التي يتم تمريرها إلى استعلامات قاعدة البيانات، مما يمنع ثغرات حقن SQL. ضمان تعقيم البيانات التي يوفرها المستخدم بشكل صحيح قبل استخدامها في استعلام قاعدة البيانات. يمكن أن يشمل ذلك التحقق من أنواع البيانات والأطوال والتنسيقات، بالإضافة إلى تخطي الأحرف الخاصة لمنع حقن الكود الخبيث.
• التحقق من صحة ملفات التكوين: يمكن استخدام المزينات للتحقق من صحة إعدادات ملفات التكوين، مما يضمن أنها ضمن النطاقات المقبولة ومن النوع الصحيح.
• تسلسل/إلغاء تسلسل البيانات: يمكن استخدام المزينات للتحقق من صحة البيانات أثناء عمليات التسلسل وإلغاء التسلسل، مما يضمن سلامة البيانات ويمنع تلفها. التحقق من بنية بيانات JSON قبل معالجتها، وفرض الحقول المطلوبة وأنواع البيانات والتنسيقات.

مقارنة المزينات بتقنيات التحقق الأخرى

بينما تعد المزينات أداة قوية للتحقق من صحة المعلمات، من الضروري فهم نقاط قوتها وضعفها مقارنة بتقنيات التحقق الأخرى:

• التحقق اليدوي: يتضمن التحقق اليدوي كتابة منطق التحقق مباشرة داخل الدوال. يمكن أن يكون هذا النهج مملاً وعرضة للخطأ، خاصة بالنسبة لقواعد التحقق المعقدة. توفر المزينات نهجًا أكثر تعريفية وقابلية لإعادة الاستخدام.
• مكتبات التحقق: توفر مكتبات التحقق مجموعة من دوال وقواعد التحقق المعدة مسبقًا. في حين أن هذه المكتبات يمكن أن تكون مفيدة، إلا أنها قد لا تكون مرنة أو قابلة للتخصيص مثل المزينات. مكتبات مثل Joi أو Yup ممتازة لتعريف المخططات للتحقق من صحة الكائنات بأكملها، بينما تتفوق المزينات في التحقق من صحة المعلمات الفردية.
• البرمجيات الوسيطة (Middleware): غالبًا ما تستخدم البرمجيات الوسيطة للتحقق من صحة الطلبات في تطبيقات الويب. بينما تكون البرمجيات الوسيطة مناسبة للتحقق من صحة الطلبات بأكملها، يمكن استخدام المزينات للتحقق الأكثر دقة من معلمات الدوال الفردية.

الخاتمة

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

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

علاوة على ذلك، فإن الاعتماد المتزايد على TypeScript، الذي يوفر دعمًا أصليًا للمزينات، يجعل هذه التقنية أكثر إقناعًا لتطوير JavaScript الحديث. إن تبني المزينات للتحقق من صحة المعلمات هو خطوة نحو كتابة تطبيقات JavaScript أنظف وأكثر قابلية للصيانة وأكثر قوة.