java.lang.instrument.Instrumentation文档翻译

最新推荐文章于 2023-10-21 23:53:20 发布

原创最新推荐文章于 2023-10-21 23:53:20 发布 · 528 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java #jvm #开发语言

Opentelemetry 专栏收录该内容

1 篇文章

订阅专栏

Java的Instrumentation接口提供了对Java代码进行插装（Instrumentation）的服务，允许在方法上添加字节码以收集数据供工具使用。接口方法包括注册类文件转换器、重定义和重新转型类等，支持监控、分析、覆盖率检查和日志记录等良性工具。获取Instrumentation实例的方式有两种：一是JVM启动时传给agent的premain方法，二是JVM运行时通过agentmain方法。接口还提供了判断类是否可修改、是否支持类的再定义和再转型等功能。

包：java.lang.instrument

Instrumentation接口

public interface Instrumentation

这个类提供了插装（Instrument）Java编程语言代码的服务。插装（Instrument）是在方法上添加字节码，获取数据后提供给工具（tools）使用。这些改变完全是附加的（additive），因此这些工具并没有改变应用的状态和行为。

这些温和的工具（benign tools）包括monitoring agents, profilers, coverage analyzers 甚至 loggers。

有两种方法获取Instrumentation接口的实例，他们在 包规范中均有描述。一旦agent获取了Instrumentation接口的实例，就可以在任何时间调用（call）该实例的方法。这个接口自JDK 1.5开始提供。

当JVM同agent一起启动（launch）时。这种情况下，Instrumentation 实例被传递（passed）给agent的premain 方法.
当JVM提供了虚拟机启动后再启动agent的机制时。这种情况下，Instrumentation 实例被传递（passed）给agent的agentmain 方法.

This class provides services needed to instrument Java programming language code. Instrumentation is the addition of byte-codes to methods for the purpose of gathering data to be utilized by tools. Since the changes are purely additive, these tools do not modify application state or behavior. Examples of such benign tools include monitoring agents, profilers, coverage analyzers, and event loggers.

There are two ways to obtain an instance of the Instrumentation interface:

These mechanisms are described in the package specification.

Once an agent acquires an Instrumentation instance, the agent may call methods on the instance at any time.

Since:

1.5

When a JVM is launched in a way that indicates an agent class. In that case an Instrumentation instance is passed to the premain method of the agent class.
When a JVM provides a mechanism to start agents sometime after the JVM is launched. In that case an Instrumentation instance is passed to the agentmain method of the agent code.

方法概览


Modifier and Type	Method and Description
`void`	`addTransformer(ClassFileTransformer transformer)` 注册给定的transformer Registers the supplied transformer.
`void`	`addTransformer(ClassFileTransformer transformer, boolean canRetransform)` 注册给定的transformer Registers the supplied transformer.
`void`	`appendToBootstrapClassLoaderSearch(JarFile jarfile)` 指定一个JAR文件，其中包含将会被（to be）BootstrapClassLoader定义的instrumentation类 Specifies a JAR file with instrumentation classes to be defined by the bootstrap class loader.
`void`	`appendToSystemClassLoaderSearch(JarFile jarfile)` 指定一个JAR文件，其中包含将会被（to be）SystemClassLoader定义的instrumentation类 Specifies a JAR file with instrumentation classes to be defined by the system class loader.
`Class[]`	`getAllLoadedClasses()` `返回当前JVM加载的所有类的array` Returns an array of all classes currently loaded by the JVM.
`Class[]`	`getInitiatedClasses(ClassLoader loader)` 返`回当前JVM initiating loader加载的所有类的array` Returns an array of all classes for which `loader` is an initiating loader.
`long`	`getObjectSize(Object objectToSize)` 返回基于特定实现的指定对象消耗存储量的特定近似值。 Returns an implementation-specific approximation of the amount of storage consumed by the specified object.
`boolean`	`isModifiableClass(Class<?> theClass)` 决定一个类能够被 retransformation or redefinition修改 Determines whether a class is modifiable by retransformation or redefinition.
`boolean`	`isNativeMethodPrefixSupported()` `返回当前JVM配置能否支持设置一个native方法前缀` Returns whether the current JVM configuration supports setting a native method prefix.
`boolean`	`isRedefineClassesSupported()` `返回当前JVM配置能否支持类的redefinition` Returns whether or not the current JVM configuration supports redefinition of classes.
`boolean`	`isRetransformClassesSupported()` `返回当前JVM配置能否支持类的`retransformation Returns whether or not the current JVM configuration supports retransformation of classes.
`void`	`redefineClasses(ClassDefinition... definitions)` 使用提供的类文件重新定义提供的类集 Redefine the supplied set of classes using the supplied class files.
`boolean`	`removeTransformer(ClassFileTransformer transformer)` `注册提供的transformer` Unregisters the supplied transformer.
`void`	`retransformClasses(Class<?>... classes)` Retransform提供的类集 Retransform the supplied set of classes.
`void`	`setNativeMethodPrefix(ClassFileTransformer transformer, String prefix)` 此方法通过允许使用应用于名称的前缀重试来修改本机方法解析的失败处理 This method modifies the failure handling of native method resolution by allowing retry with a prefix applied to the name.

