此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Framework 6.2.0spring-doc.cadn.net.cn

将 bean 导出到 JMX

Spring 的 JMX 框架中的核心类是MBeanExporter.这个类是 负责获取您的 Spring bean 并将其注册到 JMX 中MBeanServer. 例如,请考虑以下类:spring-doc.cadn.net.cn

public class JmxTestBean implements IJmxTestBean {

	private String name;
	private int age;

	@Override
	public int getAge() {
		return age;
	}

	@Override
	public void setAge(int age) {
		this.age = age;
	}

	@Override
	public void setName(String name) {
		this.name = name;
	}

	@Override
	public String getName() {
		return name;
	}

	@Override
	public int add(int x, int y) {
		return x + y;
	}

	@Override
	public void dontExposeMe() {
		throw new RuntimeException();
	}
}

要将此 Bean 的属性和方法公开为 MBean 中,您可以配置MBeanExporter类 配置文件并传入 Bean,如下例所示:spring-doc.cadn.net.cn

@Configuration
public class JmxConfiguration {

	@Bean
	MBeanExporter exporter(JmxTestBean testBean) {
		MBeanExporter exporter = new MBeanExporter();
		exporter.setBeans(Map.of("bean:name=testBean1", testBean));
		return exporter;
	}

	@Bean
	JmxTestBean testBean() {
		JmxTestBean testBean = new JmxTestBean();
		testBean.setName("TEST");
		testBean.setAge(100);
		return testBean;
	}
}

前面配置片段中的相关 bean 定义是exporter豆。这beansproperty 告诉MBeanExporter确切地说,你的 bean 必须是 导出到 JMXMBeanServer.在默认配置中,每个条目的 key 在beans Map用作ObjectName对于 相应的 entry 值。您可以更改此行为,如控制ObjectNameBean 的实例.spring-doc.cadn.net.cn

使用此配置,testBeanbean 在ObjectName bean:name=testBean1.默认情况下,所有publicBean 的属性 作为属性公开,并且所有public方法(从Object类)作为作公开。spring-doc.cadn.net.cn

MBeanExporter是一个Lifecyclebean (请参阅 Startup and Shutdown Callbacks )。默认情况下,MBean 在 应用程序生命周期。您可以配置phase在哪个 将发生导出,或者通过设置autoStartup旗。

创建 MBeanServer

上一节中所示的配置假定 应用程序在具有一个(且只有一个)的环境中运行MBeanServer已经在运行。在这种情况下, Spring 会尝试查找正在运行的MBeanServer和 向该服务器注册您的 bean(如果有)。当您的 应用程序在容器(例如 Tomcat 或 IBM WebSphere)中运行,该容器具有 有MBeanServer.spring-doc.cadn.net.cn

但是,这种方法在独立环境中或在 一个不提供MBeanServer.要解决此问题,您可以创建一个MBeanServer实例,方法是添加org.springframework.jmx.support.MBeanServerFactoryBean类添加到您的配置中。 您还可以确保特定的MBeanServer通过设置MBeanExporter实例的server属性设置为MBeanServer值由MBeanServerFactoryBean,如下例所示:spring-doc.cadn.net.cn

<beans>

	<bean id="mbeanServer" class="org.springframework.jmx.support.MBeanServerFactoryBean"/>

	<!--
	this bean needs to be eagerly pre-instantiated in order for the exporting to occur;
	this means that it must not be marked as lazily initialized
	-->
	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<property name="beans">
			<map>
				<entry key="bean:name=testBean1" value-ref="testBean"/>
			</map>
		</property>
		<property name="server" ref="mbeanServer"/>
	</bean>

	<bean id="testBean" class="org.springframework.jmx.JmxTestBean">
		<property name="name" value="TEST"/>
		<property name="age" value="100"/>
	</bean>

</beans>

在前面的示例中,MBeanServerMBeanServerFactoryBean和 is 提供给MBeanExporter通过server财产。当您提供自己的MBeanServer实例中,MBeanExporter不尝试查找正在运行的MBeanServer并使用提供的MBeanServer实例。要使它起作用 正确地,您的 Classpath 上必须有一个 JMX 实现。spring-doc.cadn.net.cn

重用现有的MBeanServer

如果未指定服务器,则MBeanExporter尝试自动检测正在运行的MBeanServer.这在大多数环境中都有效,其中只有一个MBeanServerinstance 为 使用。但是,当存在多个实例时,导出程序可能会选择错误的服务器。 在这种情况下,您应该使用MBeanServer agentId以指示要 ,如下例所示:spring-doc.cadn.net.cn

