이번에는 이전 시간에 만든 writeClass()를 이용해서 생성된 클래스를 변형을 해보도록 하겠습니다.

혹시나 "클래스 생성하기" 챕터를 건너뛰신 분들을 위해서 저~~~~ 아래쪽에 writeClass() 메소드 소스를 올려놓도록 하겠습니다.

자 그럼 시작해볼까요...

변형하는거는 그리 어렵지 않습니다. ClassVisitor를 이용하면 됩니다. 제일 첫번째 시간에 MyClassVisitor를 만들었으니 이걸 이용해보도록 하겠습니다.

큰 그림부터 한번 볼까요?? 순서는 아래와 같습니다.

1. ClassWriter 생성

2. ClassWriter를 이용하여 ClassVisitor 생성 ( ClassWriter를 인자로 넘겨줌 )

3. ClassReader를 이용하여 변형하고자하는 클래스 정보를 읽어들임

4. cr.accept( ClassVisitor, int ) 메소드를 이용해서 클래스 변형

실질적으로 변형을 하는 녀석은 바로 이 ClassVisitor라는 것을 알고 넘어가시면 됩니다.

자, 그럼 우선 클래스를 변형하기위한 메소드를 하나 만들어보죠.

private byte[] transformClass(){
        ClassWriter cw = new ClassWriter(0);
        ClassVisitor cv = new MyClassVisitor(Opcodes.ASM5, cw){};
        ClassReader cr = new ClassReader(writeClass());
        cr.accept(cv, 0);
        return cw.toByteArray();
}

여기서 writeClass()의 소스는 이 포스트 하단에 있습니다.

간단하게 소스설명을 드리자면 우선 cw를 만들고 cv를 생성할 때 인자로 넣어줍니다. 여기서 기존에 만들었던 MyClassVisitor에는 위 소스에서 사용한 생성자가 없으므로 하나를 추가로 생성해주셔야 합니다.

MyClassVisitor클래스에 아래 생성자를 하나 추가해주세요.

public MyClassVisitor(int version, ClassWriter cw) {
        super(version, cw);
}

다시 소스설명으로 넘어와서....

이렇게 cv를 생성을 했으면 이제 변형할 클래스를 읽어옵니다.

그리고 cr의 accept()를 이용해서 방문(?)하면서 변환을 합니다. 이렇게 변환이 된 클래스 정보는 cw에 들어가게 됩니다.

뭔가 간단한것 같으면서도 어지러운것 같죠??

자, 그럼 테스트를 해봐야 하겠죠..

우리가 만들었던 MyClassVisitor의 visit() 메소드를 한번 볼까요?

@Override
    public void visit(int version, int access, String name,
            String signature, String superName, String[] interfaces) {
        name = "BCItest/Modified";
        super.visit(version, access, name, signature, superName, interfaces);
        System.out.println(name + " extends " + superName + " {");
}

자, 위에서 오렌지색으로 표시된 부분이 추가된 부분입니다. 이게 뭘 할건지 짐작이 가시나요?

자 그리고 테스트 클래스에서 지난 시간에 했던 생성된 클래스 테스트해보는 소스를 조금만 수정해보겠습니다.

// 기존 테스트 소스

Class c = new MyClassLoader().defineClass("BCItest.Comparable", writeClass());
System.out.println(c.getName());

// 수정한 테스트 소스

Class c = new MyClassLoader().defineClass("BCItest.Comparable", transformClass());
System.out.println(c.getName());

변경된 부분은 오렌지색으로 표시했습니다.

이렇게 해서 실행을 하면 뭐가 나올까요?

ClassLoader로 읽어오는 과정에서 아래와 같은 오류가 납니다.

java.lang.NoClassDefFoundError: BCItest/Comparable (wrong name: BCItest/Modified)

자....우리가 클래스로더를 이용해서 로드하려고한 클래스명은 Comparable이었는데 transformClass()에서 만들어진 클래스는 Modified이기 때문입니다.

그럼 이번에는 BCItest.Modified를 읽어오도록 해봅시다.

Class c = new MyClassLoader().defineClass("BCItest.Modified", transformClass());
 

위 처럼 defineClass() 메소드에 들어가는 인자를 바꿔주세요.

이제 다시 실행해보면 BCItest.Modified 라고 출력이 되는 것을 확인하실 수 있을겁니다.

참고로 지난번에 했던 MyClassVisitor를 그대로 사용하신다면 클래스 구조가 출력되는 것도 보실 수가 있습니다.

어렵지 않죠?

자 이제 여러분도 BCI의 기본기를 모두 익힌 셈입니다.

클래스 읽기, 쓰기, 수정 까지 했으니까요.

ASM을 이용해서 클래스를 읽어오고, 생성 및 변환하는 부분까지 공부를 해보았는데요

제가 설명하는 능력이 약해서 첫시간부터 지금까지 한 내용을 소스를 첨부했으니 소스를 보면서 천천히 한번 공부해보세요 ^_^

다음시간에는 수정할때 최적화 관련된 부분에 대해서 알아보도록 하겠습니다.

