第59章 JacksonXML
Jackson XML は、XML Mapper エクステンションとともに Jackson ライブラリー を使用して XML ペイロードを Java オブジェクトにアンマーシャリングしたり、Java オブジェクトを XML ペイロードにマーシャリングしたりする Data Format です。注記:Jackson に精通している場合、この XML データ形式は JSON の対応する方法と同じように動作するため、JSON シリアライゼーション/デシリアライズにアノテーションが付けられたクラスで使用できます。
また、この拡張機能は JAXB の "Code first" アプローチ を模倣します。
このデータ形式は、Woodstox (特にpretty print などの機能)に依存します。これは、高速で効率的な XML プロセッサーです。
from("activemq:My.Queue").
unmarshal().jacksonxml().
to("mqseries:Another.Queue");
from("activemq:My.Queue").
unmarshal().jacksonxml().
to("mqseries:Another.Queue");
59.1. JacksonXML オプション リンクのコピーリンクがクリップボードにコピーされました!
JacksonXML データ形式は、以下に示す 15 個のオプションをサポートします。
| 名前 | デフォルト | Java タイプ | 説明 |
|---|---|---|---|
| xmlMapper |
| 指定された ID で既存の XmlMapper を検索し、使用します。 | |
| prettyPrint | false |
| 適切にフォーマットされたきれいな印刷出力を有効にします。デフォルトでは false です。 |
| unmarshalType |
| アンマーシャリング時に使用する Java 型のクラス名。 | |
| jsonView |
| POJO を JSON にマーシャリングする際に、JSON 出力から特定のフィールドを除外したい場合があります。Jackson では、JSON ビューを使用してこれを実現できます。このオプションは、JsonView アノテーションを持つクラスを参照するためのものです。 | |
| include |
| pojo を JSON にマーシャリングする必要があり、pojo に null 値を持つフィールドがいくつかある場合。これらの null 値をスキップしたい場合は、このオプションを NON_NULL に設定できます。 | |
| allowJmsType |
| JMS ユーザーが JMS 仕様の JMSType ヘッダーを使用して、アンマーシャリングに使用する FQN クラス名を指定できるようにするために使用されます。 | |
| collectionType |
| 使用するレジストリーを参照するカスタムコレクションタイプを参照します。このオプションはあまり使用しないでください。ただし、デフォルトとして java.util.Collection に基づくものとは異なるコレクションタイプを使用できます。 | |
| useList |
| Map の List または Pojo の List にアンマーシャリングします。 | |
| enableJaxbAnnotationModule |
| jackson の使用時に JAXB アノテーションモジュールを有効にするかどうか。有効にすると、Jackson によって JAXB アノテーションを使用できます。 | |
| moduleClassNames |
| カスタム Jackson モジュール com.fasterxml.jackson.databind.Module を使用するには、FQN クラス名を持つ文字列として指定します。複数のクラスはコンマで区切ることができます。 | |
| moduleRefs |
| Camel レジストリーから参照されるカスタム Jackson モジュールを使用します。複数のモジュールはコンマで区切ることができます。 | |
| enableFeatures |
| Jackson com.fasterxml.jackson.databind.ObjectMapper で有効にする機能のセット。機能は、com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature、または com.fasterxml.jackson.databind.MapperFeature の列挙型と一致する名前である必要があります。複数の機能はコンマで区切ることができます。 | |
| disableFeatures |
| Jackson com.fasterxml.jackson.databind.ObjectMapper で無効にする機能のセット。機能は、com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature、または com.fasterxml.jackson.databind.MapperFeature の列挙型と一致する名前である必要があります。複数の機能はコンマで区切ることができます。 | |
| allowUnmarshallType |
| 有効にすると、Jackson はアンマーシャリング中に CamelJacksonUnmarshalType ヘッダーの使用を試みることができます。これは、使用する必要がある場合にのみ有効にする必要があります。 | |
| contentTypeHeader |
| データ形式が Content-Type ヘッダーにデータ形式のタイプを設定する必要があるかどうか。たとえば、XML にマーシャリングするデータ形式の場合は application/xml、JSON にマーシャリングするデータ形式の場合は application/json です。 |
59.1.1. Spring DSL での Jackson XML の使用 リンクのコピーリンクがクリップボードにコピーされました!
Spring DSL で Data Format を使用する場合は、最初にデータ形式を宣言する必要があります。これは、DataFormats XML タグで実行されます。
<dataFormats>
<!-- here we define a Xml data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalType is optional, if not provided Camel will use a Map as the type -->
<jacksonxml id="jack" unmarshalType="org.apache.camel.component.jacksonxml.TestPojo"/>
</dataFormats>
<dataFormats>
<!-- here we define a Xml data format with the id jack and that it should use the TestPojo as the class type when
doing unmarshal. The unmarshalType is optional, if not provided Camel will use a Map as the type -->
<jacksonxml id="jack" unmarshalType="org.apache.camel.component.jacksonxml.TestPojo"/>
</dataFormats>
そして、ルートでこの ID を参照できます。
<route>
<from uri="direct:back"/>
<unmarshal><custom ref="jack"/></unmarshal>
<to uri="mock:reverse"/>
</route>
<route>
<from uri="direct:back"/>
<unmarshal><custom ref="jack"/></unmarshal>
<to uri="mock:reverse"/>
</route>
59.1.2. POJO フィールドをマーシャリングから除外する リンクのコピーリンクがクリップボードにコピーされました!
POJO を XML にマーシャリングする場合は、XML 出力から特定のフィールドを除外する場合があります。Jackson では、JSON ビュー を使用してこれを実現できます。まず、1 つ以上のマーカークラスを作成します。
@JsonView アノテーションを持つマーカークラスを使用して、特定のフィールドを包含/除外します。注釈はゲッターでも機能します。
最後に、Camel JacksonXMLDataFormat を使用して上記の POJO を XML にマーシャリングします。
結果となる XML には weight フィールドがない点に注意してください。
<pojo age="30" weight="70"/>
<pojo age="30" weight="70"/>