دکوراتورهای جاوا اسکریپت برای اعتبارسنجی پارامترها: تضمین یکپارچگی داده‌ها

در توسعه مدرن جاوا اسکریپت، تضمین یکپارچگی داده‌هایی که به توابع و متدها ارسال می‌شوند، امری حیاتی است. یکی از تکنیک‌های قدرتمند برای دستیابی به این هدف، استفاده از دکوراتورها برای اعتبارسنجی پارامترها است. دکوراتورها، که یک ویژگی در جاوا اسکریپت از طریق Babel یا به صورت بومی در تایپ‌اسکریپت در دسترس هستند، روشی تمیز و زیبا برای افزودن عملکرد به توابع، کلاس‌ها و خصوصیات فراهم می‌کنند. این مقاله به دنیای دکوراتورهای جاوا اسکریپت می‌پردازد و به طور خاص بر کاربرد آن‌ها در بررسی آرگومان‌ها تمرکز دارد و مثال‌های عملی و بینش‌هایی را برای توسعه‌دهندگان در تمام سطوح ارائه می‌دهد.

دکوراتورهای جاوا اسکریپت چه هستند؟

دکوراتورها یک الگوی طراحی هستند که به شما امکان می‌دهند به صورت پویا و ایستا، رفتار جدیدی به یک کلاس، تابع یا خصوصیت موجود اضافه کنید. در اصل، آن‌ها کد موجود را با عملکرد جدید "تزئین" می‌کنند بدون اینکه خود کد اصلی را تغییر دهند. این امر با اصل باز/بسته (Open/Closed Principle) از طراحی SOLID مطابقت دارد که بیان می‌کند موجودیت‌های نرم‌افزاری (کلاس‌ها، ماژول‌ها، توابع و غیره) باید برای توسعه باز، اما برای تغییر بسته باشند.

در جاوا اسکریپت، دکوراتورها نوع خاصی از اعلان هستند که می‌توانند به اعلان کلاس، متد، اکسسور، خصوصیت یا پارامتر متصل شوند. آن‌ها از سینتکس @expression استفاده می‌کنند، که در آن expression باید به تابعی ارزیابی شود که در زمان اجرا با اطلاعاتی در مورد اعلان تزئین‌شده فراخوانی خواهد شد.

برای استفاده از دکوراتورها در جاوا اسکریپت، معمولاً باید از یک ترانسپایلر مانند Babel با پلاگین @babel/plugin-proposal-decorators فعال‌شده استفاده کنید. تایپ‌اسکریپت به صورت بومی از دکوراتورها پشتیبانی می‌کند.

مزایای استفاده از دکوراتورها برای اعتبارسنجی پارامترها

استفاده از دکوراتورها برای اعتبارسنجی پارامترها مزایای متعددی دارد:

• بهبود خوانایی کد: دکوراتورها روشی اعلانی برای بیان قوانین اعتبارسنجی فراهم می‌کنند که باعث می‌شود کد آسان‌تر فهمیده و نگهداری شود.
• کاهش کد تکراری (Boilerplate): به جای تکرار منطق اعتبارسنجی در توابع متعدد، دکوراتورها به شما امکان می‌دهند آن را یک بار تعریف کرده و در سراسر کدبیس خود اعمال کنید.
• افزایش قابلیت استفاده مجدد کد: دکوراتورها می‌توانند در کلاس‌ها و توابع مختلف مجدداً استفاده شوند که باعث ترویج استفاده مجدد از کد و کاهش افزونگی می‌شود.
• جداسازی مسئولیت‌ها: منطق اعتبارسنجی از منطق اصلی کسب‌وکار تابع جدا می‌شود که منجر به کدی تمیزتر و ماژولارتر می‌شود.
• متمرکزسازی منطق اعتبارسنجی: تمام قوانین اعتبارسنجی در یک مکان تعریف می‌شوند که به‌روزرسانی و نگهداری آن‌ها را آسان‌تر می‌کند.

پیاده‌سازی اعتبارسنجی پارامتر با دکوراتورها

بیایید بررسی کنیم که چگونه اعتبارسنجی پارامتر را با استفاده از دکوراتورهای جاوا اسکریپت پیاده‌سازی کنیم. ما با یک مثال ساده شروع می‌کنیم و سپس به سناریوهای پیچیده‌تر می‌پردازیم.

مثال پایه: اعتبارسنجی یک پارامتر رشته‌ای

تابعی را در نظر بگیرید که انتظار یک پارامتر رشته‌ای را دارد. ما می‌توانیم یک دکوراتور ایجاد کنیم تا اطمینان حاصل شود که پارامتر واقعاً یک رشته است.

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")); // Output: Hello, Alice!
  // example.greet(123); // Throws an error
} 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")); // Output: Registered with email: test@example.com
  // user.register("invalid-email"); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

