JMX（Java Management Extension）学习

Posted 2020-12-02

目录

• 基本概念
• MBean的种类
  • StandardMBean
  • DynamicBean
  • ModelMBean
• JMX的实现方式
• StandardMBean的使用方法
• JMX服务的访问方式
• JMX——Notifications

基本概念

JMX(Java Management Extensions)是一个为应用程序植入管理功能的框架。

JMX让程序有被管理的功能，例如你开发一个WEB网站，它是在24小时不间断运行，那么你肯定会对网站进行监控，如每天的UV、PV是多少；又或者在业务高峰的期间，你想对接口进行限流，就必须去修改接口并发的配置值。

JMX框架主要由以下几层构成：

• 探针层（Probe Level）/设备层(Instrumentation Level)
• 代理层（Agent Level）
• 远程管理层（Remote Management Level）

它们之间的关系如下图所示：

需要通过JMX服务获得被管理对象信息的程序，就是通过远程管理层来与具体的MBean进行交互的。

分别介绍一下比较重要的一些概念：

• MBean（Managed Bean）

通常是一个 Java 类，它提供接口可以使这个类具有可以被管理（能够成功注册到server上）的功能。它通常代表我们想要实际管理的一个程序，或者一个设备等等，这是我们用MBean的规范将管理对象封装了起来。

• MBeanServer

是管理MBean的一个 Java 类，你需要向 MBeanServer 注册一个 MBean 后，这个 MBean 才会真正具备被管理的能力，MBeanServer 还提供了查询功能和注册监听器的功能，sun 提供的只是接口，不同的 JMX 实现中的 MBean server 实现也不同。

• JMX Agent

Agent 是 MBean Server 的容器，主要为了管理一系列的 MBean，并且提供的一系列的服务，通常有MBean relationships, dynamically loading classes, simple monitoring services, timers。Agent 可以利用 Protocol adapters（例如 HTTP 和 SNMP）和 connectors（RMI 和Jini）使不同的客户端可以访问 MBean。

• Protocol adapters 和 connectors

适配器和连接器主要使不同的协议和客户端可以使用这个 Agent，一个 Agent 中可以有多个 Protocol adapters 和 connectors，这样管理起 MBean 来就更方便了（有多种类型的客户端和协议可以操作 MBean）。注意，Protocol adapters 和 connectors 通常也是 MBean。

【JMX学习】1、jmx入门

JMX超详细解读

MBean的种类

• standard MBean:需要定义MBean接口，接口中包含需要被管理的资源，并编写MBean接口的实现类。接口和实现类的命名必须满足一定规范，若实现类名为Classname，则接口的命名必须为ClassNameMBean。
• dynamic MBean：必须实现javax.management.DynamicMBean接口，所有的属性，方法都在运行时定义。
• open MBean：此MBean的规范还不完善，正在改进中
• model MBean：与标准和动态MBean相比，你可以不用写MBean类，只需使用javax.management.modelmbean.RequiredModelMBean即可。RequiredModelMBean实现了ModelMBean接口，而ModelMBean扩展了DynamicMBean接口，因此与DynamicMBean相似，Model MBean的管理资源也是在运行时定义的。与DynamicMBean不同的是，DynamicMBean管理的资源一般定义在DynamicMBean中（运行时才决定管理那些资源），而model MBean管理的资源并不在MBean中，而是在外部（通常是一个类），只有在运行时，才通过set方法将其加入到model MBean中。

JMX学习笔记(一)-MBean

StandardMBean

从零开始玩转JMX(一)——简介和Standard MBean

JMX学习笔记(三)：MXBean

MXBean相比MBean支持更复杂数据类型的类属性管理

DynamicBean

动态MBean：DynamicMBean

ModelMBean

从零开始玩转JMX(三)——Model MBean

JMX的实现方式

StandardMBean的使用方法

1. 定义MBean接口
2. 编写MBean接口实现类
3. 创建MBeanServer类，并向server注册MBean类(server.registerMBean(实现类对象，ObjectName)) 【ObjectName取名是有规范的，格式为：“域名：name=MBean名称”，其中域名和MBean的名称可以任意取。这样定义后，就可以唯一标识我们定义的这个MBean的实现类了。】
4. 为了查看实现状态，可以再加一个Thread.sleep(Long.MAX_VALUE)，然后用JConsole工具查看。

JMX服务的访问方式

JMX服务可以有多种方式对其进行连接和使用，也有不同的展现方式，但内容都是相同的。

1.JDK自带工具JConsole(jdk/bin/jconsole.exe)

• 首先连接JMX服务。

  JMX服务或者是本地提供，或者是远程提供，本地提供可以直接在jconsole的连接界面上显示，选中连接即可。远程提供的连接，则需要输入远程地址和端口号，并且如果设置了帐号密码还需要输入帐号密码，然后连接。

• 连接成功后，可以看到如文件目录形式展现的MBean，可以点击展开，查看属性，或者实时调用方法（在MBean接口实现类中实现的非属性相关的get/set方法都可以调用）。

2.通过JMX提供的工具页访问

这里需要到导入外部jar包jdmk

package jmx;

import java.lang.management.ManagementFactory;

import javax.management.JMException;
import javax.management.MBeanServer;
import javax.management.ObjectName;

import com.sun.jdmk.comm.htmlAdaptorServer;

public class HelloAgent
{
    public static void main(String[] args) throws JMException, Exception
    {
         MBeanServer server = ManagementFactory.getPlatformMBeanServer();
         ObjectName helloName = new ObjectName("jmxBean:name=hello");
         //create mbean and register mbean
         server.registerMBean(new Hello(), helloName);
         
         //这里需要对Html适配器的MBean进行注册，并启动适配器，这样就可以通过网页来使用JMX。
         ObjectName adapterName = new ObjectName("HelloAgent:name=htmladapter,port=8082");   
         HtmlAdaptorServer adapter = new HtmlAdaptorServer();   
         server.registerMBean(adapter, adapterName);  
         adapter.start();
    }
}

访问地址：http://localhost:8082，点击name=hello：

3.通过客户端程序进行远程访问（RMI）

当然，需要先启动JMX服务，并监听端口才可以访问。

package jmx;

import java.io.IOException;

import javax.management.Attribute;
import javax.management.MBeanServerConnection;
import javax.management.MBeanServerInvocationHandler;
import javax.management.ObjectName;
import javax.management.remote.JMXConnector;
import javax.management.remote.JMXConnectorFactory;
import javax.management.remote.JMXServiceURL;


public class Client
{
    public static void main(String[] args) throws IOException, Exception, NullPointerException
    {
        /**
         * JMX提供服务的url
         * @type {JMXServiceURL}
         */
        JMXServiceURL url = new JMXServiceURL
            ("service:jmx:rmi:///jndi/rmi://localhost:9999/jmxrmi");
        
        /**
         * JMX服务连接器，用于发起连接
         * @type {[type]}
         */
        JMXConnector jmxc = JMXConnectorFactory.connect(url,null);
        
        /**
         * 从JMX服务连接器上获取的MBeanServer连接器。
         * @type {[type]}
         */
        MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();
        //ObjectName的名称与前面注册时候的保持一致
        ObjectName mbeanName = new ObjectName("jmxBean:name=hello");
        
        System.out.println("Domains ......");
        
        //获得所有server下的域名
        String[] domains = mbsc.getDomains();
        
        for(int i=0;i<domains.length;i++)
        {
            System.out.println("domain[" + i + "]=" + domains[i] );
        }
        
        //获得所有注册在该server上的MBean数目
        System.out.println("MBean count = " + mbsc.getMBeanCount());

        //设置指定Mbean的特定属性值
        //这里的setAttribute、getAttribute操作只能针对bean的属性
        //例如对getName或者setName进行操作，只能使用Name，需要去除方法的前缀
        mbsc.setAttribute(mbeanName, new Attribute("Name","杭州"));
        mbsc.setAttribute(mbeanName, new Attribute("Age","1990"));
        String age = (String)mbsc.getAttribute(mbeanName, "Age");
        String name = (String)mbsc.getAttribute(mbeanName, "Name");
        System.out.println("age=" + age + ";name=" + name);
        
        
        /**
         * 通过JMX调用MBean实例的方法
         */
        
        //方法一
        //通过获得代理调用MBean实例的方法
        HelloMBean proxy = MBeanServerInvocationHandler.
            newProxyInstance(mbsc, mbeanName, HelloMBean.class, false);
        proxy.helloWorld();
        proxy.helloWorld("migu");
        proxy.getTelephone();
        
        //方法二
        //通过msbc的invoke方法调用MBean实例的方法，只针对非属性的相关的方法(get/set)
        //例如invoke不能对getName方法进行调用
        mbsc.invoke(mbeanName, "getTelephone", null, null);
        mbsc.invoke(mbeanName, "helloWorld", 
            new String[]{"I\'ll connect to JMX Server via client2"}, new String[]{"java.lang.String"});
        mbsc.invoke(mbeanName, "helloWorld", null, null);
    }
}

JMX——Notifications

从零开始玩转JMX(二)——Condition

JMX学习笔记(四)：Notifications

JMX API定义了一种机制，使MBean能生成通知，如当信号状态改变，检测到事件或者一个问题时。

通知模型仅仅涉及了在同一个JMX代理中的管理构件之间的事件传播。JMX通知模型依靠以下几个部分：

• Notification，一个通用的事件类型，该类标识事件的类型，可以被直接使用，也可以根据传递的事件的需要而被扩展。
• NotificationListener接口，接受通知的对象需实现此接口。
• NotificationFilter接口，作为通知过滤器的对象需实现此接口，为通知监听者提供了一个过滤通知的过滤器。
• NotificationBroadcaster接口，通知发送者需实现此接口，该接口允许希望得到通知的监听者注册。

发送一个通用类型的通知，任何一个监听者都会得到该通知。因此，监听者需提供过滤器来选择所需要接受的通知。任何类型的MBean，标准的或动态的，都可以作为一个通知发送者，也可以作为一个通知监听者，或两者都是。

要生成通知，MBean必须实现NotificationEmitter接口或继承NotificationBroadcasterSupport类。要发送一个通知必须构造Notification类的实例或者子类(如NotificationChangedAttribute),通知实例产生后，由NotificationBroadcasterSupport的sendNotification方法发送通知。

• 例子：

Step 1 ：定义HelloMBean接口

    package com.jmx.demo5;  
      
    public interface HelloMBean {  
        public void sayHello();  
      
        public int add(int x, int y);  
      
        public String getName();  
      
        public int getCacheSize();  
      
        public void setCacheSize(int size);  
      
    }  

Step 2 ：编写HelloMBean的实现类Hello

    package com.jmx.demo5;  
      
    import javax.management.AttributeChangeNotification;  
    import javax.management.MBeanNotificationInfo;  
    import javax.management.Notification;  
    import javax.management.NotificationBroadcasterSupport;  
      
    //MBean must extends NotificationBroadcasterSupport or implements NotificationEmitter  
    public class Hello extends NotificationBroadcasterSupport implements HelloMBean {  
        private final String name = "Reginald";  
        private int cacheSize = DEFAULT_CACHE_SIZE;  
        private static final int DEFAULT_CACHE_SIZE = 200;  
        private long sequenceNumber = 1;  
      
        public void sayHello() {  
            System.out.println("hello, world");  
        }  
      
        public int add(int x, int y) {  
            return x + y;  
        }  
      
        public String getName() {  
            return this.name;  
        }  
      
        public int getCacheSize() {  
            return this.cacheSize;  
        }  
      
        public synchronized void setCacheSize(int size) {  
            int oldSize = this.cacheSize;  
            this.cacheSize = size;  
            System.out.println("Cache size now " + this.cacheSize);  
      
            /** 
             * To send a notification,you need to construct an instance of class 
             * Notification or a Subclass(such as AttributeChangedNotification),and 
             * pass the instance to NotificationBroadcastSupport.sendNotification. 
             *  
             */  
            Notification n = new AttributeChangeNotification(this,  
                    sequenceNumber++, System.currentTimeMillis(),  
                    "CacheSize changed", "CacheSize", "int", oldSize,  
                    this.cacheSize);  
      
            sendNotification(n);  
        }  
      
        @Override  
        public MBeanNotificationInfo[] getNotificationInfo() {  
            String[] types = new String[] { AttributeChangeNotification.ATTRIBUTE_CHANGE };  
            String name = AttributeChangeNotification.class.getName();  
            String description = "An attribute of this MBean has changed";  
            MBeanNotificationInfo info = new MBeanNotificationInfo(types, name,  
                    description);  
            return new MBeanNotificationInfo[] { info };  
        }  
      
    }  

Step 3：创建MBeanServer,标识MBean,注册MBean,并运行Main方法：

    package com.jmx.demo5;  
      
    import java.lang.management.ManagementFactory;  
      
    import javax.management.MBeanServer;  
    import javax.management.ObjectName;  
      
    public class Main {  
        public static void main(String[] args) throws Exception{  
            MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();  
            ObjectName name = new ObjectName("com.jmx.demo:type=Hello");  
            Hello mbean = new Hello();  
            mbs.registerMBean(mbean, name);  
            System.out.println("Waiting forever...");  
            Thread.sleep(Long.MAX_VALUE);  
              
        }  
    }  

然后可以用jconsole打开JMX服务，查看运行结果：通知选项初始状态没有值，点击订阅后，通知项为0

！pic

更改CacheSize的值后，在观察通知选项，变为1

总结：

Notification可以用于监测任何有关MBean方法调用的信息，只要MBean实现类继承NotificationBroadcasterSupport类，然后在需要监测的方法中调用NotificationBroadcasterSupport处继承来的sendNotification(Notification n)方法即可，而方法的参数是一个Notification实例，需要传入相关的通知信息。