JavaScript декоратори за валидация на параметри: Гарантиране на целостта на данните

В съвременната JavaScript разработка, гарантирането на целостта на данните, предавани на функции и методи, е от първостепенно значение. Една мощна техника за постигане на това е чрез използването на декоратори за валидация на параметри. Декораторите, функционалност, достъпна в JavaScript чрез Babel или нативно в TypeScript, предоставят изчистен и елегантен начин за добавяне на функционалност към функции, класове и свойства. Тази статия се потапя в света на JavaScript декораторите, като се фокусира конкретно върху тяхното приложение при проверка на аргументи, предлагайки практически примери и прозрения за разработчици от всички нива.

Какво представляват JavaScript декораторите?

Декораторите са шаблон за дизайн, който ви позволява да добавяте поведение към съществуващ клас, функция или свойство динамично и статично. По същество те "декорират" съществуващия код с нова функционалност, без да променят самия оригинален код. Това се придържа към принципа "Отворен/Затворен" (Open/Closed Principle) на SOLID дизайна, който гласи, че софтуерните единици (класове, модули, функции и т.н.) трябва да бъдат отворени за разширение, но затворени за модификация.

В JavaScript декораторите са специален вид декларация, която може да бъде прикачена към декларация на клас, метод, аксесор, свойство или параметър. Те използват синтаксиса @expression, където expression трябва да се изчисли до функция, която ще бъде извикана по време на изпълнение с информация за декорираната декларация.

За да използвате декоратори в JavaScript, обикновено трябва да използвате транспайлър като Babel с активиран плъгин @babel/plugin-proposal-decorators. TypeScript поддържа декоратори нативно.

Предимства на използването на декоратори за валидация на параметри

Използването на декоратори за валидация на параметри предлага няколко предимства:

• Подобрена четимост на кода: Декораторите предоставят декларативен начин за изразяване на правила за валидация, което прави кода по-лесен за разбиране и поддръжка.
• Намаляване на повтарящия се код: Вместо да повтаряте логика за валидация в множество функции, декораторите ви позволяват да я дефинирате веднъж и да я прилагате в цялата си кодова база.
• Подобрена преизползваемост на кода: Декораторите могат да се използват многократно в различни класове и функции, което насърчава повторната употреба на код и намалява излишъка.
• Разделяне на отговорностите: Логиката за валидация е отделена от основната бизнес логика на функцията, което води до по-чист и по-модулен код.
• Централизирана логика за валидация: Всички правила за валидация са дефинирани на едно място, което улеснява тяхното актуализиране и поддръжка.

Прилагане на валидация на параметри с декоратори

Нека разгледаме как да приложим валидация на параметри с помощта на JavaScript декоратори. Ще започнем с прост пример и след това ще преминем към по-сложни сценарии.

Основен пример: Валидиране на параметър от тип низ

Да разгледаме функция, която очаква параметър от тип низ. Можем да създадем декоратор, за да гарантираме, че параметърът наистина е низ.

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 = /^[\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);
}

Обяснение:

• Декораторът validateEmail използва регулярен израз, за да провери дали параметърът е валиден имейл адрес.
• Ако параметърът не е валиден имейл адрес, се хвърля грешка.

Комбиниране на няколко валидатора

Можете да комбинирате няколко валидатора, като използвате декоратора 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.

Най-добри практики при използването на декоратори за валидация на параметри

Ето някои най-добри практики, които да имате предвид, когато използвате декоратори за валидация на параметри:

• Поддържайте декораторите прости: Декораторите трябва да се фокусират върху логиката за валидация и да избягват сложни изчисления.
• Осигурете ясни съобщения за грешки: Уверете се, че съобщенията за грешки са информативни и помагат на разработчиците да разберат неуспешните валидации.
• Използвайте смислени имена: Избирайте описателни имена за вашите декоратори, за да подобрите четимостта на кода.
• Документирайте своите декоратори: Документирайте целта и употребата на вашите декоратори, за да ги направите по-лесни за разбиране и поддръжка.
• Вземете предвид производителността: Въпреки че декораторите предоставят удобен начин за добавяне на функционалност, бъдете наясно с тяхното въздействие върху производителността, особено в приложения, където тя е от критично значение.
• Използвайте TypeScript за подобрена типова сигурност: TypeScript предоставя вградена поддръжка за декоратори и подобрява типовата сигурност, което улеснява разработването и поддръжката на логика за валидация, базирана на декоратори.
• Тествайте обстойно своите декоратори: Пишете единични тестове, за да се уверите, че вашите декоратори функционират правилно и обработват различни сценарии по подходящ начин.