توضیح:

• دکوراتور validateEmail از یک عبارت منظم (regular expression) برای بررسی اینکه آیا پارامتر یک آدرس ایمیل معتبر است، استفاده می‌کند.
• اگر پارامتر یک آدرس ایمیل معتبر نباشد، یک خطا پرتاب می‌شود.

ترکیب چندین اعتبارسنج

شما می‌توانید چندین اعتبارسنج را با استفاده از دکوراتور 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)); // Output: Product created: Laptop - $1200
  // product.create("", 0); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

توضیح:

• اعتبارسنج isNotEmptyString بررسی می‌کند که آیا یک رشته پس از حذف فضاهای خالی، خالی نیست.
• اعتبارسنج isPositiveNumber بررسی می‌کند که آیا یک مقدار یک عدد مثبت است.
• دکوراتور validate برای اعمال هر دو اعتبارسنج به متد create از کلاس Product استفاده می‌شود.

بهترین شیوه‌ها برای استفاده از دکوراتورها در اعتبارسنجی پارامتر

در اینجا چند بهترین شیوه برای در نظر گرفتن هنگام استفاده از دکوراتورها برای اعتبارسنجی پارامتر آورده شده است:

• ساده نگه داشتن دکوراتورها: دکوراتورها باید بر منطق اعتبارسنجی متمرکز باشند و از محاسبات پیچیده اجتناب کنند.
• ارائه پیام‌های خطای واضح: اطمینان حاصل کنید که پیام‌های خطا آموزنده هستند و به توسعه‌دهندگان در درک شکست‌های اعتبارسنجی کمک می‌کنند.
• استفاده از نام‌های معنادار: برای بهبود خوانایی کد، نام‌های توصیفی برای دکوراتورهای خود انتخاب کنید.
• مستندسازی دکوراتورها: هدف و نحوه استفاده از دکوراتورهای خود را مستند کنید تا درک و نگهداری آن‌ها آسان‌تر شود.
• در نظر گرفتن عملکرد: در حالی که دکوراتورها روشی راحت برای افزودن عملکرد ارائه می‌دهند، از تأثیر عملکرد آن‌ها آگاه باشید، به خصوص در برنامه‌های کاربردی حساس به عملکرد.
• استفاده از تایپ‌اسکریپت برای افزایش ایمنی نوع: تایپ‌اسکریپت پشتیبانی داخلی از دکوراتورها را فراهم می‌کند و ایمنی نوع را افزایش می‌دهد، که توسعه و نگهداری منطق اعتبارسنجی مبتنی بر دکوراتور را آسان‌تر می‌کند.
• تست کامل دکوراتورها: تست‌های واحد بنویسید تا اطمینان حاصل کنید که دکوراتورهای شما به درستی عمل می‌کنند و سناریوهای مختلف را به طور مناسب مدیریت می‌کنند.

مثال‌های دنیای واقعی و موارد استفاده

در اینجا چند مثال از دنیای واقعی در مورد چگونگی استفاده از دکوراتورها برای اعتبارسنجی پارامتر آورده شده است:

• اعتبارسنجی درخواست API: دکوراتورها می‌توانند برای اعتبارسنجی پارامترهای درخواست‌های ورودی API استفاده شوند و اطمینان حاصل کنند که با انواع داده و فرمت‌های مورد انتظار مطابقت دارند. این کار از رفتار غیرمنتظره در منطق بک‌اند شما جلوگیری می‌کند. سناریویی را در نظر بگیرید که یک اندپوینت API انتظار یک درخواست ثبت‌نام کاربر با پارامترهایی مانند username، email و password را دارد. دکوراتورها می‌توانند برای اعتبارسنجی اینکه این پارامترها وجود دارند، از نوع صحیح (رشته) هستند و با فرمت‌های خاصی (مثلاً اعتبارسنجی آدرس ایمیل با استفاده از یک عبارت منظم) مطابقت دارند، استفاده شوند.
• اعتبارسنجی ورودی فرم: دکوراتورها می‌توانند برای اعتبارسنجی فیلدهای ورودی فرم استفاده شوند تا اطمینان حاصل شود که کاربران داده‌های معتبر وارد می‌کنند. به عنوان مثال، اعتبارسنجی اینکه فیلد کد پستی حاوی فرمت کد پستی معتبر برای یک کشور خاص است.
• اعتبارسنجی کوئری پایگاه داده: دکوراتورها می‌توانند برای اعتبارسنجی پارامترهای ارسال شده به کوئری‌های پایگاه داده استفاده شوند و از آسیب‌پذیری‌های تزریق SQL جلوگیری کنند. اطمینان از اینکه داده‌های ارائه‌شده توسط کاربر قبل از استفاده در کوئری پایگاه داده به درستی پاکسازی شده‌اند. این می‌تواند شامل بررسی انواع داده، طول‌ها و فرمت‌ها، و همچنین فرار از کاراکترهای خاص برای جلوگیری از تزریق کد مخرب باشد.
• اعتبارسنجی فایل پیکربندی: دکوراتورها می‌توانند برای اعتبارسنجی تنظیمات فایل پیکربندی استفاده شوند تا اطمینان حاصل شود که در محدوده‌های قابل قبول و از نوع صحیح هستند.
• سریال‌سازی/دی‌سریال‌سازی داده‌ها: دکوراتورها می‌توانند برای اعتبارسنجی داده‌ها در طول فرآیندهای سریال‌سازی و دی‌سریال‌سازی استفاده شوند تا یکپارچگی داده‌ها را تضمین کرده و از خرابی داده‌ها جلوگیری کنند. اعتبارسنجی ساختار داده‌های JSON قبل از پردازش آن، اعمال فیلدهای مورد نیاز، انواع داده و فرمت‌ها.

مقایسه دکوراتورها با سایر تکنیک‌های اعتبارسنجی

در حالی که دکوراتورها ابزاری قدرتمند برای اعتبارسنجی پارامترها هستند، درک نقاط قوت و ضعف آن‌ها در مقایسه با سایر تکنیک‌های اعتبارسنجی ضروری است:

• اعتبارسنجی دستی: اعتبارسنجی دستی شامل نوشتن منطق اعتبارسنجی به طور مستقیم در توابع است. این رویکرد می‌تواند خسته‌کننده و مستعد خطا باشد، به خصوص برای قوانین اعتبارسنجی پیچیده. دکوراتورها رویکردی اعلانی‌تر و قابل استفاده مجدد ارائه می‌دهند.
• کتابخانه‌های اعتبارسنجی: کتابخانه‌های اعتبارسنجی مجموعه‌ای از توابع و قوانین اعتبارسنجی از پیش ساخته شده را ارائه می‌دهند. در حالی که این کتابخانه‌ها می‌توانند مفید باشند، ممکن است به اندازه دکوراتورها انعطاف‌پذیر یا قابل سفارشی‌سازی نباشند. کتابخانه‌هایی مانند Joi یا Yup برای تعریف شماها برای اعتبارسنجی کل اشیاء عالی هستند، در حالی که دکوراتورها در اعتبارسنجی پارامترهای فردی برتری دارند.
• میان‌افزار (Middleware): میان‌افزار اغلب برای اعتبارسنجی درخواست در برنامه‌های وب استفاده می‌شود. در حالی که میان‌افزار برای اعتبارسنجی کل درخواست‌ها مناسب است، دکوراتورها می‌توانند برای اعتبارسنجی دقیق‌تر پارامترهای تابع فردی استفاده شوند.

نتیجه‌گیری

دکوراتورهای جاوا اسکریپت روشی قدرتمند و زیبا برای پیاده‌سازی اعتبارسنجی پارامترها فراهم می‌کنند. با استفاده از دکوراتورها، می‌توانید خوانایی کد را بهبود بخشید، کد تکراری را کاهش دهید، قابلیت استفاده مجدد کد را افزایش دهید و منطق اعتبارسنجی را از منطق اصلی کسب‌وکار جدا کنید. چه در حال ساخت API، برنامه‌های وب یا انواع دیگر نرم‌افزار باشید، دکوراتورها می‌توانند به شما در تضمین یکپارچگی داده‌ها و ایجاد کدی قوی‌تر و قابل نگهداری‌تر کمک کنند.

همانطور که دکوراتورها را کاوش می‌کنید، به یاد داشته باشید که از بهترین شیوه‌ها پیروی کنید، مثال‌های دنیای واقعی را در نظر بگیرید و دکوراتورها را با سایر تکنیک‌های اعتبارسنجی مقایسه کنید تا بهترین رویکرد را برای نیازهای خاص خود تعیین کنید. با درک قوی از دکوراتورها و کاربرد آن‌ها در اعتبارسنجی پارامترها، می‌توانید کیفیت و قابلیت اطمینان کد جاوا اسکریپت خود را به طور قابل توجهی افزایش دهید.

علاوه بر این، پذیرش روزافزون تایپ‌اسکریپت، که پشتیبانی بومی از دکوراتورها را ارائه می‌دهد، این تکنیک را برای توسعه مدرن جاوا اسکریپت جذاب‌تر می‌کند. پذیرش دکوراتورها برای اعتبارسنجی پارامترها گامی به سوی نوشتن برنامه‌های جاوا اسکریپت تمیزتر، قابل نگهداری‌تر و قوی‌تر است.