Question

19.1.1. 介绍

可以使用标准Java管理扩展（Java Management Extensions, JMX）技术连接Flowable引擎，查询信息或修改配置。任何符合标准的JMX客户端都可以使用。通过JMX可以完成启用与禁用作业执行器、部署新的流程定义文件或删除流程等操作，而不需要写一行代码。

19.1.2. 快速开始

默认情况下没有启用JMX。用Maven或其他方法将flowable-jmx jar文件加入classpath即可使用默认配置启动JMX。如果使用Maven，可以在pom.xml中添加下列依赖：

<dependency>
  <groupId>org.flowable</groupId>
  <artifactId>flowable-jmx</artifactId>
  <version>latest.version</version>
</dependency>

在添加依赖并启动流程引擎后，就可以使用JMX进行连接了。可以使用在标准JDK发行版中提供的jconsole。在本地线程列表中，可以找到运行Flowable的JVM。如果在“本地进程”中没有列出Flowable的JVM，可以尝试使用这个URL从“远程进程”中连接：

service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi/flowable

可以在日志文件中找到正确的本地URL。连接成功后，可以看到标准的JVM信息以及MBean。选择MBeans页签，并在右侧面板选择"org.flowable.jmx.Mbeans"，查看Flowable的MBean。选择任何MBean，都可以查询相应的信息或修改配置。如下图所示：

不只是jconsole，任何JMX客户端都可以访问 MBeans。大多数数据中心的监控工具都会提供连接至JMX MBeans的连接器。

19.1.3. 属性与操作

下表是目前可用的属性与操作的列表。这个列表可能根据需要在未来版本中扩展。

MBean	类型	名字	描述
ProcessDefinitionsMBean	属性	processDefinitions	已部署流程定义的Id、Name、Version、IsSuspended等参数，是一个字符串的list
	属性	deployments	当前部署的Id、Name、TenantId参数
	方法	getProcessDefinitionById(String id)	给定id流程定义的Id、Name、Version与IsSuspended参数
	方法	deleteDeployment(String id)	删除给定Id的部署
	方法	suspendProcessDefinitionById(String id)	暂停给定Id的流程定义
	方法	activatedProcessDefinitionById(String id)	激活给定Id的流程定义
	方法	suspendProcessDefinitionByKey(String id)	暂停给定key的流程定义
	方法	activatedProcessDefinitionByKey(String id)	激活给定key的流程定义
	方法	deployProcessDefinition(String resourceName, String processDefinitionFile)	部署流程定义文件
JobExecutorMBean	属性	isJobExecutorActivated	返回作业执行器是否在运行
	方法	setJobExecutorActivate(Boolean active)	启用或停用作业执行器

19.1.4. 配置

JMX默认配置为最常使用的配置，以简化部署。但也可以很容易地以代码或配置文件的方式修改默认配置。下列代码展示了如何修改配置文件：

<bean class="...SomeProcessEngineConfigurationClass">
  ...
  <property name="configurators">
  <list>
	  <bean class="org.flowable.management.jmx.JMXConfigurator">

	  <property name="connectorPort" value="1912" />
    <property name="serviceUrlPath" value="/jmxrmi/flowable" />

		...
    </bean>
  </list>
  </property>
</bean>

下表展示了可配置的参数与其默认值：

名字	默认值	描述
disabled	false	若值为true，即使已添加依赖也不会启动JMX
domain	org.flowable.jmx.Mbeans	MBean的域
createConnector	true	若值为true，则会创建一个连接器至MbeanServer
MBeanDomain	DefaultDomain	MBean服务器的域
registryPort	1099	注册端口，组成服务URL
serviceUrlPath	/jmxrmi/flowable	组成服务URL
connectorPort	-1	如果大于0，则作为连接端口组成服务URL

19.1.5. JMX服务URL

JMX服务URL格式如下：

service:jmx:rmi://<hostName>:<connectorPort>/jndi/rmi://<hostName>:<registryPort>/<serviceUrlPath>

hostName自动设置为机器的网络名。可以配置connectorPort、registryPort与serviceUrlPath。

如果connectionPort小于0，则服务URL不包括这部分，简化为：

service:jmx:rmi:///jndi/rmi://:<hostname>:<registryPort>/<serviceUrlPath>