ArchUnit으로 아키텍처 검사하기

개요

ArchUnit은 Java 코드의 아키텍처를 검사하기 위한 간결하고 확장 가능한 오픈소스 라이브러리입니다. ArchUnit은 Java의 기본 단위 테스트 프레임워크를 활용하여, 주어진 Java 바이트 코드를 분석하고 모든 클래스의 구조를 해석함으로써 애플리케이션의 아키텍처를 체계적으로 테스트할 수 있게 해 줍니다.

• 패키지 및 클래스 의존성 검사: 패키지와 클래스 간의 의존 관계를 분석하고, 격리된 구조를 유지하는지 확인
• 상속 관계 및 순환 참조 검사: 클래스 간의 상속 구조를 분석하고, 순환 참조가 없는지 검사
• 레이어 아키텍처 검사: 레이어 간의 의존성을 검사하여, 명확하고 견고한 레이어 구조를 유지하는지 확인
• 코딩 컨벤션 검사: 사용자가 정의한 코딩 규칙을 검사하여, 일관된 코딩 스타일을 유지하는지 확인

전체 코드는 깃허브에서 확인 가능합니다.

 

 

사용 방법

ArchUnit을 사용하기 위해서 복잡한 인프라 설정이나 새로운 언어 학습이 필요하지 않습니다. 기존 스프링 프로젝트에 간단하게 아래의 의존성을 추가함으로써 쉽게 사용할 수 있습니다.

dependencies {

    //archunit
    testImplementation 'com.tngtech.archunit:archunit:1.1.0'
}

 

 

코드

테스트 클래스와 초기 설정

class ArchitectureTest {
    JavaClasses javaClasses;

    @BeforeEach
    public void beforeEach() {
        javaClasses = new ClassFileImporter()
                .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS) // 테스트 패키지는 제외
                .importPackages("com.example.ArchUnit");
    }

    // 이하 테스트 메소드들...
}

ClassFileImporter는 ArchUnit을 사용하여 Java 클래스를 가져올 때 주로 사용되는 클래스입니다. ClassFileImporter는 다양한 체이닝 메서드를 제공하며, 가져올 클래스의 범위와 조건을 세밀하게 지정할 수 있습니다. 여기에서 사용된 withImportOption메서드는 가져올 클래스들에 대한 필터링 옵션을 설정하는 데 사용됩니다.

ClassFileImporter의 주요 메서드

• withImportOption(ImportOption option): 가져올 클래스에 대한 옵션을 설정합니다. 예를 들어, 테스트 클래스를 제외하거나 특정 패턴에 맞는 클래스만 포함시키는 등의 옵션을 설정할 수 있습니다.
• importPackages(String... packages): 지정된 패키지 내의 클래스들을 가져옵니다. 여러 패키지를 동시에 지정할 수 있습니다.
• importClasses(Class... classes): 특정 클래스들을 직접 지정하여 가져올 수 있습니다.
• importUrl(URL url): URL을 통해 클래스를 가져올 수 있습니다. 이는 웹 기반 리소스나 JAR 파일 등에서 클래스를 가져올 때 유용합니다.
• importJar(File jarFile): JAR 파일로부터 클래스들을 가져옵니다.

ImportOption의 주요 옵션들

• DO_NOT_INCLUDE_TESTS: 테스트 클래스를 제외합니다. 일반적으로 테스트 코드의 아키텍처를 검사할 필요가 없을 때 사용됩니다.
• DO_NOT_INCLUDE_ARCHIVES: 아카이브(예: JAR 파일) 내의 클래스를 제외합니다.
• DO_NOT_INCLUDE_JARS: JAR 파일 내의 클래스를 제외합니다.
• Predefined: 사전에 정의된 여러 옵션들을 제공합니다. 예를 들어, DO_NOT_INCLUDE_TESTS는 Predefined 옵션 중 하나입니다.

실제로는 옵션들이 더 많은데, 오픈 소스를 살펴보면 좋을 것 같습니다.

 

