[PT선생님][23]자바 javax.lang.model.util.AbstractElementVisitor8 알아보기

 

javax.lang.model.util.AbstractElementVisitor8 클래스는 Java 컴파일러 API의 일부로, 특정 자바 소스코드 요소를 방문하고 처리하는 기능을 제공하는 추상 클래스입니다. 이 클래스는 JDK 1.8 버전에서 추가되었습니다.

AbstractElementVisitor8 클래스는 javax.lang.model.element.ElementVisitor 인터페이스를 구현합니다. 이 인터페이스는 다양한 유형의 Element 객체(클래스, 인터페이스, 필드, 메소드 등)를 방문하는 방법을 제공합니다. ElementVisitor 인터페이스에는 여러 종류의 visit 메서드가 정의되어 있으며, 이들 메서드 중 일부는 AbstractElementVisitor8 클래스에서 이미 구현되어 있습니다. 

AbstractElementVisitor8 클래스를 상속받는 클래스는 이 메서드들을 오버라이드하여 특정 Element 객체를 처리하고 원하는 작업을 수행할 수 있습니다. 클래스를 선언할 때는 다음과 같은 타입 매개변수를 정의해야 합니다.

 

public abstract class MyClass<R, P> extends AbstractElementVisitor8<R, P> {
    // 클래스 구현
}

R은 visit 메서드가 반환할 값의 타입을, P는 visit 메서드가 전달받을 추가적인 매개변수의 타입을 나타냅니다.

AbstractElementVisitor8 클래스에서 이미 구현되어 있는 visit 메서드는 다음과 같습니다.

- visit(Element e, P p): Element의 서브클래스에서 구현되지 않은 visit 메서드를 호출할 때 사용됩니다.
- visitUnknown(Element e, P p): visit 메서드를 호출할 수 없는 Element 타입을 처리할 때 사용됩니다.
- visitModule(ModuleElement e, P p): ModuleElement를 처리하는 visit 메서드입니다.
- visitPackage(PackageElement e, P p): PackageElement를 처리하는 visit 메서드입니다.
- visitType(TypeElement e, P p): TypeElement를 처리하는 visit 메서드입니다.
- visitExecutable(ExecutableElement e, P p): ExecutableElement를 처리하는 visit 메서드입니다.
- visitTypeParameter(TypeParameterElement e, P p): TypeParameterElement를 처리하는 visit 메서드입니다.
- visitVariable(VariableElement e, P p): VariableElement를 처리하는 visit 메서드입니다.

이외에도 javax.lang.model.util.AbstractElementVisitor8 클래스에는 여러 가지 유용한 메서드가 포함되어 있습니다. 예를 들어, 다음과 같은 메서드를 사용하여 visit 메서드 호출 시 기본값을 지정할 수 있습니다.

public final R visit(Element e) {
    return e.accept(this, null);
}

AbstractElementVisitor8 클래스를 사용하면 Java 소스코드 요소를 방문하고 처리하는 작업을 쉽게 구현할 수 있습니다. ElementVisitor 인터페이스에서 제공하는 visit 메서드를 직접 구현하는 것보다 코드 양을 줄일 수 있으며, 오버라이드한 visit 메서드에서제공되는 매개변수와 반환값의 타입을 지정하여 구현함으로써 타입 안정성을 보장할 수 있습니다.

예를 들어, AbstractElementVisitor8 클래스를 사용하여 특정 타입의 필드를 찾고자 할 때, 다음과 같이 visitVariable 메서드를 오버라이드하여 구현할 수 있습니다.

 

public class FieldVisitor extends AbstractElementVisitor8<Void, Void> {

    @Override
    public Void visitVariable(VariableElement e, Void p) {
        if (e.getKind() == ElementKind.FIELD && e.asType().toString().equals("java.lang.String")) {
            System.out.println("Found string field: " + e.getSimpleName());
        }
        return null;
    }
}

위 코드에서는 String 타입의 필드를 찾기 위해 visitVariable 메서드를 오버라이드하였습니다. visitVariable 메서드는 VariableElement 타입의 객체를 매개변수로 받으며, 반환값은 Void 타입으로 지정되어 있습니다.

이제 FieldVisitor 클래스를 사용하여 소스코드에서 String 타입의 필드를 찾아내는 작업을 수행할 수 있습니다.

Elements elements = processingEnv.getElementUtils();
TypeElement typeElement = elements.getTypeElement("com.example.MyClass");
FieldVisitor fieldVisitor = new FieldVisitor();
for (Element e : typeElement.getEnclosedElements()) {
    e.accept(fieldVisitor, null);
}

위 코드에서는 processingEnv.getElementUtils() 메서드를 사용하여 ElementUtils 객체를 얻고, getTypeElement 메서드를 사용하여 MyClass 클래스의 TypeElement 객체를 가져왔습니다. 이제 TypeElement 객체의 getEnclosedElements 메서드를 사용하여 클래스의 모든 Element 객체를 가져온 다음, 각 Element 객체의 accept 메서드를 호출하여 FieldVisitor 객체를 전달하여 visit 메서드를 호출합니다.

이처럼 AbstractElementVisitor8 클래스는 Java 소스코드 요소를 처리하는 작업을 간편하게 구현할 수 있도록 도와주는 클래스입니다. 이 클래스를 상속받아 visit 메서드를 오버라이드하여 자신이 원하는 작업을 수행하면 됩니다.아래는 예제 코드입니다. MyClass 클래스는 String 타입의 필드와 int 타입의 필드를 가지고 있습니다. FieldVisitor 클래스는 String 타입의 필드를 찾아 출력합니다.

import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.TypeElement;
import javax.lang.model.element.VariableElement;
import javax.lang.model.util.AbstractElementVisitor8;
import javax.lang.model.util.Elements;

public class MyClass {
    private String strField;
    private int intField;
}

class FieldVisitor extends AbstractElementVisitor8<Void, Void> {

    @Override
    public Void visitVariable(VariableElement e, Void p) {
        if (e.getKind() == ElementKind.FIELD && e.asType().toString().equals("java.lang.String")) {
            System.out.println("Found string field: " + e.getSimpleName());
        }
        return null;
    }
}

class Main {
    public static void main(String[] args) {
        Elements elements = processingEnv.getElementUtils();
        TypeElement typeElement = elements.getTypeElement("MyClass");
        FieldVisitor fieldVisitor = new FieldVisitor();
        for (Element e : typeElement.getEnclosedElements()) {
            e.accept(fieldVisitor, null);
        }
    }
}

위 코드를 실행하면 "Found string field: strField"가 출력됩니다.