您可以捐助,支持我们的公益事业。

1元 10元 50元





认证码:  验证码,看不清楚?请点击刷新验证码 必填



  要资料 文章 文库 Lib 视频 Code iProcess 课程 认证 咨询 工具 火云堂 讲座吧   成长之路  
会员   
 
   
 
  
每天15篇文章
不仅获得谋生技能
更可以追随信仰
 
     
   
 订阅
  捐助
Java管理扩展指南之MBean简介
 
来源:码农网 发布于 2017-10-27
194 次浏览     评价:      
 

MBean简介

1.1. MBeans简要介绍

本课程介绍JMX API的基本概念,它被称之为被管理的bean,或者MBean。

MBean是一个被管理的Java对象,就像Javabean组件一样,但是它遵从JMX规范的设计模式。MBean可以表示设备、应用或者任何需要被管理的资源。MBeans暴露如下管理接口:

1.一组可读和可写属性,或者两者兼而有之。

2.一组调用方法。

3.自我描述。

在MBean实例的生命周期中,管理接口都不会发生变化。MBeans可以在某种预定义的事件发生时发送通知。

JMX规范定义了五种MBean:

1.标准MBeans

2.动态MBeans

3.开放MBeans

4.模型MBeans

5.MXBeans

本系列的例子主要介绍最简单的MBeans类型-标准MBeans和MXBeans。

1.2. 标准MBeans

本章主要介绍标准MBean的简单例子。

标准MBean通过编写SomethingMBean的java接口进行定义,然后定义一个Java类Something实现接口SomethingMBean。SomethingMBean中的方法用于定义属性和操作。默认情况下,每个方法都会定义一个操作。属性和操作都是满足特定设计模式的java类方法。标准MBean由MBean接口和一个实现类组成。MBean接口的方法列出所有暴露的属性和操作。实现类实现MBean接口以此提供管理资源功能。

下面的章节介绍标准MBean的例子和一个简单的JMX代理管理MBean。

2.2.1. MBean接口

MBean接口HelloMBean,如下:

package com.example;

public interface HelloMBean {

public void sayHello();
public int add(int x, int y);

public String getName();

public int getCacheSize();
public void setCacheSize(int size);
}

按照约定,MBean接口的名称由其实现类名+MBean后缀组成。在本例中,MBean接口类为HelloMBean,Hello类实现该接口。

根据JMX规范,MBean接口由属性(可读getter方法或者可写setter方法)和操作(暴露的方法)组成。HelloMBean接口定义了两种方法:add()和sayHello()。

HelloMBean定义两个属性:Name是只读的(getter方法)String属性,CacheSize是可读且可写的(getter和setter)int属性。Getter和setter方法允许管理程序访问并改变属性的值。在JMX规范中,getter方法是以get开头并且不能返回void的任何public方法。getter方法允许管理程序读取属性的值。Setter方法是以set开头并且接收一个参数的任何public方法。setter方法允许管理程序修改属性的值。

这些操作和属性在MBean实现中展示。

2.2.2. MBean实现

Hello类试下HelloMBean接口如下:

package com.example;

public class Hello ...
implements HelloMBean {
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) {
...

this.cacheSize = size;
System.out.println("Cache size now " + this.cacheSize);
}
...

private final String name = "Reginald";
private int cacheSize = DEFAULT_CACHE_SIZE;
private static final int
DEFAULT_CACHE_SIZE = 200;
}

Hello类实现HelloMBean。sayHello()和add()操作很简单,实际操作可以可繁可简,依操作简繁而异。

同时,Hello定义了获取Name属性的getter方法和读写CacheSize属性的getter和setter方法。本例中,Name属性不会改变。然而,在实际场景中,该属性随着资源的运行,依然可以改变。例如,这个属性值可以代表运行时间或者内存占用。这里,该属性值为Reginald。