클래스 이름 검사

    @Test
    @DisplayName("Controller 패키지 내의 클래스의 이름은 'Controller'로 끝나야 한다.")
    void controllersShouldBeNamedCorrectly() {
        ArchRule rule = ArchRuleDefinition.classes()
                .that().resideInAPackage("..controller..")
                .should().haveSimpleNameEndingWith("Controller")
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

    @Test
    @DisplayName("서비스 패키지 내의 클래스의 이름은 'Service'로 끝나야 한다.")
    void servicesShouldBeNamedCorrectly() {
        ArchRule rule = ArchRuleDefinition.classes()
                .that().resideInAPackage("..service..")
                .should().haveSimpleNameEndingWith("Service")
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

    @Test
    @DisplayName("리포지토리 패키지 내의 클래스의 이름은 'Repository'로 끝나야 한다.")
    void repositoriesShouldBeNamedCorrectly() {
        ArchRule rule = ArchRuleDefinition.classes()
                .that().resideInAPackage("..repository..")
                .should().haveSimpleNameEndingWith("Repository")
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

위 세 개의 테스트 메서드는 ArchUnit을 사용하여 특정 클래스 유형의 이름이 일정한 패턴을 따르는지 검사합니다. 각 메서드는 다음과 같은 과정을 거칩니다.

1. ArchRuleDefinition.classes()를 사용하여 규칙을 정의한다. 이는 클래스 유형에 대한 규칙을 정의하기 위한 시작점이다.
2. .that().resideInAPacakage("..controller..")와 같은 메서드를 사용하여 특정 패키지 내의 클래스를 대상을 지정한다. 여기서 "..controller.."와 같은 문자열은 패키지 경로를 나타내며, 이 경로는 패키지 이름의 일부를 포함하거나 전체를 포함할 수 있다.
3. .should().havaSimpleNameEndingWith("Controller")와 같은 메서드를 사용하여 클래스 이름이 특정 문자열로 끝나야 한다는 규칙을 설정한다. 여기서는 각각 "Controller", "Service", "Repository"로 끝나는 이름을 가진 클래스만 통과시킨다.
4. .allowEmptyShould(true)는 해당 규칙에 대해 검사할 대상이 없을 경우(예: 특정 패턴을 따르는 클래스가 없거나, 패키지가 없는 경우) 테스트가 실패하지 않도록 한다.
5. rule.check(javaClasses)는 정의된 규칙을 javaClasses컬렉션에 대해 실행한다. 여기서 javaClasses는 테스트 대상이 되는 클래스들의 집합이다.

위 테스트를 통해 코드베이스 내에서 일관된 네이밍 컨벤션을 유지하고, 각 패키지(계층)의 클래스들이 그들의 역할에 맞는 이름을 가지고 있는지 확인할 수 있습니다.

 

컨트롤러의 의존성 검사

    @Test
    @DisplayName("컨트롤러는 서비스 클래스에만 의존해야 한다.")
    void controllersShouldOnlyDependOnServices() {
        ArchRule rule = ArchRuleDefinition.classes()
                .that().resideInAPackage("..controller..")
                .should().onlyDependOnClassesThat()
                .resideInAnyPackage("..service..", "java..", "..controller..")
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

이 테스트는 컨트롤러 클래스가 서비스 클래스, 자바 기본 클래스, 또는 다른 컨트롤러 클래스에만 의존해야 한다는 규칙을 검사합니다.

이를 통해 컨트롤러가 서비스 계층에만 의존하고, 다른 계층(예: 리포지토리, 유틸리티 클래스 등)에 직접적으로 의존하지 않도록 함으로써, 코드의 모듈성과 유지보수성을 높일 수 있습니다.

 

필드 인젝션 검사

    @Test
    @DisplayName("모든 클래스는 필드 인젝션을 사용하지 않아야 한다.")
    void allClassesShouldNotUseFieldInjection() {
        ArchRule rule = ArchRuleDefinition.fields()
                .that().areDeclaredInClassesThat().resideInAPackage("..")
                .should().notBeAnnotatedWith(Autowired.class)
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

위 테스트는 모든 프로젝트 내의 클래스에 대해 @Autowired를 통한 의존성 주입을 사용하는지 검사합니다.

 

순환 의존성 검사

    @Test
    @DisplayName("클래스들은 순환 의존성을 가지면 안 된다.")
    void noCyclicDependencies() {
        ArchRule rule = SlicesRuleDefinition.slices()
                .matching("com.example.ArchUnit.(*)..")
                .should().beFreeOfCycles()
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

위 테스트는 프로젝트 내의 클래스들 사이에 순환 의존성이 존재하지 않아야 한다는 규칙을 정의합니다.

SlicesRuleDefinition.slices()는 프로젝트 내의 클래스를 여러 슬라이스로 그룹화하는 기능을 제공하며, matching("com.example.ArchUnit.(*)..")부분은 com.example.ArchUnit패키지 아래의 모든 클래스를 대상으로 규칙을 적용하겠다는 것을 나타냅니다. 여기서 `(*)`는 하위 패키지를 포함하는 와일드카드를 의미합니다.

should().beFreeOfCycles()부분은 이 슬라이스들 사이에 순환 의존성이 없어야 한다는 규칙을 설정합니다. 만약 순환 의존성이 발견되면, 테스트는 실패합니다.

 

클래스 접근 검사

    @Test
    @DisplayName("서비스 클래스는 컨트롤러 클래스에 접근하지 않아야 한다.")
    void servicesShouldNotAccessControllers() {
        ArchRule rule = ArchRuleDefinition.classes()
                .that().resideInAPackage("..service..")
                .should().onlyAccessClassesThat()
                .resideOutsideOfPackage("..controller..")
                .allowEmptyShould(true);  // 빈 결과 허용

        rule.check(javaClasses);
    }

위 테스트는 서비스 클래스들이 컨트롤러 클래스에 접근하지 않아야 한다는 규칙을 정의합니다. 일반적으로 계층화된 아키텍처에서 서비스 레이어가 컨트롤러 레이어에 종속되지 않는 것을 목표로 하며 컨트롤러와 서비스뿐만 아니라 다양하게 검사할 수 있습니다.

.should().onlyAccessClassesThat().resideOutsideOfPackage("..controller..")부분은 서비스 클래스들이 "controller" 패키지 외부의 클래스들에만 접근해야 한다는 규칙을 설정합니다. 만약 서비스 클래스가 컨트롤러 클래스에 접근하는 경우가 발견되면, 테스트는 실패합니다.

 

 

테스트 관련 같이 보면 좋은 글

• AssertJ 핵심 기능 알아보기
• Junit5 자세히 알아보기
• TestContainer로 통합 테스트 환경 구축하기
• LocalStack을 활용한 AWS S3 테스트 환경 구축하기