JMX的使用

1. 定义和意义 

JMX是Java Management Extention的缩写，出发点是让外部通过属性/方法来读取或设置程序状态。对于提供对外服务的程序来说，天生就有这样的能力，Web程序通过HTTP接口对外暴露，RPC应用通过RPC接口暴露。不过带来的问题，一是依赖环境，不同的环境能力不同；二是需要单独处理安全性问题，尤其是对公网暴露的情况下。JMX从某种程度上来说，解决了上述两个问题，无论什么应用都能通过JMX对外暴露管理功能，单独的非业务含义的协议和通道，可以避免非必要的公网暴露。

2. 架构 

JDK官网上介绍，JMX在架构上分为3层: Instrumentation、JMX Agent、Remote Management

2.1 Instrumentation 

Instrumentation定义了MBean的创建规范，JDK自带一组叫做MXBean的特殊MBean，对外提供JVM信息及操作。

2.2 JMX Agent

JMX Agent用来管理Instrument，核心是MBeanServer(用来注册MBean)，并至少提供一组adaptor和connector，可以理解为通信协议和通信方式，允许外部程序或者客户端和JMX Agent通信。

2.3 Remote Management

可以把它理解为JMX Agent的客户端，通过不同的adapter和connect(协议和通信方式)连接到JMX Agent，进行远程调用。

3. 服务端

3.1 注册MBean

MBeanServer server = ManagementFactory.getPlatformMBeanServer();
String domain = "MyMBean";
// 注册hello
ObjectName helloName = new ObjectName(domain + ":name=hello");
server.registerMBean(new Hello(),helloName);

3.2 启动服务

1. 使用JVM参数

-Dcom.sun.management.jmxremote 
-Dcom.sun.management.jmxremote.port=1099 
-Dcom.sun.management.jmxremote.local.only=false 
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.ssl=false

1. 使用Java代码

String domain = "jmxrmi"
int rmiPort = 1099;
Registry registry = LocateRegistry.createRegistry(rmiPort);
JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:" + rmiPort + "/" + domain);
JMXConnectorServer jmxConnector = JMXConnectorServerFactory.newJMXConnectorServer(url,null,server);
jmxConnector.start();

如果是代码或者是远程连接JMX Agent，后续会用到JMXServiceURL的地址。和使用Java代码创建不同，JVM参数的domain值固定为jmxrm

4. 客户端

JMX的客户端有两类，一类是现成的GUI工具，如JConsole、VisualVM等；另一类是通过代码操作。通过GUI程序启动的客户端，只需要直接选择对应进程ID，或者填入注册MBean时提供的JMXServiceURL即可，如下图所示。这里我们主要聚焦通过代码操作MBean。

4.1 建立连接

和启动JMXConnectorServer一样，先建立JMXServiceURL，不同的是这里创建的是JMXConnector对象。

String domain = "jmxrmi";
int rmiPort = 1099;
JMXServiceURL url = new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:" + rmiPort + "/" + domain);
JMXConnector jmxc = JMXConnectorFactory.connect(url);
MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();

4.2 MBean列表

Set ins = mbsc.queryMBeans(null,null);
for(ObjectInstance i : ins) {    
    System.out.println("object: " + i.getObjectName());
}

4.3 Domain列表

String[] domains = mbsc.getDomains();
for (String d : domains) {    
    System.out.println(d);
}

4.4 MBean计数

System.out.println("MBeanCount:" + mbsc.getMBeanCount());

4.5 属性读写

String domain = "MyMBean";
ObjectName helloName = new ObjectName(domain + ":name=hello");
System.out.println("getAttribute:--->" + mbsc.getAttribute(helloName, "Slogan")); // 获取
mbsc.setAttribute(helloName, new Attribute("Slogan", "" + System.nanoTime())); // 设置
System.out.println("getAttribute modified--->" + mbsc.getAttribute(helloName, "Slogan")); // 获取

4.6 方法调用

有两种方式可以调用MBean的方法，一种是直接使用MBeanServerConnection调用

String domain = "MyMBean";
ObjectName helloName = new ObjectName(domain + ":name=hello");
 // 无返回
mbsc.invoke(helloName, "printHello", new String[]{"shit"}, new String[]{String.class.getName()});
 // 有返回
Object resp = mbsc.invoke(helloName, "daydream", new Integer[]{5000}, new String[]{Integer.class.getName()});
System.out.println("daydream:--->" + resp);

