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

javax.lang.model.util.AbstractElementVisitor9는 Java SE 9부터 도입된 클래스로, javax.lang.model.element 패키지에 속해있습니다. 이 클래스는 javax.lang.model.element.ElementVisitor 인터페이스의 구현 클래스 중 하나이며, ElementVisitor 인터페이스를 구현하는 데 필요한 메서드를 미리 구현해 놓은 추상 클래스입니다. 

AbstractElementVisitor9 클래스는 다음과 같은 메서드를 구현하고 있습니다.

- public R visitExecutable(ExecutableElement e, P p): ExecutableElement를 방문하는 메서드입니다.
- public R visitType(TypeElement e, P p): TypeElement를 방문하는 메서드입니다.
- public R visitPackage(PackageElement e, P p): PackageElement를 방문하는 메서드입니다.
- public R visitTypeParameter(TypeParameterElement e, P p): TypeParameterElement를 방문하는 메서드입니다.
- public R visitVariable(VariableElement e, P p): VariableElement를 방문하는 메서드입니다.
- public R visitUnknown(Element e, P p): Element 타입이 정의되지 않은 경우에 호출되는 메서드입니다.

각 메서드는 첫 번째 인자로 Element 인스턴스를, 두 번째 인자로는 P 타입의 사용자 정의 데이터를 전달받습니다. 각 메서드는 R 타입을 반환하며, 이는 visit 메서드를 호출한 클라이언트에서 지정한 타입입니다.

AbstractElementVisitor9 클래스는 상속을 통해 이용됩니다. 이 클래스를 상속받아 ElementVisitor 인터페이스의 모든 메서드를 구현하면, 특정한 Element 타입을 방문할 때 적절한 visit 메서드가 자동으로 호출됩니다. 이를 통해 코드를 간결하게 작성할 수 있습니다. 

예를 들어, 다음과 같이 ElementVisitor 인터페이스를 구현하는 클래스가 있다고 가정해봅시다.

public class MyElementVisitor extends AbstractElementVisitor9<Void, Void> {
    @Override
    public Void visitVariable(VariableElement e, Void p) {
        System.out.println("변수를 방문했습니다.");
        return null;
    }
}

MyElementVisitor 클래스는 AbstractElementVisitor9 클래스를 상속받아 visitVariable 메서드만 구현했습니다. 이제 MyElementVisitor 클래스를 이용해 다음과 같이 Element 타입을 방문할 수 있습니다.

Element element = ...; // 방문할 Element 타입의 인스턴스
MyElementVisitor visitor = new MyElementVisitor();
element.accept(visitor, null);

Element 인스턴스의 accept 메서드를 호출할 때, MyElementVisitor 클래스에서 구현한 visitVariable 메서드가 자동으로 호출됩니다. 이를 통해 코드를 간결하게 작성할 수 있습니다.AbstractElementVisitor9 클래스는 이외에도 다양한 메서드를 제공합니다. 

- public R visit(Element e, P p): Element 타입을 방문하는 메서드입니다. 이 메서드를 사용하면 Element 타입의 서브 클래스가 아닌 모든 Element 타입을 방문할 수 있습니다. 예를 들어, visit 메서드를 호출할 때 전달한 Element 인스턴스가 TypeElement 타입이라면 visitType 메서드가, PackageElement 타입이라면 visitPackage 메서드가 호출됩니다.
- public R visitAnnotation(AnnotationMirror a, P p): AnnotationMirror 타입을 방문하는 메서드입니다.
- public R visitExecutableAsConstructor(ExecutableElement e, P p): 생성자를 방문하는 메서드입니다. 
- public R visitExecutableAsMethod(ExecutableElement e, P p): 메서드를 방문하는 메서드입니다. 
- public R visitTypeAsEnum(TypeElement e, P p): enum 타입을 방문하는 메서드입니다.
- public R visitTypeAsInterface(TypeElement e, P p): 인터페이스 타입을 방문하는 메서드입니다.
- public R visitTypeAsAnnotationType(TypeElement e, P p): 어노테이션 타입을 방문하는 메서드입니다.

AbstractElementVisitor9 클래스는 Java 컴파일러 API에서 널리 사용됩니다. 예를 들어, 자바 컴파일러에서 소스 코드의 유효성을 검사하는 등의 작업에서 이 클래스를 이용합니다. 또한, AbstractElementVisitor9 클래스는 ElementKindVisitor9, ElementScanner9 등의 클래스에서도 사용됩니다. 이러한 클래스들은 AbstractElementVisitor9 클래스를 상속받아 특정한 Element 타입을 방문하는 동작을 수행합니다.

요약하면, javax.lang.model.util.AbstractElementVisitor9 클래스는 ElementVisitor 인터페이스를 구현하기 위한 미리 구현된 추상 클래스입니다. 이 클래스를 상속받아 visit 메서드를 구현하면, Element 타입을 방문할 때 적절한 visit 메서드가 자동으로 호출됩니다. 이를 통해 코드를 간결하게 작성할 수 있으며, Java 컴파일러 API에서 널리 사용됩니다.자바 언어에서 javax.lang.model.util.AbstractElementVisitor9 클래스를 사용한 간단한 예제 코드를 작성해보겠습니다.

다음은 TypeElement 타입을 방문하고, 해당 타입의 속성을 출력하는 예제 코드입니다.

 

import javax.lang.model.element.TypeElement;
import javax.lang.model.util.AbstractElementVisitor9;

public class MyTypeElementVisitor extends AbstractElementVisitor9<Void, Void> {
    @Override
    public Void visitType(TypeElement e, Void p) {
        System.out.println("Type name: " + e.getSimpleName());
        System.out.println("Type kind: " + e.getKind());
        return null;
    }
}

이제 위 예제 코드를 사용해 TypeElement 타입을 방문하는 코드를 작성해보겠습니다.

import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.ElementScanner9;

public class Main {
    public static void main(String[] args) {
        String className = "com.example.MyClass";
        Elements elementUtils = processingEnv.getElementUtils();
        ElementScanner9<Void, Void> scanner = new ElementScanner9<Void, Void>() {
            @Override
            public Void visitType(TypeElement e, Void p) {
                if (e.getQualifiedName().toString().equals(className)) {
                    MyTypeElementVisitor visitor = new MyTypeElementVisitor();
                    e.accept(visitor, null);
                }
                return super.visitType(e, p);
            }
        };
        for (Element element : ElementFilter.typesIn(elementUtils.getAllMembers(elementUtils.getPackageElement("")))) {
            scanner.scan(element, null);
        }
    }
}

위 예제 코드에서는 `javax.lang.model.util.ElementScanner9` 클래스를 사용해 모든 `TypeElement` 타입을 방문하고, 해당 클래스의 이름이 `"com.example.MyClass"`인 경우에 한해 `MyTypeElementVisitor` 클래스를 사용해 해당 클래스의 정보를 출력하도록 구현했습니다.

이와 같이 `javax.lang.model.util.AbstractElementVisitor9` 클래스를 사용하면, Java 소스 코드를 검사하거나, 특정한 클래스 또는 메서드의 정보를 분석하는 등 다양한 용도로 활용할 수 있습니다.