Java Annotation Processor 와 Lombok (feat. AST)

레벨 3 해커톤 중 에러를 마주쳤습니다.

잘만 동작하던 코드였는데, 갑자기 컴파일에 실패했습니다.

@Getter를 사용한 코드들에서 메서드를 찾을 수 없다는 에러였는데요.

 

사실 해당 에러는 이전에도 프로젝트를 했었을 때 몇번 봤었던 에러였습니다.

항상 Annotation Processor라는 의존성을 추가하고 그저 넘어갔었는데, 이번 기회를 통해 정확하게 해당 Lombok Annotation Processor가 의미하는 바를 파악하기 위해 작성하게 되었습니다.

Syntax tree 란

먼저 Annotation Processor를 알아보기 전에 알아두어야 할 개념이 있습니다.

Syntax tree에 대해서 먼저 알아두면 좋을 것 같은데요.

 

Syntax tree는 Parse Tree라고도 불리는데요.

Parse Tree 즉, 구문 분석 트리는 프로그래밍 언어나 자연어의 문장 구조를 나타내는 트리 구조입니다. 주로 컴파일러 설계와 자연어 처리에서 사용되며 소스 코드의 모든 구문적 세부 사항을 포함합니다.

 

AST란

AST 즉, abstract syntax tree란 위의 syntax tree를 추상화한 트리입니다.

 

AST는 Parse Tree보다 추상화된 형태로, 불필요한 구문적 세부사항을 제거합니다.

때문에 코드의 구조를 더 명확하게 표현하며, 코드 분석과 변환에 용이합니다.

 

출처: https://ruslanspivak.com/lsbasi-part7/

 

그림으로 보면 확실히 둘의 차이가 느껴지는 것 같습니다.

---

Annotation Processor이란

돌아와서 java의 Annotation Processor 에 대해 알아봅시다.

Annotation Processor는 Java 소스 코드나 컴파일된 클래스에서 말 그대로, 애노테이션을 처리하는 도구입니다.

 

 

컴파일러는 소스 코드에서 애노테이션을 발견하면 해당 애노테이션을 처리할 Annotation Processor를 찾아 활성화합니다.

 

자바 Annotation Processing API

자바에서는 Java 6부터 도입된 Annotation Processing API를 통해 Annotation Processor를 제공합니다.

 

 

Processor 인터페이스를 보면, 애노테이션 프로세서를 위한 인터페이스로 컴파일 시 애노테이션을 처리하는 역할을 합니다.

 

Processor는 어노테이션을 여러 라운드에 걸쳐 다음과 같이 처리합니다.

• 각 라운드에서 애노테이션 프로세서가 실행되고, 그 과정에서 새로운 소스 파일을 생성할 수 있습니다.
• 새로운 소스 파일이 생성되면 다음 라운드가 시작됩니다.
• 더 이상 새로운 소스 파일이 생성되지 않으면 처리가 종료됩니다.

자바 Annotation Processing API 사용방법

 

내가 직접 생성한 Annotation을 다른 방식으로 처리하고 싶다라면 AbstractProcessor 클래스를 상속하여 Annotation Processor를 직접 구현하면 됩니다.

 

AbstractProcessor에는 process() 메소드가 있는데요. 이 메서드를 오버라이드하여 애노테이션 처리 로직을 작성하면 됩니다.

Lombok Annotation Processor이란

지금까지 오기가 조금 길었네요.

Lombok은 다들 아시다 싶이 반복적인 보일러 플레이트 코드 (ex. getter)를 Annotation 형태로 사용할 수 있게 해주는 라이브러리인데요.

 

앞의 내용을 토대로 Lombok Annotation Processor가 무엇인지 유추할 수 있습니다.

바로 Lombok 어노테이션에 대한 Annotation Processor 라는 것인데요.

 

Annotation Processor를 주입해줘야 하는만큼 Lombok의 Annotation Processor은 조금 다르게 동작합니다.

여기서 잊혀져 가는 AST가 나옵니다.

 

Lombok의 Annotation Processor는 우리가 어노테이션을 부착하면 그에 맞는 코드(ex. getter)를 생성해줍니다.

 

Lombok Annotation Processor 동작과정

1. LombokProcessor는 AST를 순회하며 롬복 애노테이션(@Getter, @Setter 등)을 찾습니다.
2. 각 애노테이션에 대응하는 핸들러(예: GetterHandler, SetterHandler)를 호출합니다.
3. 각 핸들러는 AST를 분석하고 필요한 코드를 생성합니다.
   • 예를 들어, @Getter 애노테이션을 만나면 GetterHandler가 getter 메서드에 해당하는 AST 노드를 생성합니다.
4. 생성된 AST 노드를 기존 AST에 주입합니다. 
   • 이때 롬복은 자바 컴파일러의 내부 API를 사용하여 AST를 직접 수정합니다.
5. 수정된 AST 컴파일 
   
   • 롬복에 의해 수정된 AST를 기반으로 자바 컴파일러가 바이트코드를 생성합니다.
6. 컴파일된 클래스 파일에는 롬복이 생성한 메서드가 포함됩니다.
   • 원본 소스 코드는 변경되지 않지만, 컴파일된 결과물에는 추가된 코드가 반영됩니다.

---

이렇게 롬복이 어떻게 동작하는지 알아보았습니다.

사실 자바로 개발하면서 롬복이라는 라이브러리를 사용하는 것처럼, 자바 Annotation Processing API를 직접 사용하는 일은 거의 없다고 합니다.

 

그래도 롬복이 어떻게 동작하는지 알게 되니 재미있는 것 같네요!

의존성도 그냥 추가하는 것이 아닌 왜 필요한지 의문을 가지며 보는 것이 중요한 것 같습니다!

 

그러면 오늘도 파이팅! 🔥