Использование языка выражений NiFi

Язык выражений NiFi всегда начинается с начального разделителя ${ и заканчивается конечным разделителем }. Между начальным и конечным разделителями находится текст самого выражения. В своей простейшей форме выражение может состоять только из имени атрибута. Например, ${topic.name} вернет значение атрибута названия топика.

Для манипуляций со значением атрибута, переменной или параметра в языке выражений используются различные функции.

Вы можете заменить часть значения атрибута, вызвав функцию replace — ${topic.name:replace('1', '2')}. В этом случае мы обращаемся к атрибуту topic.name, а затем меняем часть значения этого атрибута с 1 на 2.

Когда для атрибута выполняется вызов функции, этот атрибут является субъектом, над которым работает функция. Можно комбинировать несколько вызовов функций, когда возвращаемое значение первой функции становится субъектом второй функции, а возвращаемое значение становится субъектом третьей функции и так далее. Количество функций, которые можно связать вместе, не ограничено.

На любой атрибут FlowFile можно ссылаться с помощью языка выражений. Однако, если имя атрибута содержит "специальный символ", имя атрибута необходимо экранировать, заключив его в кавычки. Следующие символы считаются "специальными символами" — $, |, {, }, (, ), [, ], ,, :, ;, /, *, ', пробел, \t, \r, \n.

Кроме того, число считается "специальным символом", если оно является первым символом имени атрибута. Если какой-либо из этих специальных символов присутствует в атрибуте, он заключается в одинарные или двойные кавычки.

Также существуют некоторые функции. Эти функции вызываются простым вызовом в начале выражения, например, ${hostname()}. Попытка вызвать функцию с субъектом приведет к ошибке.

При использовании языка выражений для ссылки на свойство по имени существует определенная иерархия, в которой NiFi будет искать значение.

Текущая иерархия в NiFi выглядит так:

NiFi ищет и возвращает первое вхождение соответствующего свойства. Если подходящее свойство не найдено, возвращается null.

Настройка значения свойств процессоров более удобна при использовании редактора языка выражений. Для выражений, начинающихся с ввода ${, редактор выделяет круглые и фигурные скобки, чтобы пользователь мог легко определить, какая открывающая скобка или фигурная скобка соответствует какой закрывающей скобке или фигурной скобке.

Редактор также предоставляет контекстно-зависимую справку, предоставляя список всех функций, которые можно использовать в текущей позиции курсора. Для активации этой функции необходимо нажать Ctrl+Space на клавиатуре.

Пользователь также может ввести часть имени функции, а затем нажать Ctrl+Space, чтобы увидеть все функции, которые можно использовать и которые начинаются с того же префикса. Если напечатать в редакторе ${topic:replace и затем нажать Ctrl+Space, появится всплывающее окно со списком функций:

Если продолжить ввод, можно сузить список отображаемых функций. Также можно выбрать одну из функций из списка, дважды нажав мышью или используя клавиши со стрелками, чтобы выделить нужную функцию, затем нажать Enter.

Каждое значение субьекта функции, значение аргумента и значение, возвращаемое функцией, имеют определенный тип данных. Тип субьекта функции (Subject Type), тип аргументов (Arguments), если они есть, или тип значения, возвращаемого функцией (Return Type), указаны в описании каждой из функций.

Язык выражений поддерживает четыре различных типа данных:

После оценки функций языка выражений все атрибуты сохраняются как тип String.

Язык выражений широко используется в интерфейсе NiFi Server для настройки свойств процессора. Не все свойства процессора поддерживают язык выражений. Информация о том, поддерживается ли язык выражений для данного свойства процессора указана в верхней части окна для ввода значения при настройке процессора на вкладке PROPERTIES.

Также при нажатии на иконку у наименования свойства видно, какая область видимости для языка выражений поддерживается: