Remote Repositoryの構築と参照方法について、まとめます。

Remote Repositoryとは

Remote Repositoryはネットワークを経由して参照されることを目的にしたリポジトリです。言い換えれば、ネットワーク上に公開されたリポジトリです。

リポジトリを所持するホストをリポジトリサーバと言います。

このサーバを何処に設置するかによって、リポジトリを公開する範囲が決まってきます。

例えば、誰もが参照可能な外部ネットワークに設置すれば、全世界に公開することになります。

「Central Repository」も「Remote Repository」の中の1つです。

利用可能なスキーム

ライブラリの発行先リポジトリサーバはURLで指定します。

このURLのスキームで使用するプロトコルとサーバのタイプが決まります。

スキームは次のようなものが利用可能です。

ライブラリの構築

まず、Module Libraryを作成（「Module Libraryの構築と参照」を参照）します。

作成後、ライブラリをリポジトリへ発行するためのプラグインと指示書（publishing）が必要になるので、build.gradleへ追記します。

指示書のrepositoriesで発行先リポジトリサーバのURLを指定します。

以下は、スキームfileを用いて、ローカルストレージへ発行する例です。

plugins {
    id 'com.android.library'
    id 'org.jetbrains.kotlin.android'
    id 'maven-publish'  // 発行するためのプラグイン
}

android {
    ...
}

afterEvaluate {     // 指示書に従った処理はビルド後に行う
    publishing {    // 発行するための指示書
        publications {   // ライブラリの情報
            decoration(MavenPublication) {
                groupId = 'com.example.lib'
                artifactId = 'decoration'
                version = '0.0.1'

                from components.release    // ビルドバリアントを指定
            }
		}
		repositories {   // 発行先のリポジトリ
            maven {
                url "file:///Y:/MyRepo"    // Windows Y:ドライブのMyRepoフォルダ
            }
        }
    }
}

dependencies {
    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

build.gradleを再読み込みするために「Sync Project」を実行すると、タスクが作成されます。

最後にタスクを実行します。

ビルドバリアントで指定されたビルドが行われた後に、ライブラリの発行が指示書に従って行われます。

以下は作成されたRemote Repositoryのフォルダ構成です。Mavenリポジトリ形式になっています。

Y:￥MyRepo
└── com
    └── example
        └── lib
            └── decoration
                ├── 0.0.1
                │   ├── decoration-0.0.1.aar
                │   ├── decoration-0.0.1.aar.md5
                │   ├── decoration-0.0.1.aar.sha1
                │   ├── decoration-0.0.1.aar.sha256
                │   ├── decoration-0.0.1.aar.sha512
                │   ├── decoration-0.0.1.module
                │   ├── decoration-0.0.1.module.md5
                │   ├── decoration-0.0.1.module.sha1
                │   ├── decoration-0.0.1.module.sha256
                │   ├── decoration-0.0.1.module.sha512
                │   ├── decoration-0.0.1.pom
                │   ├── decoration-0.0.1.pom.md5
                │   ├── decoration-0.0.1.pom.sha1
                │   ├── decoration-0.0.1.pom.sha256
                │   └── decoration-0.0.1.pom.sha512
                ├── maven-metadata.xml
                ├── maven-metadata.xml.md5
                ├── maven-metadata.xml.sha1
                ├── maven-metadata.xml.sha256
                └── maven-metadata.xml.sha512

ライブラリの参照

Remote Repositoryをライブラリの参照先に追加します。

pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}
dependencyResolutionManagement {  // すべてのモジュールに有効な指示
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {       // ライブラリの参照先となるリポジトリのリスト
        google()
        mavenCentral()
		maven {
            url "file:///Y:/MyRepo"    // Remote Repositoryを追加
        }
    }
}
rootProject.name = "MyApplication"
include ':app'

「≧ Gradle Version 7.0」からrepositories命令の記述場所が、repositoriesModeの値により制限されるようになりました。注意が必要です。

参照するライブラリを依存関係リスト（dependencies）に追加します。フォーマットは「groupId:artifactId:version」です。

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    ...
}

