ログ出力時にLogcatからコードにジャンプ出来るようにしておくと便利かもしれない

Sato Shun — Sat, 17 Feb 2024 11:43:35 +0000

ファイル名:行数 を出力すると、Android StudioのLogcatからジャンプすることが可能です。

Timberライブラリを使った、コード例を示します。

Timber.d("message (MediaStoreUtils.kt:125)")

これを実行すると、次のようにLogcatに出力されます。

Android Studioの、Logcatのファイル名の部分がリンク形式になっていることが分かります。
これをクリックすると、コードにジャンプすることが出来ます。

また、このコードのように都度 ファイル名:行数 を書いてもいいのですが、次のように関数にまとめることも出来ます。

fun logd(message: String) {
  if (!BuildConfig.DEBUG) return
  val stackTrace = Thread.currentThread().getStackTrace()[3]
  Timber.d("$message (${stackTrace.fileName}:${stackTrace.lineNumber})")
}

Timber.DebugTreeを使っているのであれば、DebugTreeを拡張しても動きます。
val newMessage のあたりをプロジェクトに合わせて修正して下さい。

Timber.plant(object : Timber.DebugTree() {
  private val fqcnIgnore = listOf(
    Timber::class.java.name,
    Timber.Forest::class.java.name,
    Timber.Tree::class.java.name,
    Timber.DebugTree::class.java.name,
  )

  private val stackTrace: StackTraceElement
    get() = Throwable().stackTrace
      .filter { it.className !in fqcnIgnore }[2]

  override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
    val newMessage = if (priority == Log.DEBUG) {
      val stackTrace = stackTrace
      "$message (${stackTrace.fileName}:${stackTrace.lineNumber})"
    } else {
      message
    }
    super.log(priority, tag, newMessage, t)
  }
})

このログどこで出力しているんだっけ、ってなることが多い場合には検討してみて下さい🐱

Jetpack ComposeでListなどのクラスをStableにする

Sato Shun — Sun, 04 Feb 2024 08:28:47 +0000

概要

Jetpack ComposeではListなどのクラスはunstable型としてマークされており、stableとして扱うためには、都度Wrapperクラスを定義する必要がありました。

@Stable
data class UserState(
  val users: List<User>,
  ...
)

Compose Compiler1.5.5から stability configurationという機能が入り、Listなどの外部クラスをStableとして扱うことが出来るようなりました😀

使い方

次の2つを設定することで使うことが出来ます。

まず、freeCompilerArgsにstabilityConfigurationPathを設定します。

kotlinOptions {
 freeCompilerArgs += listOf(
   "-P",         

 "plugin:androidx.compose.compiler.plugins.kotlin:stabilityConfigurationPath=" +
    "${configurationPath}"
  )
}

次に、上部で設定したconfigurationPathにファイルを作り、クラスを記述するだけです。

java.time.LocalDateTime
kotlin.collections.List

これで、ListとLocalDateTimeをそれぞれStableにマークすることが出来ます。

詳しい定義の仕方は https://github.com/skydoves/landscapist/pull/417 このPRが参考になります。

確認方法

Composeのmetric reportsで確認することが出来ます。
metrics reportsはComposable関数の状態を確認することが出来る機能です。
詳細な使い方はChrisさんのブログによくまとまっておりおすすめです。 https://chrisbanes.me/posts/composable-metrics/

これを使い、before/afterを比較すると次のようになりました。

@Composable
fun Test(names: List<String>) {
  Text(text = "$names")
}

// before
restartable scheme("[androidx.compose.ui.UiComposable]") fun 
Test(
  unstable names: List<String>
)

// after
restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun Test(
 stable names: List<String>
)

beforeではListがunstable、afterではstableになっていることが分かります。

これで都度Wrapperクラスを作っていた部分を省略することが出来ます😀

まとめ

いちいちwrapするのがめんどくさかったところをstability Configurationを使うことで、解決することが出来ました。readonly Listや、サードパーティが提供しているimmutableなクラスを定義に追加しておけば、自然とskip可能なComposable関数が作れるので、とりあえず色々と追加しておくのが良いと思います。
とはいえ、mutableなクラスを追加してしまうと、予期せぬ動作をする可能性があるので、しっかりとStableにしても良いかを確認することが大切です。

DEV Community: Sato Shun

ログ出力時にLogcatからコードにジャンプ出来るようにしておくと便利かもしれない

Jetpack ComposeでListなどのクラスをStableにする

概要

使い方

確認方法

まとめ

参考