对于最新的稳定版本，请使用 Spring Framework 6.2.0！spring-doc.cn

控制 Bean 的 Management Interface

在上一节的示例中， 您对 Bean 的 Management Interface 几乎没有控制权。每个导出的 bean 的所有属性和方法都作为 JMX 属性和 操作。要对具体内容进行更精细的控制 导出的 bean 的属性和方法实际上作为 JMX 属性公开 和操作，Spring JMX 为 控制 bean 的 Management 接口。publicspring-doc.cn

使用界面MBeanInfoAssembler

在后台，委托给接口的实现，即 负责定义每个公开的 bean 的 Management 接口。 默认实现 ， 定义公开所有公共属性和方法的管理接口 （如您在前面部分的示例中看到的那样）。Spring 提供两个 接口的其他实现，可让您 使用源级元数据控制生成的管理界面 或任何任意接口。MBeanExporterorg.springframework.jmx.export.assembler.MBeanInfoAssemblerorg.springframework.jmx.export.assembler.SimpleReflectiveMBeanInfoAssemblerMBeanInfoAssemblerspring-doc.cn

使用源级元数据：Java 标注

通过使用 ，您可以定义管理接口 用于 bean。元数据的读取是封装的 通过界面。 Spring JMX 提供了一个使用 Java 注解的默认实现，即 . 您必须使用 使其正常运行的接口（没有默认值）。MetadataMBeanInfoAssemblerorg.springframework.jmx.export.metadata.JmxAttributeSourceorg.springframework.jmx.export.annotation.AnnotationJmxAttributeSourceMetadataMBeanInfoAssemblerJmxAttributeSourcespring-doc.cn

要标记要导出到 JMX 的 Bean，您应该使用注释对 Bean 类进行注释。您必须将要公开的每个方法标记为操作 并标记要公开的每个属性 替换为注释。标记属性时，可以省略 getter 或 setter 的注解，用于创建 write-only 或 read-only 属性。ManagedResourceManagedOperationManagedAttributespring-doc.cn

带 -ancomments 的 bean 必须是 public 的，公开 操作或属性。ManagedResource

下面的示例显示了类的注释版本，我们 用于 创建 MBeanServer：JmxTestBeanspring-doc.cn

package org.springframework.jmx;

import org.springframework.jmx.export.annotation.ManagedResource;
import org.springframework.jmx.export.annotation.ManagedOperation;
import org.springframework.jmx.export.annotation.ManagedAttribute;

@ManagedResource(
		objectName="bean:name=testBean4",
		description="My Managed Bean",
		log=true,
		logFile="jmx.log",
		currencyTimeLimit=15,
		persistPolicy="OnUpdate",
		persistPeriod=200,
		persistLocation="foo",
		persistName="bar")
public class AnnotationTestBean implements IJmxTestBean {

	private String name;
	private int age;

	@ManagedAttribute(description="The Age Attribute", currencyTimeLimit=15)
	public int getAge() {
		return age;
	}

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

	@ManagedAttribute(description="The Name Attribute",
			currencyTimeLimit=20,
			defaultValue="bar",
			persistPolicy="OnUpdate")
	public void setName(String name) {
		this.name = name;
	}

	@ManagedAttribute(defaultValue="foo", persistPeriod=300)
	public String getName() {
		return name;
	}

	@ManagedOperation(description="Add two numbers")
	@ManagedOperationParameters({
		@ManagedOperationParameter(name = "x", description = "The first number"),
		@ManagedOperationParameter(name = "y", description = "The second number")})
	public int add(int x, int y) {
		return x + y;
	}

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

}

在前面的示例中，您可以看到该类标有 annotation，并且此 annotation 已配置 具有一组属性。这些属性可用于配置各个方面 由 生成的 MBean 和 在 greater 中解释 稍后在 Source-level Metadata Types 中详细介绍。JmxTestBeanManagedResourceManagedResourceMBeanExporterspring-doc.cn

和 属性都使用注释进行注释，但在属性的情况下，仅标记 getter。 这会导致这两个属性都包含在管理界面中 作为属性，但该属性是只读的。agenameManagedAttributeageagespring-doc.cn

最后，该方法使用属性 而 method 则不是。这会导致管理界面 仅包含一个操作 （） 时。add(int, int)ManagedOperationdontExposeMe()add(int, int)MetadataMBeanInfoAssemblerspring-doc.cn

