|
此版本仍在开发中，尚不被认为是稳定的。对于最新的稳定版本，请使用 Spring Integration 6.5.1！ |
Filter
消息过滤器用于确定Message应根据某些标准（例如消息标头值或消息内容本身）传递或删除。因此，消息过滤器类似于路由器，不同之处在于，对于从过滤器的输入通道接收的每条消息，相同的消息可能会或可能不会发送到过滤器的输出通道。与路由器不同，它不会决定将消息发送到哪个消息通道，而只决定是否发送消息。
| 正如我们在本节后面所述，过滤器还支持丢弃通道。 在某些情况下，它可以根据布尔条件扮演非常简单的路由器（或“交换机”）的角色。 |
在 Spring Integration 中，您可以将消息过滤器配置为消息端点，该端点委托给MessageSelector接口。
该界面本身非常简单，如以下列表所示：
public interface MessageSelector {
boolean accept(Message<?> message);
}这MessageFilter构造函数接受一个选择器实例，如以下示例所示：
MessageFilter filter = new MessageFilter(someSelector);使用 Java、Groovy 和 Kotlin DSL 配置过滤器
这IntegrationFlowBuilder由 Java DSL（也用作 Groovy 和 Kotlin DSL 的基础）提供了许多重载方法filter()算子。
这MessageSelector上面提到的抽象可以用作filter()定义：
-
Java DSL
-
Kotlin DSL
-
Groovy DSL
@Bean
public IntegrationFlow someFlow() {
return f -> f
.<String>filter((payload) -> !"junk".equals(payload));
}@Bean
fun someFlow() =
integrationFlow {
filter<String> { it != "junk" }
}@Bean
someFlow() {
integrationFlow {
filter String, { it != 'junk' }
}
}在相应的章节中查看有关 DSL 的更多信息：
使用 XML 配置过滤器
结合命名空间和 SpEL，您可以使用很少的 Java 代码配置强大的过滤器。
您可以使用<filter>元素用于创建消息选择端点。
除了input-channel和output-channel属性，它需要一个ref属性。
这ref可以指向MessageSelector实现，如以下示例所示：
<int:filter input-channel="input" ref="selector" output-channel="output"/>
<bean id="selector" class="example.MessageSelectorImpl"/>或者，您可以添加method属性。
在这种情况下，ref属性可以引用任何对象。
引用的方法可能需要Message类型或入站消息的有效负载类型。
该方法必须返回布尔值。
如果该方法返回“true”，则消息将发送到输出通道。
以下示例演示如何配置使用method属性：
<int:filter input-channel="input" output-channel="output"
ref="exampleObject" method="someBooleanReturningMethod"/>
<bean id="exampleObject" class="example.SomeObject"/>如果选择器或适配的 POJO 方法返回false，一些设置控制被拒绝邮件的处理。
默认情况下，（如果如前面示例所示配置）将以静默方式删除被拒绝的邮件。
如果拒绝应该导致错误条件，请将throw-exception-on-rejection属性设置为true，如以下示例所示：
<int:filter input-channel="input" ref="selector"
output-channel="output" throw-exception-on-rejection="true"/>如果您希望将被拒绝的消息路由到特定通道，请将该引用作为discard-channel，如以下示例所示：
<int:filter input-channel="input" ref="selector"
output-channel="output" discard-channel="rejectedMessages"/>如果throwExceptionOnRejection == false和没有discardChannel，则消息将以静默方式删除，并且o.s.i.filter.MessageFilter实例仅发出有关此丢弃消息的警告日志消息（从版本 6.1 开始）。
要在日志中删除没有警告的消息，请NullChannel可以配置为discardChannel在过滤器上。
默认情况下，框架的目标是不要完全静默，如果这是所需的行为，则需要设置显式选项。
另请参阅Advising Filters。
| 消息过滤器通常与发布-订阅通道结合使用。 许多筛选器终结点可能订阅到同一通道，它们决定是否将消息传递到下一个终结点，该终结点可以是任何受支持的类型（例如服务激活器）。 这为使用具有单个点对点输入通道和多个输出通道的消息路由器的更主动的方法提供了一种被动的替代方案。 |
我们建议使用ref属性（如果自定义过滤器实现在其他<filter>定义。
但是，如果自定义筛选器实现的范围限定为单个<filter>元素，您应该提供内部 bean 定义，如以下示例所示：
<int:filter method="someMethod" input-channel="inChannel" output-channel="outChannel">
<beans:bean class="org.foo.MyCustomFilter"/>
</filter>同时使用ref属性和内部处理程序定义<filter>不允许配置，因为它会创建不明确的条件并引发异常。 |
如果ref属性引用扩展的 beanMessageFilter（例如框架本身提供的过滤器），通过将输出通道直接注入过滤器 bean 来优化配置。
在这种情况下，每个ref必须是单独的 bean 实例（或prototype-scoped bean）或使用<bean/>配置类型。
但是，仅当未在过滤器 XML 定义中提供任何特定于过滤器的属性时，此优化才适用。
如果您无意中从多个 Bean 引用了相同的消息处理程序，则会收到配置异常。 |
随着 SpEL 支持的引入，Spring Integration 添加了expression属性添加到过滤器元件。
它可以用来完全避免 Java 进行简单过滤器，如以下示例所示：
<int:filter input-channel="input" expression="payload.equals('nonsense')"/>作为 expression 属性值传递的字符串被计算为 SpEL 表达式，其中包含在评估上下文中可用的消息。
如果必须将表达式的结果包含在应用程序上下文的作用域中，则可以使用 SpEL 参考文档中定义的表示法，如以下示例所示：#{}
<int:filter input-channel="input"
expression="payload.matches(#{filterPatterns.nonsensePattern})"/>如果表达式本身需要动态，您可以使用 'expression' 子元素。
这提供了一个间接级别，用于通过其键解析表达式，从ExpressionSource.
这是一个可以直接实现的策略接口，或者您可以依赖 Spring Integration 中可用的版本，该版本从“资源包”加载表达式，并可以在给定的秒数后检查修改。
所有这些都在以下配置示例中进行了演示，如果修改了基础文件，则可以在一分钟内重新加载表达式：
<int:filter input-channel="input" output-channel="output">
<int:expression key="filterPatterns.example" source="myExpressions"/>
</int:filter>
<beans:bean id="myExpressions"
class="o.s.i.expression.ReloadableResourceBundleExpressionSource">
<beans:property name="basename" value="config/integration/expressions"/>
<beans:property name="cacheSeconds" value="60"/>
</beans:bean>如果ExpressionSourcebean 被命名为expressionSource，则无需在<expression>元素。
但是，在前面的示例中，为了完整起见，我们显示了它。
'config/integration/expressions.properties' 文件（或任何具有语言环境扩展名的更具体版本，以加载资源包的典型方式解析）可以包含键/值对，如以下示例所示：
filterPatterns.example=payload > 100所有这些使用expression作为属性或子元素也可以应用于 Transformer、Router、Splitter、Service-Activator 和 Header-Enricher 元素中。
给定组件类型的语义和作用将影响评估结果的解释，就像解释方法调用的返回值一样。
例如，表达式可以返回将路由器组件视为消息通道名称的字符串。
但是，根据消息作为根对象评估表达式并在前缀为“@”时解析 bean 名称的底层功能在 Spring Integration 中的所有核心 EIP 组件中是一致的。 |
使用注释配置过滤器
以下示例演示如何使用注释配置过滤器：
public class PetFilter {
...
@Filter (1)
public boolean dogsOnly(String input) {
...
}
}| 1 | 指示此方法将用作过滤器的注释。 如果要将此类用作过滤器，则必须指定它。 |
XML 元素提供的所有配置选项也可用于@Filter注解。
过滤器可以从 XML 显式引用，或者如果@MessageEndpoint注释在类上定义，通过类路径扫描自动检测。
另请参阅使用注释为端点提供建议。