Примери от реалния свят и случаи на употреба

Ето няколко примера от реалния свят за това как декораторите могат да се използват за валидация на параметри:

• Валидация на API заявки: Декораторите могат да се използват за валидиране на входящи параметри на API заявки, като се гарантира, че те отговарят на очакваните типове данни и формати. Това предотвратява неочаквано поведение във вашата бекенд логика. Представете си сценарий, при който API ендпойнт очаква заявка за регистрация на потребител с параметри като username, email и password. Декораторите могат да се използват за валидиране, че тези параметри са налични, от правилния тип (низ) и отговарят на специфични формати (напр. валидация на имейл адрес с регулярен израз).
• Валидация на данни от формуляри: Декораторите могат да се използват за валидиране на полета за въвеждане във формуляри, като се гарантира, че потребителите въвеждат валидни данни. Например, валидиране, че поле за пощенски код съдържа валиден формат на пощенски код за конкретна държава.
• Валидация на заявки към база данни: Декораторите могат да се използват за валидиране на параметри, предавани на заявки към база данни, предотвратявайки уязвимости от тип SQL инжекция. Гарантиране, че предоставените от потребителя данни са правилно почистени, преди да бъдат използвани в заявка към база данни. Това може да включва проверка на типове данни, дължини и формати, както и екраниране на специални символи за предотвратяване на инжектиране на злонамерен код.
• Валидация на конфигурационни файлове: Декораторите могат да се използват за валидиране на настройки в конфигурационни файлове, като се гарантира, че те са в приемливи граници и от правилния тип.
• Сериализация/Десериализация на данни: Декораторите могат да се използват за валидиране на данни по време на процесите на сериализация и десериализация, като се гарантира целостта на данните и се предотвратява тяхното повреждане. Валидиране на структурата на JSON данни преди обработката им, налагане на задължителни полета, типове данни и формати.

Сравнение на декораторите с други техники за валидация

Въпреки че декораторите са мощен инструмент за валидация на параметри, е важно да се разберат техните силни и слаби страни в сравнение с други техники за валидация:

• Ръчна валидация: Ръчната валидация включва писане на логика за валидация директно във функциите. Този подход може да бъде досаден и податлив на грешки, особено при сложни правила за валидация. Декораторите предлагат по-декларативен и преизползваем подход.
• Библиотеки за валидация: Библиотеките за валидация предоставят набор от предварително изградени функции и правила за валидация. Въпреки че тези библиотеки могат да бъдат полезни, те може да не са толкова гъвкави или адаптивни като декораторите. Библиотеки като Joi или Yup са отлични за дефиниране на схеми за валидиране на цели обекти, докато декораторите се отличават с валидирането на отделни параметри.
• Междинен софтуер (Middleware): Междинният софтуер често се използва за валидация на заявки в уеб приложения. Докато междинният софтуер е подходящ за валидиране на цели заявки, декораторите могат да се използват за по-фина валидация на отделни параметри на функции.

Заключение

JavaScript декораторите предоставят мощен и елегантен начин за прилагане на валидация на параметри. Като използвате декоратори, можете да подобрите четимостта на кода, да намалите повтарящия се код, да подобрите преизползваемостта на кода и да отделите логиката за валидация от основната бизнес логика. Независимо дали изграждате API, уеб приложения или друг тип софтуер, декораторите могат да ви помогнат да гарантирате целостта на данните и да създадете по-здрав и лесен за поддръжка код.

Докато изследвате декораторите, не забравяйте да следвате най-добрите практики, да разглеждате примери от реалния свят и да сравнявате декораторите с други техники за валидация, за да определите най-добрия подход за вашите конкретни нужди. Със солидно разбиране на декораторите и тяхното приложение при валидация на параметри, можете значително да подобрите качеството и надеждността на вашия JavaScript код.

Освен това, нарастващото приемане на TypeScript, който предлага нативна поддръжка за декоратори, прави тази техника още по-привлекателна за съвременната JavaScript разработка. Възприемането на декоратори за валидация на параметри е стъпка към писането на по-чисти, по-лесни за поддръжка и по-здрави JavaScript приложения.