还有一种方式是通过BeanServerInvocationHandler生成代理对象，再用这个对象直接调用

String domain = "MyMBean";
ObjectName helloName = new ObjectName(domain + ":name=hello");
HelloMBean proxy = MBeanServerInvocationHandler.newProxyInstance(mbsc,helloName,HelloMBean.class,false);
System.out.println("proxy get attribute:" + proxy.getSlogan());
System.out.println("proxy invoke:" + proxy.daydream(9999));

第二种方式的使用体验会好一些，尤其是需要频繁、多次使用MBean的方法时。

4.7 BeanInfo读写

String domain = "MyMBean";
ObjectName helloName = new ObjectName(domain + ":name=hello");

MBeanInfo beanInfo = mbsc.getMBeanInfo(helloName);
System.out.println("class name:" + beanInfo.getClassName()); // MBean实现类

MBeanAttributeInfo[] attrinfos = beanInfo.getAttributes();  // MBean的属性
for(MBeanAttributeInfo a: attrinfos) {
    System.out.println("attribute name:" + a.getName());
}

MBeanOperationInfo[] operationInfos = beanInfo.getOperations(); // MBean上的操作
for(MBeanOperationInfo o: operationInfos) {
    System.out.println("operation name:" + o.getName());
}

5. Spring对JMX的支持

5.1 MBeanServer

通过提供MBeanServerFactoryBean，允许我们声明配置并创建MBeanServer对象

@Bean
public MBeanServerFactoryBean mbeanServer() {
    MBeanServerFactoryBean mbeanServer = new MBeanServerFactoryBean();
    return mbeanServer;
}

5.2 JMXConnectorServer

提供了ConnectorServerFactoryBean对象，用于配置并创建JMXConnectorServer

@Bean
public ConnectorServerFactoryBean connectorServer() {
    ConnectorServerFactoryBean factoryBean = new ConnectorServerFactoryBean();
    factoryBean.setServer(mbeanServer().getObject());
    factoryBean.setServiceUrl("service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi");
    return factoryBean;
}

5.3 注册MBean

要启用对MBean的自动注册，如果是Spring Boot应用的话，在@Configuration类上添加一个注解@EnableMBeanExport，注册MBean有两种方案可选，一种方式是使用MBeanExporter，可以用正常的Spring Bean配置为MBean，比如这里的globalProduct bean，后面被做为MBean的目标对象。

@Bean
public Product globalProduct() {
    Product product = new Product();
    product.setId(1234L);
    product.setStaticScore(1.222F);
    product.setRelationScore(2.333F);
    product.setCategoryId(4321);
    return product;
}

@Bean
public MBeanExporter hello() {
    MBeanExporter exporter = new MBeanExporter();
    Map beans = new HashMap<>();
    beans.put("hello:name=globalProduct", globalProduct());
    exporter.setBeans(beans);
    exporter.setServer(mbeanServer().getObject());
    return exporter;
}

另一种方案是通过注解，使用@ManagedResource、@ManagedAttribute、@ManagedOperation注解，直接暴露Bean对象

@Component
@ManagedResource(objectName = "hello:name=appInfo")
public class AppInfo {

    @ManagedAttribute(description = "numbers of processors")
    public int getProcessorCount() {
        return Runtime.getRuntime().availableProcessors();
    }

    @ManagedOperation
    public void resetSystemProperties() {
        System.getProperties().setProperty("appInfo","lws");
    }
}

6. 效果和评估

通过JConsole连接到我们的应用，查看MBean效果如下图。除了我们自己注册的MBean，Java默认提供一对内置MBean，用来读取系统、JVM的信息，包括类加载、内存使用、GC、ClassPath、环境变量等等信息，甚至可以通过JFR的MBean来启动JFR记录，打线程堆栈、手工执行GC等等。

单纯的从Java用户的角度来说，这不失为一种不错的Java管理的扩展能力(Java Management Extension)，有一定的基础设施，使用也算方便。但是在跨语言方法就显得有点弱势，网上也可以看到各种从JMX适配到其他协议的工具，以便将JMX数据暴露给其他中间件，比如Promethus和JMX 之间就有个JMX Exporter，让Promethus能获取JMX的数据。

经过上面的学习和试验后，我们对JMX态度是可以了解和使用，不必要过多深入，学完本文的内容已经够用。有具体使用场景，比如希望通过JMX监控Kafka，再详细了解Kafka提供的MBean即可。