Kotlinでテキストファイルを読み込む12の方法

Kotlinを使ったテキストファイル読み込みのイラストKotlin
2023.09.30
この記事は約18分で読めます。

 

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

基本的な知識があればカスタムコードを使って機能追加、目的を達成できるように作ってあります。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を凌駕する現役のプログラマチームによって監修されています。

サイト内のコードを共有する場合は、参照元として引用して下さいますと幸いです

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

Kotlinは近年急速に人気を集めているプログラミング言語の一つであり、Androidアプリ開発など様々な場面で使用されています。

そのKotlinを使って、テキストファイルの読み込みをすることは、多くの開発者にとって必須のスキルとなっています。

そこで、この記事ではKotlinを用いて、テキストファイルをいかに効率的に読み込むかについて、基本的な読み込み方から応用的な読み込み方までを徹底的に解説していきます。

●Kotlinとは？

Kotlinは、JetBrains社が開発した静的型付けのプログラミング言語です。

Javaに似ている点も多いですが、よりシンプルで、より機能的な部分が強化されています。

特にAndroidの公式開発言語として採用されたことから、その知名度は一気に上昇しました。

○Kotlinの特徴

  • Null安全：Kotlinはnull参照を排除する設計となっており、ランタイムでのNullPointExceptionを大幅に減少させることができます。
  • 拡張関数：既存のクラスに新しい関数を追加することができます。
  • スマートキャスト：一度型チェックを行った変数は、それ以降その型として自動的にキャストされる機能です。

○テキストファイル読み込みの利点

テキストファイルの読み込みは、設定ファイルの読み込みや、ログの分析など、多くのアプリケーションで必須の技術です。

Kotlinを用いると、次のような利点があります。

  1. 簡潔にコードを記述できる：Kotlinの言語機能を活かし、わずかなコードでテキストファイルの読み込みを行うことができます。
  2. 安全性：Null安全などの機能を活かし、安全にファイルの読み込みを行うことができます。
  3. 高いパフォーマンス：KotlinはJavaと同じJVM上で実行されるため、Javaと同等の高いパフォーマンスを発揮します。

●Kotlinでのテキストファイルの基本的な読み込み方法

Kotlinでは、様々な方法でテキストファイルを読み込むことができます。

初心者の方にも分かりやすいように、基本的な読み込み方法を3つのサンプルコードを交えて説明します。

○サンプルコード1：BufferedReaderを使用した基本的な読み込み

このコードでは、BufferedReaderクラスを使って、テキストファイルを行ごとに読み込む方法を示します。

BufferedReaderは、大量のデータを効率的に読み込む際に非常に有効なクラスです。

import java.io.File

fun main() {
    val filePath = "path_to_your_textfile.txt"
    File(filePath).bufferedReader().use { reader ->
        var line = reader.readLine()
        while (line != null) {
            println(line)
            line = reader.readLine()
        }
    }
}

このコードを実行すると、指定したテキストファイルの内容がコンソールに表示されます。

この例では、use関数を使ってリソースの解放も自動的に行っています。

○サンプルコード2：readLines関数を使った一行ずつの読み込み

次に、readLines関数を使用した読み込み方法を見ていきます。

この関数を使うと、テキストファイルのすべての行をListとして取得することができます。

import java.io.File

fun main() {
    val filePath = "path_to_your_textfile.txt"
    val lines = File(filePath).readLines()
    for (line in lines) {
        println(line)
    }
}

このコードを実行すると、テキストファイルの各行が順番にコンソールに表示されます。

ファイルが大きくない場合には、この方法が便利です。

○サンプルコード3：readText関数での一気に読み込み

readText関数を使用すると、テキストファイルの内容を一気にStringとして読み込むことができます。

この方法は、ファイルの内容をすぐに一つの文字列として取得したい場合に適しています。

import java.io.File

fun main() {
    val filePath = "path_to_your_textfile.txt"
    val content = File(filePath).readText()
    println(content)
}

このコードを実行すると、テキストファイルの内容全体がコンソールに表示されます。

ただし、大きなファイルを読み込む場合にはメモリの消費が増えるので注意が必要です。

●応用的なテキストファイル読み込み方法

テキストファイルの読み込みにおいて、特定の条件を満たす行だけを抽出したり、正規表現を使って内容をフィルタリングするなど、応用的な読み込み方法もKotlinでは可能です。

