Netflix, ArchUnit 기반 Nebula ArchRules로 대규모 Java 프로젝트 아키텍처 관리

본문은 ArchUnit을 사용하여 아키텍처 규칙을 정의하고, 이를 Nebula ArchRules 플러그인을 통해 여러 Java 프로젝트에 적용하는 방법을 설명한다. ArchUnit은 ASM(ASM)을 사용하여 컴파일된 바이트코드를 분석하므로, 소스 코드의 언어(Kotlin, Scala 등)에 독립적으로 규칙을 적용할 수 있다. Nebula ArchRules는 Gradle 기반으로, 규칙을 정의하는 ArchRulesService 인터페이스(ArchRulesService Interface)를 제공하여 규칙을 쉽게 공유하고 관리할 수 있도록 지원한다. 또한, Standalone Rule Libraries와 Bundled Rule Libraries를 통해 규칙의 재사용성을 높이고, 자동화된 규칙 실행을 가능하게 한다.

ArchUnit은 AST(Abstract Syntax Tree) 기반의 정적 분석 도구와 달리, 컴파일된 바이트코드를 분석하여 언어 종속성(Language Dependency) 문제를 해결한다. PMD와 같은 도구는 AST 기반이므로, 각 언어별로 규칙을 다시 작성해야 하는 번거로움이 있다. ArchUnit은 클래스 관계(Class Relations)를 기반으로 규칙을 정의하므로, 코드의 실제 실행 흐름을 정확하게 파악할 수 있다. 또한, ArchUnit은 Fluent API(Fluent API)를 제공하여 규칙을 간결하고 가독성 있게 작성할 수 있으며, JUnit(JUnit)을 통해 쉽게 테스트할 수 있다.

Nebula ArchRules를 사용하면 Standalone Rule Libraries와 Bundled Rule Libraries를 통해 규칙을 쉽게 작성하고 배포할 수 있다. Standalone Rule Library는 ArchRulesService 인터페이스(ArchRulesService Interface)를 구현하여 규칙을 정의하고, Gradle Module Metadata를 사용하여 종속성을 관리한다. Bundled Rule Library는 라이브러리 코드와 규칙을 함께 묶어 배포하며, ArchRules Runner Plugin이 자동으로 규칙을 실행한다. 또한, ArchRules Runner Plugin은 JSON 및 콘솔 리포트를 제공하여 규칙 위반 사항을 쉽게 확인할 수 있도록 지원한다.

Netflix는 Nebula ArchRules를 사용하여 대규모 Java 프로젝트의 아키텍처 규칙을 관리하고, 기술 부채를 줄이는 데 성공했다. 특히, API Lifecycle Annotation을 활용하여 deprecated API의 사용을 감지하고, 코드 품질(Code Quality)을 향상시켰다. 또한, 자동화된 규칙 검사(Automated Rule Checking)를 통해 개발자가 코드 변경 시 즉각적인 피드백을 받을 수 있도록 지원한다. Netflix는 현재 358개 이상의 규칙을 5,000개 이상의 레포지토리에 적용하여, 약 100만 건의 문제를 감지하고 있으며, 이 중 1,000건은 High Priority 규칙에 해당한다. 향후 자동 수정(Auto-Remediation) 기능을 통합하여 개발 생산성을 더욱 향상시킬 계획이다.

본문은 ArchUnit의 향후 발전 방향으로 자동 수정(Auto-Remediation) 기능의 통합을 제시한다. ArchUnit은 규칙 위반에 대한 상세한 정보를 제공하므로, OpenRewrite와 같은 도구를 활용하여 자동 수정 솔루션을 구축할 수 있다. 또한, IDE(Integrated Development Environment) 통합을 통해 규칙 위반 정보를 실시간으로 확인할 수 있도록 지원할 예정이다. 이러한 기능들을 통해 개발자는 코드 품질을 더욱 효율적으로 관리하고, 기술 부채를 줄일 수 있을 것으로 기대된다.