- Method Detail
  - addTransformer
```
void addTransformer(ClassFileTransformer transformer,
                    boolean canRetransform)
```
    Registers the supplied transformer. All future class definitions will be seen by the transformer, except definitions of classes upon which any registered transformer is dependent. The transformer is called when classes are loaded, when they are redefined. and if canRetransform is true, when they are retransformed. See ClassFileTransformer.transform for the order of transform calls. If a transformer throws an exception during execution, the JVM will still call the other registered transformers in order. The same transformer may be added more than once, but it is strongly discouraged -- avoid this by creating a new instance of transformer class.
    This method is intended for use in instrumentation, as described in the class specification.
    
    Parameters:
    
    transformer - the transformer to register
    
    canRetransform - can this transformer's transformations be retransformed
    
    Throws:
    
    NullPointerException - if passed a null transformer
    
    UnsupportedOperationException - if canRetransform is true and the current configuration of the JVM does not allow retransformation (isRetransformClassesSupported() is false)
    
    Since:
    
    1.6
  - addTransformer
```
void addTransformer(ClassFileTransformer transformer)
```
    Registers the supplied transformer.
    Same as addTransformer(transformer, false).
    
    Parameters:
    
    transformer - the transformer to register
    
    Throws:
    
    NullPointerException - if passed a null transformer
    
    See Also:
    
    addTransformer(ClassFileTransformer,boolean)
  - removeTransformer
```
boolean removeTransformer(ClassFileTransformer transformer)
```
    Unregisters the supplied transformer. Future class definitions will not be shown to the transformer. Removes the most-recently-added matching instance of the transformer. Due to the multi-threaded nature of class loading, it is possible for a transformer to receive calls after it has been removed. Transformers should be written defensively to expect this situation.
    
    Parameters:
    
    transformer - the transformer to unregister
    
    Returns:
    
    true if the transformer was found and removed, false if the transformer was not found
    
    Throws:
    
    NullPointerException - if passed a null transformer
  - isRetransformClassesSupported
```
boolean isRetransformClassesSupported()
```
    Returns whether or not the current JVM configuration supports retransformation of classes. The ability to retransform an already loaded class is an optional capability of a JVM. Retransformation will only be supported if the Can-Retransform-Classes manifest attribute is set to true in the agent JAR file (as described in the package specification) and the JVM supports this capability. During a single instantiation of a single JVM, multiple calls to this method will always return the same answer.
    
    Returns:
    
    true if the current JVM configuration supports retransformation of classes, false if not.
    
    Since:
    
    1.6
    
    See Also:
    
    retransformClasses(java.lang.Class<?>...)
  - retransformClasses
