博客

如何使用Java Attach API？

  • Post category:Java

下面是Java AttachAPI的使用攻略。

1. 简介

Java AttachAPI是JDK中自带的一组API，它可以让我们通过Java程序来操作其他Java进程。它提供了许多接口，如VirtualMachine、VirtualMachineDescriptor等，可以用来执行远程方法调用、获取远程对象、获取进程ID等操作。使用AttachAPI需要注意以下两点：
* 必须使用和目标进程相同的JVM版本或更高版本；
* 必须具有访问目标进程的权限。

2. 示例

下面通过两个示例来讲解如何使用Java AttachAPI。

2.1 远程获取进程ID

获取进程ID是一种比较简单的使用场景，下面是示例代码：

import java.io.IOException;
import com.sun.tools.attach.AttachNotSupportedException;
import com.sun.tools.attach.VirtualMachine;
import com.sun.tools.attach.VirtualMachineDescriptor;

public class GetProcessID {

    public static void main(String[] args) throws AttachNotSupportedException, IOException {

        List<VirtualMachineDescriptor> list = VirtualMachine.list();
        for (VirtualMachineDescriptor vm : list) {
            if (vm.displayName().contains("<target-process-name>")) {
                VirtualMachine machine = VirtualMachine.attach(vm.id());
                System.out.println("Process ID of <target-process-name> is: " + machine.getSystemProperties().getProperty("pid"));
                machine.detach();
                break;
            }
        }

    }

}

首先我们通过VirtualMachine.list()获取到正在运行的所有Java进程，接着匹配目标进程的名称并获取它的ID，最后detach()即可。

2.2 可以在运行中的Java进程上执行JMX操作

这个示例展示了如何在运行中的Java进程上执行JMX操作，通过AttachAPI，我们可以获取到正在运行的Java进程的MBeanServerConnection，从而对其进行JMX操作。下面是示例代码：

“`java
import java.io.IOException;
import java.lang.management.ManagementFactory;
import java.util.Properties;
import javax.management.MBeanServerConnection;
import javax.management.remote.*;
import com.sun.tools.attach.AttachNotSupportedException;
import com.sun.tools.attach.VirtualMachine;
import com.sun.tools.attach.VirtualMachineDescriptor;

public class JMXOperation {

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

    List<VirtualMachineDescriptor> list = VirtualMachine.list();
    for (VirtualMachineDescriptor vm : list) {
        if (vm.displayName().contains("<target-process-name>")) {
            VirtualMachine machine = VirtualMachine.attach(vm.id());
            String connectorAddress = getJMXConnectorAddress(machine);
            JMXServiceURL url = new JMXServiceURL(connectorAddress);
            JMXConnector jmxc = JMXConnectorFactory.connect(url);
            MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();
            System.out.println(mbsc.getAttribute(ManagementFactory.OPERATING_SYSTEM_MXBEAN_NAME, "ProcessCpuLoad"));
            jmxc.close();
            machine.detach();
            break;
        }
    }

}

private static String getJMXConnectorAddress(VirtualMachine vm) throws Exception {
    Properties systemProperties = vm.getSystemProperties();
    String home = systemProperties.getProperty("java.home");
    String agent = home + File.separator + "lib" + File.separator + "management-agent.jar";
    vm.loadAgent(agent);
    Properties agentProperties = vm.getAgentProperties();
    return agentProperties.getProperty("com.sun.management.jmxremote.localConnectorAddress");
}

}
JMXOperation主要分为以下几个步骤：
1. 通过VirtualMachine.list()获取到正在运行的进程列表；
2. 寻找到目标进程，并attach()到目标进程；
3. 获取目标进程的JMXConnectorAddress，连接到MBeanServerConnection并获取操作所需的对象；
4. 执行操作，关闭连接，并最后detach()。

上面的示例代码中的getJMXConnectorAddress()方法是选取一个运行中的Java进程，通过AttachAPI获取它的JMXConnector地址的过程。最后我们通过getObjectInstance()获取到目标进程的MBeanServerConnection，然后就可以进行操作了。

Tags: