コードの気になるところ洗い出し

[LeoAndo]

課題提出後なのでPRは出さないが、コード上の気になるところをこのイシューに洗い出しておく。

[LeoAndo]

プロガードの記述で消せそうなやつがある

以下、消せそう。

android-engineer-codecheck/app/proguard-rules.pro

Line 13 in 0523ccc

-keep class jp.co.yumemi.android.codecheck.R$* { *; }

[LeoAndo]

検索APIのレスポンス値について

pushed_at がnullのケースがあるのでNullableにする必要がある

pushed_atの型指定をString?に変更したい

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/data/api/response/GithubSearchResponse.kt

Line 72 in 57debd3

val pushed_at: String,

[LeoAndo]

RecyclerView周り

DiffUtilに指定する一意のキーはリポジトリ名を表すnameだと被るので、idを指定したい

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/ui/repositories/RepositoriesListAdapter.kt

Line 37 in 7ecf2d3

return oldItem.name == newItem.name

検索APIのResponse値で取れるidをマッピングしたい

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/data/api/response/GithubSearchResponse.kt

Line 51 in 57debd3

val id: Int,

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/data/api/response/GithubSearchResponse.kt

Line 127 in 57debd3

fun GithubSearchResponse.toModel(): List<RepositorySummary> {

API Reference

[LeoAndo]

package構成 / クラス名の変更

ErrorResult

ErrorResultクラスは、通信系のエラー専用なのでクラス名をApiErrorResultに変更し、別ファイルに切り出しapi配下に移動したい。

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/data/SafeResult.kt

Line 15 in 7ecf2d3

sealed class ErrorResult : Exception() {

以下のような感じで。
https://github.com/LeoAndo/AndroidGithubSearch/blob/deacbba26117839e5d1eb28fd9a810b291e4c026/app/src/main/java/com/leoleo/androidgithubsearch/data/api/ApiErrorResult.kt#L5

dataOrThrow

dataOrThrowメソッドは、Ktorに特化したエラーハンドリングのためKtorHandlerみたいなクラスを作りインスタンスメソッドで提供する形にし、別ファイルに切り出しapi配下に移動したい。

android-engineer-codecheck/app/src/main/kotlin/jp/co/yumemi/android/codecheck/data/SafeResult.kt

Line 23 in 7ecf2d3

suspend fun <T> dataOrThrow(

以下のような感じで。
https://github.com/LeoAndo/AndroidGithubSearch/blob/c5d76b7ff15bb6ee63af6a99618140b268ea5666/app/src/main/java/com/leoleo/androidgithubsearch/data/api/KtorHandler.kt#L14

https://github.com/LeoAndo/AndroidGithubSearch/blob/c5d76b7ff15bb6ee63af6a99618140b268ea5666/app/src/main/java/com/leoleo/androidgithubsearch/di/NetworkModule.kt#L21

[LeoAndo]

各環境用でアクセスポイントを切り替える仕組み

本課題アプリはGithubが公開している外部APIを使うのみなので必要なさそうですが、
各環境のアクセスポイントを切り替える仕組みを持つことが通常なのでその場合は、以下のようにFlavorで対応する。
参考PR

[LeoAndo]

stub環境に関して

今回の課題アプリでは、出来上がっている 外部サービスのAPIを使っていて導入していないが、
実務においてサーバー API開発前にstubでアプリ側の開発を進めたいことがある。

もしGithub APIが開発段階であれば、以下のようなStubの実装を行います。

• Flavorの追加
• テストデータの作成
  • 実際に想定されるレスポンスのjsonデータをを使う
• 使用例

[LeoAndo]

マルチモジュール化

今回の課題アプリでは小規模なアプリのため導入を控えたが、
仮に導入する場合は以下のPRのような方針でモジュール化したい。
LeoAndo/AndroidGithubSearch#56