```
void retransformClasses(Class<?>... classes)
                 throws UnmodifiableClassException
```
    Retransform the supplied set of classes.
    This function facilitates the instrumentation of already loaded classes. When classes are initially loaded or when they are redefined, the initial class file bytes can be transformed with the ClassFileTransformer. This function reruns the transformation process (whether or not a transformation has previously occurred). This retransformation follows these steps:
    - starting from the initial class file bytes
    - for each transformer that was added with canRetransform false, the bytes returned by transform during the last class load or redefine are reused as the output of the transformation; note that this is equivalent to reapplying the previous transformation, unaltered; except that transform is not called
    - for each transformer that was added with canRetransform true, the transform method is called in these transformers
    - the transformed class file bytes are installed as the new definition of the class
    The order of transformation is described in the transform method. This same order is used in the automatic reapplication of retransformation incapable transforms.
    
    The initial class file bytes represent the bytes passed to ClassLoader.defineClass or redefineClasses (before any transformations were applied), however they might not exactly match them. The constant pool might not have the same layout or contents. The constant pool may have more or fewer entries. Constant pool entries may be in a different order; however, constant pool indices in the bytecodes of methods will correspond. Some attributes may not be present. Where order is not meaningful, for example the order of methods, order might not be preserved.
    
    This method operates on a set in order to allow interdependent changes to more than one class at the same time (a retransformation of class A can require a retransformation of class B).
    
    If a retransformed method has active stack frames, those active frames continue to run the bytecodes of the original method. The retransformed method will be used on new invokes.
    
    This method does not cause any initialization except that which would occur under the customary JVM semantics. In other words, redefining a class does not cause its initializers to be run. The values of static variables will remain as they were prior to the call.
    
    Instances of the retransformed class are not affected.
    
    The retransformation may change method bodies, the constant pool and attributes. The retransformation must not add, remove or rename fields or methods, change the signatures of methods, or change inheritance. These restrictions maybe be lifted in future versions. The class file bytes are not checked, verified and installed until after the transformations have been applied, if the resultant bytes are in error this method will throw an exception.
    
    If this method throws an exception, no classes have been retransformed.
    
    This method is intended for use in instrumentation, as described in the class specification.
    
    Parameters:
    
    classes - array of classes to retransform; a zero-length array is allowed, in this case, this method does nothing
    
    Throws:
    
    UnmodifiableClassException - if a specified class cannot be modified (isModifiableClass(java.lang.Class<?>) would return false)
    
    UnsupportedOperationException - if the current configuration of the JVM does not allow retransformation (isRetransformClassesSupported() is false) or the retransformation attempted to make unsupported changes
    
    ClassFormatError - if the data did not contain a valid class
    
    NoClassDefFoundError - if the name in the class file is not equal to the name of the class
    
    UnsupportedClassVersionError - if the class file version numbers are not supported
    
    ClassCircularityError - if the new classes contain a circularity
    
    LinkageError - if a linkage error occurs
    
    NullPointerException - if the supplied classes array or any of its components is null.
    
    Since:
    
    1.6
    
    See Also:
    
    isRetransformClassesSupported(), addTransformer(java.lang.instrument.ClassFileTransformer, boolean), ClassFileTransformer
  - isRedefineClassesSupported
```
boolean isRedefineClassesSupported()
```
    Returns whether or not the current JVM configuration supports redefinition of classes. The ability to redefine an already loaded class is an optional capability of a JVM. Redefinition will only be supported if the Can-Redefine-Classes manifest attribute is set to true in the agent JAR file (as described in the package specification) and the JVM supports this capability. During a single instantiation of a single JVM, multiple calls to this method will always return the same answer.
    
    Returns:
    
    true if the current JVM configuration supports redefinition of classes, false if not.
    
    See Also:
    
    redefineClasses(java.lang.instrument.ClassDefinition...)
  - redefineClasses