ここでは、そのような応用的な読み込み方法を3つのサンプルコードを通じて解説します。

○サンプルコード4：特定のキーワードを含む行のみを読み込む

このコードでは、指定したキーワードを含む行だけを抽出して読み込む方法を表しています。

たとえば、ログファイルからエラーに関する行だけを取得するような場面で役立ちます。

import java.io.File

fun main() {
    val keyword = "エラー"
    val filePath = "path_to_your_textfile.txt"
    File(filePath).readLines()
        .filter { it.contains(keyword) }
        .forEach { println(it) }
}

このコードを実行すると、テキストファイル内で「エラー」というキーワードを含む行がコンソールに表示されます。

○サンプルコード5：ファイルの末尾から特定の行数を読み込む

ログファイルなどの大きなファイルで、最新のログだけを取得したい場合に役立つ方法です。

下記のコードは、ファイルの末尾から10行を読み込む例を表しています。

import java.io.File

fun main() {
    val linesToRead = 10
    val filePath = "path_to_your_textfile.txt"
    val lines = File(filePath).readLines()
    val lastLines = lines.takeLast(linesToRead)
    lastLines.forEach { println(it) }
}

このコードを実行すると、指定したファイルの最後の10行がコンソールに表示されます。

○サンプルコード6：正規表現を利用した行のフィルタリング

正規表現を使用すると、特定のパターンに一致する行を簡単に抽出することができます。

下記のコードは、日付の形式（例：2023-09-30）に一致する行をフィルタリングして表示する例を表しています。

import java.io.File

fun main() {
    val regex = """\d{4}-\d{2}-\d{2}""".toRegex()
    val filePath = "path_to_your_textfile.txt"
    File(filePath).readLines()
        .filter { regex.containsMatchIn(it) }
        .forEach { println(it) }
}

このコードを実行すると、日付の形式に一致する行がコンソールに表示されます。

正規表現を用いることで、様々なパターンのテキストを柔軟に抽出することができるため、テキスト解析の際に非常に便利です。

●大量のデータを扱う際の読み込み方法

大量のデータを持つテキストファイルを効率的に読み込むための手法は、アプリケーションの性能や応答速度に大きな影響を与えます。

Kotlinを利用する際には、メモリ使用量や読み込み速度を考慮した方法を選択することが重要です。

ここでは、大量のデータを扱う際のテキストファイルの読み込み方法を2つのサンプルコードで解説します。

○サンプルコード7：ストリームを用いたメモリ効率の良い読み込み

このコードでは、ファイルからのデータをストリームとして読み込む方法を紹介します。

ストリームを利用することで、一度に全てのデータをメモリに読み込むのではなく、必要な部分だけを順次読み込むことができます。

import java.nio.file.Files
import java.nio.file.Paths

fun main() {
    val filePath = "path_to_your_large_textfile.txt"
    Files.newBufferedReader(Paths.get(filePath)).use { reader ->
        var line: String? = reader.readLine()
        while (line != null) {
            println(line)
            line = reader.readLine()
        }
    }
}

このコードを実行すると、指定した大きなテキストファイルの内容がストリームとして順次コンソールに表示されます。

この方法は、特に大容量のファイルを効率よく読み込む際に有効です。

○サンプルコード8：外部ライブラリを使用したCSVファイルの読み込み

多くの場合、大量のデータを持つテキストファイルはCSV形式で保存されることが多いです。

ここでは、外部ライブラリを利用してCSVファイルを読み込む方法を示します。

まず、外部ライブラリ「opencsv」をプロジェクトに追加します。

import com.opencsv.CSVReader
import java.io.FileReader

fun main() {
    val filePath = "path_to_your_large_csvfile.csv"
    CSVReader(FileReader(filePath)).use { reader ->
        var nextLine: Array<String>?
        while (reader.readNext().also { nextLine = it } != null) {
            println(nextLine?.joinToString(","))
        }
    }
}

このコードを実行すると、指定したCSVファイルの各行が配列として読み込まれ、コンソールに表示されます。

「opencsv」を利用することで、CSVファイルの読み込みやパースが簡単かつ効率的に行えます。

●Kotlinでのエラーハンドリング

Kotlinを使用してテキストファイルを読み込む際には、さまざまなエラーが発生する可能性があります。