dependencies {
    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
    implementation 'com.example.lib:decoration:0.0.1'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

これで、Remote Repositoryのライブラリを参照するようになります。

サンプルの実行結果

サンプルの実行結果を示します。

import com.example.lib.decoration.Brackets
import com.example.lib.decoration.angle
import com.example.lib.decoration.round
import com.example.lib.decoration.square

...
{
    val _str1 = Brackets("#", "#").bracket("Hello World !!")
    println(_str1)
    val _str2 = round("Hello World !!")
    println(_str2)
    val _str3 = angle("Hello World !!")
    println(_str3)
    val _str4 = square("Hello World !!")
    println(_str4)
}

I/System.out: # Hello World !! #
I/System.out: ( Hello World !! )
I/System.out: < Hello World !! >
I/System.out: [ Hello World !! ]

Gradleタスクの作られ方

タスクは発行するライブラリ毎に作成されます。

publishAllPublicationsToMavenRepositoryタスクは一括で処理するタスクです。

この例では、sample-releaseとsample-debugライブラリが発行されます。

Y:￥MyRepo
└── com
    └── example
        └── lib
            ├── sample-debug
            │   ├── 0.0.1
            │   │   ├── sample-debug-0.0.1.aar
            │   │   ├── sample-debug-0.0.1.aar.md5
            │   │   ├── sample-debug-0.0.1.aar.sha1
            │   │   ├── sample-debug-0.0.1.aar.sha256
            │   │   ├── sample-debug-0.0.1.aar.sha512
            │   │   ├── sample-debug-0.0.1.module
            │   │   ├── sample-debug-0.0.1.module.md5
            │   │   ├── sample-debug-0.0.1.module.sha1
            │   │   ├── sample-debug-0.0.1.module.sha256
            │   │   ├── sample-debug-0.0.1.module.sha512
            │   │   ├── sample-debug-0.0.1.pom
            │   │   ├── sample-debug-0.0.1.pom.md5
            │   │   ├── sample-debug-0.0.1.pom.sha1
            │   │   ├── sample-debug-0.0.1.pom.sha256
            │   │   └── sample-debug-0.0.1.pom.sha512
            │   ├── maven-metadata.xml
            │   ├── maven-metadata.xml.md5
            │   ├── maven-metadata.xml.sha1
            │   ├── maven-metadata.xml.sha256
            │   └── maven-metadata.xml.sha512
            └── sample-release
                ├── 0.0.1
                │   ├── sample-release-0.0.1.aar
                │   ├── sample-release-0.0.1.aar.md5
                │   ├── sample-release-0.0.1.aar.sha1
                │   ├── sample-release-0.0.1.aar.sha256
                │   ├── sample-release-0.0.1.aar.sha512
                │   ├── sample-release-0.0.1.module
                │   ├── sample-release-0.0.1.module.md5
                │   ├── sample-release-0.0.1.module.sha1
                │   ├── sample-release-0.0.1.module.sha256
                │   ├── sample-release-0.0.1.module.sha512
                │   ├── sample-release-0.0.1.pom
                │   ├── sample-release-0.0.1.pom.md5
                │   ├── sample-release-0.0.1.pom.sha1
                │   ├── sample-release-0.0.1.pom.sha256
                │   └── sample-release-0.0.1.pom.sha512
                ├── maven-metadata.xml
                ├── maven-metadata.xml.md5
                ├── maven-metadata.xml.sha1
                ├── maven-metadata.xml.sha256
                └── maven-metadata.xml.sha512

Gradleによるキャッシュ

ライブラリの参照において、URLのスキームをfile以外にした場合、ネットワークを経由したライブラリの参照が行われます。

この時、Gradleは初回の参照でダウンロードしたライブラリをキャッシュします。そして、次回の参照でダウンロードを行いません。キャッシュの参照のみを行います。ネットワークの利用を少なくして、ビルドを高速化するためです。

キャッシュは次の場所にあります。

キャッシュはいつ更新されるのでしょう。これは２つの条件があります。

　（1）バージョンが変更された時
　（2）キャッシュ時間が切れた時（デフォルトは24H）

また、ライブラリの更新は内容により２つのケースが考えられます。

　（A）中身とバージョンの更新を行う（dynamic versions）
　（B）中身の更新のみ、バージョンは同じ（changing modules）

よって（B）のように、バージョンを変更しないライブラリの更新は、キャッシュ時間切れにならない限り、ビルドに反映されない結果になります。

これを回避するには、changing modulesのキャッシュ時間を変更します。

plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    ...
}

configurations.all {   // すべての依存グループに対する指定
    // Check for updates every build（changing modulesのキャッシュ時間は0[s]）
    resolutionStrategy.cacheChangingModulesFor 0, 'seconds'
}
dependencies {
    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.1'
    implementation 'com.google.android.material:material:1.5.0'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
	implementation('com.example.lib:decoration:0.0.1') { changing = true }
	//                                                 ↑↑changing module↑↑
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
}

「changing = true」は「ライブラリがchanging modulesである」というフラグです。ライブラリの記述上、dynamic versionsとchanging modulesの見分けが付かないため、changing modulesであることを明記します。

ちなみに、changing modulesのようなライブラリはスナップショットで用いられます。開発途中のライブラリを常に指し続けたい場合です。

関連記事：