5、用Apache的commons-modeler来辅助开发JMX

[JMX一步步来]　5、用Apache的commons-modeler来辅助开发JMX

文/陈刚  from www.chengang.com.cn at 2005-12-13

 

一、前言

　

　　每一个MBean都要有一个接口，比如前面的Hello要有一个HelloMBean接口。要多维护一个接口，的确是件麻烦的事。Apache的commons-modeler利用JMX中的动态MBean原理很好的解决了这一问题，commons-modeler使用得我们可以只写Hello，而不用写HelloMBean这个接口。不过这是有代价的，它要求我们写一个mbean的xml描述文件（唉，少了一件事，却又多出另一件事来）。但commons-modeler还是有优点的，就是它让mbean的装配更加灵活，把多个mbean的装配都集中在一个XML文件里来了。

　　开始实例之前，你需要先去apache网站下载commons-modeler，以及modeler的依赖项目commons-logging。下载网址为： http://jakarta.apache.org/site/downloads/downloads_commons.html，下载的文件是ZIP压缩包，解压后找到commons-logging.jar和commons-modeler.jar。如果在DOS下用命令行开发，则把这两个JAR包加入到classpath系统变量中。如果你用Eclipse开发，则把JAR包加入到项目属性的Libratries（库）引用中。

 

二、HelloWorld实例

 

 　我们以本系统的第一篇“1、JMX的Hello World”为例，来重新实现一次。

　

1、Hello.java的代码不变（注：为了在Eclipse上和原来的Hello文件放在不同的地方，我把新Hello放到了mbean.modelbean包），如下：

package mbean.modelbean;

import mbean.standard.HelloMBean;

public class Hello implements HelloMBean {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public void printHello() {
        System.out.println("Hello World, " + name);
    }
    public void printHello(String whoName) {
        System.out.println("Hello , " + whoName);
    }
}

 

2、MBean不用写了，但需要写一个XML描述文件。文件名任取，这里取名为：mbeans-descriptors

<?xml version="1.0"?>
<mbeans-descriptors>
 <mbean name="Hello" description="the hello bean" domain="chengang" group="helloGroup" type="mbean.modelbean.Hello">
  <attribute name="name" description="a name attribute" type="java.lang.String" writeable="true"/>
  <operation name="printHello" description="a operation to print hello" impact="INFO" returnType="String"/>
 </mbean>
</mbeans-descriptors> 

这里只对<mbean>标签做一下说明：

• name mbean在xml中的唯一标识，不一定要和类同名
• description　mbean的注释说明信息
• domain mbean所属域
• group mbean所属组
• type mbean的类全名（包名＋类名）
• classname 指定实现代理功能的ModelMbean的全名，如果不指定则默认为BaseModelMBean 

3、接下来改写HelloAgent

package mbean.modelbean;

import java.io.InputStream;
import javax.management.MBeanServer;
import javax.management.ObjectName;
import javax.management.modelmbean.ModelMBean;
import org.apache.commons.modeler.ManagedBean;
import org.apache.commons.modeler.Registry;
import com.sun.jdmk.comm.HtmlAdaptorServer;

public class HelloAgent {
    public static void main(String[] args) throws Exception {
        //基于xml中的信息构建一个Registry
        Registry registry = Registry.getRegistry(null, null);
        InputStream stream = HelloAgent.class.getResourceAsStream("Mbeans-descriptors.xml");
        registry.loadMetadata(stream);
        stream.close();
        //由Registry得到一个MBeanServer
        MBeanServer server = registry.getMBeanServer();

        //得到Hello在描述文件中的信息类，对应于xml文件<mbean>标签的name属性。
        ManagedBean managed = registry.findManagedBean("Hello");
        //创建ObjectName
        ObjectName helloName = new ObjectName(managed.getDomain() + ":name=HelloWorld");
        //得到ModelMBean
        ModelMBean hello = managed.createMBean(new Hello());
        //注册MBean
        server.registerMBean(hello, helloName);

        ObjectName adapterName = new ObjectName("HelloAgent:name=htmladapter,port=8082");
        HtmlAdaptorServer adapter = new HtmlAdaptorServer();
        server.registerMBean(adapter, adapterName);
        adapter.start();
        System.out.println("start.....");
    }
}

　

HelloAgent是效复杂的地方，我们来和以前的HelloAgent逐步比较一下，前后有什么不同：

（1）首先，新的HelloAgent需要将xml信息读入到Registry对象中，这是旧HelloAgent所没有的。

Registry registry = Registry.getRegistry(null, null);
InputStream stream = HelloAgent.class.getResourceAsStream("Mbeans-descriptors.xml");
registry.loadMetadata(stream);
stream.close();

 

（2）接着创建MBeanServer的方式也不同了

现在：MBeanServer server = registry.getMBeanServer();

以前: MBeanServer server = MBeanServerFactory.createMBeanServer();

　

（3）Hello相应的ObjectName创建也略不相同。主要是域名在XML描述文件里设置好了。

现在：ManagedBean managed = registry.findManagedBean("Hello");
     ObjectName helloName = new ObjectName(managed.getDomain() + ":name=HelloWorld");
以前：ObjectName helloName = new ObjectName("chengang:name=HelloWorld")

　

（4）得到MBean的方式也不同，这里就是关键的不同点

现在：ModelMBean hello = managed.createMBean(new Hello());

以前：Hello hello = new Hello();

注意：为什么现在要比以前多一个createMbean步骤呢，就是因为现在的写法并没有写Mbean，所以需要动态才需要生成一个。而以前就直接把new Hello()注册到mbean server就可以了，server会自动找到它的HelloMBean接口文件。

　

　也就上面四点区别，其他代码完全一样。测试和查看效果的方法和以前一样，在此不累述了。我们来看看界面情况有那些变化（红圈部份）。

　

　由图可见commons Modeler为Hello动态生成了一个MBean接口：BaseModelBean

　

参考资料

　　 用Commons Modeler 开发JMX应用