前言:
本周为了解决局点的主线共性问题,需要用到javaagent字节码增强技术,用于实现不同局点问题的解决,同时又要避免一些局点不能重启的问题;之前对java探针技术的了解是来自于skywalking的采集agent、cglib如何实现代理的和idea工具的热加载功能的实现原理,但是没有在实际工作中应用过,通过本周应用的实践,自己也收获很多,对技术较好的理解还是需要动手实践和深入分析;
今天在体检间隙也在了解attach的相关内容,这一块的知识还是需要一些时间分析整理,当前文章只对javaagent中的agentmain
使用过程中遇到的问题做一个总结,同时也输出一个完成使用实例;
简介:
1)JavaAgent是在JDK5之后提供的新特性,故名思义也可以叫java代理.他不是应用程序中的一部分,instrument支持以Java代理的形式监控或重新定义运行中的服务.可以让我们在不修改程序代码的前提下通过Instrumentation API改变运行中的java程序.
-javaagent命令要求指定的类中必须要有premain()方法
,并且必须满足以下两种格式:
public static void premain(String agentArgs, Instrumentation inst)
public static void premain(String agentArgs)
关于premain的使用介绍这里不再赘述,之前的文章已经介绍过了,大家有需求的可以翻看之前的文章;
2)从JDK6以来,我们可以通过agentmain方法
进行对JVM中运行的程序进行监控。然鹅不像premain由JVM启动时被调用,这个agentmain方法调用的时机是什么?我们又如何发送一个信号给目标虚拟机?
gentmain方法
调用的时机,自然是我们在一个进程中所触发的,它通过发送信号告诉另外一个进程,也就是目标JVM进程,此时要加载我们指定的agent。这个过程中,涉及进程间通信,在进程间传递命令与参数。
JDK提供了一种方式去实现这种通信:Attach API
。它的核心类为VirtualMachine
,其中的attach方法利用了UDS(Unix Domain socket)
原理实现了Linux中进程间的通信。
Unix domain socket
又叫 IPC
(inter-process communication 进程间通信) socket,用于实现同一主机上的进程间通信
。socket 原本是为网络通讯设计的,但后来在 socket 的框架上发展出一种 IPC 机制,就是 UNIX domain socket。虽然网络 socket
也可用于同一台主机的进程间通讯(通过 loopback 地址 127.0.0.1),但是 UNIX domain socket 用于 IPC 更有效率:不需要经过网络协议栈,不需要打包拆包、计算校验和、维护序号和应答等
,只是将应用层数据从一个进程拷贝到另一个进程。这是因为,IPC 机制本质上是可靠的通讯,而网络协议是为不可靠的通讯设计的。
UNIX domain socket 是全双工
的,API 接口语义丰富,相比其它 IPC 机制有明显的优越性,目前已成为使用最广泛的 IPC 机制,比如 X Window 服务器和 GUI 程序之间就是通过 UNIX domain socket 通讯的。
Unix domain socket
是 POSIX 标准中的一个组件,所以不要被名字迷惑,linux 系统也是支持它的。
注:作为一个软件开发者,应该对这种通讯协议有一定的热情!!!
agentmain
方法同样也有两种格式:
public static void premain(String agentArgs, Instrumentation instrumentation)
public static void premain(String agentArgs)
两个方法的执行也有先后顺序,如果第一个方法执行过了,第二个方法就不再执行
MANIFEST.MF配置文件说明:
Premain-Class: 包含 premain 方法的类(类的全路径名)
Agent-Class: 包含 agentmain 方法的类(类的全路径名)
Boot-Class-Path: 设置引导类加载器搜索的路径列表。查找类的特定于平台的机制失败后,引导类加载器会搜索这些路径。按列出的顺序搜索路径。列表中的路径由一个或多个空格分开。路径使用分层 URI 的路径组件语法。如果该路径以斜杠字符(“/”)开头,则为绝对路径,否则为相对路径。相对路径根据代理 JAR 文件的绝对路径解析。忽略格式不正确的路径和不存在的路径。如果代理是在 VM 启动之后某一时刻启动的,则忽略不表示 JAR 文件的路径。(可选)
Can-Redefine-Classes: true表示能重定义此代理所需的类,默认值为 false(可选)
Can-Retransform-Classes: true 表示能重转换此代理所需的类,默认值为 false (可选)
Can-Set-Native-Method-Prefix: true表示能设置此代理所需的本机方法前缀,默认值为 false(可选)
使用attach api:
使用java attach主要是为了实现服务不重启进行class类更新,即热加载方式;
我们主要使用到的Attach API很简单,涉及2个主要的类,都在com.sun.tools.attach包里面,分别为:
VirtualMachine
和VirtualMachineDescriptor
,这里不再做相信说明,有兴趣的同学可以自行了解,这一块的资料很多;
整理的业务流程图如下:
1)创建被修改项目testDemo;
这个项目主要用于验证agent热加载的代码有没有生效;
TaskService.java
package com.sk.service;
import lombok.SneakyThrows;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import java.util.concurrent.TimeUnit;
@Component
public class TaskService {
@SneakyThrows
public void run(){
//System.out.println("--------------------attach----join-----哈哈哈---------");
System.out.println("------------------------------1--");
long timeBefore = System.currentTimeMillis();
TimeUnit.SECONDS.sleep(3);
long timeAfter = System.currentTimeMillis();
System.out.println("-------time---(after-before:{})"+(timeAfter-timeBefore));
}
}
InitAction.java
package com.sk.service;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.concurrent.TimeUnit;
@Component
public class InitAction {
@Resource
private TaskService taskService;
@PostConstruct
public void task(){
Runnable r = new Runnable() {
@Override
public void run() {
while(true){
taskService.run();
try {
TimeUnit.SECONDS.sleep(5);
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
};
new Thread(r).start();
}
}
2)创建agent服务
FirstAgent.java
package com.sk.service;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.lang.instrument.ClassDefinition;
import java.lang.instrument.Instrumentation;
import java.lang.instrument.UnmodifiableClassException;
public class FirstAgent {
/*public static void premain(String agentArgs, Instrumentation inst){
System.out.println("1-----FirstAgent is Start.");
inst.addTransformer(new FirstTransformer());
}*/
public static void agentmain(String args, Instrumentation ins) {
System.out.println("2-----FirstAgent is Start.");
System.out.println("Agent-Main called , args : " + args);
System.out.println("------:"+ins.getAllLoadedClasses().length);
Class<?>[] cls = ins.getAllLoadedClasses();
int i=0;
for (Class<?> cl : cls) {
if (cl.getName().equals("com.sk.service.TaskService")) {
System.out.println(i+"---------"+cl.getName());
System.out.println("Find Demo.Class ! ");
String fileName = "G:\\work2\\javaAgent\\TaskService.class";
byte[] bytes = getBytesFromFile(fileName);
try {
ClassDefinition classDefinition = new ClassDefinition(cl, bytes);
ins.redefineClasses(classDefinition);
} catch (Exception e){
System.out.println("------error----"+e);
}
i++;
}
}
}
public static void agentmain(String args) {
System.out.println("-----attach-----00----"+args);
}
public static byte[] getBytesFromFile(String fileName) {
File file = new File(fileName);
Long filelength = file.length();
byte[] filecontent = new byte[filelength.intValue()];
FileInputStream in = null;
try {
in = new FileInputStream(file);
in.read(filecontent);
} catch (Exception e){
System.out.println(e);
}finally {
if(null != in){
try {
in.close();
} catch (IOException e) {
System.out.println(e);
}
}
}
return filecontent;
}
}
pom.xml文件
<build>
<plugins>
<plugin>
<!-- maven 打包插件 打原始jar包 第三方依赖打入jar包中-->
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifestEntries>
<!-- <Class-Path>.</Class-Path>-->
<!--<Premain-Class>com.sk.service.FirstAgent02</Premain-Class>-->
<Agent-Class>com.sk.service.FirstAgent</Agent-Class>
<Can-Redefine-Classes>true</Can-Redefine-Classes>
<Can-Retransform-Classes>true</Can-Retransform-Classes>
</manifestEntries>
</archive>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
<executions>
<execution>
<id>make-assembly</id> <!-- this is used for inheritance merges -->
<phase>package</phase> <!-- 指定在打包节点执行jar包合并操作 -->
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
注:如果第一次使用,pom.xml文件还是要梳理看一下,遇到问题时有助于理解
3)创建attach项目
在使用attach时遇到了两个问题:
问题一:tools.jar找不到
maven导入依赖以后发现缺少一个tools,解决方法也简单,直接在pom里面添加如下依赖
<dependency>
<groupId>com.sun</groupId>
<artifactId>tools</artifactId>
<version>1.8.0</version>
<scope>system</scope>
<systemPath>${env.JAVA_HOME}/lib/tools.jar</systemPath>
</dependency>
问题二:编译attach.jar包时,tools.jar没有被编译到包里面
解决方法:在pom文件中的build中添加resources
<resources>
<resource>
<directory>lib</directory>
<targetPath>BOOT-INF/lib/</targetPath>
<includes>
<include>${env.JAVA_HOME}/lib/tools.jar</include>
</includes>
</resource>
</resources>
Init.java
package com.sk.service;
import com.sun.tools.attach.VirtualMachine;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
import java.io.BufferedReader;
import java.io.InputStreamReader;
@Component
public class Init {
@PostConstruct
public void run() {
System.out.println("-----开始执行---attach----------------------1");
try {
String pid = getLinuxPid();
VirtualMachine virtualMachine = VirtualMachine.attach(pid);
virtualMachine.loadAgent("G:\\work2\\javaAgent\\patchAgent\\target\\patchAgent-0.0.1-jar-with-dependencies.jar");
virtualMachine.detach();
} catch (Exception e) {
e.printStackTrace();
}
}
public String getLinuxPid() {
String javaProcessName = "publicserver";
String cmd = "ps -ef|grep " + javaProcessName;
try {
Runtime rt = Runtime.getRuntime();
Process p = rt.exec(cmd);
BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
String line;
while ((line = br.readLine()) != null) {
String[] strs = line.split("\\s+");
return strs[1];
}
} catch (Exception e) {
System.out.println(e);
}
return null;
}
}
验证功能时,pid需要填写testDemo项目运行的进程pid
验证:
第一步:创建完成项目并运行项目,并获取testDemo项目运行进程的pid,由于我的验证环境是window环境,我就在cmd窗口获取进行pid,获取如下图:
第二步编译agent.jar
第三步在attach上配置agent.jar地址和testDemo项目运行pid信息,然后运行项目
testDemo运行结果变更:
由上图可以,agent变更内容已加载到testDemo项目运行JVM中,动态变更执行代码。
======济南-经十路的骑士