그럼 여러분 안녀~엉~

출처 : ASM 4 가이드 문서

-----------------writeClass()-----------------------

BCItest 패키지를 기준으로 소스가 작성되었습니다.

private byte[] writeClass(){
        ClassWriter cw = new ClassWriter(0);
        cw.visit(Opcodes.V1_5, Opcodes.ACC_PUBLIC + Opcodes.ACC_ABSTRACT + Opcodes.ACC_INTERFACE,
                "BCItest/Comparable", null, "java/lang/Object",
                null);
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "LESS", "I",
        null, new Integer(-1)).visitEnd();
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "EQUAL", "I",
        null, new Integer(0)).visitEnd();
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "GREATER", "I",
        null, new Integer(1)).visitEnd();
        cw.visitMethod(Opcodes.ACC_PUBLIC + Opcodes.ACC_ABSTRACT, "compareTo",
        "(Ljava/lang/Object;)I", null, null).visitEnd();
        cw.visitEnd();

        return cw.toByteArray();
}

오늘은 클래스를 생성해보는 예제를 가져와봤습니다.

클래스를 생성할때는 ClassWriter 컴포넌트만 필요합니다.

자, 아래와 같은 인터페이스를 ClassWriter를 이용해서 생성해보도록 하겠습니다.

:: 생성하려는 인터페이스

package BCItest;
public interface Comparable extends Mesurable {
    int LESS = -1;
    int EQUAL = 0;
    int GREATER = 1;
    int compareTo(Object o);
}

-- 위 인터페이스를 생성하기위한 소스

private byte[] writeClass(){
        ClassWriter cw = new ClassWriter(0);
        cw.visit(Opcodes.V1_5, Opcodes.ACC_PUBLIC + Opcodes.ACC_ABSTRACT + Opcodes.ACC_INTERFACE,
        "BCItest/Comparable", null, "java/lang/Object",
        new String[] { "BCItest/Mesurable" });
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "LESS", "I",
        null, new Integer(-1)).visitEnd();
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "EQUAL", "I",
        null, new Integer(0)).visitEnd();
        cw.visitField(Opcodes.ACC_PUBLIC + Opcodes.ACC_FINAL + Opcodes.ACC_STATIC, "GREATER", "I",
        null, new Integer(1)).visitEnd();
        cw.visitMethod(Opcodes.ACC_PUBLIC + Opcodes.ACC_ABSTRACT, "compareTo",
        "(Ljava/lang/Object;)I", null, null).visitEnd();
        cw.visitEnd();

        return cw.toByteArray();
}

간 단하게 소스를 훑어볼까요?? 우선 ClassWriter ( 이하 cw ) 인스턴스를 생성하고 visit, visitField, visitMethod 메소드를 호출한 뒤에 마지막으로 visitEnd를 호출했습니다. 각 메소드안에 들어가는 ACC_XXX라는 상수들은 ASM에 미리 정의되어있는 Opcodes 들입니다. Opcodes 인터페이스를 통해서 사용하실 수 있습니다.

필 드 선언부를 보시면 첫번째 필드가 int LESS 라는 필드죠. 우선 인터페이스 내에 선언되어있는 int라서 visitField메소드에서 public, final, static이라는 상수값을 주고 그 다음에 필드명(LESS)과 필드 타입(I)을 주었습니다. 그 다음에 null은 generic관련 필드입니다. 마지막으로는 해당 필드에 할당할 값입니다. 위 예제에서는 new Integer(-1)이죠. 

그리고 cw를 바이트형태로 추출했습니다.

이제 이 바이트 클래스를 이용해서 생성된 인터페이스를 사용해볼까요??

우선 클래스로더가 필요합니다.

아래와 같이 MyClassLoader 클래스를 하나 만들어주세요.

class MyClassLoader extends ClassLoader {
    public Class defineClass(String name, byte[] b) {
        return defineClass(name, b, 0, b.length);
    }   
}

그리고 아래처럼 테스트해보면 됩니다.

Class c = new MyClassLoader().defineClass("BCItest.Comparable", writeClass());
System.out.println(c.getName());

문제가 없다면 BCItest.Comparable 이라고 콘솔창에 출력이 될겁니다.

여 기서 잠깐!!! 제가 실습해본 결과 인터페이스가 Mesurable을 상속하는 형태로 되어있기 때문에 Measurable클래스가 없다면 오류가 납니다. 그래서 1. Measurable을 생성해 주시거나 아니면 2. writeClass()의 cw.visit() 메소드의 마지막 인자인 new String[] { " .... "} 를 null 로 바꿔주시면 실행이 잘 될겁니다.

그럼 다음 시간에는 클래스 변환에 대해서 올리도록 하겠습니다.

출처 : ASM 가이드

BCI ( Byte Code Instrumentation )을 위한 ASM 5.0 프레임 워크에 대해서 공부해볼 예정입니다.

ASM에 대한 사용자메뉴얼 및 개발자가이드는 http://asm.ow2.org/index.html 이곳에서 쉽게 찾을 수 있습니다.

