[💡]멀티모듈에 관하여..(_ _)

멀티 모듈 !
최근 개인 프로젝트+실습 과제 등등 멀티 모듈을 적용해볼 일이 많았다. 말로만 하면 그저 모듈을 분리하면 되는 것이 아닌가 하겠지만 막상 적용하려면 무수한 오류를 맞닥뜨린다.
이 오류들이 나의 밑거름이 될 수 있도록 오늘도 포스팅하여 잊지 않기!

생성방법

멀티 모듈 생성 방법은 쉽다. 그저 마우스 우클릭 + Module + 생성만 해주면 완성이다. 그럼 루트 프로젝트 하위에 내가 만들려던 모듈이 생성되고

이렇게 각각의 모듈 안에 build.gradle 파일이 존재하는 것을 확인할 수 있다.
(이건 잠깐 반짝인 아이디어를 실행해 볼 토이 프로젝트..)
루트에 src는 사용하지 않을 거라 삭제해줬다.

대망의 설정방법

일단 settings.gradle 에 하위 모듈들이 잘 세팅이 되었나 확인

domain과 api 모듈을 포함한다고 잘 세팅이 되어있다. 안되어있어도 타이핑 해주고 코끼리 눌러서 적용해주면 되니 걱정은 금물

첫번째로 루트 하위 build.gradle 파일을 수정한다.

// Gradle이 빌드되기 전 실행되는 설정
buildscript {
	ext {
		springBootVersion = '3.0.3'
	}
	repositories {
		mavenCentral()
	}
	dependencies {
		classpath "org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}"
		classpath "io.spring.gradle:dependency-management-plugin:1.1.0.RELEASE"
	}
}

// 현재 root 프로젝트와 서브 모듈에 대한 설정
allprojects {}

// 전체 서브 모듈에 해당되는 설정
subprojects {
	apply plugin: 'java-library'
	apply plugin: 'org.springframework.boot'
	apply plugin: 'io.spring.dependency-management'

	group = 'com.sek.ottfind'
	version = '0.0.1-SNAPSHOT'
	sourceCompatibility = '17'

	repositories {
		mavenCentral()
	}

	dependencies {
		compileOnly 'org.projectlombok:lombok'
		annotationProcessor 'org.projectlombok:lombok'
		testImplementation 'org.springframework.boot:spring-boot-starter-test'
	}

	tasks.named('test') {
		useJUnitPlatform()
	}
}

// api 모듈에 domain의 의존성을 추가
project(':api') {
	dependencies {
		implementation project(':domain')
	}
}

apply plugin: 'java' 가 아니라 apply plugin: 'java-library' 인 이유는 아래에서 설명하겠다.

두번째로 domain의 build.gradle 파일

dependencies {
    api 'org.springframework.boot:spring-boot-starter-data-jpa'
    api 'org.springframework.boot:spring-boot-starter-web'

    runtimeOnly 'com.mysql:mysql-connector-j'
}
bootJar {
    enabled = false
}

jar {
    enabled = true
}

여기 dependencies 를 보면 implementation이 아니라 api를 사용했는데 implementation을 쓰면 직접 의존하는 domian 모듈밖에 의존성을 사용할 수 없기 때문이다. api 모듈에서도 쓰기 위해선 api 명령어를 사용해주어야 하고 그러려면 위에서 말한 플러그인 아이디는 java가 아닌 java-library 사용하면 된다.

bootJar는 실행가능한 jar를 만들기 때문에 main()이 필요한데 domain는 main()이 없다. 따라서 domain에 enabled를 false 옵션으로 설정하여 추후 domain에 있는 bean class를 다른 모듈에서 에러 없이 사용하도록 한다.

마지막으로 api의 build.gradle 파일은

dependencies {}

필요한 의존성을 추가해주면 된다.
모든 설정을 완료해주면 api 서버에서도 domain의 의존성이 추가되어 사용할 수 있다.

queryDSL 적용

아직도

Attempt to recreate a file for type com.sek.ottfind.domain.entity.QTest

에러에서 헤어나오고 있지 못하긴 하다만 ..

plugins {
    // QueryDSL 플러그인 추가
    id "com.ewerk.gradle.plugins.querydsl" version "1.0.10"
}
dependencies {
    api 'org.springframework.boot:spring-boot-starter-data-jpa'
    api 'org.springframework.boot:spring-boot-starter-web'

    // QueryDSL 의존성 추가 (스프링 부트 3.0 +)
    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
    annotationProcessor "com.querydsl:querydsl-apt:${dependencyManagement.importedProperties['querydsl.version']}:jakarta"

    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
    annotationProcessor "jakarta.persistence:jakarta.persistence-api"

    runtimeOnly 'com.mysql:mysql-connector-j'
}
bootJar {
    enabled = false
}

jar {
    enabled = true
}

// QClass 디렉토리 생성 위치
def querydslDir = "$buildDir/generated/querydsl"
querydsl {
    jpa = true
    querydslSourcesDir = querydslDir
}
// QClass 소스 위치 지정
sourceSets {
    main.java.srcDir querydslDir
}
compileQuerydsl{
    options.annotationProcessorPath = configurations.querydsl
}
configurations {
    compileOnly {
        extendsFrom annotationProcessor
    }
    querydsl.extendsFrom compileClasspath
}

일단 domain 쪽에 queryDSL 설정을 추가해주면 된다.
dependencies 에 추가하는 부분에서 애를 많이 먹었다 T^T 스프링 부트 3.0+ 부터는 조금 다른 설정방식이 필요했다.

annotationProcessor "jakarta.annotation:jakarta.annotation-api"
annotationProcessor "jakarta.persistence:jakarta.persistence-api"

이 구문은

java.lang.NoClassDefFoundError:javax/persistence/Entity

이 에러 방지를 위해 추가해준다.

일단 큐클래스 생성까지는 잘되는데 아무리 build clean을 하고 generated 디렉토리를 삭제해도 저 에러가 없어지질 않는다. 좀 더 찾아보고 포스팅을 수정해야겠다!

그럼 오늘은 이만..