第 165 章 JacksonXML DataFormat

作为 Camel 版本 2.16 可用

jackson XML 是一个数据格式，它使用带有 XMLMapper 扩展的 Jackson 库 ，将 XML 有效负载分到 Java 对象或将 marshal Java 对象编入 XML 有效负载中。

INFO：如果您熟悉 Jackson，此 XML 数据格式的行为与其 JSON 计数器部分相同，因此可用于 JSON 序列化/反序列化的类。

此扩展也模拟 JAXB 的"代码先"方法。

这个数据格式依赖于 Woodstox （特别是印刷等功能），这是一个快速、高效的 XML 处理器。 

from("activemq:My.Queue").
  unmarshal().jacksonxml().
  to("mqseries:Another.Queue");

165.1. JacksonXML 选项

JacksonXML 数据格式支持 15 选项，它们如下所列。

名称默认Java 类型描述

xmlMapper

 

字符串

查找并使用给定 ID 的现有 XmlMapper。

prettyPrint

false

布尔值

启用大量打印输出。默认为 false。

unmarshalTypeName

 

字符串

取消armshalling 时要使用的 java 类型的类名称

jsonView

 

class<?>

当 marshalling a POJO to JSON 时，您可能想要从 JSON 输出中排除某些字段。通过 Jackson，您可以使用 JSON 视图来达到此目的。此选项引用包含 JsonView 注解的类

Include

 

字符串

如果您想将 pojo to JSON 放入 JSON，则 pojo 含有一些带有 null 值的字段。而且，您想要跳过这些 null 值，您可以将这个选项设置为 not_NULL

allowJmsType

false

布尔值

用于 JMS 用户，允许 JMS spec 中的 JMSType 标头指定用于 unmarshal 的 FQN 类名称。

collectionTypeName

 

字符串

指的是要在注册表中查找的自定义集合类型。这个选项很少被使用，但允许使用与 java.util.Collection 不同的集合类型作为默认值。

useList

false

布尔值

要取消与映射列表或 Pojo 列表相关的内容。

enableJaxbAnnotationModule

false

布尔值

使用 jackson 时是否启用 JAXB 注解模块。启用之后，Jackson 可以使用 JAXB 注释。

moduleClassNames

 

字符串

要使用自定义 Jackson 模块 com.fasterxml.jackson.databind.Module 指定为带有 FQN 类名称的 String。可以使用逗号分隔多个类。

moduleRefs

 

字符串

使用由 Camel registry 引用的自定义 Jackson 模块。可以使用逗号分隔多个模块。

enableFeatures

 

字符串

在 Jackson com.fasterxml.jackson.databind.ObjectMapper 上启用的功能集。这个功能应当是与 com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature 或 com.fasterxml.jackson.jackson.jackson.databind.MapperFeature.jackson.databind.

disableFeatures

 

字符串

在 Jackson com.fasterxml.jackson.databind.ObjectMapper 上禁用功能集。这个功能应当是与 com.fasterxml.jackson.databind.SerializationFeature, com.fasterxml.jackson.databind.DeserializationFeature 或 com.fasterxml.jackson.jackson.jackson.databind.MapperFeature.jackson.databind.

allowUnmarshallType

false

布尔值

如果启用，则 Jackson 可以在 unmarshalling 中尝试使用 CamelJacksonUnmarshalType 标头。只有在需要使用时，才应启用它。

contentTypeHeader

false

布尔值

如果数据格式能够这样做，则数据格式是否应该以 data 格式设置 Content-Type 标头。例如，用于数据格式的 application/xml （数据格式）或 application/json 用于数据格式 marshalling to JSon etc。

165.1.1. 在 Spring DSL 中使用 Jackson XML

在 Spring DSL 中使用数据格式时，您需要首先声明数据格式。这是在 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 unmarshalTypeName is optional, if not provided Camel will use a Map as the type -->
            <jacksonxml id="jack" unmarshalTypeName="org.apache.camel.component.jacksonxml.TestPojo"/>
        </dataFormats>

然后您可以在路由中引用这个 id： 

       <route>
            <from uri="direct:back"/>
            <unmarshal ref="jack"/>
            <to uri="mock:reverse"/>
        </route>