[java] 애노테이션 프로세서를 이용한 코드 생성

12 Dec 2023

java

애플리케이션 개발 시 반복되는 코드 작성을 줄이고, 보다 효율적인 작업을 위해 애노테이션 프로세서를 사용할 수 있습니다. 애노테이션 프로세서는 컴파일 시점에 소스 코드를 분석하고, 이를 바탕으로 새로운 소스 코드나 리소스 파일을 생성할 수 있습니다.

애노테이션 프로세서의 장점

반복적이고 지루한 작업 자동화: Getter 및 Setter 메서드 생성, JSON 직렬화 등과 같은 반복 작업을 애노테이션을 통해 자동화할 수 있습니다.
컴파일 시간 안전성: 애노테이션 프로세서를 통해 코드를 생성하므로, 이후의 작업에서 안전한 코드를 유지할 수 있습니다.
코드 중복 최소화: 애노테이션 프로세서를 사용하여 코드 작성을 줄이고, 중복을 최소화할 수 있습니다.

애노테이션 프로세서를 사용한 코드 생성 예제

// 애노테이션 정의
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface GenerateCode {
    String className();
}

// 애노테이션 프로세서
@SupportedAnnotationTypes("com.example.GenerateCode")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class CodeGeneratorProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement annotation : annotations) {
            for (Element element : roundEnv.getElementsAnnotatedWith(annotation)) {
                // 소스 코드 생성 로직
                String className = element.getSimpleName() + "Generated";
                // ... (생성된 코드 작성)
            }
        }
        return true;
    }
    // ...
}

// 사용 예제
@GenerateCode(className = "GeneratedClass")
public class MyClass {
    // ...
}

위 예제에서 GenerateCode 애노테이션과 애노테이션 프로세서를 사용하여 MyClass에 해당하는 새로운 클래스를 생성할 수 있습니다.

애노테이션 프로세서를 통해 보다 효율적이고 유지보수가 용이한 코드 작성을 할 수 있으며, 이를 통해 개발 시간을 단축하고 품질을 향상시킬 수 있습니다.

참고 자료

Oracle Java SE Documentation