Kotlin：useスコープ関数 | Y

useスコープ関数は、オブジェクトが確保したリソースの開放（close関数の実行）を自動的に行ってくれる関数です。

とてもお勧めのスコープ関数です。

※環境：Android Studio Hedgehog | 2023.1.1 Patch 2

1 useスコープ関数
2 useの利用例

useスコープ関数

オブジェクトが確保したリソースを、終了後に開放しなければならないクラスがあります。

ファイルアクセスやデータベースを扱うクラスに多いです。

そのようなクラスは、Closeableインターフェースを継承し、close関数を実装しています。そして、close関数の実行でリソースの開放が行われます。

useスコープ関数は、オブジェクトが確保したリソースの開放（close関数の実行）を自動的に行ってくれる関数です。

@InlineOnly
public inline fun <T : Closeable?, R> T.use(block: (T) -> R): R {
    contract {
        callsInPlace(block, InvocationKind.EXACTLY_ONCE)
    }
    var exception: Throwable? = null
    try {
        return block(this)
    } catch (e: Throwable) {
        exception = e
        throw e
    } finally {
        when {
            apiVersionIsAtLeast(1, 1, 0) -> this.closeFinally(exception)
            this == null -> {}
            exception == null -> close()
            else ->
                try {
                    close()
                } catch (closeException: Throwable) {
                    // cause.addSuppressed(closeException) // ignored here
                }
        }
    }
}

「オブジェクトが正常に役割を終えた」、「Exceptionがスローされた」かどうかに関わらず、適切にcloseします。

useを使うと、try-catch-final構文の記述がすっきりします。

useの利用例

URI（ファイル）へデータ（ByteArray型）を書き込む例です。

レシーバーのOutputStreamオブジェクトは、役割を終えた後にcloseが必要です。

fun Context.writeToUri_Resolver(data: ByteArray, uri: Uri) {
    try {
        contentResolver.openOutputStream(uri, "w")?.use { outputStream ->
            outputStream.write(data)
            outputStream.flush()
        }
    } catch (e: Exception) { Log.i(TAG, "[writeToUri] ${e}") }
}

useが利用可能なクラスは「Closeableインターフェースを継承したクラス」である点に注意して下さい。

public abstract class OutputStream implements Closeable, Flushable {
    
	...
	
    public void close() throws IOException {
    }
}

ページのトップへ

KDocのドキュメント記述例

Dokka KDoc Kotlin デザインドキュメント

KDocのドキュメント記述例を紹介します。 KDocを使えばKotlinのソースコードに書いたコメントからドキュメントを作成することが出来ます。後々、クラスの再利用を考えているなら、ドキュメントを残して再利用性を高めておきましょう！ ...