2015. 11. 28.

Gradle 을 이용해서 Multiproject 를 구성하는 방법 (중 하나)

개요

회사에서 Gradle 을 이용하게 된 이래로 계속 Multi-project 형태로 설정하여 진행을 해 오고 있다.
매번 멀티 프로젝트 형태로 만들어지고 있는 회사의 프로젝트들이다 보니 그때마다 다시 이전 빌드 스크립트를 보면서 만드는데 프로젝트들이 복잡하다보니 필요없는 설정들까지 복사해서 쓰고 있는 부분들이 있어서 한번 정리를 했으면 하고 있었다.
가장 기본적인 상태의 멀티프로젝트용 build.gradle 에 대한 여러가지 방법 중 한가지라 생각하고 참고가 된다면 좋겠다.

요구사항

기본 요구사항은 다음과 같다.
1) 멀티프로젝트는 디렉터리를 기반으로 아래와 같이 그룹으로 만들어 질 수 있어야 한다.
  - Shared : 다른 프로젝트에서 Dependency로 추가될 수 있는 공통 라이브러리를 포함하는 라이브러리 모듈 그룹
  - Web : Front 모듈 그룹
  - Server : 주로 어플리케이션 간의 설정 등을 관리하는 Server 모듈 그룹
  - Service : Web API 서버 모듈 그룹
2) 모든 Subproject 들은 Java project 이며, 프로젝트 명은 "모듈그룹명-모듈명" 으로 만든다. 즉, Server 모듈의 configuration-server 모듈이라면 server-configuration-server의 형태로 만들어지면 된다.

이후에 작업된 모든 내용은 Ubuntu 14.04 OS와 IntelliJ IDEA 15에서 작업되었다.
(윈도우즈와 이클립스에서도 동일한 내용을 동작이 될 것으로 보인다. 다만, 테스트되지 않았을 뿐이다)

Main Gradle Script 작업

1) 파일 구성
  - build.gradle : gradle script 파일
  - settings.gradle : sub project 관리를 위한 파일

2) build.gradle 파일 작성
  - 우선은  프로젝트 기본 정보로 group 정보와 version 을 설정한다. 본인의 입맛에 따라 설정하면 된다. 또한, 전체 프로젝트를 감싸는 프로젝트 인 만큼 plugin은 base 로 설정한다.
group 'com.road.sample'
version '1.0-SNAPSHOT'
apply plugin: 'base'
apply plugin: 'eclipse'
apply plugin: 'idea'

  - buildscript 와 allprojects 블럭을 설정한다. 여기서는 repository 정보로 jcenter(bintray) 를 설정했지만, 많이 사용하는 mavenCentral() 이나 커스텀으로 설정해도 된다.
buildscript {
    repositories {
        jcenter()
    }
}

// Wrapper를 이용해서 gradle version을 정해주는 것이 좋다.
task wrapper(type: Wrapper) {
    // version 정보는 후에 gradle.properties로 옮기는 게 좋을 듯 하다.
    gradleVersion = '2.9'
}

allprojects {
    repositories {
        jcenter()
    }
}

- subproject 들을 위한 설정을 진행한다. 아직은 별다른 내용이 없으므로,  모든 subproject는 자바 프로젝트라는 요구사항을 만족시키기 위해서 java plugin 으로 설정하고, 자바 버전과 인코딩 설정 그리고 모든 프로젝트에 junit dependency를 설정해주는 정도의 작업을 진행한다.
subprojects { subproject ->
    apply plugin: 'java'

    sourceCompatibility = 1.8
    targetCompatibility = 1.8

    [compileJava, compileTestJava]*.options*.encoding = 'UTF-8'

    repositories {
        jcenter()
    }

    dependencies {
        testCompile group: 'junit', name: 'junit', version: '4.11'
    }

}


여기까지 기본 설정은 마무리가 되었다.

여기까지 진행되면 아래와 비슷한 모습이 되어있을 것으로 기대된다.

(settings.gradle 파일은 아직 없을 것이지만...)

이제 subproject 를 설정하기 위한 작업들을 진행해야 한다.

요구사항에서 하위 그룹 디렉터리는 크게 Shared, Web, Server, Service 로 나누어진다.
해당 디렉터리의 하위에 모듈을 생성하고 그래들 빌드를 하면 해당 모듈이 서브 프로젝트로 등록되도록 처리하는 작업이 남았다.

우선은 settings.gradle 파일에 대한 설정을 먼저 진행하자.

3) settings.gradle 작성

- 우선은 root project의 이름을 지정한다. 안해도 되지만, root project가 rootproject 따위로 나오는 건 원하지 않으니까...
rootProject.name = 'gradle-multiproject'

