JavaScript Dekoratorlari yordamida Parametrlarni Tekshirish: Ma'lumotlar Yaxlitligini Ta'minlash

Zamonaviy JavaScript dasturlashda funksiyalar va metodlarga uzatiladigan ma'lumotlarning yaxlitligini ta'minlash juda muhim. Bunga erishishning kuchli usullaridan biri parametrlarni tekshirish uchun dekoratorlardan foydalanishdir. Babel orqali JavaScript'da yoki TypeScript'da tabiiy ravishda mavjud bo'lgan dekoratorlar funksiyalar, sinflar va xususiyatlarga funksionallik qo'shishning toza va oqlangan usulini taqdim etadi. Ushbu maqola JavaScript dekoratorlari dunyosiga chuqur kirib boradi, xususan, ularning argumentlarni tekshirishdagi qo'llanilishiga e'tibor qaratadi va barcha darajadagi dasturchilar uchun amaliy misollar va tushunchalarni taklif qiladi.

JavaScript Dekoratorlari Nima?

Dekoratorlar - bu mavjud sinf, funksiya yoki xususiyatga dinamik va statik tarzda xatti-harakat qo'shish imkonini beruvchi dizayn naqshidir. Aslini olganda, ular mavjud kodni o'zgartirmasdan, yangi funksionallik bilan "bezatadi". Bu SOLID dizaynining Ochiq/Yopiq Prinsipiga mos keladi, ya'ni dasturiy ta'minot sub'ektlari (sinflar, modullar, funksiyalar va boshqalar) kengaytirish uchun ochiq, ammo o'zgartirish uchun yopiq bo'lishi kerak.

JavaScript'da dekoratorlar - bu sinf e'loniga, metodga, aktsessorga, xususiyatga yoki parametrga biriktirilishi mumkin bo'lgan maxsus turdagi deklaratsiyadir. Ular @expression sintaksisidan foydalanadi, bunda expression ish vaqtida bezatilgan deklaratsiya haqidagi ma'lumot bilan chaqiriladigan funksiyaga baholanishi kerak.

JavaScript'da dekoratorlardan foydalanish uchun odatda Babel kabi transpilyatordan @babel/plugin-proposal-decorators plagini yoqilgan holda foydalanish kerak. TypeScript dekoratorlarni tabiiy ravishda qo'llab-quvvatlaydi.

Parametrlarni Tekshirish uchun Dekoratorlardan Foydalanishning Afzalliklari

Parametrlarni tekshirish uchun dekoratorlardan foydalanish bir qancha afzalliklarni taqdim etadi:

• Kodning O'qilishi Osonlashadi: Dekoratorlar tekshirish qoidalarini ifodalashning deklarativ usulini taqdim etadi, bu esa kodni tushunish va saqlashni osonlashtiradi.
• Shablon Kodning Kamayishi: Bir nechta funksiyalarda tekshirish mantiqini takrorlash o'rniga, dekoratorlar uni bir marta aniqlashga va butun kod bazasi bo'ylab qo'llashga imkon beradi.
• Kodni Qayta Ishlatish Imkoniyatining Oshishi: Dekoratorlar turli sinflar va funksiyalar bo'ylab qayta ishlatilishi mumkin, bu esa kodni qayta ishlatishga yordam beradi va ortiqcha takrorlanishni kamaytiradi.
• Mas'uliyatlarni Ajratish: Tekshirish mantiqi funksiyaning asosiy biznes mantiqidan ajratiladi, bu esa toza va modulli kodga olib keladi.
• Markazlashtirilgan Tekshirish Mantiqi: Barcha tekshirish qoidalari bir joyda aniqlanadi, bu ularni yangilash va saqlashni osonlashtiradi.

Dekoratorlar yordamida Parametrlarni Tekshirishni Amalga Oshirish

Keling, JavaScript dekoratorlari yordamida parametrlarni tekshirishni qanday amalga oshirishni ko'rib chiqaylik. Biz oddiy misoldan boshlaymiz va keyin murakkabroq stsenariylarga o'tamiz.

Asosiy Misol: Satr Parametrini Tekshirish

Satr parametrini kutayotgan funksiyani ko'rib chiqaylik. Biz parametr haqiqatan ham satr ekanligini ta'minlash uchun dekorator yaratishimiz mumkin.

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

Tushuntirish:

• validateString dekoratori greet metodining name parametriga qo'llaniladi.
• U metod bilan bog'liq tekshirish metama'lumotlarini saqlash va olish uchun Reflect.defineMetadata va Reflect.getOwnMetadata'dan foydalanadi.
• Asl metodni chaqirishdan oldin, u tekshirish metama'lumotlari bo'ylab iteratsiya qiladi va har bir parametrga validator funksiyasini qo'llaydi.
• Agar biron bir parametr tekshiruvdan o'tmasa, xatolik yuzaga keladi.
• validate dekoratori parametrlarga validatorlarni qo'llashning umumiyroq va kompozitsion usulini taqdim etadi, bu esa har bir parametr uchun bir nechta validatorni belgilash imkonini beradi.
• isString funksiyasi - bu qiymatning satr ekanligini tekshiradigan oddiy validator.
• Example sinfi greet metodining name parametrini tekshirish uchun dekoratorlardan qanday foydalanishni namoyish etadi.