以下配置显示了如何配置 以使用 ：MBeanExporterMetadataMBeanInfoAssemblerspring-doc.cn

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

	<bean id="jmxAttributeSource"
			class="org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource"/>

	<!-- will create management interface using annotation metadata -->
	<bean id="assembler"
			class="org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler">
		<property name="attributeSource" ref="jmxAttributeSource"/>
	</bean>

	<!-- will pick up the ObjectName from the annotation -->
	<bean id="namingStrategy"
			class="org.springframework.jmx.export.naming.MetadataNamingStrategy">
		<property name="attributeSource" ref="jmxAttributeSource"/>
	</bean>

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

在前面的示例中，Bean 配置了 实例，并通过 assembler 属性传递给 。这就是利用所需的全部内容 元数据驱动的管理接口，用于 Spring 公开的 MBean。MetadataMBeanInfoAssemblerAnnotationJmxAttributeSourceMBeanExporterspring-doc.cn

源级元数据类型

下表描述了可在 Spring JMX 中使用的源级元数据类型：spring-doc.cn

表 1.源级元数据类型
目的 注解 注释类型

将 的所有实例标记为 JMX 托管资源。Classspring-doc.cn

@ManagedResourcespring-doc.cn

类spring-doc.cn

将方法标记为 JMX 操作。spring-doc.cn

@ManagedOperationspring-doc.cn

方法spring-doc.cn

将 getter 或 setter 标记为 JMX 属性的一半。spring-doc.cn

@ManagedAttributespring-doc.cn

方法（仅限 getter 和 setter）spring-doc.cn

定义操作参数的描述。spring-doc.cn

@ManagedOperationParameter和@ManagedOperationParametersspring-doc.cn

方法spring-doc.cn

下表描述了可用于这些源级别的配置参数 元数据类型：spring-doc.cn

表 2.源级元数据参数
参数 描述 适用于

ObjectNamespring-doc.cn

用于确定托管资源的 。MetadataNamingStrategyObjectNamespring-doc.cn

ManagedResourcespring-doc.cn

descriptionspring-doc.cn

设置资源、属性或操作的友好描述。spring-doc.cn

ManagedResource或ManagedAttributeManagedOperationManagedOperationParameterspring-doc.cn

currencyTimeLimitspring-doc.cn

设置 descriptor 字段的值。currencyTimeLimitspring-doc.cn

ManagedResource或ManagedAttributespring-doc.cn

defaultValuespring-doc.cn

设置 descriptor 字段的值。defaultValuespring-doc.cn

ManagedAttributespring-doc.cn

logspring-doc.cn

设置 descriptor 字段的值。logspring-doc.cn

ManagedResourcespring-doc.cn

logFilespring-doc.cn

设置 descriptor 字段的值。logFilespring-doc.cn

ManagedResourcespring-doc.cn

persistPolicyspring-doc.cn

设置 descriptor 字段的值。persistPolicyspring-doc.cn

ManagedResourcespring-doc.cn

persistPeriodspring-doc.cn

设置 descriptor 字段的值。persistPeriodspring-doc.cn

ManagedResourcespring-doc.cn

persistLocationspring-doc.cn

设置 descriptor 字段的值。persistLocationspring-doc.cn

ManagedResourcespring-doc.cn

persistNamespring-doc.cn

设置 descriptor 字段的值。persistNamespring-doc.cn

ManagedResourcespring-doc.cn

namespring-doc.cn

设置操作参数的显示名称。spring-doc.cn

ManagedOperationParameterspring-doc.cn

indexspring-doc.cn

设置操作参数的索引。spring-doc.cn

ManagedOperationParameterspring-doc.cn

使用界面AutodetectCapableMBeanInfoAssembler

为了进一步简化配置， Spring 包括了接口，该接口扩展了接口以添加对 MBean 资源的自动检测的支持。如果使用 的实例配置 ，则为 允许 “投票” 包含用于 JMX 的 bean。AutodetectCapableMBeanInfoAssemblerMBeanInfoAssemblerMBeanExporterAutodetectCapableMBeanInfoAssemblerspring-doc.cn

接口的唯一实现是 ，它投票以包括任何标记为 替换为属性。在这种情况下，默认方法是使用 bean name 指定为 ，这将产生类似于以下内容的配置：AutodetectCapableMBeanInfoMetadataMBeanInfoAssemblerManagedResourceObjectNamespring-doc.cn

