JSONata

Поддерживается только производитель

Компонент Jsonata позволяет обрабатывать JSON-сообщения, используя спецификацию JSONATA (opens in a new tab) . Это может быть идеальным решением для преобразования JSON в JSON и других преобразований JSON.

Пользователям Maven необходимо добавить следующую зависимость для pom.xmlэтого компонента:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jsonata</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

jsonata:specName[?options]

Где specName -- это локальный URI classpath спецификации, которую нужно вызвать; или полный URL удаленной спецификации (например: file://folder/myfile.vm).

Configuring Options

Компоненты Camel настраиваются на двух отдельных уровнях:

• уровень компонентов

• уровень конечной точки

Configuring Component Options

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

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

У некоторых компонентов всего несколько параметров, а у других -- много. Поскольку компоненты обычно имеют предустановленные значения по умолчанию, которые широко используются, зачастую вам может потребоваться настроить лишь несколько параметров компонента, а то и вовсе ни одного.

Вы можете настроить компоненты, используя:

• Компонент DSL (opens in a new tab) .

• в файле конфигурации ( application.propertiesфайлы *.yaml, и т.д.).

• непосредственно в коде Java.

Configuring Endpoint Options

Настройка конечных точек обычно занимает больше времени, поскольку у них есть множество параметров. Эти параметры помогают вам настроить функции конечной точки. Параметры также классифицируются по тому, используется ли конечная точка как потребитель ( от ), как производитель ( от ) или и то, и другое.

Конечные точки чаще всего настраиваются непосредственно в URI конечной точки в виде параметров пути и запроса . Вы также можете использовать Endpoint DSL (opens in a new tab) и DataFormat DSL (opens in a new tab) в качестве типобезопасного способа настройки конечных точек и форматов данных в Java.

Хорошей практикой при настройке параметров является использование заполнителей свойств (opens in a new tab) .

Заполнители свойств обеспечивают несколько преимуществ:

• Они помогают предотвратить использование жестко запрограммированных URL-адресов, номеров портов, конфиденциальной информации и других настроек.

• Они позволяют вынести конфигурацию за пределы кода.

• Они помогают коду стать более гибким и пригодным для повторного использования.

В следующих двух разделах перечислены все параметры, сначала для компонента, а затем для конечной точки.

Component Options

Компонент JSONata поддерживает 5 опций, которые перечислены ниже.

allowTemplateFromHeader (producer)

• Разрешить или запретить использование шаблона ресурса из заголовка (по умолчанию -- false). Включение этого параметра позволяет указывать динамические шаблоны через заголовок сообщения. Однако это может рассматриваться как потенциальная уязвимость безопасности, если заголовок исходит от злоумышленника, поэтому используйте этот параметр с осторожностью.

• По умолчанию: false

• Тип: boolean

contentCache (producer)

• Устанавливает, использовать ли кэш содержимого ресурсов или нет.

• По умолчанию: true

• Тип: boolean

lazyStartProducer (producer)

• Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.

• По умолчанию: false

• Тип: boolean

autowiredEnabled (advanced)

• Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.

• По умолчанию: true

• Тип: boolean

frameBinding (advanced)

• Для настройки пользовательских привязок фреймов и внедрения пользовательских функций.

• По умолчанию:

• Тип: JsonataFrameBinding

Endpoint Options

Конечная точка JSONata настраивается с использованием синтаксиса URI:

jsonata:resourceUri

Со следующими параметрами пути и запроса :

Path Parameters (1 parameters)

resourceUri (producer)

• Требуемый путь к ресурсу. Можно указать префикс: classpath, file, http, ref или bean. classpath, file и http загружают ресурс по этим протоколам (classpath используется по умолчанию). ref ищет ресурс в реестре. bean вызывает метод bean-компонента, который будет использоваться в качестве ресурса. Для bean-компонента можно указать имя метода после точки, например, bean:myBean.myMethod.

• По умолчанию:

• Тип: String

Query Parameters (8 parameters)

allowContextMapAll (producer)

• Тип: Определяет, должна ли карта контекста разрешать доступ ко всем данным. По умолчанию доступен только текст и заголовки сообщения. Этот параметр можно включить для полного доступа к текущему Exchange и CamelContext. Это может представлять потенциальную угрозу безопасности, поскольку открывает доступ ко всем возможностям API CamelContext.

• По умолчанию: false

• Тип: boolean

allowTemplateFromHeader (producer)

• Разрешить или запретить использование шаблона ресурса из заголовка (по умолчанию -- false). Включение этого параметра позволяет указывать динамические шаблоны через заголовок сообщения. Однако это может рассматриваться как потенциальная уязвимость безопасности, если заголовок исходит от злоумышленника, поэтому используйте этот параметр с осторожностью.

• По умолчанию: false

• Тип: boolean

contentCache (producer)

• Устанавливает, использовать ли кэш содержимого ресурсов или нет.

• По умолчанию: true

• Тип: boolean

inputType (producer)

• Указывает, должен ли вводиться Jackson JsonNode или строка JSON.

  Значения перечисления:

  • Jackson

  • JsonString

• По умолчанию: Jackson

• Тип: JsonataInputOutputType

outputType (producer)

• Указывает, должен ли выводиться Jackson JsonNode или строка JSON.

  Значения перечисления:

  • Jackson

  • JsonString

• По умолчанию: Jackson

• Тип: JsonataInputOutputType

prettyPrint (producer)

• Нужно ли красиво выводить выходные данные JSon при использовании строки в качестве типа выходных данных.

• По умолчанию: false

• Тип: boolean

lazyStartProducer (producer (advanced))

• Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.

• По умолчанию: false

• Тип: boolean

frameBinding (advanced)

• Для настройки привязки фрейма Jsonata. Позволяет добавлять пользовательские функции.

• По умолчанию:

• Тип: JsonataFrameBinding

Examples

Basic

Например, вы можете использовать что-то вроде:

from("activemq:My.Queue").
  to("jsonata:com/acme/MyResponse.json");

И файловый ресурс:

from("activemq:My.Queue").
  to("jsonata:file://myfolder/MyResponse.json?contentCache=true").
  to("activemq:Another.Queue");

Frame bindings

Можно настроить пользовательские функции, вызываемые из Jsonata. Например, вам может понадобиться возможность внедрения переменных окружения:

from("activemq:My.Queue").
  to("jsonata:file://myfolder/MyResponse.json?contentCache=true&frameBinding=#customBindings").
  to("activemq:Another.Queue");

Пользовательская привязка может выглядеть следующим образом:

@NoArgsConstructor
public class CustomJsonataFrameBinding implements JsonataFrameBinding {
  @Override
  public void bindToFrame(Jsonata.Frame frame) {
    frame.bind("env", (String s) -> System.getenv(s));
  }
}

Spring Boot Auto-Configuration

При использовании jsonata с Spring Boot обязательно используйте следующую зависимость Maven для поддержки автоматической настройки:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-jsonata-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

Компонент поддерживает 6 опций, которые перечислены ниже.

camel.component.jsonata.allow-template-from-header

• Разрешить или запретить использование шаблона ресурса из заголовка (по умолчанию -- false). Включение этого параметра позволяет указывать динамические шаблоны через заголовок сообщения. Однако это может рассматриваться как потенциальная уязвимость безопасности, если заголовок исходит от злоумышленника, поэтому используйте этот параметр с осторожностью.

• По умолчанию: false

• Тип: Boolean

camel.component.jsonata.autowired-enabled

• Включено ли автоматическое связывание. Это используется для параметров автоматического связывания (параметр должен быть помечен как autowired) путём поиска в реестре экземпляра соответствующего типа, который затем настраивается в компоненте. Это может использоваться для автоматической настройки источников данных JDBC, фабрик JMS-подключений, клиентов AWS и т. д.

• По умолчанию: true

• Тип: Boolean

camel.component.jsonata.content-cache

• Устанавливает, использовать ли кэш содержимого ресурсов или нет.

• По умолчанию: true

• Тип: Boolean

camel.component.jsonata.enabled

• Включить ли автоматическую настройку компонента jsonata. По умолчанию эта опция включена.

• По умолчанию:

• Тип: Boolean

camel.component.jsonata.frame-binding

• Для настройки пользовательских привязок фреймов и внедрения пользовательских функций. Параметр имеет тип org.apache.camel.component.jsonata.JsonataFrameBinding.

• По умолчанию:

• Тип: JsonataFrameBinding

camel.component.jsonata.lazy-start-producer

• Тип: Следует ли запускать производитель в режиме ленивого запуска (при первом сообщении). Запуск в режиме ленивого запуска позволяет разрешить запуск CamelContext и маршрутов в ситуациях, когда производитель может выйти из строя при запуске, что приведет к сбою запуска маршрута. Отложив запуск в режим ленивого запуска, можно обработать сбой запуска во время маршрутизации сообщений с помощью обработчиков ошибок маршрутизации Camel. Имейте в виду, что после обработки первого сообщения создание и запуск производителя могут занять некоторое время и увеличить общее время обработки.

• По умолчанию: false

• Тип: Boolean