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

 

javax.lang.model.util.AbstractAnnotationValueVisitor14는 자바 언어에서 제공하는 Annotation 처리를 위한 유틸리티 클래스 중 하나입니다. 이 클래스는 javax.lang.model.element.AnnotationValue를 처리하기 위한 Visitor 패턴을 구현한 추상 클래스입니다.

Visitor 패턴은 객체 지향 디자인 패턴 중 하나로, 객체들의 구조와 기능을 분리하여 기능을 추가하거나 변경하기 쉽게 만드는 패턴입니다. AbstractAnnotationValueVisitor14 클래스는 AnnotationValue를 처리하는 visit 메소드를 제공하며, 이를 상속받아 실제로 AnnotationValue를 처리하는 구체적인 Visitor 클래스를 만들 수 있습니다.

AbstractAnnotationValueVisitor14 클래스는 Java SE 8에서 새로 추가된 타입을 지원하며, AnnotationValue의 타입이 여러 개인 경우에도 처리할 수 있습니다. 이 클래스는 AnnotationValue의 타입별로 visit 메소드를 제공하며, 이를 상속받아 구체적인 Visitor 클래스를 만들 때 필요한 visit 메소드만 오버라이드하여 사용할 수 있습니다.

예를 들어, AnnotationValue의 타입이 String인 경우에는 visitString 메소드를 오버라이드하여 처리하고, 타입이 배열인 경우에는 visitArray 메소드를 오버라이드하여 처리할 수 있습니다. 이러한 방식으로 AnnotationValue를 처리하는 Visitor 클래스를 만들 수 있습니다.

따라서, javax.lang.model.util.AbstractAnnotationValueVisitor14 클래스는 Annotation 처리를 위한 유용한 유틸리티 클래스 중 하나이며, Visitor 패턴을 활용하여 AnnotationValue를 처리하는 방법을 제공합니다.

 

AbstractAnnotationValueVisitor14 클래스의 주요 메소드와 기능은 다음과 같습니다.

visitBoolean(boolean b)
boolean 타입의 AnnotationValue를 처리하는 메소드입니다.

visitByte(byte b)
byte 타입의 AnnotationValue를 처리하는 메소드입니다.

visitChar(char c)
char 타입의 AnnotationValue를 처리하는 메소드입니다.

visitDouble(double d)
double 타입의 AnnotationValue를 처리하는 메소드입니다.

visitEnumConstant(javax.lang.model.element.VariableElement c, javax.lang.model.type.TypeMirror t)
Enum 상수 타입의 AnnotationValue를 처리하는 메소드입니다.

visitFloat(float f)
float 타입의 AnnotationValue를 처리하는 메소드입니다.

visitInt(int i)
int 타입의 AnnotationValue를 처리하는 메소드입니다.

visitLong(long i)
long 타입의 AnnotationValue를 처리하는 메소드입니다.

visitShort(short s)
short 타입의 AnnotationValue를 처리하는 메소드입니다.

visitString(String s)
String 타입의 AnnotationValue를 처리하는 메소드입니다.

visitAnnotation(javax.lang.model.element.AnnotationMirror a, java.lang.Object p)
중첩된 Annotation을 처리하는 메소드입니다.

visitArray(java.util.List<? extends javax.lang.model.element.AnnotationValue> values, java.lang.Object p)
AnnotationValue 배열을 처리하는 메소드입니다.

AbstractAnnotationValueVisitor14 클래스는 javax.lang.model.util.AbstractAnnotationValueVisitor 클래스를 상속받았으며, Java SE 8부터 추가된 AnnotationValue 타입을 지원합니다. 따라서 이 클래스를 사용하면 자바 소스 코드의 Annotation을 처리하면서 Visitor 패턴을 활용할 수 있습니다.

 

다음은 AbstractAnnotationValueVisitor14 클래스를 상속받아 만든 Visitor 클래스의 예제 코드입니다.

 

import javax.lang.model.element.AnnotationValue;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.AbstractAnnotationValueVisitor14;

public class MyAnnotationValueVisitor extends AbstractAnnotationValueVisitor14<String, Void> {

    private final Element element;

    public MyAnnotationValueVisitor(Element element) {
        this.element = element;
    }

    @Override
    public String visitString(String s, Void v) {
        return "String value: " + s;
    }

    @Override
    public String visitEnumConstant(VariableElement c, TypeMirror t) {
        return "Enum value: " + c.getSimpleName();
    }

    @Override
    public String visitArray(List<? extends AnnotationValue> values, Void v) {
        StringBuilder sb = new StringBuilder();
        sb.append("Array values: [");
        for (int i = 0; i < values.size(); i++) {
            sb.append(values.get(i).accept(this, v));
            if (i < values.size() - 1) {
                sb.append(", ");
            }
        }
        sb.append("]");
        return sb.toString();
    }

    @Override
    protected String defaultAction(Object o, Void v) {
        return "Unsupported value type: " + o.getClass().getSimpleName();
    }

}

 

위의 예제 코드에서는 AbstractAnnotationValueVisitor14 클래스를 상속받아 MyAnnotationValueVisitor 클래스를 만들었습니다. MyAnnotationValueVisitor 클래스는 String 타입의 값을 반환하는 visitString 메소드, Enum 타입의 값을 반환하는 visitEnumConstant 메소드, 배열 타입의 값을 반환하는 visitArray 메소드를 오버라이드하여 처리하는 Visitor 클래스입니다.

이 Visitor 클래스를 사용하려면, 다음과 같이 AnnotationValue를 받아 Visitor 클래스의 visit 메소드를 호출하면 됩니다.

 

import javax.lang.model.element.AnnotationValue;
import javax.lang.model.element.Element;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.TypeElement;
import javax.lang.model.util.Elements;
import javax.lang.model.util.Types;

...

Elements elements = processingEnv.getElementUtils();
Types types = processingEnv.getTypeUtils();
Element element = ... // 처리할 Element

if (element.getKind() == ElementKind.METHOD) {
    ExecutableElement method = (ExecutableElement) element;
    TypeElement enclosingClass = (TypeElement) method.getEnclosingElement();
    MyAnnotationValueVisitor visitor = new MyAnnotationValueVisitor(method);
    for (AnnotationMirror annotationMirror : method.getAnnotationMirrors()) {
        Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotationMirror.getElementValues();
        for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
            System.out.println(entry.getKey().getSimpleName() + ": " + entry.getValue().accept(visitor, null));
        }
    }
}

 

위의 코드에서는 ElementUtils와 TypeUtils를 사용하여 처리할 Element를 가져온 후, 이 Element가 메소드인 경우에만 MyAnnotationValueVisitor 클래스를 사용하여 AnnotationValue를 처리하고 결과를 출력합니다. 이렇게 하면 AnnotationValue를 Visitor 패턴을 활용하여 쉽게 처리할 수 있습니다.