|
对于最新的稳定版本，请使用 Spring Framework 7.0.6! |
控制您 Bean 的管理接口
在上一节的示例中，
您对Bean的管理接口的控制很少。每个导出Bean的所有public
属性和方法分别作为JMX属性和操作公开。为了更精细地控制哪些
属性和方法实际上作为JMX属性和操作公开，Spring JMX提供了全面且可扩展的机制来
控制您的Bean的管理接口。
使用 MBeanInfoAssembler 接口
在幕后，MBeanExporter 会委托给 org.springframework.jmx.export.assembler.MBeanInfoAssembler 接口的一个实现，该接口负责定义每个暴露的 bean 的管理接口。
默认实现 org.springframework.jmx.export.assembler.SimpleReflectiveMBeanInfoAssembler 定义了一个管理接口，该接口公开所有公共属性和方法（如前面各节中的示例所示）。Spring 提供了 MBeanInfoAssembler 接口的另外两个实现，它们允许您通过使用源级元数据或任何任意接口来控制生成的管理接口。
使用源代码级元数据：Java 注解
通过使用 MetadataMBeanInfoAssembler，您可以使用源级元数据定义 beans 的管理接口。元数据的读取由 org.springframework.jmx.export.metadata.JmxAttributeSource 接口封装。
Spring JMX 提供了一个默认实现，该实现使用 Java 注解，即 org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource。
您必须将 MetadataMBeanInfoAssembler 配置为 JmxAttributeSource 接口的实现实例，才能正常工作（没有默认值）。
要将一个bean标记为导出到JMX，应该使用ManagedResource注解标注该bean类。您必须使用ManagedOperation注解标注每个希望作为操作公开的方法，并使用ManagedAttribute注解标注每个希望公开的属性。在标注属性时，可以省略getter或setter的注解，以分别创建只写或只读属性。
一个带有ManagedResource注解的bean必须是公共的，以及暴露操作或属性的方法也必须是公共的。 |
以下示例显示了我们在 创建 MBeanServer 中使用的 JmxTestBean 类的注释版本：
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();
}
}在前面的示例中，您可以看到 JmxTestBean 类使用了 ManagedResource 注解，并且这个 ManagedResource 注解配置了一组属性。这些属性可用于配置由 MBeanExporter 生成的 MBean 的各个方面，并在 源级元数据类型 中有更详细的说明。
age 和 name 属性都使用 ManagedAttribute 注解进行注解，
但 age 属性的情况不同，只有 getter 方法被标记。
这会导致这两个属性都被包含在管理界面中作为属性，
但 age 属性是只读的。
最后，add(int, int)方法使用ManagedOperation属性进行标记，
而dontExposeMe()方法则没有。这导致当你使用MetadataMBeanInfoAssembler时，管理接口中只包含一个操作（add(int, int)）。
以下配置展示了如何配置 MBeanExporter 以使用 MetadataMBeanInfoAssembler：
<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>在前面的示例中，一个 MetadataMBeanInfoAssembler bean 已配置为 AnnotationJmxAttributeSource 类的实例，并通过装配属性传递给 MBeanExporter。这就是利用 Spring 暴露的 MBeans 的元数据驱动管理接口所需的一切。
源代码级元数据类型
下表描述了可用于 Spring JMX 的源级别元数据类型：
| 目的 | 注解 | 注解类型 |
|---|---|---|
将所有 |
|
类 |
将方法标记为 JMX 操作。 |
|
方法 |
将getter或setter标记为JMX属性的一半。 |
|
方法（仅getter和setter） |
为操作参数定义描述。 |
|
方法 |
下表描述了可用于这些源级元数据类型的配置参数：
| 参数 | 描述 | 适用于 |
|---|---|---|
|
由 |
|
|
设置资源、属性或操作的友好描述。 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置 |
|
|
设置操作参数的显示名称。 |
|
|
设置操作参数的索引。 |
|
使用 AutodetectCapableMBeanInfoAssembler 接口
为了进一步简化配置，Spring包含了一个
AutodetectCapableMBeanInfoAssembler 接口，该接口扩展了 MBeanInfoAssembler
接口以添加对MBean资源的自动检测支持。如果您将
MBeanExporter 配置为 AutodetectCapableMBeanInfoAssembler 的实例，则可以“投票”决定是否将 beans 包含到 JMX 中。
AutodetectCapableMBeanInfo 接口的唯一实现是
MetadataMBeanInfoAssembler，它会包含任何带有 ManagedResource 属性的 bean。在这种情况下，默认方法是使用 bean 名称作为 ObjectName，这将生成如下类似的配置：
<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 传递给 MBeanExporter。
然而，JmxTestBean 仍然被注册，因为它带有 ManagedResource 属性，而 MetadataMBeanInfoAssembler 检测到这一点并投票将其包含进来。
这种方法唯一的问题是 JmxTestBean 的名称现在具有业务含义。您可以通过更改 ObjectName 创建的默认行为来解决此问题，如 控制 ObjectName 实例的创建 中所定义的那样。
通过使用Java接口定义管理接口
除了 MetadataMBeanInfoAssembler 之外，Spring 还包括
InterfaceBasedMBeanInfoAssembler，它可以根据一组接口中定义的方法来限制公开的方法和属性。
尽管暴露MBeans的标准机制是使用接口和简单的命名方案，InterfaceBasedMBeanInfoAssembler通过消除对命名约定的需求扩展了此功能，使您可以使用多个接口，并消除了您的bean实现MBean接口的需要。
考虑以下接口，该接口用于定义我们之前展示的JmxTestBean类的管理接口：
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();
}这个接口定义了作为 JMX MBean 上的操作和属性公开的方法和属性。以下代码展示了如何配置 Spring JMX 以将此接口用作管理接口的定义：
<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 构建管理接口时，InterfaceBasedMBeanInfoAssembler 被配置为使用 IJmxTestBean 接口。理解这一点很重要：由 InterfaceBasedMBeanInfoAssembler 处理的 bean 不需要实现用于生成 JMX 管理接口的接口。
在前面的情况下，IJmxTestBean 接口用于构建所有 bean 的管理接口。在许多情况下，这不是期望的行为，您可能希望为不同的 bean 使用不同的接口。在这种情况下，可以通过 interfaceMappings 属性传递一个 Properties 实例，其中每个条目的键是 bean 名称，每个条目的值是用于该 bean 的接口名称的逗号分隔列表。
如果通过managedInterfaces或interfaceMappings属性未指定管理接口，InterfaceBasedMBeanInfoAssembler将对bean进行反射，并使用该bean实现的所有接口来创建管理接口。
使用 MethodNameBasedMBeanInfoAssembler
MethodNameBasedMBeanInfoAssembler 允许你指定一组方法名称，这些方法通过 JMX 作为属性和操作公开。以下代码显示了一个示例配置：
<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>在前面的示例中，您可以看到 add 和 myOperation 方法作为 JMX 操作公开，getName()、setName(String) 和 getAge() 作为 JMX 属性的适当一半公开。在前面的代码中，方法映射适用于暴露给 JMX 的 bean。要按 bean 控制方法的公开，可以使用 methodMappings 属性的 MethodNameMBeanInfoAssembler 来将 bean 名称映射到方法名称列表。