调用setCacheSize 方法使你可以修改CacheSize 的值(初始值为200)。真实场景中,改变CacheSize属性值需要其他操作同时执行,例如申请、释放内存。本例仅打印该值以确保其已经改变。然而,更复杂的操作绝不仅仅调用println()。

HelloMBean接口和其实现类Hello定义之后,便可以使用它们管理资源了,如下节所示。

2.2.3. 创建JMX代理管理资源

资源通过MBean装配后,资源的管理可以通过JMX代理执行。

JMX代理的核心组件时MBean Server。MBean server是用于MBean进行注册的对象管理服务器,包括一系列的管理MBeans的服务。查看MBeanServer的API文档了解MBean server实现详情。

Main class实现了一个基本的JMX代理。

package com.example;

import java.lang.management.*;
import javax.management.*;

public class Main {

public static void main(String[] args)
throws Exception {

MBeanServer mbs = ManagementFactory.getPlatformMBeanServer();
ObjectName name = new ObjectName("com.example:type=Hello");
Hello mbean = new Hello();
mbs.registerMBean(mbean, name);

...

System.out.println("Waiting forever...");
Thread.sleep(Long.MAX_VALUE);
}
}

JMX代理类Main首先获取MBean server,MBean server通过调用 java.lang.management.ManagementFactory类的getPlatformMBeanServer()方法进行初始化。如果平台之前没有创建MBean server,getPlatformMBeanServer会自动调用JMX方法MBeanServerFactory.createMBeanServer()创建MBean server。Main中MBeanServer的实例名为mbs。

然后,Main类为MBean实例定义一个对象名(ObjectName)。每个JMX MBean必须有一个对象名。对象名是JMX类ObjectName的实例,必须满足JMX规范的语法。即对象名必须包含一个域domain和一系列的key-value属性值。Main中定义的对象名中,域domain是com.example(也就是MBean所在的包名)。同时,key-value属性值声明该对象名额属性type值为Hello。

接下来创建Hello对象的实例mbean,该对象注册到MBean server实例mbs中,注册需传递mbean和对象名,注册方法是MBeanServer.registerMBean()。

Hello MBean注册到MBean server后,Main就只需等待Hello执行管理操作。本例中,这些管理操作时调用sayHell()和add(),获取和设置属性值。

2.2.4. 运行标准MBean实例

完成例子中的各类后,你现在可以运行本例子。本例使用JConsole与MBean进行交互。

要运行本例,执行以下步骤:

a)保存jmx_examples.zip到你的工作目录。

b)在终端窗口中通过如下命令解压压缩包。

unzip jmx_examples.zip

c)在工作目录中编译java类。

