使用ASM 4处理Java类文件–第二部分：Tree API

最新推荐文章于 2024-06-20 22:27:44 发布
最新推荐文章于 2024-06-20 22:27:44 发布
阅读量405 收藏
点赞数
文章标签： java python jvm jdk spring
什么是ASM树API： ASM树API是ASM的一部分，可让您创建/修改内存中的类。 该类被视为信息树。 像整个类一样，它是ClassNode的实例，其中包含FieldNode对象列表，MethodNode对象列表等。本文假设读者已经在这里阅读了第一部分。

通过树API的简单类：让我们使用树API创建我们的第一类。 同样，我将直接进入一个代码示例，因为没有什么比代码示例更好。 生成的类具有打印“ Hello World！”的主要方法。

TreeAPIDemo.java 

package com.geekyarticles.asm;

import java.io.DataOutputStream;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;

import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.tree.ClassNode;
import org.objectweb.asm.tree.FieldInsnNode;
import org.objectweb.asm.tree.InsnNode;
import org.objectweb.asm.tree.LdcInsnNode;
import org.objectweb.asm.tree.MethodInsnNode;
import org.objectweb.asm.tree.MethodNode;


public class TreeAPIDemo {
    public static void main(String [] args) throws Exception{
        
        ClassNode classNode=new ClassNode(4);//4 is just the API version number
        
        //These properties of the classNode must be set
        classNode.version=Opcodes.V1_6;//The generated class will only run on JRE 1.6 or above
        classNode.access=Opcodes.ACC_PUBLIC;
        classNode.signature="Lcom/geekyarticles/asm/Generated;";
        classNode.name="com/geekyarticles/asm/Generated";
        classNode.superName="java/lang/Object";
        
        //Create a method
        MethodNode mainMethod=new MethodNode(4,Opcodes.ACC_PUBLIC|Opcodes.ACC_STATIC,"main", "([Ljava/lang/String;)V",null, null);
        
        mainMethod.instructions.add(new FieldInsnNode(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;"));
        mainMethod.instructions.add(new LdcInsnNode("Hello World!"));
        mainMethod.instructions.add(new MethodInsnNode(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V"));
        mainMethod.instructions.add(new InsnNode(Opcodes.RETURN));

        //Add the method to the classNode
        classNode.methods.add(mainMethod);
        
        //Write the class
        ClassWriter cw=new ClassWriter(ClassWriter.COMPUTE_MAXS|ClassWriter.COMPUTE_FRAMES);
        classNode.accept(cw);
        
        //Dump the class in a file
        File outDir=new File("out/com/geekyarticles/asm");
        outDir.mkdirs();
        DataOutputStream dout=new DataOutputStream(new FileOutputStream(new File(outDir,"Generated.class")));
        dout.write(cw.toByteArray());
        dout.flush();
        dout.close();
        
    }
}

如您所见，代码非常简单。 与BCEL相比，它的主要优点是与BCEL不同，ASM不需要您将每个常量显式添加到常量池中。 相反，ASM会照顾常量池本身。

读取类文件： ClassNode是ClassVisitor。 因此，读取用于树API的类就像创建ClassReader对象并使用它读取类文件一样简单，同时将ClassNode对象作为其accept方法传递给参数。 完成此操作后，将通过类中存在的所有信息完全初始化传递的ClassNode。 在下面的示例中，我们将打印类中的所有方法。

TreeAPIClassReaderDemo.java 

package com.geekyarticles.asm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.tree.ClassNode;
import org.objectweb.asm.tree.MethodNode;

public class TreeAPIClassReaderDemo {

    public static void main(String[] args) throws Exception{
        InputStream in=new FileInputStream("out/com/geekyarticles/asm/Generated.class");
        
        ClassReader cr=new ClassReader(in);
        ClassNode classNode=new ClassNode();
        
        //ClassNode is a ClassVisitor
        cr.accept(classNode, 0);
        
        //Let's move through all the methods
        
        for(MethodNode methodNodeclassNode.methods){
            System.out.println(methodNode.name+"  "+methodNode.desc);
        }

    }

}

修改类文件：修改类文件是上述两个过程的组合。 我们首先以通常的方式读取该类，对数据进行必要的更改，然后将其写回到文件中。 以下程序实现了一些日志代码的自动注入。 当前，我们的Logger类仅打印到标准输出。 @Loggable注释的每个方法在开始和返回时都将被记录。 在此，我们不记录throw-exception。 但是，也可以通过检查操作码ATHROW以相同的方式实现。

LoggingInsertion.java 

package com.geekyarticles.asm;

import java.io.DataOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.util.Iterator;

import org.objectweb.asm.ClassReader;
import org.objectweb.asm.ClassWriter;
import org.objectweb.asm.Opcodes;
import org.objectweb.asm.tree.AbstractInsnNode;
import org.objectweb.asm.tree.AnnotationNode;
import org.objectweb.asm.tree.ClassNode;
import org.objectweb.asm.tree.InsnList;
import org.objectweb.asm.tree.LdcInsnNode;
import org.objectweb.asm.tree.MethodInsnNode;
import org.objectweb.asm.tree.MethodNode;

public class LoggingInsertion {

    public static void main(String[] args) throws Exception{
        InputStream in=LoggingInsertion.class.getResourceAsStream("/com/geekyarticles/asm/LoggingTest.class");

        ClassReader cr=new ClassReader(in);
        ClassNode classNode=new ClassNode();
        cr.accept(classNode, 0);

        //Let's move through all the methods

        for(MethodNode methodNodeclassNode.methods){
            System.out.println(methodNode.name+"  "+methodNode.desc);
            boolean hasAnnotation=false;
            if(methodNode.visibleAnnotations!=null){
                for(AnnotationNode annotationNodemethodNode.visibleAnnotations){
                    if(annotationNode.desc.equals("Lcom/geekyarticles/asm/Loggable;")){
                        hasAnnotation=true;
                        break;
                    }
                }
            }
            if(hasAnnotation){
                //Lets insert the begin logger
                InsnList beginList=new InsnList();
                beginList.add(new LdcInsnNode(methodNode.name));
                beginList.add(new MethodInsnNode(Opcodes.INVOKESTATIC, "com/geekyarticles/asm/Logger", "logMethodStart", "(Ljava/lang/String;)V"));
                
                Iterator<AbstractInsnNode> insnNodes=methodNode.instructions.iterator();
                while(insnNodes.hasNext()){
                    System.out.println(insnNodes.next().getOpcode());
                }
                
                methodNode.instructions.insert(beginList);
                System.out.println(methodNode.instructions);
                
                //A method can have multiple places for return
                //All of them must be handled.
                insnNodes=methodNode.instructions.iterator();
                while(insnNodes.hasNext()){
                    AbstractInsnNode insn=insnNodes.next();
                    System.out.println(insn.getOpcode());
                    
                    if(insn.getOpcode()==Opcodes.IRETURN
                            ||insn.getOpcode()==Opcodes.RETURN
                            ||insn.getOpcode()==Opcodes.ARETURN
                            ||insn.getOpcode()==Opcodes.LRETURN
                            ||insn.getOpcode()==Opcodes.DRETURN){
                        InsnList endList=new InsnList();
                        endList.add(new LdcInsnNode(methodNode.name));
                        endList.add(new MethodInsnNode(Opcodes.INVOKESTATIC, "com/geekyarticles/asm/Logger", "logMethodReturn", "(Ljava/lang/String;)V"));
                        methodNode.instructions.insertBefore(insn, endList);
                    }
                    
                }
                
            }
        }

        //We are done now. so dump the class
        ClassWriter cw=new ClassWriter(ClassWriter.COMPUTE_MAXS|ClassWriter.COMPUTE_FRAMES);
        classNode.accept(cw);


        File outDir=new File("out/com/geekyarticles/asm");
        outDir.mkdirs();
        DataOutputStream dout=new DataOutputStream(new FileOutputStream(new File(outDir,"LoggingTest.class")));
        dout.write(cw.toByteArray());
        dout.flush();
        dout.close();

    }

}

LoggingTest.java 

package com.geekyarticles.asm;

public class LoggingTest {
    public static void run1(){
        System.out.println("run 1");
    }
    @Loggable
    public static void run2(){
        System.out.println("run 2");
    }
    
    @Loggable
    public static void main(String [] args){
        run1();
        run2();
    }
}

记录器 

package com.geekyarticles.asm;

public class Logger {
    public static void logMethodStart(String methodName){
        System.out.println("Starting method: "+methodName);
    }
    
    public static void logMethodReturn(String methodName){
        System.out.println("Ending method: "+methodName);
    }
}

Loggable.java 

package com.geekyarticles.asm;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Loggable {

}

如果运行此程序，则生成的文件将依赖于Logger类。 手动将Logger类复制到out目录中的正确软件包。 如果运行生成的类（它是LoggingTest类的修改版本），则将输出以下内容。 

bash-4.1$ java  com.geekyarticles.asm.LoggingTest
Starting method: main
run 1
Starting method: run2
run 2
Ending method: run2
Ending method: main

请注意，与普通列表不同，在迭代InsnList对象时可以对其进行修改。 任何更改都会立即反映出来。 因此，如果在当前位置之后插入了一些指令，则也将对其进行迭代。

参考： 使用ASM 4处理Java类文件–第二部分： JCG合作伙伴提供的 Tree API   极客文章博客上的Debasish Ray Chawdhuri。


翻译自: https://www.javacodegeeks.com/2012/02/manipulating-java-class-files-with-asm_22.html

dnc8371
关注
ASM(五) 利用TreeApi 解析生成及转换Class
马猴烧酒└(┐卍^o^)卍ﾄﾞｩﾙﾙﾙ~楪詩月「YUZURIHA SHIZUKI」
07-15 2万+
篇开始介绍ASM另一部分主要的Api。TreeApi。这一部分源码是关联的asm-tree-5.0.4的版本。 在介绍前，先要知道一点， Tree工程的接口基本可以完成大部分我们之前介绍的Core中的功能。但是在实际使用中更加便利，当然也会更加消耗时间和性能。完成一个简单的生成编译后的Class字节码的任务，可能会花费多余Core的30%的时间，同时也会消耗更多内存。但是通过下面的介绍，相信在选择用哪种Api上，我们也会做出自己的取舍和判断。
ASM(六) 利用TreeApi 动态生成以及转换方法字节码
热门推荐
马猴烧酒└(┐卍^o^)卍ﾄﾞｩﾙﾙﾙ~楪詩月「YUZURIHA SHIZUKI」
08-29 2万+
一、MethodNode概述      ASM的TreeApi 对于Method的转换、生成也提供了一系列的组件和接口。其功能主要基于前一章提到的MethodNode类。MethodNode中大多数属性和方法都和ClassNode类似，其中最主要的属性就是InsnList了。InsnList是一个双向链表对象，包含了存储方法的字节指令序。先来看下InsnList中的主要是属性和方法：
Caused by: java.lang.ClassNotFoundException: org.objectweb.asm.Type异常
09-16
主要介绍了Caused by: java.lang.ClassNotFoundException: org.objectweb.asm.Type异常，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
asm-tree-3.3.jar
04-11
this is a lib for java named : asm-tree-3.3.jar
一起来学字节码插桩：ASM Tree API
最新发布
Dream It Possible
06-20 86
ASM是一个通用的Java字节码操作和分析框架。它可用于修改现有类或直接以二进制形式动态生成类。ASM提供了一些常见的字节码转换和分析算法，可以根据这些算法构建定制的复杂转换和代码分析工具。ASM提供了与其他Java字节码框架类似的功能，但更关注性能。因为它的设计和实现尽可能的小和快，它非常适合在动态系统中使用(但当然也可以以静态的方式使用，例如在编译器中)。关于ASM更多介绍，可以参见ASM官网。ASM从组成结构上可以分成两部分，一部分为Core API，另一部分为Tree API。Core API包括。
ASM 系列详细教程-16-ASM Tree api 类接口与组件
12-23 1万+
本章简介 本章介绍如何使用ASM树API生成和转换类。 它从仅介绍tree API入手，然后进行说明如何与核心API组合在一起。 在下一章中将说明用于方法，注解和泛型内容的树形API。 Interfaces and components Presentation（介绍） 类节点信息 用于生成和转换已编译Java类的ASM树API基于ClassNode类（请参见图6.1）。 Figure 6.1....
asm-tree（3.0 /3.3）
08-14
asm-tree（3.0 /3.3） 不同版本， 资源共享，有需要其他jar包的可以在评论留言，看到后我会陆续上传。
ASM框架使用（五）--Tree API修改类和方法
ljz2016的博客
10-30 2471
Tree API通过ClassNode创建和修改类，ClassNode类的API： 创建一个类：
java asm 中文文档_ASM 简介
weixin_33602725的博客
02-23 2508
前言很早之前就写过面向切面的编程思想，主要学习了AOP的思想(参考：AOP简介)以及使用 AspectJ 实现简单的切面编程(参考：AspectJ之切点语法)。其他常见的AOP编程框架还有 Cglib，Hibernate 和 Spring 等等，而这些目前流行的AOP框架绝大多数底层实现都是直接或间接地通过 ASM 来实现字节码操作。因此，如果你想实现一些简单的切面编程，直接采用上面提及的AOP框...
ASM4手册中文版.pdf
04-06
2. 树API（Tree API）：采用基于对象的模型，类被表示为对象的树形结构，其中每个对象代表类的一部分。这种方式类似于XML中的DOM（Document Object Model），虽然可能比基于事件的模型更慢，但提供了更好的可读性和...
ASM(二) 利用Core API 变更类成员
Ernest’‘’的博客
09-27 277
之前一篇简单介绍了一下ASM框架。这一篇继续对CoreApi进行扩展。这里还是继续对ClassWriter ，ClassReader和ClassVisitor的应用的扩展。前面一篇主要介绍的是ClassWriter和ClassReader单独应用的场景。这一篇把这两者作为producer（ClassReader）和consumer（ClassWriter）来结合起来介绍一下另外一些...
asm-tree-5.1jar
05-22
java资源架包
asm-3.3.jar,asm-commons-3.3,asm-tree-3.3.jar
08-22
struts2.3开发依赖的asm包.不然有以下报错java.lang.NoClassDefFoundError: com/opensymphony/xwork2/util/finder/ClassFinder$InfoBuildingVisitor,导入asm-3.3.jar,asm-commons-3.3,asm-tree-3.3.jar即可
ASM 系列详细教程-19-ASM Tree api 方法组件组成入门详解
12-23 1万+
成分组成 到目前为止，我们只看到了如何创建和转换MethodNode对象，但是还没有看到与类的字节数组表示形式相关的链接。 像对于类一样，此链接是通过组合核心API和树API组件来完成的，如本节所述。 介绍 除了图7.1中所示的字段外，MethodNode类还扩展了MethodVisitor类，并且还提供了两个接受方法，它们将MethodVisitor或ClassVisitor作为参数。 acce...
ASM 系列详细教程-23-ASM Tree API 向后兼容能力
12-24 1万+
介绍 与核心API一样，ASM 4.0的树API中也引入了一种新机制，以确保在将来的ASM版本中向后兼容。 但是，这里再次不能单独通过ASM来确保此属性。 要求用户在编写自己的文章时遵循一些简单的准则 码。 本章的目的是介绍这些准则，并给出ASM树API中使用的内部机制的概念，以确保向后兼容。 指导方针 本节介绍了使用ASM树API时必须遵循的准则，以确保您的代码在以后的任何ASM版本中保持有效（...
ASM 系列详细教程-18-ASM Tree api 方法接口与组件
12-23 1万+
方法 本章介绍如何使用ASM树API生成和转换方法。 它从仅提供树API的介绍开始，并提供一些说明性示例，然后介绍如何与核心API组合。 下一章介绍了用于泛型和注解的树形API。 Interfaces and components 说明 MethodNode 用于生成和转换方法的ASM树API基于MethodNode类（请参见图7.1）。 Figure 7.1.: The MethodNode ...
ASM系列八 利用TreeApi动态注入方法逻辑
云深不知处
08-28 616
 一、转换方法的字节码           利用Tree Api转化方法字节码，其实也就是对MethodNode对象的InsnList的操作。通过获取InsnList的迭代器，可以直接add 或者remove方法的指令。如果需要添加比较多的指令集，那么可以把指令集分开成不同的InsnList（临时的指令集对象）再将这些子集合并。具体的代码块如下： InsnList il = new I...
ASM 系列详细教程-17-ASM Tree api 类组件组成详解
12-23 1万+
组件组成 到目前为止，我们只看到了如何创建和转换ClassNode对象，但是还没有看到如何从类的字节数组表示形式构造ClassNode，反之亦然，如何从ClassNode构造此字节数组。 实际上，这是通过组合核心API和树API组件来完成的，如本节所述。 介绍 除了图6.1中所示的字段之外，ClassNode类还扩展了ClassVisitor类，并且还提供了一个接受方法，该方法将ClassVisi...
ASM组成部分解析：Core API与Tree API
Tree API将类的结构表示为一个抽象语法树（AST），允许更直观地处理类的组件。比如，`ClassNode`、`FieldNode`和`MethodNode`等类提供了更友好的接口来处理类的字段、方法和注解。 使用Tree API，开发者可以避免...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值