使用JMX对项目进行管理

JMX

JMX（Java Management Extensions，即Java管理扩展）是一个为应用程序、设备、系统等植入管理功能的框架。JMX可以跨越一系列异构操作系统平台、系统体系结构和网络传输协议，灵活的开发无缝集成的系统、网络和服务管理应用。
用一段形象的描述来说明JMX的作用：

• 程序初哥一般是写死在程序中，到要改变的时候就去修改代码，然后重新编译发布。
• 程序熟手则配置在文件中（JAVA一般都是properties文件），到要改变的时候只要修改配置文件，但还是必须重启系统，以便读取配置文件里最新的值。
• 程序好手则会写一段代码，把配置值缓存起来，系统在获取的时候，先看看配置文件有没有改动，如有改动则重新从配置里读取，否则从缓存里读取。
• 程序高手则懂得物为我所用，用JMX把需要配置的属性集中在一个类中，然后写一个MBean，再进行相关配置。另外JMX还提供了一个工具页，以方便我们对参数值进行修改。

使用JConsole管理MBean

定义MBean接口

public interface HelloMBean {

    String getName();

    void setName(String name);

    int getAge();

    void setAge(int age);

    void helloWorld();

    void helloWorld(String str);
}

MBean实现

public class Hello implements HelloMBean {

    private static final Logger LOGGER = LoggerFactory.getLogger(Hello.class);

    private String name;

    private int age;

    @Override
    public String getName() {
        LOGGER.info("get name: {}", name);
        return name;
    }

    @Override
    public void setName(String name) {
        LOGGER.info("set name: {}", name);
        this.name = name;
    }

    @Override
    public int getAge() {
        LOGGER.info("age: {}", age);
        return age;
    }

    @Override
    public void setAge(int age) {
        LOGGER.info("set age: {}", age);
        this.age = age;
    }

    @Override
    public void helloWorld() {
        LOGGER.info("say hello world!");
    }

    @Override
    public void helloWorld(String str) {
        LOGGER.info("hello world, {}", str);
    }
}

启动MBean容器，注册MBean实现

public class HelloAgent {

    private static final Logger LOGGER = LoggerFactory.getLogger(HelloAgent.class);

    public static void main(String[] args) {
        try {
            // 获取MBeanServer，作为MBean容器
            MBeanServer mBeanServer = ManagementFactory.getPlatformMBeanServer();
            // ObjectName命名规范为 domain:name=MBean名称，domain和MBean名称可以任意取，用以唯一标识MBean的实现类
            ObjectName helloName = new ObjectName("com.wch.base.jmx:name=Hello");
            // 在MBeanServer注册此MBean，通过JConsole对MBean是属性和方法进行管理
            mBeanServer.registerMBean(new Hello(), helloName);

            System.in.read();
        } catch (JMException | IOException e) {
            LOGGER.error(e.getMessage());
        }
    }
}

使用JConsole

使用CMD命令打开JConsole来连接HelloAgent。

JConsole 管理属性 JMX管理属性 管理方法 JMX管理方法

使用Spring集成JMX

标准MBean实现

标准MBean实现仍然要求被管理的Bean实现一个MBean接口，spring提供MBeanExporter来探测需要纳入JMX管理范围的Bean。
以下是一个简单的jmx配置文件的实现，被管理的bean的命名规范为 域名:name=MBean名称。

    <bean name="domain:name=hello" class="com.wch.base.jmx.Hello"/>

    <!-- 配置MBean探测器 -->
    <bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
        <!-- MBean探测模式默认为AUTODETECT_ALL：所有注册的MBean -->
        <property name="autodetectModeName" value="AUTODETECT_ALL"/>
    </bean>

autodetectModeName

MBeanExporter的属性autodetectModeName表示探测的方式，包括：

• AUTODETECT_NONE：不启用自动探测，需要手动在MBeanServer注册，即通过MBeanExporter的beans属性进行注册。
• AUTODETECT_MBEAN：在当前IOC容器中进行查找MBean组件。
• AUTODETECT_ASSEMBLER：根据MBeanInfoAssembler策略进行探测。
• AUTODETECT_ALL：启用自动探测，包含AUTODETECT_MBEAN和AUTODETECT_ASSEMBLER的情况。
  此外，MBeanExporter还可设置autodetect属性，当该属性为true时，采用AUTODETECT_ALL模式，否则采用AUTODETECT_NONE模式。

Spring提供的MBean实现

与标准MBean实现不同的是，被管理的Bean不需要实现MBean接口，但是需要配置在MBeanExporter的beans属性中，该属性是一个Map，要求以JMS名称作为key值。

   <bean id="hello" class="com.wch.base.jmx.Hello"/>

    <!-- 配置MBean探测器 -->
    <bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
        <!-- 配置纳入JMX管理的bean -->
        <property name="beans">
            <map>
                <entry key="com.wch.base.jmx:name=Hello" value-ref="hello"/>
            </map>
        </property>
    </bean>