```
void redefineClasses(ClassDefinition... definitions)
              throws ClassNotFoundException,
                     UnmodifiableClassException
```
    Redefine the supplied set of classes using the supplied class files.
    This method is used to replace the definition of a class without reference to the existing class file bytes, as one might do when recompiling from source for fix-and-continue debugging. Where the existing class file bytes are to be transformed (for example in bytecode instrumentation) retransformClasses should be used.
    
    This method operates on a set in order to allow interdependent changes to more than one class at the same time (a redefinition of class A can require a redefinition of class B).
    
    If a redefined method has active stack frames, those active frames continue to run the bytecodes of the original method. The redefined method will be used on new invokes.
    
    This method does not cause any initialization except that which would occur under the customary JVM semantics. In other words, redefining a class does not cause its initializers to be run. The values of static variables will remain as they were prior to the call.
    
    Instances of the redefined class are not affected.
    
    The redefinition may change method bodies, the constant pool and attributes. The redefinition must not add, remove or rename fields or methods, change the signatures of methods, or change inheritance. These restrictions maybe be lifted in future versions. The class file bytes are not checked, verified and installed until after the transformations have been applied, if the resultant bytes are in error this method will throw an exception.
    
    If this method throws an exception, no classes have been redefined.
    
    This method is intended for use in instrumentation, as described in the class specification.
    
    Parameters:
    
    definitions - array of classes to redefine with corresponding definitions; a zero-length array is allowed, in this case, this method does nothing
    
    Throws:
    
    UnmodifiableClassException - if a specified class cannot be modified (isModifiableClass(java.lang.Class<?>) would return false)
    
    UnsupportedOperationException - if the current configuration of the JVM does not allow redefinition (isRedefineClassesSupported() is false) or the redefinition attempted to make unsupported changes
    
    ClassFormatError - if the data did not contain a valid class
    
    NoClassDefFoundError - if the name in the class file is not equal to the name of the class
    
    UnsupportedClassVersionError - if the class file version numbers are not supported
    
    ClassCircularityError - if the new classes contain a circularity
    
    LinkageError - if a linkage error occurs
    
    NullPointerException - if the supplied definitions array or any of its components is null
    
    ClassNotFoundException - Can never be thrown (present for compatibility reasons only)
    
    See Also:
    
    isRedefineClassesSupported(), addTransformer(java.lang.instrument.ClassFileTransformer, boolean), ClassFileTransformer
  - isModifiableClass
```
boolean isModifiableClass(Class<?> theClass)
```
    Determines whether a class is modifiable by retransformation or redefinition. If a class is modifiable then this method returns true. If a class is not modifiable then this method returns false.
    For a class to be retransformed, isRetransformClassesSupported() must also be true. But the value of isRetransformClassesSupported() does not influence the value returned by this function. For a class to be redefined, isRedefineClassesSupported() must also be true. But the value of isRedefineClassesSupported() does not influence the value returned by this function.
    
    Primitive classes (for example, java.lang.Integer.TYPE) and array classes are never modifiable.
    
    Parameters:
    
    theClass - the class to check for being modifiable
    
    Returns:
    
    whether or not the argument class is modifiable
    
    Throws:
    
    NullPointerException - if the specified class is null.
    
    Since:
    
    1.6
    
    See Also:
    
    retransformClasses(java.lang.Class<?>...), isRetransformClassesSupported(), redefineClasses(java.lang.instrument.ClassDefinition...), isRedefineClassesSupported()
  - getAllLoadedClasses
```
Class[] getAllLoadedClasses()
```
    Returns an array of all classes currently loaded by the JVM.
    
    Returns:
    
    an array containing all the classes loaded by the JVM, zero-length if there are none
  - getInitiatedClasses
```
Class[] getInitiatedClasses(ClassLoader loader)
```
    Returns an array of all classes for which loader is an initiating loader. If the supplied loader is null, classes initiated by the bootstrap class loader are returned.
    
    Parameters:
    
    loader - the loader whose initiated class list will be returned
    
    Returns:
    
    an array containing all the classes for which loader is an initiating loader, zero-length if there are none
  - getObjectSize
```
long getObjectSize(Object objectToSize)
```
    Returns an implementation-specific approximation of the amount of storage consumed by the specified object. The result may include some or all of the object's overhead, and thus is useful for comparison within an implementation but not between implementations. The estimate may change during a single invocation of the JVM.
    
    Parameters:
    
    objectToSize - the object to size
    
    Returns:
    
    an implementation-specific approximation of the amount of storage consumed by the specified object
    
    Throws:
    
    NullPointerException - if the supplied Object is null.
  - appendToBootstrapClassLoaderSearch