例えば、指定したファイルが存在しない、ファイルが開けない、データの形式が正しくないなど、多くの原因でエラーが発生する可能性が考えられます。

このようなエラーを効果的にハンドリングするための方法を、Kotlinのエラーハンドリングに関するサンプルコードを通して解説します。

○サンプルコード9：try-catchを用いたエラーハンドリングの実装

このコードでは、try-catchを使ってテキストファイルの読み込み時に発生する可能性のあるエラーをキャッチし、適切なメッセージを表示する方法を紹介します。

import java.io.File
import java.io.IOException

fun main() {
    val filePath = "path_to_your_textfile.txt"
    try {
        val content = File(filePath).readText()
        println(content)
    } catch (e: IOException) {
        println("ファイルの読み込み中にエラーが発生しました: ${e.message}")
    }
}

このコードを実行すると、正常にファイルが読み込めた場合はその内容がコンソールに表示されます。

しかし、何らかの理由でエラーが発生した場合は、キャッチしたエラーメッセージがコンソールに表示されます。

○サンプルコード10：存在しないファイルパスへの対応

このコードでは、指定したファイルが存在しない場合のエラーハンドリングを実装しています。

import java.io.File
import java.io.FileNotFoundException

fun main() {
    val filePath = "nonexistent_file.txt"
    try {
        val content = File(filePath).readText()
        println(content)
    } catch (e: FileNotFoundException) {
        println("指定したファイルが見つかりませんでした: $filePath")
    } catch (e: Exception) {
        println("予期せぬエラーが発生しました: ${e.message}")
    }
}

このコードを実行すると、ファイルが存在しないため、「指定したファイルが見つかりませんでした: nonexistent_file.txt」というメッセージがコンソールに表示されます。

さらに、他の予期せぬエラーが発生した場合のハンドリングも追加しています。

●テキストファイル読み込みのパフォーマンス向上

テキストファイルを効率的に読み込むためには、読み込み速度を向上させるテクニックやトリックがあります。

特に大量のデータや大きなファイルを扱う際には、読み込みのパフォーマンスが要求されます。

今回は、Kotlinでのテキストファイル読み込みのパフォーマンスを向上させるための方法を、サンプルコードを交えて紹介します。

○サンプルコード11：キャッシュを活用した高速化テクニック

キャッシュは、一度読み込んだデータを一時的に保存しておき、再度アクセスする際に高速にデータを取得するための技術です。

このコードでは、読み込んだテキストデータをキャッシュとして保存し、二度目以降のアクセスを高速化する方法を表しています。

import java.io.File

val fileCache = mutableMapOf<String, String>()

fun readFileWithCache(filePath: String): String {
    return fileCache[filePath] ?: File(filePath).readText().also { fileCache[filePath] = it }
}

fun main() {
    val path = "path_to_your_textfile.txt"
    val content1 = readFileWithCache(path)  // 初回はファイルから読み込み
    val content2 = readFileWithCache(path)  // 二度目以降はキャッシュから取得
    println(content2)
}

このコードを実行すると、初回の読み込みではファイルからデータを取得しますが、二度目以降はキャッシュから高速にデータを取得します。

○サンプルコード12：スレッドを活用した非同期読み込み

スレッドを利用することで、ファイルの読み込みを非同期に行い、アプリケーションのレスポンスを向上させることができます。

このコードでは、Kotlinのコルーチンを利用して非同期にテキストファイルを読み込む方法を紹介します。

import kotlinx.coroutines.*
import java.io.File

suspend fun readFileAsync(filePath: String): String = withContext(Dispatchers.IO) {
    File(filePath).readText()
}

fun main() = runBlocking {
    val path = "path_to_your_textfile.txt"
    val content = async { readFileAsync(path) }
    println("ファイル読み込みを非同期で開始しました。")
    println(content.await())
}

このコードを実行すると、「ファイル読み込みを非同期で開始しました。」のメッセージが表示された後、非同期でファイルの内容が読み込まれて表示されます。

●注意点と対処法

テキストファイルを読み込む際には、いくつかの注意点や、それに対する対処法があります。

Kotlinでのテキストファイル読み込みを安全かつ効率的に行うためのポイントを、サンプルコードとともに詳しく紹介します。

○文字コードの違いに対応する方法

