Android のモジュールのパスを簡潔にする
はじめに
Android Studio1 上で multi-module project2 を構成する際に、モジュール名とフォルダ構成に関して、以下のようなトレードオフを考えることがあります。
- フォルダ構成の混沌さを許容しつつ、モジュール名を簡潔する。
- 中間フォルダを設けてフォルダ構成をわかりやすくしつつ、モジュール名に中間フォルダ名を含める。
本稿では、これらのトレードオフの説明と、双方のメリットのみを享受する方法を示します。
トレードオフ
◆ サブモジュール名を簡潔にする
サブモジュール名を :android
, :kotlin
のように簡潔に記述する。
☆ メリット
サブモジュール名が簡潔になります。
include ':android'
include ':kotlin'
☆ デメリット
フォルダ構成がカオスになり、サブモジュールの名前空間も制限されます。3
※ モジュールと非モジュールフォルダ数十個が混然一体とした状況を想像してみてください。カオスです、、、。
◆ 中間フォルダを設ける
☆ メリット
フォルダ構成が簡潔になり、サブモジュールの名前空間も制限されません。4
☆ デメリット
サブモジュール名が無駄に長くなります。
include ':modules:android'
include ':modules:kotlin'
メリットのみを享受する方法
◆ settings.gradle
settings.gradle
include(
':android',
':kotlin'
)
// ↑ は以下と等価です。どちらでもOKです。
// include ':android'
// include ':kotlin'
project(":android").projectDir = new File(rootDir, "/modules/android")
project(":kotlin").projectDir = new File(rootDir, "/modules/kotlin")
☆ 自動化版
include(
':android',
':kotlin'
)
// ↑ は以下と等価です。どちらでもOKです。
// include ':android'
// include ':kotlin'
project(":android").projectDir = new File(rootDir, "/modules/android")
project(":kotlin").projectDir = new File(rootDir, "/modules/kotlin")
modules フォルダ直下に全サブモジュールのみが配置されるのであれば、以下のようにモジュールの列挙から設定までを自動化することもできます。5
new File("modules").listFiles().each { file ->
def name = file.getName()
def path = ":$name"
include path
project(path).projectDir = new File(rootDir, "/modules/$name")
}
◆ サブモジュールの参照例
include ':android'
include ':kotlin'
◆ Android 用の表示例
おわりに
- Android Studio 上で multi-module project を構成する際に、Gradle project に任意の名称を設定することにより、モジュール名とフォルダ構成の両方を簡潔にする方法を説明しました。
- settings.gradle の記述を自動化する例を示しました。
それでは、また。
追記(2020-08-04)
モジュールを動的に追加する Gradle Plugin を作ってみた
概要
- "build.gradle" もしくは "build.gradle.kts" の存在する箇所をすべて include します。ただし、root project, buildSrc は無視します。
- 例えば、"/modules/android/build.gradle.kts" が存在する場合は、":modules:android" が include されます。
使い方
settings.gradle.kts
もしくは settings.gradle
に以下のように設定します。
注意: build.gradle ではなく settings.gradle なので注意!
buildscript {
repositories {
// mavenLocal() // for of-commons SNAPSHOT release
maven { url = uri("https://beyondseeker.github.io/of-commons/mvn-repo") } // for of-commons
google()
jcenter()
}
dependencies {
classpath("com.objectfanatics:gradle-plugin-dynamicmodulesplugin:0.0.1")
}
}
apply(mapOf("plugin" to "com.objectfanatics.gradle.plugin.dynamicmodulesplugin"))
buildscript {
repositories {
// mavenLocal() // for of-commons SNAPSHOT release
maven { url = uri("https://beyondseeker.github.io/of-commons/mvn-repo") } // for of-commons
google()
jcenter()
}
dependencies {
classpath 'com.objectfanatics:gradle-plugin-dynamicmodulesplugin:0.0.1'
}
}
apply plugin: 'com.objectfanatics.gradle.plugin.dynamicmodulesplugin'
Author And Source
この問題について(Android のモジュールのパスを簡潔にする), 我々は、より多くの情報をここで見つけました https://qiita.com/beyondseeker/items/6a1f0caddf995f5df46d著者帰属:元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。
Content is automatically searched and collected through network algorithms . If there is a violation . Please contact us . We will adjust (correct author information ,or delete content ) as soon as possible .