Murakkab Misol: Elektron Pochta Formatini Tekshirish

Keling, satr parametri haqiqiy elektron pochta manzili ekanligini tekshirish uchun dekorator yarataylik.

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 = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/g;
    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);
}

Tushuntirish:

• validateEmail dekoratori parametrning haqiqiy elektron pochta manzili ekanligini tekshirish uchun regular ifodadan foydalanadi.
• Agar parametr haqiqiy elektron pochta manzili bo'lmasa, xatolik yuzaga keladi.

Bir Nechta Validatorlarni Birlashtirish

Siz validate dekoratori va maxsus validator funksiyalari yordamida bir nechta validatorlarni birlashtirishingiz mumkin.

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

Tushuntirish:

• isNotEmptyString validatori satrning bo'sh joylarni olib tashlagandan keyin bo'sh emasligini tekshiradi.
• isPositiveNumber validatori qiymatning musbat son ekanligini tekshiradi.
• validate dekoratori Product sinfining create metodiga ikkala validatorni qo'llash uchun ishlatiladi.

Parametrlarni Tekshirishda Dekoratorlardan Foydalanishning Eng Yaxshi Amaliyotlari

Parametrlarni tekshirish uchun dekoratorlardan foydalanishda e'tiborga olish kerak bo'lgan ba'zi eng yaxshi amaliyotlar:

• Dekoratorlarni Oddiy Saqlang: Dekoratorlar tekshirish mantiqiga e'tibor qaratishi va murakkab hisob-kitoblardan qochishi kerak.
• Aniq Xato Xabarlarini Taqdim Eting: Xato xabarlari ma'lumot beruvchi bo'lishini va dasturchilarga tekshirishdagi nosozliklarni tushunishga yordam berishini ta'minlang.
• Mazmunli Nomlardan Foydalaning: Kodning o'qilishini osonlashtirish uchun dekoratorlaringizga tavsiflovchi nomlar tanlang.
• Dekoratorlaringizni Hujjatlashtiring: Dekoratorlaringizning maqsadi va ishlatilishini hujjatlashtiring, bu ularni tushunish va saqlashni osonlashtiradi.
• Ishlash Samaradorligini Hisobga Oling: Dekoratorlar funksionallik qo'shishning qulay usulini taqdim etsa-da, ularning ishlash samaradorligiga ta'sirini, ayniqsa, yuqori unumdorlik talab qilinadigan ilovalarda yodda tuting.
• Kengaytirilgan Tur Xavfsizligi uchun TypeScript'dan Foydalaning: TypeScript dekoratorlarni o'rnatilgan qo'llab-quvvatlashni ta'minlaydi va tur xavfsizligini oshiradi, bu esa dekoratorga asoslangan tekshirish mantiqini ishlab chiqish va saqlashni osonlashtiradi.
• Dekoratorlaringizni Puxta Sinovdan O'tkazing: Dekoratorlaringiz to'g'ri ishlashini va turli stsenariylarni to'g'ri bajara olishini ta'minlash uchun birlik testlarini yozing.

Haqiqiy Dunyodan Misollar va Qo'llash Holatlari

Bu yerda dekoratorlarni parametrlarni tekshirish uchun qanday ishlatish mumkinligiga oid ba'zi real misollar keltirilgan:

• API So'rovlarini Tekshirish: Dekoratorlar kiruvchi API so'rov parametrlarini tekshirish uchun ishlatilishi mumkin, bu ularning kutilgan ma'lumotlar turlari va formatlariga mos kelishini ta'minlaydi. Bu sizning backend mantiqingizda kutilmagan xatti-harakatlarning oldini oladi. API nuqtasi foydalanuvchini ro'yxatdan o'tkazish so'rovini username, email va password kabi parametrlar bilan kutayotgan stsenariyni ko'rib chiqing. Dekoratorlar ushbu parametrlar mavjudligini, to'g'ri turda (satr) ekanligini va ma'lum formatlarga (masalan, regular ifoda yordamida elektron pochta manzilini tekshirish) mos kelishini tekshirish uchun ishlatilishi mumkin.
• Forma Kiritishlarini Tekshirish: Dekoratorlar forma kiritish maydonlarini tekshirish uchun ishlatilishi mumkin, bu esa foydalanuvchilar to'g'ri ma'lumotlarni kiritishini ta'minlaydi. Masalan, pochta indeksi maydoni ma'lum bir mamlakat uchun haqiqiy pochta indeksi formatini o'z ichiga olganligini tekshirish.
• Ma'lumotlar Bazasi So'rovlarini Tekshirish: Dekoratorlar ma'lumotlar bazasi so'rovlariga uzatiladigan parametrlarni tekshirish uchun ishlatilishi mumkin, bu SQL in'ektsiyasi zaifliklarining oldini oladi. Foydalanuvchi tomonidan taqdim etilgan ma'lumotlarning ma'lumotlar bazasi so'rovida ishlatilishidan oldin to'g'ri tozalanganligini ta'minlash. Bu ma'lumotlar turlarini, uzunliklarini va formatlarini tekshirishni, shuningdek, zararli kod in'ektsiyasining oldini olish uchun maxsus belgilarni ekrannlashni o'z ichiga olishi mumkin.
• Konfiguratsiya Faylini Tekshirish: Dekoratorlar konfiguratsiya fayli sozlamalarini tekshirish uchun ishlatilishi mumkin, bu ularning qabul qilinadigan diapazonlarda va to'g'ri turda ekanligini ta'minlaydi.
• Ma'lumotlarni Seriyalashtirish/Deseriyalashtirish: Dekoratorlar ma'lumotlarni seriyalashtirish va deseriyalashtirish jarayonlarida tekshirish uchun ishlatilishi mumkin, bu ma'lumotlar yaxlitligini ta'minlaydi va ma'lumotlarning buzilishini oldini oladi. JSON ma'lumotlarini qayta ishlashdan oldin uning tuzilishini tekshirish, talab qilinadigan maydonlar, ma'lumotlar turlari va formatlarini majburiy qilish.

Dekoratorlarni Boshqa Tekshirish Usullari bilan Taqqoslash

Dekoratorlar parametrlarni tekshirish uchun kuchli vosita bo'lsa-da, ularning boshqa tekshirish usullariga nisbatan kuchli va zaif tomonlarini tushunish muhimdir:

• Qo'lda Tekshirish: Qo'lda tekshirish to'g'ridan-to'g'ri funksiyalar ichida tekshirish mantiqini yozishni o'z ichiga oladi. Bu yondashuv, ayniqsa, murakkab tekshirish qoidalari uchun zerikarli va xatolarga moyil bo'lishi mumkin. Dekoratorlar yanada deklarativ va qayta ishlatiladigan yondashuvni taklif etadi.
• Tekshirish Kutubxonalari: Tekshirish kutubxonalari oldindan tayyorlangan tekshirish funksiyalari va qoidalari to'plamini taqdim etadi. Bu kutubxonalar foydali bo'lishi mumkin bo'lsa-da, ular dekoratorlar kabi moslashuvchan yoki sozlanishi mumkin emas. Joi yoki Yup kabi kutubxonalar butun ob'ektlarni tekshirish uchun sxemalarni aniqlashda a'lo darajada ishlaydi, dekoratorlar esa alohida parametrlarni tekshirishda ustunlik qiladi.
• Middleware (Oraliq Dasturiy Ta'minot): Middleware ko'pincha veb-ilovalarda so'rovlarni tekshirish uchun ishlatiladi. Middleware butun so'rovlarni tekshirish uchun mos bo'lsa-da, dekoratorlar alohida funksiya parametrlarini yanada nozikroq tekshirish uchun ishlatilishi mumkin.

Xulosa

JavaScript dekoratorlari parametrlarni tekshirishni amalga oshirishning kuchli va oqlangan usulini taqdim etadi. Dekoratorlardan foydalanib, siz kodning o'qilishini yaxshilashingiz, shablon kodni kamaytirishingiz, kodni qayta ishlatish imkoniyatini oshirishingiz va tekshirish mantiqini asosiy biznes mantiqidan ajratishingiz mumkin. API, veb-ilovalar yoki boshqa turdagi dasturiy ta'minot yaratayotgan bo'lsangiz ham, dekoratorlar ma'lumotlar yaxlitligini ta'minlashga va yanada mustahkam va saqlanuvchan kod yaratishga yordam beradi.

Dekoratorlarni o'rganar ekansiz, eng yaxshi amaliyotlarga rioya qilishni, real dunyo misollarini ko'rib chiqishni va o'zingizning maxsus ehtiyojlaringiz uchun eng yaxshi yondashuvni aniqlash uchun dekoratorlarni boshqa tekshirish usullari bilan taqqoslashni unutmang. Dekoratorlar va ularning parametrlarni tekshirishdagi qo'llanilishini puxta tushunish bilan siz JavaScript kodingizning sifati va ishonchliligini sezilarli darajada oshirishingiz mumkin.

Bundan tashqari, dekoratorlarni tabiiy ravishda qo'llab-quvvatlaydigan TypeScript'ning tobora ommalashib borayotgani ushbu texnikani zamonaviy JavaScript dasturlashi uchun yanada jozibador qiladi. Parametrlarni tekshirish uchun dekoratorlarni qabul qilish - bu toza, saqlanuvchan va mustahkamroq JavaScript ilovalarini yozish sari bir qadamdir.