テキストファイルには様々な文字コードが存在します。

UTF-8, Shift_JIS, EUC-JPなど、ファイルの文字コードと読み込む際の文字コードが異なると文字化けや読み込みエラーが発生する可能性があります。

このコードでは、Kotlinで指定した文字コードでテキストファイルを読み込む方法を示しています。

import java.io.File
import java.nio.charset.Charset

fun readFileWithCharset(filePath: String, charset: Charset): String {
    return File(filePath).readText(charset)
}

fun main() {
    val path = "path_to_your_textfile.txt"
    val content = readFileWithCharset(path, Charsets.UTF_8)
    println(content)
}

このコードではCharsets.UTF_8を使ってUTF-8の文字コードでファイルを読み込んでいます。

他の文字コードを指定したい場合、Charsetsクラスの適切な定数を利用してください。

○大量のデータを扱う際のメモリ消費の注意

大きなサイズのテキストファイルを読み込む際、メモリ消費が急増し、システムに負荷をかける可能性があります。

この問題を回避するため、ファイルの内容を一度に全て読み込むのではなく、部分的に読み込む方法を採用することが効果的です。

下記のコードは、Kotlinでファイルを一行ずつ読み込み、メモリ消費を抑える方法を表しています。

import java.io.File

fun readFileLineByLine(filePath: String) {
    File(filePath).forEachLine { line ->
        println(line)
    }
}

fun main() {
    val path = "path_to_your_large_textfile.txt"
    readFileLineByLine(path)
}

このコードを実行すると、大きなテキストファイルでも一行ずつ読み込みながら内容を表示します。

このように部分的にデータを処理することで、メモリの過度な消費を避けることができます。

●カスタマイズ方法

Kotlinでテキストファイルを読み込む際、場面や要件に応じて読み込むデータの加工や変換、独自の読み込みロジックの実装が求められることもあります。

ここでは、テキストファイルの読み込みをカスタマイズするための具体的な方法をサンプルコードとともに解説します。

○読み込むデータの加工や変換の方法

テキストファイルからデータを読み込む際、そのデータを特定の形式に変換したり、不要な部分を取り除いたりすることがあります。

下記のコードでは、テキストファイルの各行を大文字に変換して表示する方法を表しています。

import java.io.File

fun convertToUpperCase(filePath: String) {
    File(filePath).forEachLine { line ->
        val upperCaseLine = line.toUpperCase()
        println(upperCaseLine)
    }
}

fun main() {
    val path = "path_to_your_textfile.txt"
    convertToUpperCase(path)
}

このコードでは、forEachLine関数を使ってファイルの各行を一つずつ読み取り、toUpperCase関数を用いて大文字に変換しています。

○独自の読み込みロジックの実装方法

時には、通常の読み込み方法では要件を満たせない場合があります。そんなときは、独自の読み込みロジックを実装する必要があります。

下記のコードは、テキストファイルから偶数行のみを読み取るカスタムロジックの一例として提供します。

import java.io.File

fun readEvenLines(filePath: String) {
    val lines = File(filePath).readLines()
    for (index in lines.indices) {
        if ((index + 1) % 2 == 0) {
            println(lines[index])
        }
    }
}

fun main() {
    val path = "path_to_your_textfile.txt"
    readEvenLines(path)
}

このコードでは、readLines関数を使ってファイルの全行をリストとして読み取った後、偶数行のみを表示するロジックを実装しています。

まとめ

Kotlinでのテキストファイル読み込みは非常に柔軟であり、多様な要件に応じてカスタマイズが可能です。

基本的な読み込みから応用的な方法、エラーハンドリング、さらには読み込みパフォーマンスの向上や独自のカスタマイズ方法に至るまで、多岐にわたるテクニックや関数を活用することで、幅広いシチュエーションに対応することができます。

この記事を通じて紹介した各サンプルコードや手法は、日々の開発業務やプロジェクトにおいて、データの読み込みや処理の効率化、品質の向上に大いに役立つことでしょう。

Kotlinの持つ機能や特性を最大限に活用し、テキストファイルの読み込みをより効果的に行う方法を探求し続けることで、更なる開発の成功を迎えることができます。

Kotlinのテキストファイル読み込みに関する深い理解を持ち、日々のコーディングに活かしていくことを心からお勧めします。