<beans>
	<bean id="mbeanServer" class="org.springframework.jmx.support.MBeanServerFactoryBean">
		<!-- indicate to first look for a server -->
		<property name="locateExistingServerIfPossible" value="true"/>
		<!-- search for the MBeanServer instance with the given agentId -->
		<property name="agentId" value="MBeanServer_instance_agentId>"/>
	</bean>
	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<property name="server" ref="mbeanServer"/>
		...
	</bean>
</beans>

对于现有MBeanServer具有动态 (或未知)agentId即通过 lookup 方法检索,您应该使用 factory-method, 如下例所示:spring-doc.cadn.net.cn

<beans>
	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<property name="server">
			<!-- Custom MBeanServerLocator -->
			<bean class="platform.package.MBeanServerLocator" factory-method="locateMBeanServer"/>
		</property>
	</bean>

	<!-- other beans here -->

</beans>

延迟初始化的 MBean

如果将 Bean 配置为MBeanExporter也是为 lazy 配置的 初始化时,该MBeanExporter不违反本合同并避免 实例化 Bean。相反,它会向MBeanServer并推迟 从容器中获取 Bean,直到对代理进行第一次调用。spring-doc.cadn.net.cn

这也会影响FactoryBean分辨率,其中MBeanExporter会定期 内省生成的对象,有效触发FactoryBean.getObject(). 为了避免这种情况,请将相应的 bean 定义标记为 lazy-init。spring-doc.cadn.net.cn

自动注册 MBean

通过MBeanExporter并且已经是有效的 MBean 按原样注册到MBeanServer没有 Spring 的进一步干预。 您可以使 MBean 由MBeanExporter通过设置 这autodetectproperty 设置为true,如下例所示:spring-doc.cadn.net.cn

<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
	<property name="autodetect" value="true"/>
</bean>

<bean name="spring:mbean=true" class="org.springframework.jmx.export.TestDynamicMBean"/>

在前面的示例中,名为spring:mbean=true已经是有效的 JMX MBean 并由 Spring 自动注册。默认情况下,为 JMX 自动检测的 bean registration 的 bean 名称用作ObjectName.您可以覆盖此行为, 详见控制ObjectNameBean 的实例.spring-doc.cadn.net.cn

控制注册行为

考虑 SpringMBeanExporter尝试注册MBean替换为MBeanServer通过使用ObjectName bean:name=testBean1.如果MBean实例已在同一实例下注册ObjectName,默认行为 会失败(并抛出一个InstanceAlreadyExistsException).spring-doc.cadn.net.cn

您可以精确控制当MBean是 注册到MBeanServer.Spring 的 JMX 支持允许三种不同的 注册行为 控制注册时 进程发现MBean已在同一ObjectName. 下表总结了这些注册行为:spring-doc.cadn.net.cn

表 1.注册行为
注册行为 解释

FAIL_ON_EXISTINGspring-doc.cadn.net.cn

这是默认的注册行为。如果MBean实例 已经 在同一项下注册ObjectNameMBean正在注册的不是 registered,以及InstanceAlreadyExistsException被抛出。现有的MBean不受影响。spring-doc.cadn.net.cn

IGNORE_EXISTINGspring-doc.cadn.net.cn

如果MBean实例已在同一ObjectNameMBean即正在注册 未注册。现有的MBean是 unaffected 和 noException被抛出。这在 多个应用程序希望共享一个通用的MBean在共享的MBeanServer.spring-doc.cadn.net.cn

REPLACE_EXISTINGspring-doc.cadn.net.cn

如果MBean实例已在同一ObjectName这 现存MBean之前注册的MBean在其位置上注册(新的MBean有效地取代了 previous 实例)。spring-doc.cadn.net.cn

上表中的值定义为RegistrationPolicy类。 如果要更改默认注册行为,则需要设置registrationPolicy属性MBeanExporter定义添加到其中一个 值。spring-doc.cadn.net.cn

以下示例显示如何从默认注册进行更改 行为添加到REPLACE_EXISTING行为:spring-doc.cadn.net.cn

<beans>

	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<property name="beans">
			<map>
				<entry key="bean:name=testBean1" value-ref="testBean"/>
			</map>
		</property>
		<property name="registrationPolicy" value="REPLACE_EXISTING"/>
	</bean>

	<bean id="testBean" class="org.springframework.jmx.JmxTestBean">
		<property name="name" value="TEST"/>
		<property name="age" value="100"/>
	</bean>

</beans>

APP信息