【Android】丁寧なRetrofit2とmoshiの導入解説【Kotlin】

はじめに

手順としては一括で依存関係を追加していく方が圧倒的に早いのですが、
それぞれ何のために追加してるなどがわかりにくくなるため、1つずつ丁寧に追加していきます。

この記事でのゴール

プロジェクト内で、Retrofit2を使用できる状態にすること
※ライブラリの追加までがゴールで、実装して実際にAPI通信処理などは今回はしないです。

①Retrofit2の依存関係の追加

自身のプロジェクトで、
build.gradle(:app)ファイルを開きdependencies{}内に依存関係を追加する
追加する依存関係はどこから取ってくればいいんだろう？って
他の記事を見てよく思ってたので、その部分も解説していきます。

①-1

まず、下記のリンクかGoogleなどで、retrofit2などでワード検索して、
retrofit2をオープンソースとして
提供しているsquare社の公式ドキュメントを開く。
https://square.github.io/retrofit/

①-2

右側にあるDOWNLOADをクリック

①-3

下に自動スクロールされ、GRADLEと書かれた下に
Retrofit2の依存関係があるので、ここからコピーする。

①-4

自身のプロジェクトで、
build.gradle(:app)ファイルを開きdependencies{}内にコピーした依存関係を追加する

build.gradle(app)

dependencies{
   ...
   //Retrofit2
   implementation 'com.squareup.retrofit2:retrofit:(insert latest version)'
}

画像で確認したい方はこちら

①-5

貼り付けた
'com.squareup.retrofit2:retrofit:(insert latest version)'の部分が
黄色になっているため、カーソルを合わせて、ホバーすると
A newer version of com.squareup.retrofit2:retrofit than (insert latest version) is available: 2.6.2
とでる。
2.6.2の新しいバージョンが利用可能ですということらしい。
提案に従い、Change to 2.6.2をクリックする。

①-6

黄色部分が消えて、2.6.2のバージョンで指定される。

①-7

Sync Nowする

ここまでで、Retrofit2のライブラリを追加することができました。

②retrofit2でmoshiを使うための依存関係を追加

retrofit2でmoshiを使うためには、コンバーターというものが必要だそうで、
それを追加していきます。

②-1

手順①-1で開いたsquare社のretrofit2ドキュメントを再度開く
https://square.github.io/retrofit/

②-2

Retrofit Configurationをクリックする。

②-3

ページ中部下に自動スクロールされるので、Moshiと書かれた横の
com.squareup.retrofit2:converter-moshiの部分をコピーする。

②-4

コピーしたcom.squareup.retrofit2:converter-moshiを使用して、
implementation 'com.squareup.retrofit2:converter-moshi'の形で、
自身のプロジェクトで、
build.gradle(:app)ファイルを開きdependencies{}内に依存関係を追加する

build.gradle(app)

dependencies{
   ...
    //retrofit2 converter
    implementation 'com.squareup.retrofit2:converter-moshi'
}

画像で確認したい方はこちら

②-5

バージョンをretrofit2のライブラリと合わせる。今回の場合は2.6.2とする。

build.gradle(app)

dependencies{
   ...
    //retrofit2 converter
    implementation 'com.squareup.retrofit2:converter-moshi:2.6.2'
}

画像で確認したい方はこちら

②-6

Sync Nowする

ここまででRetrofit2でMoshiを使うための
コンバーターライブラリを追加することができました。

③Moshiの依存関係の追加

Moshiそのものの依存関係を追加します。

③-1

手順①-1で開いたsquare社のretrofit2ドキュメントを再度開く
https://square.github.io/retrofit/

③-2

Retrofit Configurationをクリックする。

③-3

ページ中部下に自動スクロールされるので、Moshiと書かれた部分をクリック

③-4

MoshiのGithubのページに遷移する

ページ最下部付近のDOWNLOADと書かれているところまでスクロールし、
or Gradle:と書かれた下にMoshiそのものの依存関係の記載があるので、コピーする。

③-5

自身のプロジェクトで、
build.gradle(:app)ファイルを開きdependencies{}内に依存関係を追加する

build.gradle(app)

dependencies{
   ...
    //moshi
    implementation "com.squareup.moshi:moshi:1.12.0"
}

画像で確認したい方はこちら

③-6

Sync Nowする

ここまででMoshiのライブラリを追加することができました。

④MoshiをKotlinで使用できるようにするための依存関係を追加

MoshiをKotlinで使用できるようにするための依存関係を追加します。

④-1

手順③-3で開いた、MoshiのGithubのページを再度開く。

④-2

ページ最下部付近のKotlinと書かれた場所の下付近に
MoshiをKotlinで使うための依存関係があるので、コピーする。

④-3

自身のプロジェクトで、
build.gradle(:app)ファイルを開きdependencies{}内に依存関係を追加する

build.gradle(app)

dependencies{
   ...
    //moshiをkotlinで使用するためのライブラリ
    implementation "com.squareup.moshi:moshi-kotlin:1.12.0"
}

画像で確認したい方はこちら

④-4

Sync Nowする

⑤インターネットアクセス権の設定

Retrofit2で外部に通信を行うので、アクセス圏を許可する必要がある。

AndroidManifest.xmlファイルの
タグ内にuses-permission android:name="android.permission.INTERNETの
記述をする。

AndroidManifest.xml

<manifest>
  <uses-permission android:name="android.permission.INTERNET"></uses-permission>
</manifest>

おしまい

ここまでで、Retrofit2とMoshiがプロジェクト内で使用できるようになりました。
コンバーターが必要だったり、kotlinで使用するための依存関係が必要だったり、
覚えるのが大変だなーと思いました。
公式ドキュメントから依存関係をとってくる際に、まとめた箇所にないので、
毎回探してる自身の経験もあったので、今回記事としてまとめさせていただきました。
間違っている箇所等ありましたら、修正させていただきますので、
コメント頂けますと助かります。

最後までお読みいただきありがとうございます。
記事を読む皆様の参考になれば幸いです。

参考になりましたら、チャンネル登録、高評価はないので、
LGTMをお気持ち程度いただければ、嬉しいです！！