中級: ライブラリとAPI

拡張関数
スコープ関数
レシーバー付きラムダ式
クラスとインターフェース
オブジェクト
オープンクラスと特殊なクラス
プロパティ
Null安全性
ライブラリとAPI

Kotlinを最大限に活用するには、既存のライブラリやAPIを利用して、車輪の再発明に時間を費やすのではなく、より多くの時間をコーディングに使えるようにしましょう。

ライブラリは、一般的なタスクを簡素化する再利用可能なコードを配布します。ライブラリ内には、関連するクラス、関数、ユーティリティをグループ化するパッケージやオブジェクトがあります。ライブラリは、開発者がコードで使用できる関数、クラス、プロパティのセットとしてAPI（Application Programming Interfaces）を公開しています。

Kotlinで何ができるか見ていきましょう。

標準ライブラリ

Kotlinには、コードを簡潔かつ表現豊かにするための必須の型、関数、コレクション、ユーティリティを提供する標準ライブラリがあります。標準ライブラリの大部分（kotlinパッケージ内のすべて）は、明示的にインポートする必要なく、どのKotlinファイルでもすぐに利用できます。

fun main() {
    val text = "emosewa si niltoK"
    
   // 標準ライブラリのreversed()関数を使用
    val reversedText = text.reversed()

    // 標準ライブラリのprint()関数を使用
    print(reversedText)
    // Kotlin is awesome
}

しかし、標準ライブラリの一部は、コードで使用する前にインポートが必要です。例えば、標準ライブラリの時刻計測機能を使用したい場合は、kotlin.timeパッケージをインポートする必要があります。

ファイルの先頭で、必要なパッケージの後にimportキーワードを追加します。

import kotlin.time.*

アスタリスク*はワイルドカードインポートであり、パッケージ内のすべてをインポートするようにKotlinに指示します。アスタリスク*をコンパニオンオブジェクトと一緒に使用することはできません。代わりに、使用したいコンパニオンオブジェクトのメンバーを明示的に宣言する必要があります。

例：

import kotlin.time.Duration
import kotlin.time.Duration.Companion.hours
import kotlin.time.Duration.Companion.minutes

fun main() {
    val thirtyMinutes: Duration = 30.minutes
    val halfHour: Duration = 0.5.hours
    println(thirtyMinutes == halfHour)
    // true
}

この例では、以下のことを行います。

• Durationクラスと、そのコンパニオンオブジェクトからhoursおよびminutes拡張プロパティをインポートします。
• minutesプロパティを使用して30を30分のDurationに変換します。
• hoursプロパティを使用して0.5を30分のDurationに変換します。
• 両方の期間が等しいかチェックし、結果を出力します。

自分で実装する前に検索する

独自のコードを記述することを決定する前に、探しているものが既に存在しないか標準ライブラリを確認してください。標準ライブラリがすでに多数のクラス、関数、プロパティを提供している分野のリストを以下に示します。

• コレクション
• シーケンス
• 文字列操作
• 時間管理

標準ライブラリに他に何があるか詳しく知るには、そのAPIリファレンスを参照してください。

Kotlinライブラリ

標準ライブラリは多くの一般的なユースケースをカバーしていますが、対処できないものもあります。幸いなことに、Kotlinチームとコミュニティの残りのメンバーは、標準ライブラリを補完する幅広いライブラリを開発してきました。例えば、kotlinx-datetimeは、異なるプラットフォーム間で時間を管理するのに役立ちます。

便利なライブラリは当社の検索プラットフォームで見つけることができます。それらを使用するには、依存関係やプラグインの追加など、追加の手順が必要です。各ライブラリには、Kotlinプロジェクトに含める方法についての説明が記載されたGitHubリポジトリがあります。

ライブラリを追加したら、その中の任意のパッケージをインポートできます。以下は、ニューヨークの現在時刻を見つけるためにkotlinx-datetimeパッケージをインポートする方法の例です。

import kotlinx.datetime.*

fun main() {
    val now = Clock.System.now() // 現在のインスタントを取得
    println("Current instant: $now")

    val zone = TimeZone.of("America/New_York")
    val localDateTime = now.toLocalDateTime(zone)
    println("Local date-time in NY: $localDateTime")
}

この例では、以下のことを行います。

• kotlinx.datetimeパッケージをインポートします。
• Clock.System.now()関数を使用して現在時刻を含むInstantクラスのインスタンスを作成し、結果をnow変数に割り当てます。
• 現在時刻を出力します。
• TimeZone.of()関数を使用してニューヨークのタイムゾーンを見つけ、結果をzone変数に割り当てます。
• 現在時刻を含むインスタンスで.toLocalDateTime()関数を呼び出し、ニューヨークのタイムゾーンを引数として渡します。
• 結果をlocalDateTime変数に割り当てます。
• ニューヨークのタイムゾーンに合わせて調整された時刻を出力します。

