10.4. 声明检查 EIP
声明检查 EIP
声明检查 EIP 模式,如 图 10.4 “声明检查模式” 所示,允许您将消息内容替换为声明检查(唯一键)。稍后 使用声明检查 EIP 模式检索消息内容。您可以将消息内容临时存储到一个持久存储中,如数据库或文件系统。当消息内容非常大(以及发送过程中昂贵的)且所有组件都需要所有信息时,这个模式很有用。
当您无法使用外部方信任信息时,它也非常有用。在这种情况下,使用 Claim Check 来隐藏数据的敏感部分。
EIP 模式的 Camel 实施会在内部内存存储中临时存储消息内容。
图 10.4. 声明检查模式
10.4.1. 声明检查 EIP 选项
Claim Check EIP 支持下表中列出的选项:
Name | 描述 | 默认 | 类型 |
operation | 需要使用声明检查操作。它支持以下操作:
* get -
*
*
* push - 在堆栈上设置一个新的声明检查(不要使用该键)。
* 弹出 - 从堆栈获取最新的声明检查(不要使用密钥)。
当使用 | ClaimCheckOperation | |
key | 要将特定键用于声明检查,请执行以下操作: | 字符串 | |
filter | 指定一个过滤器来控制您要从声明检查存储库中合并的数据。 | 字符串 | |
strategyRef |
使用自定义 | 字符串 |
过滤选项
使用 Filter
选项定义在使用 Get
或 Pop
操作时要合并的数据。使用 AggregationStrategy
合并数据。默认策略使用 filter 选项轻松指定要合并的数据。
filter
选项使用 String 值,语法如下:
-
正文
:聚合邮件正文 -
附件
:聚合所有邮件附件 -
标头
:聚合所有邮件标题 -
header:pattern
: 用于聚合与模式匹配的所有消息标头
pattern 规则支持通配符和正则表达式。
-
通配符匹配(模式以
*
结尾且名称以模式开头) - 正则表达式匹配
要指定多个规则,用 逗号
(、)来分隔它们。
以下是包含消息正文以及以 foo 开头的所有标头的基本过滤器示例:
body, header:foo*
-
仅合并邮件正文:
正文
-
仅合并邮件附件:
附件
-
仅合并标头:
标头
-
合并标题名称
foo
only:header:foo
如果将过滤规则指定为空或通配符,您可以合并所有内容。如需更多信息,请参阅 过滤要合并的数据。
当您将数据合并回来时,系统会覆盖任何现有的数据。此外,它还存储现有的数据。
10.4.2. 使用 Include 和 Exclude Pattern 过滤选项
以下是支持可以用来指定 include、exclude 或 remove 选项的前缀的语法。
- + : to include (默认模式)
- - : to exclude (排除优先级优先于包括)
- -- : 要删除(删除优先级)
例如:
-
要跳过邮件正文并合并所有其他信息,请使用-
-body
-
要跳过消息标题
foo
并合并所有其他信息,请使用--header:foo
您还可以指示系统在合并数据时删除标头。例如,要删除以 bar 开头的所有标头,可使用- --headers:bar*
。
不要同时使用 include (+)和 exclude (-) 标头:pattern
。
10.4.3. Java 示例
以下示例显示了操作中的 Push
和
Pop 操作:
from("direct:start") .to("mock:a") .claimCheck(ClaimCheckOperation.Push) .transform().constant("Bye World") .to("mock:b") .claimCheck(ClaimCheckOperation.Pop) .to("mock:c");
以下是使用 Get
和 Set
操作的示例。这个示例使用 foo
键。
from("direct:start") .to("mock:a") .claimCheck(ClaimCheckOperation.Set, "foo") .transform().constant("Bye World") .to("mock:b") .claimCheck(ClaimCheckOperation.Get, "foo") .to("mock:c") .transform().constant("Hi World") .to("mock:d") .claimCheck(ClaimCheckOperation.Get, "foo") .to("mock:e");
您可以使用 Get
操作获得相同的数据两次,因为它不会删除数据。但是,如果您只想获得数据一次,请使用 GetAndRemove
操作。
以下示例演示了如何使用过滤器选项,从中只想获得 foo
或 bar
的标头。
from("direct:start") .to("mock:a") .claimCheck(ClaimCheckOperation.Push) .transform().constant("Bye World") .setHeader("foo", constant(456)) .removeHeader("bar") .to("mock:b") // only merge in the message headers foo or bar .claimCheck(ClaimCheckOperation.Pop, null, "header:(foo|bar)") .to("mock:c");
10.4.4. XML 示例
以下示例显示了操作中的 Push
和
Pop 操作。
<route> <from uri="direct:start"/> <to uri="mock:a"/> <claimCheck operation="Push"/> <transform> <constant>Bye World</constant> </transform> <to uri="mock:b"/> <claimCheck operation="Pop"/> <to uri="mock:c"/> </route>
以下是使用 Get
和 Set
操作的示例。这个示例使用 foo
键。
<route> <from uri="direct:start"/> <to uri="mock:a"/> <claimCheck operation="Set" key="foo"/> <transform> <constant>Bye World</constant> </transform> <to uri="mock:b"/> <claimCheck operation="Get" key="foo"/> <to uri="mock:c"/> <transform> <constant>Hi World</constant> </transform> <to uri="mock:d"/> <claimCheck operation="Get" key="foo"/> <to uri="mock:e"/> </route>
您可以使用 Get
操作获得相同的数据两次,因为它不会删除数据。但是,如果您想要获得一次数据,可以使用 GetAndRemove
操作。
以下示例演示了如何使用 filter
选项使标头返回为 foo
或 bar
。
<route> <from uri="direct:start"/> <to uri="mock:a"/> <claimCheck operation="Push"/> <transform> <constant>Bye World</constant> </transform> <setHeader headerName="foo"> <constant>456</constant> </setHeader> <removeHeader headerName="bar"/> <to uri="mock:b"/> <!-- only merge in the message headers foo or bar --> <claimCheck operation="Pop" filter="header:(foo|bar)"/> <to uri="mock:c"/> </route>