javac com/example/*.java

d)如果你使用JDK6及其以上,使用如下命令启动:

java com.example.Main

如果你运行低于JDK6以下的版本,你需要添加额外的启动参数来暴露管理和监控接口。

java -Dcom.sun.management.jmxremote example.Main

Main类会打印信息以确认其运行。

e)在本机另一个终端中启动JConsole。

jconsole

新建连接对话框会展现可连接的、处于运行中的JMX代理列表。

f)在新建连接对话框中,选择com.example.Main并连接。一组当前平台的活动便会展现出来。

g)点击MBean标签。该标签展示所有注册到MBean server的MBean。

h)在左侧边栏,展开MBean树形结构的com.example节点。你会看到例子中的Hello。如果点击Hello,你可以看到它暴露的属性和方法。

i)展开MBean树形结构中Hello中的属性。你会看到Hello类定义的MBean属性。

j)更改CacheSize属性值为150。在启动Main程序的终端窗口中,会提示该属性的值已经发生变化。

k)展开MBean属性结构中Hello中的方法。你将可以看到sayHello和add方法。

l)通过点击sayHello按钮调用sayHello操作。JConsole对话框将会提示你方法调用成功。Main启动的终端窗口将会显示“hello, world”。

m)点击add方法的按钮,输入两个整形参数。JConsole的对话框将会给出结果。

n)通过点击“连接”->“退出”关闭JConsole。

2.3. MXBean

本节介绍特殊的MBean,也称之为MXBean。

MXBean是一种引用预定义数据类型的MBean。通过这种方式,您可以确保任何客户机(包括远程客户机)都可以使用您的MBean,而不需要客户机访问代表MBean类型的特定的类。MXBean提供一种方便的方法来绑定数据,而不需要客户端进行特殊的绑定操作。

类似于标准MBean,MXBean定义一个名为SomethingMXBeans的java接口和一个java类实现。然而,不同于标准MBans,MXBeans不需要java实现类必须名为Something。每个接口中的方法定义属性或者操作。@MXBean注解可以用于注解Java接口,这样接口的名称就不必以MXBean为结尾了。

MXBeans包含于J2SE 5.0版本的java.lang.management包中。然而,除了java.lang.management中定义的一组标准MXBeans,使用者可以定义自己的MXBeans。

MXBeans的主要思想是:MXBean接口java.lang.management.MemoryMBean 中引用的诸如java.lang.managementMemoryUsage类型,该类型映射一组称之为开放类型(定义为javax.management.openbean包中)的类型。映射的具体规则详见MXBean规范。然而,对于简单的诸如int、String类型的映射规则保持不变,而对于复杂类型MemoryUsage则映射为基本类型CompositeDataSupport。

MXBean的例子由如下文件构成,你可以在jmx_examples.zip中找到。

1.QueueSampler定义MXBean接口

2.实现上面接口的QueueSampler类

3.MXBean 接口的getQueueSample方法返回类型QueueSample类

4.Main类,程序启动类

MXBean例子上述这些类实现如下动作:

1.定义简单的MXBean,管理Queue<String>类型的资源

2.定义getter方法:getQueueSample返回Queue的快照QueueSample类,该类将如下类绑定在一起。

3.快照时间

4.队列queue大小

5.特定时间队列queue的头部

6.将MXBean注册到MBean server

2.3.1. MXBean接口

如下代码展示示例QueueSamplerMXBean的MXBean接口:

package com.example;

public interface QueueSamplerMXBean {
public QueueSample getQueueSample();
public void clearQueue();
}

注意,你声明一个MXBean接口的方式与声明标准MBean接口的方式完全相同。QueueSamplerMXBean接口定义getter方法:getQueueSample和操作clearQueue。

2.3.2. 定义MXBean操作

QueueSampler例子中定义的MXBean操作如下:

package com.example;

import java.util.Date;
import java.util.Queue;

public class QueueSampler
implements QueueSamplerMXBean {

private Queue<String> queue;

public QueueSampler (Queue<String> queue) {
this.queue = queue;
}

public QueueSample getQueueSample() {
synchronized (queue) {
return new QueueSample(new Date(),
queue.size(), queue.peek());
}
}

public void clearQueue() {
synchronized (queue) {
queue.clear();
}
}
}

QueueSampler实现MXBean接口中定义的getter方法getQueueSampler和clearQueue操作。getQueueSample操作返回QueueSample类的实例,该实例由java.util.Queue的peek方法和size方法和java.util.Data实例构造而成。

2.3.3. 定义MXBean接口返回的Java类型

QueueSampler 返回QueueSample类型的实例,代码如下:

package com.example;

import java.beans.ConstructorProperties;
import java.util.Date;

public class QueueSample {

private final Date date;
private final int size;
private final String head;

@ConstructorProperties({"date", "size", "head"})
public QueueSample(Date date, int size,
String head) {
this.date = date;
this.size = size;
this.head = head;
}

public Date getDate() {
return date;
}

public int getSize() {
return size;
}

public String getHead() {
return head;
}
}

在QueueSample类中,MXBean框架调用QueueSample中所有的getter 方法将自己转化为CompositeDate类型的实例,同时使用@ConstructorProperities注解从CompositeData实例转化为QueueSample实例。

2.3.4. 在MBean server中创建并注册MXBean

截至目前,已经定义如下内容:一个MXBean接口和它的实现类,以及实现类的返回类型。然后,MXBean必须在MXBean server进行注册。这些操作同样由标准MBean中的Main启动JMX代理,只不过相关的代码在标准MBean章节中没有介绍。

package com.example;

import java.lang.management.ManagementFactory;
import java.util.Queue;
import java.util.concurrent.ArrayBlockingQueue;
import javax.management.MBeanServer;
import javax.management.ObjectName;

public class Main {

public static void main(String[] args) throws Exception {
MBeanServer mbs =
ManagementFactory.getPlatformMBeanServer();

...
ObjectName mxbeanName = new ObjectName("com.example:type=QueueSampler");

Queue<String> queue = new ArrayBlockingQueue<String>(10);
queue.add("Request-1");
queue.add("Request-2");
queue.add("Request-3");
QueueSampler mxbean = new QueueSampler(queue);

mbs.registerMBean(mxbean, mxbeanName);

System.out.println("Waiting...");
Thread.sleep(Long.MAX_VALUE);
}
}

Main执行如下操作:

1.获得MBean server平台。

2.为MXBean:QueueSampler创建对象名。

3.为MXBean:QueueSampler创建一个Queue的实例。

4.将Queue的实例传递给QueueSampler。

5.将MXBean注册到MXBean server中。

2.3.5. 运行MXBean实例

MXBean实例详见jmx_examples.zip。本例需要Java SE 6版本以上。运行步骤如下:

a)保存jmx_examples.zip到工作目录。

b)在终端窗口中解压压缩包。

Unzip jmx_exampless.zip

>

c)在工作目录中编译Java代码。

Javac com/example/*.java

d)启动Main应用。终端会打印提示信息。

Java com.example.Main

e)在本机不同的窗口中启动JConsole。在新建连接对话框中,展示当前可连接的JMX代理列表。

Jconsole

f)在新建连接对话框中,选择com.example.Main并点击连接按钮。当前平台的活动会展示出来。

g)点击MBean标签。该标签展示当前注册到MBean server的MBeans。

h)在左侧框架中,展开MBean树形结构中的com.example节点。你将可以看到QueueSampler。如果你点击QueueSampler,你将看到暴露出来的属性和方法。

i)展开属性节点。你可以看到QueueSample属性出现在右侧标签中,其值javax.management.openmbean.CompositeDataSupport。

j)双击CompositeDataSupport。你可以看到QueueSample中date、head和size属性(MXBean框架将QueueSample实例转换为ComositeData)。如果将QueueSampler定义为标准的MBean而不是MXBean,JConsole就不会发现QueueSample类,因为它不会在它的类路径中。如果QueueSampler是一个标准的MBean,在访问QueueSample属性值时,您将收到一个ClassNotFoundException消息。通过JConsole等通用JMX客户机连接到JMX代理时,QueueSampler演示了使用mxbean的有用性。

k)展开操作节点。可以看到clearQueue操作的按钮。

l)点击clearQueue按钮。窗口会提示clearQueue方法被调用。

m)再次展开属性节点,双击CompositeDataSupport,head和sie的值将被重置。

通过“连接”->“退出”关闭JConsole。

   
 订阅
  捐助
相关文章

深度解析:清理烂代码
如何编写出拥抱变化的代码
重构-使代码更简洁优美
团队项目开发"编码规范"系列文章
相关文档

重构-改善既有代码的设计
软件重构v2
代码整洁之道
高质量编程规范
相关课程

基于HTML5客户端、Web端的应用开发
HTML 5+CSS 开发
嵌入式C高质量编程
C++高级编程
每天2个文档/视频
扫描微信二维码订阅
订阅技术月刊
获得每月300个技术资源
 
 

关于我们 | 联系我们 | 京ICP备10020922号 京公海网安备110108001071号