この例で使用されている関数とクラスについてさらに詳しく調べるには、APIリファレンスを参照してください。

APIへのオプトイン

ライブラリの作成者は、コードで使用する前に特定のAPIにオプトインが必要であるとマークする場合があります。これは通常、APIがまだ開発中であり、将来変更される可能性がある場合に行われます。オプトインしない場合、次のような警告またはエラーが表示されます。

This declaration needs opt-in. Its usage should be marked with '@...' or '@OptIn(...)'

オプトインするには、@OptInの後に、APIを分類するクラス名をカッコで囲み、二重コロン::とclassを付け加えて記述します。

例えば、標準ライブラリのuintArrayOf()関数は、APIリファレンスに示されているように、@ExperimentalUnsignedTypesに属します。

@ExperimentalUnsignedTypes
inline fun uintArrayOf(vararg elements: UInt): UIntArray

コードでは、オプトインは次のようになります。

@OptIn(ExperimentalUnsignedTypes::class)

以下は、uintArrayOf()関数を使用して符号なし整数の配列を作成し、その要素の1つを変更するためにオプトインする例です。

@OptIn(ExperimentalUnsignedTypes::class)
fun main() {
    // 符号なし整数配列を作成
    val unsignedArray: UIntArray = uintArrayOf(1u, 2u, 3u, 4u, 5u)

    // 要素を変更
    unsignedArray[2] = 42u
    println("Updated array: ${unsignedArray.joinToString()}")
    // Updated array: 1, 2, 42, 4, 5
}

これが最も簡単なオプトイン方法ですが、他にも方法があります。詳細については、オプトイン要件を参照してください。

練習問題

練習問題1

あなたは、ユーザーが投資の将来価値を計算するのに役立つ金融アプリケーションを開発しています。複利を計算する式は次のとおりです。

$A\; =\; P\; \backslash times\; (1\; +\; \backslash displaystyle\backslash frac\{r\}\{n\})^\{nt\}$

ここで、

• Aは利息適用後の累積金額（元金＋利息）。
• Pは元金（初期投資額）。
• rは年利（小数）。
• nは1年間の複利計算回数。
• tは投資期間（年数）。

コードを更新して、以下の操作を行ってください。

1. kotlin.mathパッケージから必要な関数をインポートします。
2. 複利適用後の最終金額を計算するcalculateCompoundInterest()関数にボディを追加します。

|--|--|

// Write your code here

fun calculateCompoundInterest(P: Double, r: Double, n: Int, t: Int): Double {
    // Write your code here
}

fun main() {
    val principal = 1000.0
    val rate = 0.05
    val timesCompounded = 4
    val years = 5
    val amount = calculateCompoundInterest(principal, rate, timesCompounded, years)
    println("The accumulated amount is: $amount")
    // The accumulated amount is: 1282.0372317085844
}

import kotlin.math.*

fun calculateCompoundInterest(P: Double, r: Double, n: Int, t: Int): Double {
    return P * (1 + r / n).pow(n * t)
}

fun main() {
    val principal = 1000.0
    val rate = 0.05
    val timesCompounded = 4
    val years = 5
    val amount = calculateCompoundInterest(principal, rate, timesCompounded, years)
    println("The accumulated amount is: $amount")
    // The accumulated amount is: 1282.0372317085844
}

練習問題2

プログラムで複数のデータ処理タスクを実行するのにかかる時間を測定したいと考えています。kotlin.timeパッケージから正しいインポートステートメントと関数を追加するようにコードを更新してください。

// Write your code here

fun main() {
    val timeTaken = /* Write your code here */ {
        // データ処理をシミュレート
        val data = List(1000) { it * 2 }
        val filteredData = data.filter { it % 3 == 0 }

        // フィルタリングされたデータの処理をシミュレート
        val processedData = filteredData.map { it / 2 }
        println("Processed data")
    }

    println("Time taken: $timeTaken") // e.g. 16 ms
}

解答例

import kotlin.time.measureTime

fun main() {
    val timeTaken = measureTime {
        // データ処理をシミュレート
        val data = List(1000) { it * 2 }
        val filteredData = data.filter { it % 3 == 0 }

        // フィルタリングされたデータの処理をシミュレート
        val processedData = filteredData.map { it / 2 }
        println("Processed data")
    }

    println("Time taken: $timeTaken") // e.g. 16 ms
}

練習問題3

最新のKotlinリリースで利用できる標準ライブラリに新機能があります。試してみたいのですが、オプトインが必要です。この機能は@ExperimentalStdlibApiに該当します。コードでのオプトインはどのように記述すべきですか？

@OptIn(ExperimentalStdlibApi::class)