- 요구사항의 그룹 디렉터리를 돌면서 하위 디렉터리가 있으면 서브프로젝트로 등록하는 스크립트를 등록하자.  만약 그룹 디렉터리가 없으면 해당 디렉터리를 생성하는 스크립트도 넣어보자.
['shared', 'web', 'server', 'service'].each {
    def projectDir = new File(rootDir, it)

    // 만약 그룹디렉터리가 없으면 생성한다.
    if( !projectDir.exists() ) {
        projectDir.mkdirs()
    }

    // 모듈 그룹 디렉터리 하위에 디렉터리가 있으면 서브프로젝트로 등록한다.
    projectDir.eachDir { dir ->
        include ":${it}-${dir.name}"
        project(":${it}-${dir.name}").projectDir = new File(projectDir.absolutePath, dir.name);
    }
}

여기서 build.gradle 설정을 다시 적용해보면 (각 IDEA에 맞춰서 또는 gradle 스크립트로) 아래 이미지와 같은 디렉터리 상태로 변경되어있을 것이다.

물론 gradle projects 명령을 이용해서 결과를 보면 아직 서브프로젝트가 없으므로 아래와 같이 나올 것이다.


이제 여기서 하위 모듈 하나 만들어서 넣어보자.

하위 모듈의 등록

하위 모듈은 server 그룹 디렉터리 안에 config-server를 하나 등록해 보고자 한다.

1) 디렉터리 생성

- server 디렉터리 하위에 config-server 라는 디렉터리를 하나 만들고 build.gradle 설정을 다시 적용해보자.



위 그림과 같이 정상적으로 서브 프로젝트가 만들어졌는데 뭔가 귀찮은 일이 벌어져버렸다.
자바 프로젝트의 기본 폴더인 src, src/java, src/main, src/test 등등을 다 수작업을 해야 하는 상황이 발생한거다. 이것까지 기본으로 하면 좋을 것 같다.

- 자 다시 메인 디렉터리의 build.gradle의 subprojects 처리 블럭에 아래의 내용을 추가하자.
    task initSourceFolders {
        subproject.sourceSets*.java.srcDirs*.each {
            if( !it.exists() ) {
                it.mkdirs()
            }
        }

        subproject.sourceSets*.resources.srcDirs*.each {
            if( !it.exists() ) {
                it.mkdirs()
            }
        }
    }

이제 build.gradle 을 다시 적용해보면 아래와 같은 형태로 기본 디렉터리 작업이 완료되고 해당 build path 등도 정상적으로 적용되어있는 것을 확인할 수 있다. 이제 끝.

하위 모듈들의 디렉터리에도 되도록이면 build.gradle 파일을 만들고 그 안에 dependency 를 작업하는 것이 메인의 dependency 관련 설정을 줄일 수 있어서 좋다.

이전에는 subprojets 처리 부분에서 각 프로젝트의 이름을 잡아서 설정을 넣어주는 방식을 했었는데, 처음에는 모듈 그룹에 적용하기 편리한 부분이 있었으나, 이후 프로젝트별로 나뉘어지는 dependency들까지 모두 그 안에 넣다보니 너무 복잡해지는 불편함이 있었다.
두가지 방법을 적당히 섞어서 쓴다면 매우 편리할 듯 하다.

그럼 그래들과 함께 개발을 편하게 진행할 수 있기를 바라며, 마지막으로 완성된 build.gradle과 settings.gradle 의 내용은 아래와 같다.

[build.gradle]

group 'com.road.sample'
version '1.0-SNAPSHOT'

apply plugin: 'base'
apply plugin: 'eclipse'
apply plugin: 'idea'

buildscript {
    repositories {
        jcenter()
    }
}


allprojects {
    repositories {
        jcenter()
    }
}

task wrapper(type: Wrapper) {
 gradleVersion = '2.9'
}

subprojects { subproject ->
    apply plugin: 'java'

    sourceCompatibility = 1.8
    targetCompatibility = 1.8

    [compileJava, compileTestJava]*.options*.encoding = 'UTF-8'

    repositories {
        jcenter()
    }

    dependencies {
        testCompile group: 'junit', name: 'junit', version: '4.11'
    }

    task initSourceFolders {
        subproject.sourceSets*.java.srcDirs*.each {
            if( !it.exists() ) {
                it.mkdirs()
            }
        }

        subproject.sourceSets*.resources.srcDirs*.each {
            if( !it.exists() ) {
                it.mkdirs()
            }
        }
    }
}

[settings.gradle]
rootProject.name = 'gradle-multiproject'
['shared', 'web', 'server', 'service'].each {
    def projectDir = new File(rootDir, it)

    // 만약 그룹디렉터리가 없으면 생성한다.
    if( !projectDir.exists() ) {
        projectDir.mkdirs()
    }

    // 모듈 그룹 디렉터리 하위에 디렉터리가 있으면 서브프로젝트로 등록한다.
    projectDir.eachDir { dir ->
        include ":${it}-${dir.name}"
        project(":${it}-${dir.name}").projectDir = new File(projectDir.absolutePath, dir.name);
    }
}

댓글 2개: