애노테이션 프로세서

아주 좋은예시로는 롬복이 존재한다

롬복이 없다면 getter, setter, constructor, toString, equals, hashcode 등등 이러한 중복되는 코드들을 항상 손으로 작성해야 한다 롬복의 애노테이션인 @Getter, @Setter, @AllArgsConstructor, @ToString, @EqualsAndHashCode 등을 넣어주면 실제 코드에는 그러한 구현체가 없었지만 -> 실제로 코드에서 사용하려고 보면 정상적으로 사용되는 것들을 사용할 수 있다는 점!

이러한 신기한 기능이 동작하는 원리는 이러하다 우선 애노테이션 프로세서는 컴파일 시점에 작동하는 기능이고 애노테이션 프로세서는 컴파일 시점에 끼어들어서 특정한 애노테이션이 붙어 있는 놈들을 참조해서 또 다른 소스코드를 생성하는 방식이다 여기서의 소스코드람은 굳이 자바에 한정되지 않고 문서와 같은 다른 언어들도 가능하다

컴파일 시점에 애노테이션 프로세서를 통해서 소스코드의 Abstract Syntax Tree(AST)를 조작한다 Syntax Tree란 -> 소스 코드의 구성을 순서도와 같이 생긴거로 만드는 방식이다

일단 기존의 소스 코드를 조작하는 것이 정상적인 사용법이 아니다 실제로 코드를 보면 단순하게 애노테이션만 붙어 있지만, 바이트 코드에서 만들어진 것을 보면 해당 애노테이션에 맞는 코드가 들어가 있는 상황이다 그래서 갑을논박이 진행되기도 한다네요

애노테이션 프로세서를 만들어보자

애노테이션을 선언할때는 Retention을 설정해준다 이놈은 해당 애노테이션을 어디까지 유지할 것인가 애노테이션이란 놈은 컴파일시에 사용하고, 바이트 코드에서는 필요가 없다 그러면 RetentionPolicy.CLASS는 바이트 코드까지 간다는 의미이기 때문에 필요 없고 RetentionPolicy.SOURCE까지만 주면 된다

그렇게 먼저 애노테이션을 선언하고, 해당 애노테이션의 동작을 맡을 프로세서를 만들어야 한다 프로세서를 만들기 위해서는 자바에서 제공하는 AbstractProcessor 를 상속받으면서 사용할 수 있다 기본적인 함수들은 원하는대로 찾아보고 사용할 수 있고 대표적인 것들을 보자

getSupportedAnnotationTypes() 이 함수는 이걸 구현한 프로세서가 어떠한 애노테이션을 처리할 것인지 명시해주는 곳이다 단순하게

public Set<String> getSupportedAnnotationTypes(){
    return Set.of(만든애노테이션.class.getName());
}

이렇게 사용할 수 있다

다음으로는 process()이라는 함수인데 이놈이 해당 애노테이션을 붙혔을 때 어떠한 작업을 할 것인지 구현하는 곳이다

public boolean process(Set<? extends TypeElement> annotations, RoundEnvirnment roundEnv){
    return false;
}

해당 파라미터로는 annotations과 RoundEnvironment 이렇게 2가지가 들어가게 되는데 RoundEnvironment는 애초에 processor라는 개념은 다양한 라운드에 걸쳐서 진행이되는데 마치, 안드로이드에서의 생명주기와 같다고 볼 수 있고 이 라운드를 의미한다 리턴타입으로는 기본적으로 boolean으로 잡혀있는데 default값으로는 true가 잡혀있다 -> 이 의미는 해당 애노테이션을 다음 라운드(생명주기)에서도 처리를 할 예정이라는 의미이다 그래서 false로 잡는다면 해당 함수(process)에서만 사용하겠다는 의미이다

해당 구현내용은 이러하다 우선은 해당 애노테이션이 적절한 위치(메소드, 필드 등)에 사용되었는가를 확인한다

Set<? extneds Element> elements = roundEnv.getElementsAnnotatedWith(애노테이션.class);

만약 이렇게되면 애노테이션을 선언할때 사용하는 @Target에서 elements.getKind()을 통해서 ElementKind 타입을 비교해가면서 확실하게 사용하는 것이 가능하다

일단 사용하는데 있어서 적당한 위치에 사용했는지를 우선 체크했고, 그 다음으로는 소스코드를 생성하는 것을 확인해보자 자바 소스 코드를 생성하는데 아주 유용한 라이브러리는 Javapoet 이라는 라이브러리가 있다 우선 의존성을 주입해주고,

우선은 element를 TypeElement으로 형변환을 해두고 -> 클래스를 만들고 -> 메소드를 만든다

TypeElement type = (TypeElement)element;
//클래스 생성
ClassName className = ClassName.get(typeElement);

//메소드 생성
MethodSpec createdMethodName = MethodSpec.methodBuilder("createdMethodName")
                                .addModifiers(Modifier.PUBLIC)
                                .returns(String.class)
                                //$에 대한 변수를 뒤에 인자로 넣어준다
                                .addStatement("return $S", "returnString")
                                .build();
                                
TypeSpec createdClassName = TypeSpec.classBuilder("createdClassName")
                                .addModifiers(Modifier.PUBLIC)
                                .addMethod(createdMethodName)
                                .build();
                                

여기까지 구현한 것은 클래스의 형태를 가진 객체를 만든 것이고 메모리에 저장되어있는 상황이다 그러면 이 객체를 실제로 파일로 만들어서 쏴 애노테이션을 선언한 곳에서 컴파일시에 소스코드로 만들어서 저장해둘 것이다

그리고 filer 이라는 소스 코드, 클래스 코드 및 리소스를 생성할 수 있는 인터페이스를 통해서 생성해야한다 생성한 프로세서(AbstractProcessor를 상속받은)에는 processingEnv이라는 변수를 AbstractProcessor 에서 제공해주고 있다

Filer filer = processingEnv.getFilter();
//여기 JavaFile을 통해서 최종적으로 파일을 생성하게 되는데, 우선적으로는 패키지명을 적어줘야하고, 해당 패키지명은 기본적으로 element변수와 같은 위치에 있는 것이 자연스럽다
JavaFile.builder(className.getPackageName(), createdClassName).build().writeTo(filer);

이렇게까지 해줘야 소스코드가 생성될 수 있으며, 저렇게 파일을 생성하는 코드에는 Exception을 따로 try-catch으로 처리해두고 원하는 에러 메세지를 출력할 수 있다

뭐 대충 이렇게 만들 수 있고 해당 애노테이션을 직접 사용하기 위해서는 애노테이션을 등록해줘야한다 그 방법은, resource 패키지 밑에 META-INF을 생성하고 그 밑에 services라는 패키지를 만들고 그 밑에 javax.annotation.processing.Processor 파일을 만들고 우리가 만든 프로세서의 패키지명을 작성해주면된다 근데 위에서 만든 케이스같은 경우에는 해당 애노테이션을 만들려고하는 시점이 소스를 컴파일할 때가 아닌데, 컴파일(빌드)하는 시점에 해당 프로세서가 돌아갈려고 하기 때문에 빌드에 실패한다 -> 이 문제는 애노테이션을 주석처리해두고 빌드해두고, 클린하지 말고 빌드하면 잘 작동된다 이런 방식으로는 너무 귀찮기도하고 패키지도 수동으로 만들어줘야하기 때문에 매우 귀찮다 이러한 것을 해결해주는게 google에서 만든 @AutoService라는 애노테이션이다 -> 요놈은 단순하게 만든 프로세서 위에 @AutoService(Processor.class) 이렇게만 작성해둬도 알아서 만들어진다..! Java Service Provider?는 뭐지..?

자 이렇게 만들고 나면 어떻게 사용하냐 우선 빌드하고나면 해당 프로젝트 정보(groupId, artifactId, version)을 가지고 사용하려는 프로젝트의 gradle에 적용하고 gradle을 돌려보면 External Libraries에 들어갈 것이다 그럼 이제는 그냥 쓰면 잘 돌아갈 예정이다!!! 추가적으로 IDE에서 Annotation Processor 설정에서 Enable annotation processing을 체크해줘야하는 사항을 기억하자 그리고 target/generated-sources/annotations/패/키/지/ 에 위에서 작성한 값들이 만들어져서 들어가 있다

진짜 신기하다... 토이때 꼭만들어보자....

이러한 Annotation Processor를 어디서 사용하냐?

애노테이션 프로세서는 소스코드 레벨에서, 소스코드에 붙어있는 애노테이션의 정보를 읽어서 컴파일러가 컴파일중에 새로운 소스코드를 생성하거나 기존 코드까지도 수정할 수 있다 크게 롬복, AutoService, @Override 등에서 사용하고 있다 애노테이션 프로세서를 사용하게되면 컴파일시에 코드를 처리해두기 때문에 런타임시에 들어가는 비용이 없다는 것이 장점이다