Альтернатива регулярным выражениям: apg-exp

Эта статья была рецензирована Себастьяном Зейтцем и Альмиром Биджедиком . Спасибо всем рецензентам SitePoint за то, что сделали контент SitePoint как можно лучше!

Вряд ли кто-нибудь из программистов избежит необходимости время от времени использовать регулярные выражения в той или иной форме. Для многих синтаксис шаблона может показаться загадочным и запретным. В этом руководстве будет представлен новый механизм сопоставления с образцом, apg-exp — многофункциональная альтернатива RegExp с синтаксисом шаблонов ABNF, который немного проще для глаз.

Быстрое сравнение

Вам когда-нибудь нужно было проверять адрес электронной почты и сталкиваться с чем-то вроде этого?

^[\w!#$%&'*+/=?^_`{|}~-]+(?:\.[\w!#$%&'*+/=?^_`{|}~-]+)*@(?:[A-Z0-9-]+\.)+[AZ]{2,6}$ 

Механизм сопоставления с образцом является правильным инструментом для работы. Это хорошо разработанное, хорошо написанное регулярное выражение. Работает отлично. Так что не нравится?

Ну, если вы эксперт с регулярными выражениями, то ничего. Но для остальных из нас, они могут быть

• Трудно читать
• Еще сложнее написать
• Трудно поддерживать

Синтаксис регулярных выражений имеет давнюю, проверенную временем историю и глубоко интегрирован во многие инструменты и языки, которые мы, программисты, используем каждый день.

Однако существует альтернативный синтаксис, который существует почти столько же лет, очень популярен среди авторов и пользователей технических спецификаций Интернета, обладает всеми возможностями регулярных выражений, но редко используется в мире программирования на JavaScript. А именно, дополненная форма B ackus- N aur F , или ABNF, формально определенная IETF в RFC 5234 и RFC 7405 .

Давайте посмотрим, как этот же адрес электронной почты может выглядеть в ABNF.

 email-address = local "@" domain local = local-word *("." local-word) domain = 1*(sub-domain ".") top-domain local-word = 1*local-char sub-domain = 1*sub-domain-char top-domain = 2*6top-domain-char local-char = alpha / num / special sub-domain-char = alpha / num / "-" top-domain-char = alpha alpha = %d65-90 / %d97-122 num = %d48-57 special = %d33 / %d35 / %d36-39 / %d42-43 / %d45 / %d47 / %d61 / %d63 / %d94-96 / %d123-126 

Конечно, не такой компактный, но, как HTML и XML, он предназначен для чтения людьми и машинами. Я предполагаю, что, не имея ничего, кроме мимолетного знания шаблонов поиска по шаблону, вы можете просто прочитать, что здесь происходит, на «простом английском».

• адрес электронной почты определяется как локальная часть и домен, разделенные @
• локальная часть — одно слово, за которым следуют необязательные слова, разделенные точками
• домен является одним или несколькими разделенными точками подобластями, за которыми следует один верхний домен
• единственные вещи, которые вы можете не знать здесь, но, вероятно, можете догадаться, это:
  • так же, как подстановочный знак * означает «ноль или более», 1* означает «один или несколько», а 2*6 означает минимум 2 и максимум 6 повторений
  • / отделяет альтернативные варианты
  • %d определяет десятичные коды символов и диапазоны кодов символов
  • например, %d35 представляет # , десятичное ASCII 35
  • %d65-90 представляет любой символ в диапазоне AZ , десятичные дроби ASCII 65-90

RegExp и apg-exp сравниваются для этого адреса электронной почты в примере 1 .

apg-exp — это механизм сопоставления с образцом, разработанный для того, чтобы иметь внешний вид RegExp, но использовать синтаксис ABNF для определений шаблонов. В следующих нескольких разделах я проведу вас через:

• Как добавить apg-exp в ваше приложение
• Краткое руководство по синтаксису ABNF
• Работа с apg-exp — несколько примеров
• Куда идти дальше — больше подробностей, расширенные примеры

И работает — как его получить

НПМ

Если вы работаете в среде Node.js , из каталога вашего проекта запустите:

 npm install apg-exp --save 

Затем вы можете получить к нему доступ в своем коде с помощью require() .

Например:

 var ApgExp = require("apg-exp"); var exp = new ApgExp(pattern, flags); var result = exp.exec(stringToMatch); 

 git clone https://github.com/ldthomas/apg-js2-exp.git apg-exp 

 <!-- optional stylesheet used in tutorial examples --> <link rel="stylesheet" href="./apg-exp/apgexp.css"> <script src="./apg-exp/apgexp-min.js"></script> <script> var useApgExp = function(){ var exp = new ApgExp(pattern, flags); var result = exp.exec(stringToMatch); /* do something with the result */ } </script> 

 <link rel="stylesheet" href="https://cdn.rawgit.com/ldthomas/apg-js2-exp/89c6681798ba9e47583b685c87b244406b18a26d/apgexp.css"> <script src="https://cdn.rawgit.com/ldthomas/apg-js2-exp/c0fc3adac954a6f6ad6f265fd2f8f06f68001e10/apgexp-min.js" charset="utf-8"></script> 

 name = elements LF 

 phrase1 = elem (foo / bar) blat LF phrase2 = (elem foo) / (bar blat) LF phrase3 = elem foo / bar blat LF 

 try { var exp = new ApgExp(pattern, flags); var result = exp.exec(stringToMatch); if (result) { // do something with results } else { // handle failure } } catch(e) { if (e.name === "ApgExpError") { // display pattern errors to console console.log(e.toText()); // display pattern errors to HTML page $("#errors").html(e.toHtml()); } else { // handle other exceptions } } 

 phone-number = ["("] area-code sep office-code sep subscriber area-code = 3digit ; 3 digits office-code = 3digit ; 3 digits subscriber = 4digit ; 4 digits sep = *3(%d32-47 / %d58-126 / %d9) ; 0-3 ASCII non-digits digit = %d48-57 ; 0-9 

 \(?(\d{3})\D{0,3}(\d{3})\D{0,3}(\d{4}) 

 mm/dd/yy or mm/dd/yyyy dd/mm/yy or dd/mm/yyyy mm, 1-12 or 01-12, ie with or without leading zero dd, 1-31 or 01-31, ie with or without leading zero yy, 00-99 yyyy, 1900-1999 or 2000-2099 

 date = %^ (mm-first / dd-first) %$ mm-first = mm "/" dd "/" yyyy ; month before day dd-first = dd "/" mm "/" yyyy ; day before month dd = "0" digit1 ; 01-09 / ("1"/"2") digit ; or 10-29 / "3" %d48-49 ; or 30-31 / digit1 ; or 1-9 mm = "0" digit1 ; 01-09 / "1" %d48-50 ; or 10-12 / digit1 ; or 1-9 yyyy = ("19" / "20") 2digit ; 1900-1999 or 2000-2099 / 2digit ; or 00-99 digit = %d48-57 ; 0-9 digit1 = %d49-57 ; 1-9 

 ^(?:((?:0[1-9])|(?:1[0-2])|(?:[1-9]))/((?:0[1-9])|(?:(?:1|2)[0-9])|(?:3[0-1])|(?:[1-9]))|((?:0[1-9])|(?:(?:1|2)[0-9])|(?:3[0-1])|(?:[1-9]))/((?:0[1-9])|(?:1[0-2])|(?:[1-9])))/((?:19|20)?[0-9][0-9])$ 

 P = LPR / LR L = "(" R = ")" 

 var exp = new ApgExp(pattern[, flags[, nodeHits[, treeDepth]]]); 

 var pattern = "alphanum = alpha *(alpha / num)\n" + "alpha = %d65-90 / %d97-122\n" + "num = %d48-57\n"; 

 var result = exp.exec(str);