Android マルチモジュール: ライブラリのバージョン管理について

Created at Mon, Sep 23, 2019

マルチモジュールなアプリを作ることをテーマにいくつかの記事を書いていきたいと思っています。

まだ正確には決まっていないのですが、以下のような内容をまとめていこうと思っております。

今回は、ライブラリのバージョン管理について書いてきます。

ライブラリのバージョン管理？

Android開発では、Gradleで外部ライブラリの依存を定義するのが一般的です。マルチモジュールプロジェクトの場合、外部ライブラリのバージョンを合わせるため、変数のような形で定義しておくと便利です。

変数の定義方法には、直接記述する方法を除くと、大きく2つの方法があります。

1. Gradleのextraプロパティを使う

Androidの公式ドキュメント: Configure project-wide propertiesで紹介されている方法です。 extにバージョンを定義します。

例えば、OkHttpでは、次のように定義しています。

buildscript {
  ext.versions = [
      'animalSniffer': '1.17',
      'assertj': '3.11.0',
      'bouncycastle': '1.62',
      'brotli': '0.1.2',
  ...

  ext.deps = [
      'picocli': "info.picocli:picocli:${versions.picocli}",
      'android': "org.robolectric:android-all:9-robolectric-4913185-2",
      'animalSniffer': "org.codehaus.mojo:animal-sniffer-annotations:${versions.animalSniffer}",
      'assertj': "org.assertj:assertj-core:${versions.assertj}",
      'bouncycastle': "org.bouncycastle:bcprov-jdk15on:${versions.bouncycastle}",
      'brotli': "org.brotli:dec:${versions.brotli}",
  ...

extプロパティにライブラリのバージョンをセットします。

そして、次のように使います。

dependencies {
  api deps.okio
  api deps.kotlinStdlib
  compileOnly deps.android
  compileOnly deps.conscrypt
  ...

メリット、デメリットをまとめると次になります。

2. buildSrc + Kotlin

buildSrc以下にKotlinファイルを定義し、バージョンを管理することも出来ます。

例えば、androidx: Dependencies.ktでは、次のように定義しています。

const val ANDROID_GRADLE_PLUGIN = "com.android.tools.build:gradle:3.4.2"
const val ANDROIDX_TEST_CORE = "androidx.test:core:1.1.0"
const val ANDROIDX_TEST_EXT_JUNIT = "androidx.test.ext:junit:1.1.0"
const val ANDROIDX_TEST_EXT_KTX = "androidx.test.ext:junit-ktx:1.1.0"
const val ANDROIDX_TEST_MONITOR = "androidx.test:monitor:1.1.1"
const val ANDROIDX_TEST_RULES = "androidx.test:rules:1.1.0"
const val ANDROIDX_TEST_RUNNER = "androidx.test:runner:1.1.1"
...

Kotlinの定数として定義しています。

そして、次のように使います。

dependencies {
    api(KOTLIN_STDLIB)
    androidTestImplementation(JUNIT)
    androidTestImplementation(TRUTH)
    androidTestImplementation(ANDROIDX_TEST_EXT_JUNIT)
    ...
}

メリット、デメリットをまとめると次になります。

結局どっちがいいのか？

安定しているのは、extraプロパティを使う方法だと思います。 buildSrc + Kotlinの方法はProject Structureが使えないのと、最近まで、コード補完がうまく効かない問題もあり、もう少し待ったほうが無難かもしれません。 ただ、どちらもクリティカルなものではないので、最終的には好みで決定すれば良いと思います。

運用について

Tips的に、運用に役立つ便利ライブラリ、ASの機能を紹介します。

Gradle Versions Plugin

Gradle Versions Pluginは、ライブラリにアップデートがあるかをチェックしてくれるライブラリです。超便利です。

de.fayard.buildSrcVersions

de.fayard.buildSrcVersionsは、buildSrc以下に、いい感じにバージョン管理用のKotlinファイルを作ってくれるライブラリです。実際に使ったことはないのですが、超便利そうです。

Android Studio Project Structure

Android StudioにはProject Structureは、各モジュールのライブラリへの依存を一覧で見ることが出来ます。アップデートがあるライブラリを知ることが出来ます。

まとめ

リファレンス

Written by