<beans>

	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<!-- notice how no 'beans' are explicitly configured here -->
		<property name="autodetect" value="true"/>
		<property name="assembler" ref="assembler"/>
	</bean>

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

	<bean id="assembler" class="org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler">
		<property name="attributeSource">
			<bean class="org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource"/>
		</property>
	</bean>

</beans>

请注意，在前面的配置中，没有 bean 传递给 . 但是，它仍然被注册，因为它标有属性，并且 检测到这一点并投票将其包含在内。 这种方法的唯一问题是 name of the now 有业务 意义。您可以通过更改 Controlling ObjectName Instances for Your Bean 中定义的创建的默认行为来解决此问题。MBeanExporterJmxTestBeanManagedResourceMetadataMBeanInfoAssemblerJmxTestBeanObjectNamespring-doc.cn

使用 Java 接口定义管理接口

除了 之外，Spring 还包括 ，它允许您约束 methods 和 属性，这些属性根据 接口。MetadataMBeanInfoAssemblerInterfaceBasedMBeanInfoAssemblerspring-doc.cn

尽管公开 MBean 的标准机制是使用接口和简单的 命名方案，通过以下方式扩展此功能 无需命名约定，让您使用多个接口 以及消除 bean 实现 MBean 接口的需要。InterfaceBasedMBeanInfoAssemblerspring-doc.cn

请考虑以下接口，该接口用于定义我们前面展示的类的管理接口：JmxTestBeanspring-doc.cn

public interface IJmxTestBean {

	public int add(int x, int y);

	public long myOperation();

	public int getAge();

	public void setAge(int age);

	public void setName(String name);

	public String getName();

}

此接口定义作为操作公开的方法和属性，并且 属性。以下代码显示了如何配置 Spring JMX 以使用 此接口作为 Management Interface 的定义：spring-doc.cn

<beans>

	<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
		<property name="beans">
			<map>
				<entry key="bean:name=testBean5" value-ref="testBean"/>
			</map>
		</property>
		<property name="assembler">
			<bean class="org.springframework.jmx.export.assembler.InterfaceBasedMBeanInfoAssembler">
				<property name="managedInterfaces">
					<value>org.springframework.jmx.IJmxTestBean</value>
				</property>
			</bean>
		</property>
	</bean>

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

</beans>

在前面的示例中，配置为在为任何 bean 构造 Management 接口时使用该接口。是的 重要的是要了解由 处理的 bean 不需要实现用于生成 JMX 管理的接口 接口。InterfaceBasedMBeanInfoAssemblerIJmxTestBeanInterfaceBasedMBeanInfoAssemblerspring-doc.cn

在上述情况下，该接口用于构造所有管理 所有 bean 的接口。在许多情况下，这不是所需的行为，您可能会 希望对不同的 bean 使用不同的接口。在这种情况下，您可以通过属性传递实例，其中每个条目的键是 Bean 名称，每个条目的值是 用于该 bean 的接口名称的逗号分隔列表。IJmxTestBeanInterfaceBasedMBeanInfoAssemblerPropertiesinterfaceMappingsspring-doc.cn

如果未通过 或 属性指定管理接口，则 在 Bean 上，并使用该 Bean 实现的所有接口来创建 管理界面。managedInterfacesinterfaceMappingsInterfaceBasedMBeanInfoAssemblerspring-doc.cn

用MethodNameBasedMBeanInfoAssembler

MethodNameBasedMBeanInfoAssembler用于指定方法名称列表 作为属性和操作向 JMX 公开。下面的代码显示了一个示例 配置：spring-doc.cn

<bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
	<property name="beans">
		<map>
			<entry key="bean:name=testBean5" value-ref="testBean"/>
		</map>
	</property>
	<property name="assembler">
		<bean class="org.springframework.jmx.export.assembler.MethodNameBasedMBeanInfoAssembler">
			<property name="managedMethods">
				<value>add,myOperation,getName,setName,getAge</value>
			</property>
		</bean>
	</property>
</bean>

在前面的示例中，您可以看到 and 方法作为 JMX 公开 操作、 、 和 以及 作为 适当的 JMX 属性的一半。在上面的代码中，方法映射适用于 向 JMX 公开的 bean。要逐个 bean 控制方法公开，可以使用 将 bean 名称映射到 的属性 方法名称列表。addmyOperationgetName()setName(String)getAge()methodMappingsMethodNameMBeanInfoAssemblerspring-doc.cn