这种配置使得"hello"的所有属性和方法都暴露给外部进行管理，为了克服这种缺点，Spring还提供了基于方法集合和接口定制的暴露方式。

• 通过方法集合进行暴露

    <bean id="assembler" class="org.springframework.jmx.export.assembler.MethodNameBasedMBeanInfoAssembler">
        <property name="managedMethods" value="setName,setAge"/>
    </bean>

• 通过接口进行暴露

<bean id="assembler" class="org.springframework.jmx.export.assembler.InterfaceBasedMBeanInfoAssembler">
        <property name="managedInterfaces" value="com.wch.base.jmx.HelloMBean"/>
    </bean>

将暴露方式注入assembler属性。

    <!-- 配置MBean探测器 -->
    <bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
        <!-- 配置纳入JMX管理的bean -->
        <property name="beans">
            <map>
                <entry key="com.wch.base.jmx:name=Hello" value-ref="hello"/>
            </map>
        </property>
        <!-- 设置被管理bean的暴露方式 -->
        <property name="assembler" ref="assembler"/>
    </bean>

此外，还可以通过注解的方式暴露被管理bean的属性*。

    <bean id="hello" class="com.wch.base.jmx.Hello"/>

    <!-- 配置MBean探测器 -->
    <bean id="exporter" class="org.springframework.jmx.export.MBeanExporter">
        <!-- 设置被管理bean的暴露方式 -->
        <property name="assembler" ref="assembler"/>
        <!-- 被管理bean的命名策略 -->
        <property name="namingStrategy" ref="namingStrategy"/>
    </bean>

    <!-- 配置使用JMX注解-->
    <bean id="jmxAttributeSource" class="org.springframework.jmx.export.annotation.AnnotationJmxAttributeSource"/>

    <!-- 基于注解的暴露方式 -->
    <bean id="assembler" class="org.springframework.jmx.export.assembler.MetadataMBeanInfoAssembler">
        <property name="attributeSource" ref="jmxAttributeSource"/>
    </bean>

    <!-- 使用注解获取命名策略（objectName）-->
    <bean id="namingStrategy" class="org.springframework.jmx.export.naming.MetadataNamingStrategy">
        <property name="attributeSource" ref="jmxAttributeSource"/>
    </bean>

通过配置AnnotationMBeanExporter可以对使用注解的MBeanExporter进行简化。

    <bean id="hello" class="com.wch.base.jmx.Hello"/>

    <!-- 使用注解的简化配置 -->
    <bean class="org.springframework.jmx.export.annotation.AnnotationMBeanExporter"/>

通过JConsole远程管理 *

配置远程访问端口，通过JConsole远程管理。

    <!-- 配置RMI远程访问 -->
    <bean id="registry" class="org.springframework.remoting.rmi.RmiRegistryFactoryBean">
        <!-- 默认端口为 1099 -->
        <property name="port" value="9875"/>
    </bean>

    <!-- 配置服务端连接器，该bean本身也受JMX管理 -->
    <bean id="connectorServer" class="org.springframework.jmx.support.ConnectorServerFactoryBean" depends-on="registry">
        <property name="objectName" value="connector:name=rmi"/>
        <!-- 服务连接url，需要使用RMI端口，且使用<host>:<name>的方式远程访问时，服务名为jmxrmi-->
        <property name="serviceUrl" value="service:jmx:rmi://localhost/jndi/rmi://localhost:9875/jmxrmi"/>
    </bean>

使用JConsole进行远程管理

通过代理访问 *

public class HelloProxy {

    public static void main(String[] args) throws IOException, MalformedObjectNameException {
        String host = "localhost";
        String jmxPort = "9875";
        String serviceUrl = "service:jmx:rmi:///jndi/rmi://" + host + ":" + jmxPort + "/jmxrmi";
        ObjectName objectName = new ObjectName("com.wch.base.jmx:name=Hello");

        // 服务地址
        JMXServiceURL jmxServiceURL = new JMXServiceURL(serviceUrl);
        // 建立JMX连接
        JMXConnector jmxConnector = JMXConnectorFactory.connect(jmxServiceURL);
        // 获取MBeanServer连接
        MBeanServerConnection mBeanServerConnection = jmxConnector.getMBeanServerConnection();
        // 建立相应MBean代理
        HelloMBean proxy = MBeanServerInvocationHandler.newProxyInstance(mBeanServerConnection, objectName, 
                HelloMBean.class, false);

        proxy.setAge(21);
        proxy.setName("wch");
        proxy.helloWorld();

        // 关闭JMX连接
        jmxConnector.close();
    }
}

代理访问

使用同样位于JDK的bin目录下的jvisualvm，查看被管理的属性（需要安装MBean插件）。

安装MBean插件 jvisualvm