hexagonal architecture 방식으로 multi module 구성해보기

[beaniejoy]

📌 multi-module 구성도

• application
  • api endpoint, controller단과 관련된 부분
  • account-api, service-api 다시 하나로 통합
• domain
  • 핵심 비즈니스 로직만을 담은 모듈
  • service, repository를 interface로 두고 application과 db 모듈에서 가져다 사용할 수 있게 구성
• db(persistence)
  • DB config관련 및 repository의 구현체내용
  • ex. mysql db 접근, mongo db 접근 등 관리
• test 우선 스킵(이후 issue를 통해 개발 예정)

📌 고려사항

🏷️ multi module에서 resources 내부 설정파일 관리

• 각 모듈에서 resources/application.yml 같이 동일한 이름으로 지정하면 overriding 됨
• account-api > common > domain 에서 account-api 실행시 해당 모듈의 application.yml 파일을 사용
• app:service-api 모듈에서 db 모듈 가져올 때 runtimeOnly로 설정시 application.yml 설정을 가져오지 못하는 이슈 있음

🏷️ test에서의 application.yml 관리

• testImplementation 한 것이 아니기에 common이나 domain의 resouces 내용 가져오지 못함
• 다른 방법 필요해보임

ex. service-api 에서 @SpringBootTest 수행

1. service-api/src/test/resources/application.yml 이 있으면 이걸 최우선으로 적용
2. 1이 없으면 implementation한 domain에서 domain/src/main/resources/application.yml 을 참고
3. 2가 없으면 service-api/src/main/resources/config/application.yml 참고

즉, domain 모듈을 implementation 해도 해당 모듈의 src/test/resources/application.yml 내용은 참고 X

🏷️ test 하위 implementing한 모듈 포함 테스트

app:service-api 모듈 테스트 수행시, app:common, domain 모듈도 테스트가 수행되어야 할 필요가 있음
(CI 과정에서 test 수행하는데 최종 application 실행하기 위한 executable jar로 build되는 app:account-api, app:service-api로 test 수행할 예정)

// app:service-api module's build.gradle.kts
afterEvaluate {
    project.tasks.withType<Test> {
        dependsOn(":app:common:test")
    }
}

afterEvaluate를 통해 root build.gradle.kts에 설정된 Test task 설정에 대해서 특정 속성 overriding을 할 수 있다.

🏷️ mapstruct with kotlin

• 주의사항
  • single argument constructor에 대해서 build fail 발생 > unmapped target property: "copy".
  • (관련 이슈)
  • single argument에 대해서는 그냥 data class가 아니라 해당 argument 그 자체를 사용하는 것으로
• no default constructor
  • 1.4 버전 이후로 default constructor 없이도 mapstruct에서 알아서 constructor 사용
  • (관련 stackoverflow 내용)

📌 프로젝트 수정 사항

companion object {
    val permittedUrls = arrayOf(
        "/error",
        "/auth/members/join",
        "/auth/authenticate"
    )

    // resource urls
    val resourceUrls = StaticResourceLocation
        .values()
        .flatMap {
            it.patterns.toList()
        }
        .toTypedArray()
}

/*
@Bean
fun webSecurityCustomizer(): WebSecurityCustomizer {
    return WebSecurityCustomizer { web ->
        web.ignoring().requestMatchers(PathRequest.toStaticResources().atCommonLocations())
        web.ignoring().antMatchers("/error")
    }
}
*/

[beaniejoy]

References

• https://www.baeldung.com/hexagonal-architecture-ddd-spring
• https://toss.tech/article/how-to-manage-test-dependency-in-gradle

[beaniejoy]

gradle 버전 업

• 7.4.1 > 7.6.1
• gradle build 과정에서 GradleVersion.getNextMajor() deprecated warning 발생
  • 이에 대한 issue link
  • io.spring.dependency-management plugin version upgrade: 1.0.11.RELEASE > 1.0.14.RELEASE
• kotlin version upgrade (1.6.10 > 1.7.21)