阅读本文前需要了解什么是jvmti,jvmti全称称之为 JVM Tool Interface,有关jvmti更详细的知识,本文不再详细列出。大家可以借助百度来了解有关它更为详尽的内容。
在开源文件大行其道的今天,基于java种种解决方案和框架纷绘踏至而来,浩瀚如海看不完也学不尽。在采用这些解决方案和框架进行项目开发时,往往会出现当程序卡壳时,既无异常提示信息亦没有与之对应的日志输出的局面。每每出现这样的困境时,往往只能通过打断点来一步步调试跟踪来解决。更有甚者,基于某一底层的框架进行相应的开发时,受限于框架开发者的精力和时间等因素的影响,如果框架针对某异常处理设计的不合理,处理异常时没有向外抛出异常,同时又没有输出日志信息。当出现问题时,雪上加霜的是框架又没有提供源码用于打断点调试,此时只能借助通过反编译工具,阅读框架源码来尝试解决问题。每每出现这些困境,真希望有一种工具能够洞悉那些被框架“吃掉”没有向往抛出的异常,以便加快问题的解决步伐。
为了方便开发,一直都想做一个有关java异常查看的小工具。想了很长时间,想到了如下几种实现方式:
- 借助字节码工具,在每一个方法开头和结尾处插入java异常捕获代码。这种方式实现起来效率太低了,况且如果在方法体内,捕获异常并没有向外抛出的话,就算采用这种方式也看不到异常。
- SpringMVC框架针对异常进行了统一的封装和处理,只要进行相应的扩展就能捕获到程序抛出的异常。这种实现方式较前一种比较看来,效率大大提高了,但是仍然没有解决前者提到的,如果应用程序内部自己“吃掉异常”,不向外抛出异常的话,依然无法捕捉到异常,而且这种实现实现方式仅仅局限于使用了SpringMVC框架的WEB应用程序,如果使用了其它的WEB架构或者非WEB的应用程序就会无能为力,局限性太强。
思来索去,想到java应用程序的运行肯定是离不开jvm的,不妨看一下jvm中有没有提供这样的扩展。在网上搜索了一番,发现jvm还真提供了这样的扩展。
JVM Tool Interface 链接地址:https://docs.oracle.com/javase/8/docs/platform/jvmti/jvmti.html#Exception
示例代码,在main方法中吃掉异常之后,不作任何处理。
package com.github.torlight.jvmtit; /**
* Hello world!
*
*/
public class App { public static void main( String[] args ){ System.out.println( "Hello World!" ); try {
throw new NullPointerException("QQQ");
} catch (Exception e) { }
}
}
程序加载相应的扩展,运行之后效果如下所示,可以看到在控制台上面,打印出空指针异常。如果不借助jvmti提供的异常事件进行相应的扩展话,控制台上就不会打印空指针异常信息。其实现原理也很简单,借助jvmti提供的异常事件进行相应的扩展,当jvm捕获到异常时,会回调针对该事件的扩展方法,在该方法体内部调用 printStackTrace 方法,打印异常提示信息。
java.lang.ClassNotFoundException: com.github.torlight.jvmtit.App
at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at java.lang.ClassLoader.loadClass(ClassLoader.java:411)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
at sun.launcher.LauncherHelper.checkAndLoadMain(LauncherHelper.java:495)
java.lang.ClassNotFoundException: com.github.torlight.jvmtit.App
at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
at java.lang.ClassLoader.loadClass(ClassLoader.java:411)
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:335)
at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
at sun.launcher.LauncherHelper.checkAndLoadMain(LauncherHelper.java:495)
15 java.lang.NullPointerException: QQQ
16 at com.github.torlight.jvmtit.App.main(App.java:14)
Hello World!
loaded class name=run in Callback_JVMTI_EVENT_EXCEPTION method
Exception: Ljava/lang/ClassNotFoundException;
loaded class name=run in Callback_JVMTI_EVENT_EXCEPTION method
Exception: Ljava/lang/ClassNotFoundException;
loaded class name=run in Callback_JVMTI_EVENT_EXCEPTION method
Exception: Ljava/lang/NullPointerException;
agent onload
下面贴出针对jvmti Callback_JVMTI_EVENT_EXCEPTION 事件进行扩展的agent代码。
// 这是主 DLL 文件。 #include "stdafx.h" #include "jvmti_evt_ex.h"
#include <stdio.h>
#include <memory.h>
#include <string.h>
#include <jvmti.h> 11 void printStackTrace(JNIEnv* env, jobject exception) {
12 jclass throwable_class = (*env).FindClass("java/lang/Throwable");
13 jmethodID print_method = (*env).GetMethodID(throwable_class, "printStackTrace", "()V");
14 (*env).CallVoidMethod(exception, print_method);
15 } void JNICALL Callback_JVMTI_EVENT_EXCEPTION (jvmtiEnv *jvmti_env,
JNIEnv* jni_env,
jthread thread,
jmethodID method,
jlocation location,
jobject exception,
jmethodID catch_method,
jlocation catch_location) { printf("loaded class name=%s\n ", "run in Callback_JVMTI_EVENT_EXCEPTION method");
char* class_name; jclass exception_class = jni_env->GetObjectClass(exception);
jvmti_env->GetClassSignature(exception_class, &class_name, NULL);
printf("Exception: %s\n", class_name); printStackTrace(jni_env, exception);
} void JNICALL Callback_JVMTI_EVENT_Exception_Catch (jvmtiEnv *jvmti_env,
JNIEnv* jni_env,
jthread thread,
jmethodID method,
jlocation location,
jobject exception) { char* class_name;
jclass exception_class = jni_env->GetObjectClass(exception);
jvmti_env->GetClassSignature(exception_class, &class_name, NULL);
printf("Exception: %s\n", class_name); printStackTrace(jni_env, exception);
} JNIEXPORT jint JNICALL Agent_OnLoad(JavaVM *vm, char *options, void *reserved){
jvmtiEnv *jvmti = NULL; fprintf(stderr,"agent onload"); //获取JVMTI environment
jint erno = vm->GetEnv((void **)&jvmti, JVMTI_VERSION_1_1);
if (erno != JNI_OK) {
fprintf(stderr, "ERROR: Couldn't get JVMTI environment");
return JNI_ERR;
} //注册功能
jvmtiCapabilities capabilities;
(void)memset(&capabilities, , sizeof(jvmtiCapabilities));
capabilities.can_generate_exception_events=1; jvmtiError error = jvmti->AddCapabilities(&capabilities);
if(error != JVMTI_ERROR_NONE) {
fprintf(stderr, "ERROR: Unable to AddCapabilities JVMTI");
return error;
} //设置JVM事件 (JVMTI_EVENT_EXCEPTION) 回调
jvmtiEventCallbacks ex_callbacks;
ex_callbacks.Exception = &Callback_JVMTI_EVENT_EXCEPTION;
error = jvmti->SetEventCallbacks(&ex_callbacks, (jint)sizeof(ex_callbacks));
if(error != JVMTI_ERROR_NONE) {
fprintf(stderr, "ERROR: Unable to SetEventCallbacks JVMTI!");
return error;
} //设置事件通知
error = jvmti->SetEventNotificationMode(JVMTI_ENABLE, JVMTI_EVENT_EXCEPTION, (jthread)NULL);
if(error != JVMTI_ERROR_NONE) {
fprintf(stderr, " ERROR: Unable to SetEventNotificationMode JVMTI!,the error code=%d",error);
return error;
} return JNI_OK;
} JNIEXPORT jint JNICALL
Agent_OnAttach(JavaVM* vm, char *options, void *reserved){
//do nothing return JNI_OK;
} JNIEXPORT void JNICALL
Agent_OnUnload(JavaVM *vm){
//do nothing }
示例代码和agent代码均已经上传至github上面(链接地址:https://github.com/gittorlight/java-other/tree/master/jvmti_evt_ex),我是用 visual studio 2010 来编译agent的,编译的时候需要根据所下载的jdk是32位还是64位来选择相对应的头文件。我使用的是64位的jdk 1.8,所以使用的是64位的头文件。截图如下所示:
编译agent截图(一)
编译agent截图(二)
编译agent截图(三)
编译完成agent之后,在应用程序的启动参数上面使用-agentpath 参数来加载该agent。以eclipse为例,截图如下所示:
加载agent截图(一)
加载agent截图(二)
加载agent截图(三)