此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Integration 6.4.0! |
JMX 支持
Spring 集成提供了用于接收和发布 JMX 通知的通道适配器。
您需要将此依赖项包含在您的项目中:
-
Maven
-
Gradle
<dependency>
<groupId>org.springframework.integration</groupId>
<artifactId>spring-integration-jmx</artifactId>
<version>6.4.1-SNAPSHOT</version>
</dependency>
compile "org.springframework.integration:spring-integration-jmx:6.4.1-SNAPSHOT"
入站通道适配器允许轮询 JMX MBean 属性值,出站通道适配器允许调用 JMX MBean作。
通知侦听通道适配器
通知侦听通道适配器需要 JMXObjectName
对于发布此侦听器应注册到的通知的 MBean。
一个非常简单的配置可能类似于以下内容:
<int-jmx:notification-listening-channel-adapter id="adapter"
channel="channel"
object-name="example.domain:name=publisher"/>
这notification-listening-channel-adapter 使用MBeanServer 在启动时,默认 Bean 名称为mbeanServer ,这恰好与使用 Spring 的<context:mbean-server/> 元素。
如果您需要使用不同的名称,请务必包含mbean-server 属性。 |
适配器还可以接受对NotificationFilter
以及一个 “handback” 对象,用于提供与每个通知一起传回的一些上下文。
这两个属性都是可选的。
扩展前面的示例以包括这些属性以及显式的MBeanServer
Bean 名称生成以下示例:
<int-jmx:notification-listening-channel-adapter id="adapter"
channel="channel"
mbean-server="someServer"
object-name="example.domain:name=somePublisher"
notification-filter="notificationFilter"
handback="myHandback"/>
_Notification侦听通道适配器是事件驱动的,并在MBeanServer
径直。
它不需要任何 poller 配置。
仅对于此组件,
启用 DEBUG 级别日志记录时,将记录找到的 MBean 的名称。 |
通知发布通道适配器
通知发布通道适配器相对简单。 它的配置中只需要一个 JMX 对象名称,如下例所示:
<context:mbean-export/>
<int-jmx:notification-publishing-channel-adapter id="adapter"
channel="channel"
object-name="example.domain:name=publisher"/>
它还要求MBeanExporter
出现在上下文中。
这就是为什么<context:mbean-export/>
元素中也显示了
当消息发送到此适配器的通道时,将从消息内容创建通知。
如果有效负载是String
,它作为message
通知的文本。
任何其他有效负载类型都作为userData
的通知。
JMX 通知还有一个type
,并且它应该是点分隔的String
.
有两种方法可以提供type
.
始终优先于与JmxHeaders.NOTIFICATION_TYPE
钥匙。
或者,您也可以提供 fallbackdefault-notification-type
属性,如下例所示:
<context:mbean-export/>
<int-jmx:notification-publishing-channel-adapter id="adapter"
channel="channel"
object-name="example.domain:name=publisher"
default-notification-type="some.default.type"/>
属性轮询通道适配器
当您需要定期检查通过 MBean 作为托管属性提供的某些值时,属性轮询通道适配器非常有用。
你可以像 Spring Integration 中的任何其他 polling 适配器一样配置 Poller(或者你可以依赖默认的 Poller)。
这object-name
和attribute-name
是必需的。
还需要 MBeanServer 引用。
但是,默认情况下,它会自动检查名为mbeanServer
,与前面描述的通知侦听通道适配器相同。
下面的示例展示了如何使用 XML 配置属性轮询通道适配器:
<int-jmx:attribute-polling-channel-adapter id="adapter"
channel="channel"
object-name="example.domain:name=someService"
attribute-name="InvocationCount">
<int:poller max-messages-per-poll="1" fixed-rate="5000"/>
</int-jmx:attribute-polling-channel-adapter>
树轮询通道适配器
树轮询通道适配器查询 JMX MBean 树,并发送一条消息,其中包含一个有效负载,该有效负载是与查询匹配的对象图。
默认情况下,MBean 映射到原始对象和简单对象,例如Map
,List
和数组。
这样做允许简单地转换为 (例如) JSON。
还需要 MBeanServer 引用。
但是,默认情况下,它会自动检查名为mbeanServer
,与前面描述的通知侦听通道适配器相同。
下面的示例展示了如何使用 XML 配置树轮询通道适配器:
<int-jmx:tree-polling-channel-adapter id="adapter"
channel="channel"
query-name="example.domain:type=*">
<int:poller max-messages-per-poll="1" fixed-rate="5000"/>
</int-jmx:tree-polling-channel-adapter>
前面的示例包括所选 MBean 上的所有属性。
您可以通过提供MBeanObjectConverter
配置了适当的过滤器。
您可以使用converter
属性,或者你可以使用内部的<bean/>
定义。
Spring 集成提供了一个DefaultMBeanObjectConverter
那可能需要MBeanAttributeFilter
在其 constructor 参数中。
Spring 集成提供了两个标准过滤器。
这NamedFieldsMBeanAttributeFilter
用于指定要包含的属性列表。
这NotNamedFieldsMBeanAttributeFilter
用于指定要排除的属性列表。
您还可以实现自己的过滤器。
作调用通道适配器
作调用通道适配器支持对 MBean 公开的任何托管作进行消息驱动调用。
每次调用都需要调用的作名称和目标 MBean 的对象名称。
这两者都必须由适配器配置或通过JmxHeaders.OBJECT_NAME
和JmxHeaders.OPERATION_NAME
message headers 分别:
<int-jmx:operation-invoking-channel-adapter id="adapter"
object-name="example.domain:name=TestBean"
operation-name="ping"/>
然后适配器只需要能够发现mbeanServer
豆。
如果需要不同的 bean 名称,则提供mbean-server
属性。
消息的有效负载将映射到作的参数(如果有)。
一个Map
-typed payload 替换为String
keys 被视为名称/值对,而List
or 数组作为简单的参数列表传递(没有明确的参数名称)。
如果作需要单个参数值,则有效负载可以表示该单个值。
此外,如果作不需要任何参数,则有效负载将被忽略。
如果要为不需要包含 Headers 的消息公开单个常见作的通道,则最后一个选项效果很好。
作调用出站网关
与作调用通道适配器类似, Spring 集成也提供了一个作调用出站网关,当需要返回值时,你可以在处理非void作时使用该网关。
返回值将作为消息负载发送到reply-channel
由网关指定。
以下示例显示如何使用 XML 配置作调用出站网关:
<int-jmx:operation-invoking-outbound-gateway request-channel="requestChannel"
reply-channel="replyChannel"
object-name="o.s.i.jmx.config:type=TestBean,name=testBeanGateway"
operation-name="testWithReturn"/>
如果您未提供reply-channel
属性,则回复消息将发送到由IntegrationMessageHeaderAccessor.REPLY_CHANNEL
页眉。
该标头通常由消息流的入口点(例如任何网关组件)自动创建。
但是,如果消息流是通过手动创建 Spring Integration 消息并将其直接发送到通道来启动的,则必须显式指定消息头或使用reply-channel
属性。
MBean 导出器
Spring 集成组件本身可以作为 MBean 公开,当IntegrationMBeanExporter
已配置。
要创建IntegrationMBeanExporter
,定义一个 Bean 并提供对MBeanServer
和域名(如果需要)。
您可以省略域,在这种情况下,默认域为org.springframework.integration
.
以下示例演示如何声明IntegrationMBeanExporter
和关联的MBeanServer
实例:
<int-jmx:mbean-export id="integrationMBeanExporter"
default-domain="my.company.domain" server="mbeanServer"/>
<bean id="mbeanServer" class="org.springframework.jmx.support.MBeanServerFactoryBean">
<property name="locateExistingServerIfPossible" value="true"/>
</bean>
MBean 导出器与 Spring core 中提供的导出器正交。
它注册消息通道和消息处理程序,但不注册自身。
您可以使用标准的 它还具有一个有用的作,如 Orderly Shutdown Managed Operation 中所述。 |
Spring Integration 4.0 引入了@EnableIntegrationMBeanExport
注解,以便方便地配置默认integrationMbeanExporter
类型的 beanIntegrationMBeanExporter
在@Configuration
类级别。
以下示例显示如何配置此 Bean:
@Configuration
@EnableIntegration
@EnableIntegrationMBeanExport(server = "mbeanServer", managedComponents = "input")
public class ContextConfiguration {
@Bean
public MBeanServerFactoryBean mbeanServer() {
return new MBeanServerFactoryBean();
}
}
如果您需要提供更多选项或有多个IntegrationMBeanExporter
bean(例如用于不同的 MBean 服务器或避免与标准 Spring 冲突MBeanExporter
— 例如通过@EnableMBeanExport
),您可以配置IntegrationMBeanExporter
作为通用 Bean 进行。
MBean 对象名称
所有MessageChannel
,MessageHandler
和MessageSource
应用程序中的实例由 MBean 导出器包装,以提供管理和监控功能。
下表列出了为每种组件类型生成的 JMX 对象名称:
组件类型 | 对象名称 |
---|---|
MessageChannel 消息频道 |
`o.s.i:type=MessageChannel,name=<channelName>` |
消息源 |
`o.s.i:type=MessageSource,name=<channelName>,bean=<source>` |
MessageHandler 消息处理器 |
`o.s.i:type=MessageSource,name=<channelName>,bean=<source>` |
这bean
属性 (attribute ) 采用下表中的值之一:
Bean 值 | 描述 |
---|---|
端点 |
封闭端点的 Bean 名称(例如 |
匿名 |
指示封闭端点没有用户指定的 bean 名称,因此 JMX 名称是 input 通道名称。 |
内部 |
对于众所周知的 Spring 集成默认组件 |
处理程序/源 |
以上都不是。
回退到 |
您可以通过提供对Properties
对象在object-name-static-properties
属性。
此外,从 Spring Integration 3.0 开始,您可以使用自定义的ObjectNamingStrategy
通过设置object-naming-strategy
属性。
这样做可以更好地控制 MBean 的命名,例如将所有集成 MBean 分组到“Integration”类型下。
以下示例显示了一种可能的自定义命名策略实现:
public class Namer implements ObjectNamingStrategy {
private final ObjectNamingStrategy realNamer = new KeyNamingStrategy();
@Override
public ObjectName getObjectName(Object managedBean, String beanKey) throws MalformedObjectNameException {
String actualBeanKey = beanKey.replace("type=", "type=Integration,componentType=");
return realNamer.getObjectName(managedBean, actualBeanKey);
}
}
这beanKey
argument 是String
包含标准对象名称,以default-domain
并包括任何其他静态属性。
前面的示例将标准type
零件到componentType
并设置type
设置为 'Integration',从而在一个查询中选择所有集成 MBean:'my.domain:type=Integration,*'。
这样做还会将 bean 分组到诸如 VisualVM 之类的工具中域下的一个树条目下。
默认命名策略是MetadataNamingStrategy .
导出器将default-domain 添加到该对象中,以允许它在解析 Bean 键失败时生成一个回退对象名称。
如果您的自定义命名策略是MetadataNamingStrategy (或其子类)时,导出器不会传播default-domain .
您必须在策略 Bean 上配置它。 |
从版本 5.1 开始,任何 bean 名称(由name
key 中)如果它们包含 Java 标识符(或句点)中不允许的任何字符,则将被引用.
).
JMX 改进
版本 4.2 引入了一些重要的改进,代表了对框架中 JMX 支持的相当大的改革。 这导致了 JMX 统计信息收集的显著性能改进和更多的控制。 但是,在一些特定 (不常见) 情况下,它对用户代码有一些影响。 下面详细介绍了这些更改,并在必要时谨慎使用。
- @IntegrationManagedResource
-
与
@ManagedResource
annotation、@IntegrationManagedResource
将类标记为有资格导出为 MBean。 但是,仅当应用程序上下文具有IntegrationMBeanExporter
.某些 Spring Integration 类(在
org.springframework.integration
) 包),这些包之前使用@ManagedResource
现在使用两者进行注释@ManagedResource
和@IntegrationManagedResource
. 这是为了实现向后兼容性(请参阅下一项)。 此类 MBean 可按任何上下文导出MBeanServer
或通过IntegrationMBeanExporter
(但不能同时存在两者 — 如果两个导出器都存在,则如果 Bean 与managed-components
pattern) 的 intent 的 intent - MBean 导出器 Bean 名称模式
-
以前,
managed-components
模式仅具有包容性。 如果 bean 名称与其中一个模式匹配,则将包含该 bean 名称。 现在,可以通过在模式前加上!
. 例如!thing*, things
匹配所有不以thing
除了things
. 模式从左到右进行评估。 第一个匹配项 (正或负) 获胜,然后不再应用其他模式。将此语法添加到模式中会导致一个可能的(尽管可能不太可能)问题。 如果你有一个名为 "!thing"
,并且您包含一个!thing
在 MBean 导出器的managed-components
patterns,则不再匹配;该模式现在匹配所有未命名的 beanthing
. 在这种情况下,您可以转义!
在模式中。 这\
\!thing
pattern 匹配名为!thing
. - IntegrationMBeanExporter 更改
-
这
IntegrationMBeanExporter
不再实现SmartLifecycle
. 这意味着start()
和stop()
作不再可用于注册和注销 MBean。 现在,MBean 在上下文初始化期间注册,并在销毁上下文时取消注册。
Orderly Shutdown 托管作
MBean 导出器允许 JMX作有序地关闭应用程序。 它旨在用于停止 JVM 之前。 以下示例演示如何使用它:
public void stopActiveComponents(long howLong)
它的使用和作在 Orderly Shutdown 中介绍。