过滤器

消息过滤器用于根据某些条件（例如消息头值或消息内容本身）来决定是否应该传递或丢弃Message。因此，消息过滤器类似于路由器，不同之处在于，对于从过滤器输入通道接收到的每个消息，该消息可能会也可能不会发送到过滤器的输出通道。与路由器不同，它不决定将消息发送到哪个消息通道，而只决定是否发送消息。

正如我们将在本节后面介绍的那样，过滤器还支持丢弃通道。在某些情况下，它可以根据布尔条件扮演一个非常简单的路由器（或“开关”）的角色。

在 Spring Integration 中，您可以将消息过滤器配置为消息端点，该端点委托给MessageSelector接口的实现。该接口本身非常简单，如下所示

public interface MessageSelector {

    boolean accept(Message<?> message);

}

MessageFilter 构造函数接受一个选择器实例，如下例所示

MessageFilter filter = new MessageFilter(someSelector);

使用 Java、Groovy 和 Kotlin DSL 配置过滤器

Java DSL 提供的IntegrationFlowBuilder（也用作 Groovy 和 Kotlin DSL 的基础）为filter()运算符提供了一些重载方法。上面提到的MessageSelector抽象可以用作filter()定义中的 Lambda

  • 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。

消息过滤器通常与发布-订阅通道一起使用。许多过滤器端点可以订阅同一个通道，它们决定是否将消息传递到下一个端点，该端点可以是任何受支持的类型（例如服务激活器）。这提供了一种对使用具有单个点对点输入通道和多个输出通道的消息路由器的更主动方法的反应式替代方案。

如果自定义过滤器实现在其他<filter>定义中引用，我们建议使用ref属性。但是，如果自定义过滤器实现的范围仅限于单个<filter>元素，则应提供内部 bean 定义，如下例所示

<int:filter method="someMethod" input-channel="inChannel" output-channel="outChannel">
  <beans:bean class="org.foo.MyCustomFilter"/>
</filter>
不允许在同一个<filter>配置中同时使用ref属性和内部处理程序定义，因为它会创建一个不明确的条件并抛出异常。
如果ref属性引用扩展MessageFilter的 bean（例如框架本身提供的过滤器），则通过直接将输出通道注入过滤器 bean 来优化配置。在这种情况下，每个ref必须指向单独的 bean 实例（或prototype范围的 bean）或使用内部<bean/>配置类型。但是，此优化仅在您未在过滤器 XML 定义中提供任何过滤器特定属性时才适用。如果您无意中从多个 bean 引用同一个消息处理程序，则会得到配置异常。

随着 SpEL 支持的引入，Spring Integration 向过滤器元素添加了expression属性。它可以用于避免对简单过滤器完全使用 Java，如下例所示

<int:filter input-channel="input" expression="payload.equals('nonsense')"/>

作为表达式属性的值传递的字符串将作为 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>

如果ExpressionSource bean 的名称为expressionSource，则无需在<expression>元素上提供`source`属性。但是，在前面的示例中，我们为了完整性而显示了它。

“config/integration/expressions.properties”文件（或任何具有区域设置扩展名的更具体的版本，以典型的资源包加载方式解析）可以包含键/值对，如下例所示

filterPatterns.example=payload > 100
所有这些使用expression作为属性或子元素的示例也可以应用于转换器、路由器、拆分器、服务激活器和标头丰富器元素。给定组件类型的语义和作用将影响对评估结果的解释，这与方法调用的返回值的解释方式相同。例如，表达式可以返回字符串，路由器组件将其视为消息通道名称。但是，针对消息作为根对象评估表达式并在以“@”为前缀时解析 bean 名称的基本功能在 Spring Integration 中的所有核心 EIP 组件中都是一致的。

使用注解配置过滤器

以下示例显示了如何使用注解配置过滤器

public class PetFilter {
    ...
    @Filter  (1)
    public boolean dogsOnly(String input) {
        ...
    }
}
1 指示此方法将用作过滤器的注解。如果此类将用作过滤器，则必须指定它。

XML 元素提供的所有配置选项也适用于@Filter注解。

过滤器可以从 XML 中显式引用，或者如果在类上定义了@MessageEndpoint注解，则可以通过类路径扫描自动检测。

另请参阅 Advising Endpoints Using Annotations。