Kotlin スコープ関数 の上手な使い分け その5 - run

kotlin scope function

 

■ run の便利な使い方 (公式)


public inline fun <T, R> T.run(block: T.() -> R): R {
  contract {...}
  return block()
}

Like let, run is another scoping function from the standard library. Basically, it does the same: executes a code block and returns its result. The difference is that inside run the object is accessed by this. This is useful when you want to call the object's methods rather than pass it as an argument.

let と同様、run も標準ライブラリのスコープ関数です。基本的には、コードブロックを実行し、その結果を返すという点では同じです。違いは、runの内部でオブジェクトにアクセスするのがthisであることです。これは、オブジェクトを引数として渡すのではなく、そのオブジェクトのメソッドを呼び出したい場合に便利です。

Object configuration and computing the result

オブジェクトの構成と結果の算出


val service = MultiportService("https://example.kotlinlang.org", 80)
val result = service.run {
  port = 8080
  query(prepareRequest() + " to port $port")
}

 

■ 非拡張 run

上記の T.run(): R と違って非拡張関数の run もあります。


public inline fun <R> run(block: () -> R): R {
  contract {...}
  return block()
}

Running statements where an expression is required

式が必要な記述の実行

If-not-null-else shorthand

if-not-null-elseの略記法


val files = File("Test").listFiles()

println(files?.size ?: "empty") 

val filesSize = files?.size ?: run {
  // ...
}
println(filesSize)

?.let と組み合わせての利用が多いです。


navigationCommand.route?.let {
  popBackStack(it, false)
} ?: run {
  navigateUp()
}

プロパティでの実行。


private val isConversionAvailable: Boolean = run {
  val expressionType = element.analyze(BodyResolveMode.PARTIAL).getType(element)
  expressionType != null && expressionType != type &&
    expressionType.isSignedOrUnsignedNumberType() && type.isSignedOrUnsignedNumberType()
}

👉 Kotlin Examples: Learn Kotlin Programming By Example hatena-bookmark
👉 Scope functions | Kotlin hatena-bookmark
👉 Idioms | Kotlin hatena-bookmark

 

■ まとめ

「run」は「ブロック内を実行する」という意味合いが強いので、直感的に「let」と使い分けてもいいかもしれません。

👉 Kotlin スコープ関数 の上手な使い分け その1 - apply hatena-bookmark
👉 Kotlin スコープ関数 の上手な使い分け その2 - also hatena-bookmark
👉 Kotlin スコープ関数 の上手な使い分け その3 - with hatena-bookmark
👉 Kotlin スコープ関数 の上手な使い分け その4 - let hatena-bookmark
👉 Kotlin スコープ関数 の上手な使い分け その5 - run hatena-bookmark


関連ワード:  AndroidJetBrainsKotlinおすすめ今さら聞けない初心者開発