Edited at

Androidライブラリを作って公開する

More than 1 year has passed since last update.


経緯

弊社アプリでチュートリアルを入れることになり、ライブラリをあさっていたのですがデザイナーが納得できるものがない!

じゃあ自前で作ろう!となったのが発端でした。

で、ついでに手を入れてライブラリ化しようと思い立って今に至ります。

今回はライブラリの登録方法についてです。

作ったライブラリは後ほど公開予定です。


環境

スクリーンショット 2018-05-12 14.05.57.png


ライブラリ公開までのすゝめ


1. ライブラリ用プロジェクトの作成

最初にAndroid Studioで「New」→「ライブラリ」みたいなメニューが有ると思っていたのですが見当たらず。。。そもそも公式見ろよということで「Android ライブラリの作成 Android Developers」を見ながらやりました。


  • 最初は普通に新規プロジェクトを作ります。

スクリーンショット 2018-05-12 13.46.45.png


2. ライブラリ用モジュールを作成する


  • プロジェクトのrootディレクトリを右クリックして「New」→「Module」を選択します。

image.png


  • その後「New Module」ウィンドウで「Android Library」を選択します。

image.png


  • 次に必要な情報を入力してFinish!

  • で、新たにappと同階層に作成したライブラリ用Moduleのディレクトリが出来上がります。


3. あとは普段と同じように開発する!


  • プロジェクト作成時にinclude kotlin supportを指定していてもModuleはModuleでbuild.gradleを持っているので再設定が必要です。

  • 他に必要な依存関係があればModuleの下のbuild.gradleに追加していく


  • appパッケージ側でライブラリModuleを使う時はapp下のbuild.gradleに以下を追加する



build.gradle

dependencies {

implementation project(':library_name')
}


作ったライブラリを公開したい

ここからが本題なのですが、作ったライブラリをせっかくなので公開したい!今回はJCenterに公開しようと思います。

こちらを大いに参考にさせていただきました。ありがとうございます!

作ったAndroidライブラリを公開する方法 - Qiita


1. バイナリをアップロードするためのサービスに登録


  • 色々読んだところBintrayというサービスを使うようです。
    Bintray

image.png

ここに登録します。


  • 右上の「sign in」ではなく中央右の「Sign Up Here」からアカウントを作成します。
    (最初は「sign in」から作ろうとして、Organizationの登録とか出てきて混乱しました)


2. アップロードのためにbintray-releaseを入れる


build.gradle

publish {

userOrg = 'your_organization_name' // ユーザー登録時に一緒に登録したOrganization名
groupId = 'jp.group.your_group_name'
artifactId = 'your_library_name'
publishVersion = '0.1.0'
desc = 'description'
website = 'https://github.com/hoge/project'
repoName = 'your_library_name'
}

repoName を設定しないとエラーになります。

この repoNameの設定をすっかり忘れてずっとエラーに悩んでました。


publish のrepoNameについて


  • Bintrayにサインインして、右上のメニューからView Profileを選択

  • 以下の箇所からRepositoryを作成する

image.png


  • 作成時にNameに設定したものを repoName に設定する

  • ちなみに作成時のTypeはMavenを設定


3. アップロードする


  • 以下のコマンドを実行する

./gradlew clean build bintrayUpload -PbintrayUser=BINTRAY_USERNAME -PbintrayKey=BINTRAY_KEY -PdryRun=false

BINTRAY_USERNAME と BINTRAY_KEY は適宜読み替えてください。


  • ちなみにBINTRAY_KEYは以下のところにあります

右上のメニュー→「Edit profile」→左側のメニューの中の「API Key」

image.png


4. アップロードしたpackageをjcenterに登録


右上のメニューからView Profileを選択


登録したRepositoryを選択

image.png

image.png

image.png

image.png

Sendした後はしばらく時間がかかるようです。すぐには登録されませんでした。送っても表示が何か変わるわけでもないので、間違えて2階送ってしまいました。


  • 数時間後にメールが届き、登録されました。

image.png


登録したライブラリを使う


  • プロジェクトのapp/build.gradleで以下を入力するだけです。

dependencies {

implementation 'jp.studio.edamame:balloontutorial:0.1.0'
}

※ まだ動くか試していません。無事動作確認まで出来ました。


おわり

今回はJCenterに公開しましたがこれは中々手順が多いようで、JitPackの方が簡単に公開できそうでした。

振り返ってみたらいつの間にかエンジニアになってから意外と長い間やってきましたが個人でこういうのを残してこなかったため他人に評価してもらえるところが無いなと思いました。

これを機に少しずつライブラリやアプリを世に出していきたいです。

次回は作ったチュートリアル用ライブラリについて書きます。