一、JMX简单介绍
Tomcat从5.0版本开始引入,力图使JMX成为Tomcat未来版本的管理工具和平台。首先,让我们来对JMX做一个简单了解。JMX是JavaManagementExtension的缩写,可译为Java管理工具扩展,扩展的意思就是JMX不包含在标准的J2SE中,我们必须要另外下载JMXRI的实现。不过,这种把JMX排除在J2SE之外的情况已经成为历史了,J2SE5.0和J2SE6.0都已经包含了JMX的标准实现。这说明,JMX已经成为J2SE不可分割的一部分,另外一方面,JMX已经成为Java平台上管理工具的事实标准,在业界广泛使用。例如,JBOSS就是以JMX为微内核,Web应用模块和其它功能模块都可热插拨到这个微内核,将JMX的管理功能发挥得淋漓尽致。从当前业界使用情况看,JMX中的X(Extension,扩展)应该去掉,改名为JavaManagementStandardPlatform(JMSP,Java管理标准平台)更加合适。为了向下兼容,我们姑且还是称之为JMX吧。
JMX要管理的对象是什么呢,是资源。什么是资源,资源是指企业中的的各种应用软件和平台,举例来说,一个公司内部可能有许多应用服务器、若干Web服务器、一台至多台的数据库服务器及文件服务器等等,那么,如果我们想监视数据库服务器的内存使用情况,或者我们想更改应用服务器上JDBC最大连接池的数目,但我们又不想重启数据库和应用服务器,这就是典型意义上的资源管理,即对我们的资源进行监视(Monitoring,查看)和管理(Management,更改),这种监视和更改不妨碍当前资源的正常运行。对资源进行适当的监测和管理,可以让我们的IT资源尽可能的平稳运行,可以为我们的客户提供真正意思上的24×7服务。在资源耗尽或者在硬件出故障之前,我们就可以通过管理工具监测到,并通过管理工具进行热调整和插拔。独孤九剑,料敌机先,适当的资源管理就是我们料敌机先的工具,可以让我们立于IT服务的不败之地。在Sun公司提出JMX(JSR174)以前,人们通常都是使用SNMP对网络上的资源进行管理。SNMP的主要问题是入门门槛太高,不容易使用。所以Sun提出了JSR174倡议并且提供了一套JMX的参考实现。
从技术上说,JMX整体架构可分为三层,即资源植入层(InstrumentationLevel,可能有更好的译法?)、代理层(AgentLevel)和管理层(ManagerLevel),简述如下:
资源植入层(InstrumentationLevel):该层包含MBeans及这些MBeans所管理的资源,MBeans是一个Java对象,它必须实现JMX规范中规定的接口。按照JMX规范,在MBeans对象的接口中,我们可以指定管理层可以访问资源的哪些属性,可以调用资源的哪些方法,并且,在资源的属性发生变化是,我们的MBeans可以发出消息,通知对这些属性变化感兴趣的其它对象。JMX规范定义了四种MBeans,它们分别是标准MBeans(StandardMBeans)、动态MBeans(DynamicMBeans)、开放MBeans(OpenMBeans)和模态MBeans(ModelMBeans)。
代理层(AgentLevel):代理层的目的就是要把MBeans中实现的接口暴露给管理层,该层通常由MBeanServer和AgentServices构成,MBeanServer就是一个MBeans对象注册器,所有的资源MBeans都注册到这个MBeanServer,对象管理器或者其它的管理层应用程序可以通过访问MBeanServer,从而可以访问MBeanServer中注册的MBeans,当然也就可以监视和管理和这些MBeans绑定的资源。 管理层(ManagerLevel):又称之为分布式服务层(DistributedServices),顾名思义,该层主要包含一些管理应用程序,这些程序可以访问和操作JMX代理层(AgentLevel)。这些管理应用程序可以是一个Web应用,也可能是一个JavaSWT应用程序。
二、 举个栗子
下面,我们举一个简单的例子,理解一下JMX中中的各个概念。我们家有一个中央热水系统(CentralHeaterSystem),它是我们家的一个资源,现在我们想通过JMI进行管理。现有的代码如下所示,当然,为简单起见,我们略去了一些JNI调用代码,因为厂家提供的API是用C语言写的。
a)热水器接口(CentralHeaterInf.java)的现有代码:
public interface CentralHeaterInf { public final static String HEATER_PROVIDER = "British Gas Company" ; public int getCurrentTemperature(); public void setCurrentTemperature( int newTemperature); public void turnOn(); public void turnOff(); }b) 热水器实现代码的现有代码 (CentralHeaterImpl .java )
public class CentralHeaterImpl implements CentralHeaterInf { private int currentTemperature ; public int getCurrentTemperature() { return currentTemperature ; } public void setCurrentTemperature( int newTemperature) { currentTemperature =newTemperature; } public void turnOff() { System. out .println( "The heater is off. " ); } public void turnOn() { System. out .println( "The heater is on. " ); } }
1.1 资源植入层 (Instrumentation Level) 代码示例
我们如何让JMX对我们的中央热水器进行管理呢?
首先,我们并不想让远程管理者能够关闭我们的中央热水器,因为热水器一旦关上,我们再也无法访问厂家提供的API。既然不能关闭它,我们的MBeans中也就不需要打开 (turnOn) 方法。所以,我们简单定义的 MBeans接口如下:
public interface CentralHeaterImplMBean { public String getHeaterProvider(); public int getCurrentTemperature(); public void setCurrentTemperature( int newTemperature); public String printCurrentTemperature(); }上面的MBean接口及其简单,意义也非常明显,我们只向管理程序公开热水器的生产厂家(该属性为只读,管理程序不能更改热水器的生产厂家),但管理程序可以获取并更改当前热水器的温度,并且可以打印出热水器的当前温度。 接下来,我们要做的,就是更改我们已有的CentralHeaterImpl.java代码,让它实现CentralHeaterImplMBean接口,同时实现CentralHeaterImplMBeanMBean中规定的所有方法。CentralHeaterImpl.java更改后的源代码如下:
public class CentralHeaterImpl implements CentralHeaterInf,CentralHeaterImplMBean { int currentTemperature ; public int getCurrentTemperature() { return currentTemperature ; } public void setCurrentTemperature( int newTemperature) { currentTemperature =newTemperature; } public void turnOff() { System. out .println( "The heater is off. " ); } public void turnOn() { System. out .println( "The heater is on. " ); } public String getHeaterProvider() { return HEATER_PROVIDER ; } public String printCurrentTemperature() { String printMsg= "Current temperature is:" + currentTemperature ; System. out .println(printMsg); return printMsg; }}到此为止,我们的资源植入层 (Instrumentation Level) 的代码全部完成,它主要由一个 MBean(CentralHeaterImplBean) 及其实现类 CentralHeaterImpl 组成,在 CentralHeaterImplBean 这个 MBean 接口中,我们说明了要向管理程序暴露的属性和方法,在本例中,我们的管理程序可以访问热水器的生产厂家信息,同时还可以获取和设置并打印热水器的温度。在 MBean 的实现类中,我们实现了 MBean 接口中规定的所有方法。 然而,在上面的实现中,我们更改已有的CentralHeaterImpl.java代码。但从代码编写的角度看,这种做法违反了软件设计的基本原则—开闭原则。我们已有的CentralHeaterImpl.java类已经经过多次测试,消除了所有的Bug,现在为了支持JMX,我又增加方法,又修改代码,这会让原本运行得很好的系统重新产生Bug。您不妨思考一下,如何不修改CentralHeaterImpl类的代码,但又让使JMX能够管理我们家的热水器呢?请参考本文的附录,看看您的想法是否比我提供的参考实现高明些? 1.2 代理层 (Agent Level) 示例代码
import java.lang.management.ManagementFactory; import javax.management.MBeanServer; import javax.management.ObjectName; public class CentralHeaterAgent { private static MBeanServer mBeanServer ; public static void main(String[] args) throws Exception { ObjectName oname; // get the default MBeanServer from Management Factory mBeanServer = ManagementFactory.getPlatformMBeanServer (); // try { // create a instance of CentralHeaterImpl class CentralHeaterInf centralHeater = new CentralHeaterImpl(); // assign a Object name to above instance oname = new ObjectName( "MyHome:name=centralheater" ); // register the instance of CentralHeaterImpl to MBeanServer mBeanServer .registerMBean(centralHeater, oname); System. out .println( "Press any key to end our JMX agent..." ); System. in .read(); } }您可以看到,上面的代理层代码异常简单。前面讲过,代理层中最重要的对象就是MBeanServer,我们可以把MBeanServer理解为一个全局的HashMap,所有的MBeans都通过唯一的名字注册到这个HashMap,这个HashMap可以跨越JVM访问,甚至可以通过RMI、Http及其它手段跨越网络传输到其它机器,让其它机器也能访问这个MBeanServer中注册的对象。下面我们稍微理解一下代理层代码,在main()方法中, a)首先我们从ManagementFactory的工厂方法中获得MBeanServer对象; b)然后实例化我们的热水器对象,注意这个对象声明为CentralHeaterInf,而不是CentralHeaterImplMBean。JMX规范并没有规定对象声明,只要这个对象实现了一个以SomethingMBean命名的接口或父类即可; c)接下来通过newObjectName(String)构造函数给我们的MBean一个全局的名字,这个名字一般的格式是:”域名:属性1=*,属性2=*,…”构成; d)第四步,我们调用MBeanServer的regiesterBean方法,通过第三步声明的全局名字把我们的MBean实例注册到MBeanServer。 这几步都非常简单明了。下面我们在Eclipse中运行代理层代码,运行时,请加上下面几个JVM运行时参数:
-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.ssl="false" -Dcom.sun.management.jmxremote.authenticate="false"这四个 JVM 运行时参数的意义是, MBeanServer 允许其它管理程序通过 RMI 方式访问, RMI 端口是 9999, RMI 不使用 SSL 协议,也不需要验证。 Eclipse 的 Run 窗口如下: 然后,请在上面的窗口中点击Run(运行)按钮,运行代理层程序。 1.3管理层代码 管理层代码编写起来其实也比较简单,但如果您要求界面比较完美,并且您也不想卷入到AWT加Swing的面条代码中,您最好直接使用JDK自带的JConsole.exe程序,这个程序位于JDK\bin目录下,可直接运行。下面我们观察管理程序在远程和本地运行情况。 a)远程运行JConsole管理程序 请双击JConsole.exe或者通过命令行在本机上启动JConsole.exe,在JConsole的连接界面,选择远程连接,然后输入RMI地址和端口号,本例为localhost:9999,注意确保我们上面编写的CentralHeaterAgent代理处于运行状态,远程连接界面如下图所示: 连接成功后,请点击 MBean 标签,并展开 MyHome 节点,我们可以观察到 CentralHeaterImplMBean 中暴露给管理程序所有的属性和方法,如下图所示: 我们在 CentralHeaterImplMBean 接口中规定, CurrentTemperature 属性是可以更改的,所以上图中 CurrentTemperature 的值显示为绿色,表示远程管理者可以调节;但 HeaterProvider( 生产厂家 ) 的属性是不能更改的,所以其值显示为灰色。现在,我们以远程管理用户的身份,把 CurrentTemperature 属性的值改为 25 ,并按回车或者点击刷新按钮,接下来您可以在上面的界面中,调用操作方法 printCurrentTemperature() ,您会在弹出的对话框中看到“ Current temperature is:25 ”的字样,这说明我们的温度更改成功。请注意这是通过远程 RMI 完成的。 b) 本地运行 JConsole 管理程序 请关闭上步中打开的 JConsole ,然后重新运行 JConsole.exe 程序,选择本地进程中的 carl.test.jmx.CentralHeaterAgent 程序,并单击“连接”按钮,图示如下。 您在本地的管理程序中可以观察到,MyHome节点下的centralheater的CurrentTemperature的值已经改为25,这个更改时通过远程方式完成的。 到此为止,JMX的小例子就结束了,您可能有些疑惑。a)首先,JMX从表现形式上看似RMI或者EJB,是一种分布式计算,对吗?b)其次,我们在注册MBean时,开始声明了一个MBean对象,然后把这个对象注册到MBeanServer,那么,所有的操作都只能操纵这个对象,对吧?假设我们在程序的其它地方,又新创建了这个MBean的另一个实例,这时,我们如何管理这个新创建的实例呢? 我们先来思考一下JMX和RMI/EJB的区别,RMI/EJB是分布式计算的一种,它们通过Stub和Skeleon的方式,在服务器和客户端之间传输Bean实例,所以客户端必须知道服务器端Bean的接口;客户端可以获得服务器端的实例对象,并能调用这个实例对象的方法,被调用的方法其实是在客户端运行的,方法的运行需要占用客户端资源。但JMX不同,JMX管理程序(类似于EJB/RMI的客户端)不需要了解服务器中Bean的任何接口的信息,更不需要从服务器上获取正在运行的实例,所有方法的调用均在服务器端完成,管理程序只是用来监视或者管理服务器中注册的MBeans。 再说说JMX如何管理新实例的问题,我们知道,JMX管理的是资源。何谓资源,资源一般代表真实存在的事物。比如说上面例子中的热水器,我们家只有一个热水器,所以一个MBean的实例足矣,不必使用new来创建另一个实例。但是,您可能会问,我们家假如有两个热水器怎么办?在这种情况下,我们需要两个MBean的实例,把它们分别命名为"MyHome:name=centralheater_1"和"MyHome:name=centralheater_2",并注册到MBeanServer,这两个热水器之间没有任何关系,就和Java中同一个类的两个实例类似。当然,同一个类的两个实例之间可以通过static属性共享资源。一般说来,JMX中的MBean对应的是真实世界里存在的事物,或者服务器中独一无二的对象,这些对象往往长期驻留在内存中,所以需要管理。如果您新建一个实例,等您的方法退出之后,垃圾回收器马上将这个对象清理掉,您也没有必要使用JMX来管理这种昙花一现的对象,对吗?
三、Tomcat中的JMX
通过上面JMX的简单介绍和举例,我们对JMX有了一个整体概念。现在我们就来查看一下JMX在Tomcat中的应用。首先,我们使用JConsole查看一下Tomcat中有哪些MBeans。 3.1首先,请在Eclipse中启动Tomcat,在虚拟机参数中,设置下面几个参数:-Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port=9999 -Dcom.sun.management.jmxremote.ssl="false" -Dcom.sun.management.jmxremote.authenticate="false"运行界面如下所示: 3.2 Tomcat 运行后,请打开 JConsole.exe, 我们可以远程连接到 localhost:9999 ,我们可以看到 Tomcat 中的 MBeans 如下图所示: 我们从上图可以看出,Tomcat中的MBeans位于Catalina和Users两个domain中,Catalina域名中包含我们所关心的一些Tomcat关键组件,比如说Server、Service、Realm、Engine和Connector等等关键组件,这些MBean分别对应我们前面在Tomcat架构中讲述的那些组件资源。那么,这些组件是如何注册到MBeanServer的呢,注册的流程又是如何,这个问题需要解读Tomcat源代码,此处暂不细表,且看下回分解。 3.3下面,我们做一个非常有趣的实验,体验一下JMX管理的乐趣。首先请在浏览器中打开http://localhost:8080/examples/jsp/jsp2/el/basic-arithmetic.jsp页面,然后再上图所示的JConsole中的Manager节点下的/examples-->localhost中找到操作中的“listSessionIds”方法,然后点击调用该方法,您会在弹出的对话框中看到您刚才访问basic-arithmetic.jsp页面的sessionId值,它是一个16位的字符串,我的机器上显示为“4998AB8A07480360BC24A9E9C11A39CA”;接下来,请在Manager节点下的/examples-->localhost中找到属性中的sessionIdLength属性,把它的值从16改为22,请关闭浏览器,然后重新打开浏览器,再访问一下上面的页面,这时,您再调用”listSessionIds”方法查看一下sessionId的列表,会发现新产生的sessionId的位数是22位,在我的机器上返回”4998AB8A07480360BC24A9E9C11A39CA04348EFDE953D0B56A206BF11A13E1A5CBB14F316B4F”两个sessionId值。当然,您也可以输入sessionId值,调用expireSession方法来让某个session过期。 Tomcat中MBean的管理方式很多,例如,您可以通过下面的方法打印、查找或者管理Tomcat中的MBean,该方法的优点是不用打开RMI端口,所有操作都是通过Servlet转发给MBeanServer完成的,具体步骤如下: a)首先打开conf目录下的tomcat-users.xml文件,在<tomcat-users>和</tomcat-users>标签之间加上下面两行,然后保存该文件。
这表示我们要添加一个新用户,用户名为admin,密码也是admin,用户具有manager权限。 b)重启Tomcat,然后在浏览器中打开下面的URL,http://localhost:8080/manager/jmxproxy/,请输入用户名密码admin/admin,您将看到Tomcat中所有的MBeans。在我的机器上,显示108个MBeans的详细信息。如果您访问http://localhost:8080/manager/jmxproxy/?qry=*%3Aj2eeType=Servlet%2c*,您将会看到所有已经加载的Servlet的信息,该qry是查找j2eeType=Servlet的所有MBeans。如果您有兴趣,您还可以通过这个jmxproxy来动态设置一些Tomcat中组件运行时的值。
四、 Tomcat 中最简单的 MBean
下面我们打开 Tomcat 源代码,看看 Tomcat 中最简单的一个 MBean 。在 Tomcat 的启动引导类 Bootstrap.java 的 172 到 187 行,我们可以看到如下代码:
ClassLoader classLoader = ClassLoaderFactory.createClassLoader (locations, types, parent); // Retrieving MBean server MBeanServer mBeanServer = null; if (MBeanServerFactory.findMBeanServer(null).size() > 0) { mBeanServer = (MBeanServer) MBeanServerFactory.findMBeanServer(null).get(0); } else { mBeanServer = MBeanServerFactory.createMBeanServer(); } // Register the server classloader ObjectName objectName = new ObjectName("Catalina:type=ServerClassLoader,name=" + name); mBeanServer.registerMBean(classLoader, objectName);4.1上面的代码首先使用ClassLoaderFactory工厂类创建一个ClassLoader; 4.2然后在MBeanServerFactory这个工厂类中查找MBeanServer,如果没有发现,就使用这个工厂类创建一个MBeanServer; 4.3第三步是给刚才创建的ClassLoader这个MBean取个名字“Name:Catalina:type=ServerClassLoader,name=common”,然后注册到MBeanServer。 您如果在JConsole中观察这个MBean,会发现这个MBean没有向管理应用程序暴露任何属性和方法,并且Classloader似乎也符合JMX命名规范,它也不是一个DynamicBean,这是为什么呢?首先,这个Classloader其实一个StandardClassloader,而不是JDK中缺省的Classloader,您如果打开ClassLoaderFactory的createClassLoader方法,马上就可以看到这一点;另外,看看StanderClassloader的类签名,我们会发现该类实现了StandardClassLoaderMBean接口,这是符合JMX命名规范的;请打开StandardClassLoaderMBean接口的源代码,您会发现这是一个空接口,这意味着实现这个接口的MBean不会向管理程序暴露任何属性和方法。 最后,希望这篇入门级的简单介绍,能有助于大家理解JMX及JMX在Tomcat中的应用。 附录:针对本文中的热水器小例子,我们给出了一个简单问题,即如何修改我们既有的代码,让这些代码所在的资源能使用JMX管理?如果您稍微翻阅一下Tomcat的源代码,您会发现,Tomcat的作者们在JMX升级时对已有源代码的改动有点粗暴,勇猛有余,优美不足。org.apache.catalina.core包中的关键组件,大部分后加了preRegister()、getObjectName()等等方法,在init()方法中又添加了一堆Registry.getRegistry.unregisterComponent或registerComponent代码,这些方法其实这些core组件没有直接关系,也不是这些core组件应该具有的功能,并且这些后添加的代码及其类似。当然,这种情况在我们实际项目中更为多见,主要原因是时间不足,资源有限等等。 如果要比较优美的解决上面的问题,我个人认为,首先,保持现有代码,然后对现有代码进行扩展而不是大刀阔斧的修改已有代码。就拿我们热水器的简单例子来说,我们不要修改CentralHeaterImpl.java的现有代码,而是使用Wrapper设计模式,设计一个新类,然后将这个CentralHeaterImpl类适配成我们需要的MBean接口,具体实现如下: a) CentralHeaterDecoratorMBean.java 源代码
public interface CentralHeater Decorator MBean { public String getHeaterProvider(); public int getCurrentTemperature(); public void setCurrentTemperature( int newTemperature); }CentralHeaterDecorator .java 的源代码:
public class CentralHeaterDecorator implements CentralHeaterDecoratorMBean { private CentralHeaterImpl centralHeater ; public CentralHeaterDecorator(CentralHeaterImpl theCentralHeater){ centralHeater =theCentralHeater; } public int getCurrentTemperature() { return centralHeater .getCurrentTemperature(); } public void setCurrentTemperature( int newTemperature) { centralHeater .setCurrentTemperature(newTemperature); } public String getHeaterProvider() { return centralHeater . HEATER_PROVIDER ; } public String printCurrentTemperature() { String returnMsg = "Current temperature is:" + centralHeater .getCurrentTemperature(); System. out .println(returnMsg); return returnMsg; } }最后,请把 Agent 代码中的下面一行:
CentralHeaterInf centralHeater = new CentralHeaterImpl();改为:
CentralHeaterDecoratorMBean centralHeater = new CentralHeaterDecorator(new CentralHeaterImpl());其运行效果完全一样,但我们完全没有改动既有代码。