```
void appendToBootstrapClassLoaderSearch(JarFile jarfile)
```
    指定一个JAR文件，其中包含bootstrap class loader定义的instrument类。
    
    当虚拟机的内置类加载器（称为“bootstrap类加载器”）搜索一个类失败时，JAR文件中的条目也将被搜索。
    
    可以多次使用此方法来添加多个JAR文件，以便按照调用此方法的顺序进行搜索。
    
    代理应该注意确保JAR不包含任何类或资源，而不是引导类加载器为了插装而定义的类或资源。不遵守此警告可能导致难以诊断的意外行为。例如，假设有一个装入器L，L的委托父级是引导类装入器。此外，类C（由L定义的类）中的方法引用了非公共访问器类C$1。如果JAR文件包含一个C$1类，那么对引导类装入器的委托将导致引导类装入器定义C$1。在本例中，将抛出可能导致应用程序失败的IllegalAccessError。避免这些类型问题的一种方法是为插装类使用唯一的包名。
    
    JVM规范指定，后续尝试解析Java虚拟机以前尝试解析失败的符号引用时，总是会失败，并出现与初始解析尝试相同的错误。因此，如果JAR文件包含与Java虚拟机尝试解析引用失败的类对应的条目，则后续解析该引用的尝试将失败，并出现与初始尝试相同的错误。
  - Specifies a JAR file with instrumentation classes to be defined by the bootstrap class loader.
    When the virtual machine's built-in class loader, known as the "bootstrap class loader", unsuccessfully searches for a class, the entries in the JAR file will be searched as well.
    
    This method may be used multiple times to add multiple JAR files to be searched in the order that this method was invoked.
    
    The agent should take care to ensure that the JAR does not contain any classes or resources other than those to be defined by the bootstrap class loader for the purpose of instrumentation. Failure to observe this warning could result in unexpected behavior that is difficult to diagnose. For example, suppose there is a loader L, and L's parent for delegation is the bootstrap class loader. Furthermore, a method in class C, a class defined by L, makes reference to a non-public accessor class C$1. If the JAR file contains a class C$1 then the delegation to the bootstrap class loader will cause C$1 to be defined by the bootstrap class loader. In this example an IllegalAccessError will be thrown that may cause the application to fail. One approach to avoiding these types of issues, is to use a unique package name for the instrumentation classes.
    
    The Java™ Virtual Machine Specification specifies that a subsequent attempt to resolve a symbolic reference that the Java virtual machine has previously unsuccessfully attempted to resolve always fails with the same error that was thrown as a result of the initial resolution attempt. Consequently, if the JAR file contains an entry that corresponds to a class for which the Java virtual machine has unsuccessfully attempted to resolve a reference, then subsequent attempts to resolve that reference will fail with the same error as the initial attempt.
    
    Parameters:
    
    jarfile - The JAR file to be searched when the bootstrap class loader unsuccessfully searches for a class.
    
    Throws:
    
    NullPointerException - If jarfile is null.
    
    Since:
    
    1.6
    
    See Also:
    
    appendToSystemClassLoaderSearch(java.util.jar.JarFile), ClassLoader, JarFile
  - appendToSystemClassLoaderSearch
```
void appendToSystemClassLoaderSearch(JarFile jarfile)
```
    Specifies a JAR file with instrumentation classes to be defined by the system class loader. When the system class loader for delegation (see getSystemClassLoader()) unsuccessfully searches for a class, the entries in the JarFile will be searched as well.
    This method may be used multiple times to add multiple JAR files to be searched in the order that this method was invoked.
    
    The agent should take care to ensure that the JAR does not contain any classes or resources other than those to be defined by the system class loader for the purpose of instrumentation. Failure to observe this warning could result in unexpected behavior that is difficult to diagnose (see appendToBootstrapClassLoaderSearch).
    
    The system class loader supports adding a JAR file to be searched if it implements a method named appendToClassPathForInstrumentation which takes a single parameter of type java.lang.String. The method is not required to have public access. The name of the JAR file is obtained by invoking the getName() method on the jarfile and this is provided as the parameter to the appendToClassPathForInstrumentation method.
    
    The Java™ Virtual Machine Specification specifies that a subsequent attempt to resolve a symbolic reference that the Java virtual machine has previously unsuccessfully attempted to resolve always fails with the same error that was thrown as a result of the initial resolution attempt. Consequently, if the JAR file contains an entry that corresponds to a class for which the Java virtual machine has unsuccessfully attempted to resolve a reference, then subsequent attempts to resolve that reference will fail with the same error as the initial attempt.
    
    This method does not change the value of java.class.path system property.
    
    Parameters:
    
    jarfile - The JAR file to be searched when the system class loader unsuccessfully searches for a class.
    
    Throws:
    
    UnsupportedOperationException - If the system class loader does not support appending a a JAR file to be searched.
    
    NullPointerException - If jarfile is null.
    
    Since:
    
    1.6
    
    See Also:
    
    appendToBootstrapClassLoaderSearch(java.util.jar.JarFile), ClassLoader.getSystemClassLoader(), JarFile
  - isNativeMethodPrefixSupported
```
boolean isNativeMethodPrefixSupported()
```
    Returns whether the current JVM configuration supports setting a native method prefix. The ability to set a native method prefix is an optional capability of a JVM. Setting a native method prefix will only be supported if the Can-Set-Native-Method-Prefix manifest attribute is set to true in the agent JAR file (as described in the package specification) and the JVM supports this capability. During a single instantiation of a single JVM, multiple calls to this method will always return the same answer.
    
    Returns:
    
    true if the current JVM configuration supports setting a native method prefix, false if not.
    
    Since:
    
    1.6
    
    See Also:
    
    setNativeMethodPrefix(java.lang.instrument.ClassFileTransformer, java.lang.String)
  - setNativeMethodPrefix
```
void setNativeMethodPrefix(ClassFileTransformer transformer,
                           String prefix)
```
    This method modifies the failure handling of native method resolution by allowing retry with a prefix applied to the name. When used with the ClassFileTransformer, it enables native methods to be instrumented.
    Since native methods cannot be directly instrumented (they have no bytecodes), they must be wrapped with a non-native method which can be instrumented. For example, if we had:
```
   native boolean foo(int x);
```
    We could transform the class file (with the ClassFileTransformer during the initial definition of the class) so that this becomes:
```
   boolean foo(int x) {
     ... record entry to foo ...
     return wrapped_foo(x);
   }

   native boolean wrapped_foo(int x);
```
    Where foo becomes a wrapper for the actual native method with the appended prefix "wrapped_". Note that "wrapped_" would be a poor choice of prefix since it might conceivably form the name of an existing method thus something like "$$$MyAgentWrapped$$$_" would be better but would make these examples less readable.
    
    The wrapper will allow data to be collected on the native method call, but now the problem becomes linking up the wrapped method with the native implementation. That is, the method wrapped_foo needs to be resolved to the native implementation of foo, which might be:
```
   Java_somePackage_someClass_foo(JNIEnv* env, jint x)
```
    This function allows the prefix to be specified and the proper resolution to occur. Specifically, when the standard resolution fails, the resolution is retried taking the prefix into consideration. There are two ways that resolution occurs, explicit resolution with the JNI function RegisterNatives and the normal automatic resolution. For RegisterNatives, the JVM will attempt this association:
```
   method(foo) -> nativeImplementation(foo)
 
```
    When this fails, the resolution will be retried with the specified prefix prepended to the method name, yielding the correct resolution:
```
   method(wrapped_foo) -> nativeImplementation(foo)
 
```
    For automatic resolution, the JVM will attempt:
```
   method(wrapped_foo) -> nativeImplementation(wrapped_foo)
 
```
    When this fails, the resolution will be retried with the specified prefix deleted from the implementation name, yielding the correct resolution:
```
   method(wrapped_foo) -> nativeImplementation(foo)
 
```
    Note that since the prefix is only used when standard resolution fails, native methods can be wrapped selectively.
    
    Since each ClassFileTransformer can do its own transformation of the bytecodes, more than one layer of wrappers may be applied. Thus each transformer needs its own prefix. Since transformations are applied in order, the prefixes, if applied, will be applied in the same order (see addTransformer). Thus if three transformers applied wrappers, foo might become $trans3_$trans2_$trans1_foo. But if, say, the second transformer did not apply a wrapper to foo it would be just $trans3_$trans1_foo. To be able to efficiently determine the sequence of prefixes, an intermediate prefix is only applied if its non-native wrapper exists. Thus, in the last example, even though $trans1_foo is not a native method, the $trans1_ prefix is applied since $trans1_foo exists.
    
    Parameters:
    
    transformer - The ClassFileTransformer which wraps using this prefix.
    
    prefix - The prefix to apply to wrapped native methods when retrying a failed native method resolution. If prefix is either null or the empty string, then failed native method resolutions are not retried for this transformer.
    
    Throws:
    
    NullPointerException - if passed a null transformer.
    
    UnsupportedOperationException - if the current configuration of the JVM does not allow setting a native method prefix (isNativeMethodPrefixSupported() is false).
    
    IllegalArgumentException - if the transformer is not registered (see addTransformer).
    
    Since:
    
    1.6