오늘은 그 첫 시간. 사용자 메뉴얼을 읽어가면서 조금씩 조금씩 정리해서 블로그에 올릴 예정입니다.

오늘은 클래스 파일 읽어서 정보 얻어오는 부분만 알아보도록 하겠습니다.

우선 이클립스에 ASM 5.0 프레임워크를 설치합니다.  

http://forge.ow2.org/project/showfiles.php?group_id=23

위 링크에 가시면 버전별로 zip 파일을 다운로드 받을 수 있습니다.( 링크가 깨질 것을 염려하여 최신 버전 5.0.3을 첨부하였습니다 )

다운로드 받은 zip파일을 압축해제를 합니다.

이제 이클립스를 실행시키고 프로젝트에 라이브러리를 추가해주기만하면 됩니다.

configure build path하셔서 라이브러리 추가하면 설치 완료!

자 이제 프레임워크를 설치했으니 사용해보기로 하죠.

BCITest패키지를 만들고 그 밑에 세 개의 클래스 파일을 만듭니다.

BCITest.java
HelloWorld.java
MyClassVisitor.java

// BCITest.java 소스 ( JUnit Test를 이용했습니다 ) 

package BCItest;

import java.io.IOException;
import org.junit.Test;
import org.objectweb.asm.ClassReader;

public class BCITest {
    @Test
    public void test() throws IOException {
        MyClassVisitor cv = new MyClassVisitor(327680);    // ASM5 = 327680
        ClassReader cr = new ClassReader("BCITest.HelloWorld");       // 대소문자 구분 X ( bcitest.helloworld 라고해도 실행됨 )
        cr.accept(cv, 2);
    }
} 

테스트 해보실 때에는 BCITest.HelloWorld 대신에 다른 임의의 클래스를 넣어보시면 됩니다. 예를 들어 java.lang.String이라든가 java.lang.Exception이라든가 하는 클래스들 말이죠.

// HelloWorld.java 소스

package BCItest;

public class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello World!!");
    }
}

// MyClassVisitor.java 소스

package BCItest;

import org.objectweb.asm.AnnotationVisitor;
import org.objectweb.asm.Attribute;
import org.objectweb.asm.ClassVisitor;
import org.objectweb.asm.FieldVisitor;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.TypePath;

public class MyClassVisitor extends ClassVisitor {

    public MyClassVisitor(int arg0) {
        super(arg0);
    }
    @Override
    public void visit(int version, int access, String name,
            String signature, String superName, String[] interfaces) {
        super.visit(version, access, name, signature, superName, interfaces);
        System.out.println(name + " extends " + superName + " {");
    }
    @Override
    public void visitEnd() {
        super.visitEnd();
        System.out.println("}");
    }
    @Override
    public FieldVisitor visitField(int access, String name, String desc,
            String signature, Object value) {
        System.out.println(" " + desc + " " + name);
        return super.visitField(access, name, desc, signature, value);
    }
    @Override
    public MethodVisitor visitMethod(int access, String name,
            String desc, String signature, String[] exceptions) {
        System.out.println(" " + name + desc);
        return super.visitMethod(access, name, desc, signature, exceptions);
    }
}
 

위에서 MyClassVisitor는 ClassVisitor를 상속한 뒤 몇몇 메소드만 오버라이드 했습니다.

우선 제가 제공해드린 소스를 기준으로 테스트를 진행하면 아래와 같은 결과가 나옵니다.

BCItest/HelloWorld extends java/lang/Object {
 <init>()V
 main([Ljava/lang/String;)V
} 

여기서 <init>은 생성자를 말하고 마지막의 V는 void를 의미합니다.  

어떤가요? 어렵지 않죠?   

HelloWorld 클래스에 메소드를 더 넣어보고 ( 리턴 타입이나 파라미터 개수, 종류를 다르게 해서 ) 테스트해보세요~ 

참고로 아래는 Type Descriptor 와 Method descriptor 입니다.  

뭐가 뭘 의미하는지를 나타내주는 거니까 이거는 외우시는게 좋을거에요~

참고로 클래스를 읽어들이는 방법은 BCITest클래스에서 ClassReader생성할 때 이름을 주는 방법 외에 다른 방법도 있습니다.

사 용자 메뉴얼에는 아래와 같이 설명이 되어있습니다. 이름, 값, byte array, input stream을 이용해서 읽어들일 수 있는데 input stream을 이용해서 클래스를 읽어들일 때는 클래스 로더의 getResourceAsStream 메소드를 이용할 수 있다고 합니다. 사용 예제가 바로 밑에 나와있죠?

자, 클래스 파일 읽기는 이쯤에서 끝내겠습니다. 설명이 길면 머리만 아프죠.

다음 시간에는 기존의 클래스를 읽는것이 아니라 클래스를 생성해보도록 해보겠습니다~

그럼 오늘은 여기서 이만~ 

 출처 : ASM 4 사용자 가이드 ( 테스트는 ASM 5 로 했습니다. )