MENU
  1. ホーム
  2. Kotlin
  3. Kotlinスクリプトで簡単にファイル操作を実現する方法

Kotlinスクリプトで簡単にファイル操作を実現する方法

Kotlin

Kotlinスクリプトを使えば、複雑なファイル操作を驚くほど簡単に実現できます。Kotlinのシンプルかつ表現力豊かな文法を利用することで、開発者は時間を節約しつつ効率的にコードを書くことが可能です。本記事では、Kotlinスクリプトの基本から始め、ファイルの読み書きや検索、ディレクトリ管理の方法、さらには実践的な応用例までを包括的に解説します。特に、日常的なファイル操作を自動化したい方や、Kotlinの活用方法を広げたい方にとって役立つ内容となっています。最後には、自作のファイル管理ツールを作る実践演習も用意しており、学びを即座に実践に活かせる構成になっています。

目次

Kotlinスクリプトの基本


Kotlinスクリプト（.ktsファイル）は、簡潔なコードでタスクを迅速に実行できる便利な方法です。通常のKotlinプログラムとは異なり、Kotlinスクリプトはメイン関数を必要とせず、記述したコードが上から順にそのまま実行されます。これにより、スクリプト言語のように柔軟に使用できます。

Kotlinスクリプトの作成方法


Kotlinスクリプトを作成するには、以下の手順を実行します:

  1. 拡張子が.ktsのファイルを作成します（例: script.kts）。
  2. 必要に応じてライブラリを追加します。Gradleでkotlin-scripting-dependenciesを利用することで外部ライブラリも利用可能です。
  3. Kotlinスクリプトエンジンを用いてスクリプトを実行します。

サンプルコード


以下は、簡単なKotlinスクリプトの例です。

println("Hello, Kotlin Script!")  
val number = 42  
println("The number is $number")

このコードを実行することで、Kotlinスクリプトの基本的な挙動を確認できます。

Kotlinスクリプトの実行方法


Kotlinスクリプトを実行するには、以下のコマンドを使用します。

kotlinc -script script.kts

このコマンドでスクリプトが実行され、結果が即座に出力されます。IntelliJ IDEAなどのIDEを利用する場合、直接エディタ上でスクリプトを実行することも可能です。

Kotlinスクリプトを学ぶことで、タスクの自動化やプロトタイピングの速度が格段に向上します。本記事では、このスクリプトを活用して効率的にファイル操作を行う手法を解説していきます。

ファイルの読み書きの基本操作


Kotlinスクリプトを利用すれば、ファイルの読み書きが簡潔かつ効率的に行えます。Kotlinの標準ライブラリには、ファイル操作をサポートする機能が豊富に含まれており、外部ライブラリを使わずに基本的な操作が実現可能です。以下では、代表的なファイルの読み書き方法について説明します。

ファイルの読み込み


ファイルの内容を読み込むには、FileクラスのreadTextやreadLinesメソッドを使用します。

サンプルコード: ファイル内容の読み込み

import java.io.File

val filePath = "example.txt"
val fileContent = File(filePath).readText()
println("File Content: $fileContent")

このコードは、指定したファイル（example.txt）の内容を文字列として読み込み、出力します。

ファイルへの書き込み


ファイルにデータを書き込むには、FileクラスのwriteTextやappendTextメソッドを使用します。

サンプルコード: ファイルへの書き込み

import java.io.File

val filePath = "output.txt"
File(filePath).writeText("Hello, Kotlin Script!")
println("File written successfully.")

このコードでは、output.txtファイルを作成し、指定した文字列を書き込みます。既存のファイルがある場合は上書きされます。

ファイルの追記


既存の内容を保持したまま、新しいデータを追加するには、appendTextメソッドを使用します。

サンプルコード: ファイルへの追記

File(filePath).appendText("\nAppended text.")
println("Text appended successfully.")

バイナリデータの読み書き


文字列ではなくバイナリデータを操作する場合は、inputStreamやoutputStreamを活用します。

サンプルコード: バイナリデータのコピー

val sourceFile = File("source.bin")
val destinationFile = File("destination.bin")

sourceFile.inputStream().use { input ->
    destinationFile.outputStream().use { output ->
        input.copyTo(output)
    }
}
println("File copied successfully.")

これらの基本操作を組み合わせることで、Kotlinスクリプトを用いた柔軟なファイル操作が可能になります。次のセクションでは、ディレクトリ操作について詳しく解説します。

ディレクトリの作成と管理


Kotlinスクリプトを活用すれば、ディレクトリの作成や管理も簡単に行えます。標準ライブラリのjava.io.Fileクラスを利用して、ディレクトリ操作を効率的に実現できます。ここでは、ディレクトリの基本操作と応用例を紹介します。

ディレクトリの作成


ディレクトリを作成するには、mkdirまたはmkdirsメソッドを使用します。mkdirは1階層のディレクトリを作成し、mkdirsは階層構造を一括で作成します。

サンプルコード: ディレクトリの作成

import java.io.File

val dirPath = "exampleDir"
val dir = File(dirPath)

// 1階層のディレクトリを作成
if (dir.mkdir()) {
    println("Directory created: $dirPath")
} else {
    println("Failed to create directory: $dirPath")
}

// 階層構造を一括で作成
val nestedDirPath = "exampleDir/subDir1/subDir2"
val nestedDir = File(nestedDirPath)
if (nestedDir.mkdirs()) {
    println("Nested directories created: $nestedDirPath")
} else {
    println("Failed to create nested directories: $nestedDirPath")
}

ディレクトリの内容を取得


ディレクトリ内のファイルやサブディレクトリを取得するには、listFilesメソッドを使用します。

サンプルコード: ディレクトリ内容の取得

val dirContent = dir.listFiles()
if (dirContent != null) {
    println("Directory contents:")
    dirContent.forEach { file ->
        println(file.name)
    }
} else {
    println("Directory is empty or does not exist.")
}

ディレクトリの削除


ディレクトリを削除するには、deleteメソッドを使用します。ただし、空のディレクトリのみ削除可能です。

サンプルコード: ディレクトリの削除

if (dir.delete()) {
    println("Directory deleted: $dirPath")
} else {
    println("Failed to delete directory: $dirPath")
}

ディレクトリの再帰的な削除


内容があるディレクトリを削除するには、再帰的に削除するロジックを実装します。

サンプルコード: 再帰的なディレクトリ削除

fun deleteRecursively(file: File): Boolean {
    if (file.isDirectory) {
        file.listFiles()?.forEach { deleteRecursively(it) }
    }
    return file.delete()
}

if (deleteRecursively(nestedDir)) {
    println("Nested directories deleted: $nestedDirPath")
} else {
    println("Failed to delete nested directories: $nestedDirPath")
}

ディレクトリの応用例


これらの基本操作を活用することで、ファイル整理ツールや自動バックアップスクリプトなど、便利なユーティリティを作成できます。次のセクションでは、ファイル内容の検索と置換について解説します。

ファイル内容の検索と置換


Kotlinスクリプトを活用すれば、ファイル内の特定のテキストを検索し、必要に応じて置換する処理を簡単に実現できます。これにより、大量のファイルを一括で処理するタスクも効率的に行えます。以下では、基本的な実装から応用例までを解説します。

ファイル内のテキスト検索


ファイルの内容を検索するには、readLinesメソッドを利用して各行を確認する方法が一般的です。

サンプルコード: 特定文字列の検索

import java.io.File

val filePath = "example.txt"
val searchTerm = "Kotlin"

File(filePath).readLines().forEachIndexed { index, line ->
    if (line.contains(searchTerm)) {
        println("Found '$searchTerm' on line ${index + 1}: $line")
    }
}

このコードでは、指定された文字列（Kotlin）を含む行を検索し、その行番号と内容を出力します。

ファイル内のテキスト置換


検索した文字列を置換するには、readTextでファイル内容を取得し、replaceメソッドを利用します。その後、変更された内容をファイルに書き戻します。

サンプルコード: 特定文字列の置換

val originalText = "Kotlin"
val replacementText = "Kotlin Script"

val fileContent = File(filePath).readText()
val updatedContent = fileContent.replace(originalText, replacementText)

File(filePath).writeText(updatedContent)
println("Replaced '$originalText' with '$replacementText'.")

正規表現を使用した高度な検索と置換


正規表現を使用すれば、より複雑な条件に基づいた検索と置換が可能です。

サンプルコード: 正規表現を使用した置換

val regex = Regex("\\d{4}-\\d{2}-\\d{2}") // 日付形式 (YYYY-MM-DD) の検索
val updatedContentWithRegex = fileContent.replace(regex, "REDACTED")

File(filePath).writeText(updatedContentWithRegex)
println("Replaced all dates with 'REDACTED'.")

複数ファイルへの一括適用


ディレクトリ内のすべてのファイルに対して検索と置換を実行するには、listFilesを使用してファイルを取得し、前述のロジックを適用します。

サンプルコード: ディレクトリ内の一括置換

val dirPath = "exampleDir"
val directory = File(dirPath)

directory.listFiles { file -> file.isFile }?.forEach { file ->
    val content = file.readText()
    val updatedContent = content.replace(originalText, replacementText)
    file.writeText(updatedContent)
    println("Updated file: ${file.name}")
}

実用例: ログファイルの整理


この手法は、ログファイル内の機密データのマスキングや、古いフォーマットから新しいフォーマットへの変換に役立ちます。

これらの技術を活用すれば、大量のファイルに対する検索と置換タスクを効率的に処理できます。次のセクションでは、エラーハンドリングと安全な操作方法について解説します。

エラーハンドリングと安全な操作方法


ファイル操作は便利ですが、ファイルが存在しない、アクセス権限がない、ディスク容量が不足しているなど、予期しないエラーが発生する可能性があります。Kotlinスクリプトを使用する際には、エラーハンドリングを適切に実装し、安全に操作を行うことが重要です。ここでは、エラーハンドリングの基本と安全な操作を実現するためのテクニックを紹介します。

基本的なエラーハンドリング


Kotlinでは、try-catchブロックを利用して例外を処理します。

サンプルコード: ファイル読み込み時のエラーハンドリング

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

val filePath = "nonexistent.txt"

try {
    val content = File(filePath).readText()
    println("File content: $content")
} catch (e: IOException) {
    println("Error reading file: ${e.message}")
}

このコードでは、ファイルが存在しない場合や読み込みに失敗した場合にエラーをキャッチし、適切なメッセージを表示します。

安全なファイル書き込み


ファイル書き込み中にエラーが発生すると、データが破損するリスクがあります。これを防ぐため、一時ファイルを利用して安全にデータを保存する方法を採用します。

サンプルコード: 一時ファイルを使用した安全な書き込み

val tempFile = File("output.tmp")
val finalFile = File("output.txt")

try {
    tempFile.writeText("Temporary file content.")
    if (tempFile.renameTo(finalFile)) {
        println("File written successfully.")
    } else {
        println("Failed to rename temp file.")
    }
} catch (e: IOException) {
    println("Error writing file: ${e.message}")
} finally {
    tempFile.delete() // 一時ファイルを削除
}

ファイル存在確認


ファイルやディレクトリが存在するかを確認するには、existsメソッドを使用します。

サンプルコード: ファイル存在確認

val file = File(filePath)

if (file.exists()) {
    println("File exists: ${file.name}")
} else {
    println("File does not exist.")
}

リソースの自動解放


ファイル操作にはリソース（ストリーム）の管理が伴います。Kotlinでは、useブロックを使用することで、リソースを自動的に解放できます。

サンプルコード: リソースの解放

File(filePath).inputStream().use { input ->
    println("File size: ${input.available()} bytes")
}

useを使用すると、ストリームが閉じられてリソースリークを防止できます。

操作の安全性を高めるTips

  1. 絶対パスの確認: 相対パスではなく絶対パスを使用し、誤ったファイルにアクセスしないようにする。
  2. アクセス権の確認: ファイル操作前に、読み取りまたは書き込みの権限を確認する。
  3. 例外処理の網羅: 可能性のある例外をすべてキャッチし、適切にログを記録する。
  4. バックアップの作成: 重要なファイルは操作前にバックアップを作成する。

これらのテクニックを用いることで、エラー発生時でも安全にファイル操作を進めることが可能です。次のセクションでは、応用例としてバッチファイル処理について解説します。

応用例: バッチファイル処理


複数のファイルを対象にした一括処理（バッチ処理）は、日常的なファイル管理やデータ整備に役立ちます。Kotlinスクリプトを使用すると、簡潔なコードで大量のファイルに対して処理を適用できます。このセクションでは、代表的なバッチ処理の例を紹介します。

ディレクトリ内のファイルを一括読み込み


特定のディレクトリ内にあるすべてのファイルを読み込み、それぞれの内容を表示する例です。

サンプルコード: ディレクトリ内のファイル一覧と内容表示

import java.io.File

val directoryPath = "exampleDir"
val directory = File(directoryPath)

if (directory.exists() && directory.isDirectory) {
    directory.listFiles { file -> file.isFile }?.forEach { file ->
        println("Processing file: ${file.name}")
        val content = file.readText()
        println("Content: $content")
    }
} else {
    println("Directory does not exist or is not a directory.")
}

このコードでは、ディレクトリ内のすべてのファイルを読み込み、それぞれの内容を表示します。

特定の拡張子を持つファイルを対象に処理


特定のファイル形式（例: .txt）だけを対象に処理を行う方法を示します。

サンプルコード: テキストファイルのみを処理

directory.listFiles { file -> file.extension == "txt" }?.forEach { file ->
    println("Found text file: ${file.name}")
    val content = file.readText()
    println("File content: $content")
}

このコードは、ディレクトリ内のすべての.txtファイルを検索し、その内容を出力します。

バッチ処理でファイル名を変更


ディレクトリ内のすべてのファイルの名前を一括で変更する例です。

サンプルコード: ファイル名の一括変更

directory.listFiles { file -> file.isFile }?.forEach { file ->
    val newName = "renamed_${file.name}"
    val renamedFile = File(directory, newName)
    if (file.renameTo(renamedFile)) {
        println("Renamed ${file.name} to $newName")
    } else {
        println("Failed to rename ${file.name}")
    }
}

ファイル内容の一括置換


複数のファイルの内容を検索して置換するバッチ処理を行う例です。

サンプルコード: ファイル内容の一括置換

val searchTerm = "OldText"
val replacement = "NewText"

directory.listFiles { file -> file.extension == "txt" }?.forEach { file ->
    val content = file.readText()
    val updatedContent = content.replace(searchTerm, replacement)
    file.writeText(updatedContent)
    println("Updated file: ${file.name}")
}

ログファイルの整理


特定の条件（例: ファイルサイズや更新日）に基づいて古いファイルを削除する例を紹介します。

サンプルコード: 古いファイルの削除

val thresholdDays = 7
val thresholdMillis = System.currentTimeMillis() - thresholdDays * 24 * 60 * 60 * 1000

directory.listFiles { file -> file.isFile && file.lastModified() < thresholdMillis }?.forEach { file ->
    if (file.delete()) {
        println("Deleted file: ${file.name}")
    } else {
        println("Failed to delete file: ${file.name}")
    }
}

実用例: バッチファイル処理を活用した業務自動化


これらのバッチ処理技術は、以下のような場面で役立ちます:

  • 日次で生成されるログファイルの自動整理
  • 複数のCSVファイルのデータ整形や統合
  • ファイル形式の一括変換（例: テキストからHTMLへ）

これらを組み合わせることで、より高度な自動化ツールを構築できます。次のセクションでは、外部ライブラリを活用してさらに効率的にファイル操作を行う方法を解説します。

Kotlinライブラリの活用でさらに効率化


Kotlinの標準ライブラリだけでも多くのファイル操作が可能ですが、外部ライブラリを活用することでさらに効率的かつ高度な処理を実現できます。特に、ファイル操作やデータ解析を強化するための便利なツールが多数提供されています。このセクションでは、Kotlinでよく利用される外部ライブラリとその具体的な使い方を紹介します。

Kotlinx.ioを使ったファイル操作


Kotlinx.ioは、高速かつ効率的なI/O操作を可能にするライブラリです。ストリーム操作やバッファ管理を簡単に行えます。

サンプルコード: Kotlinx.ioでのファイル読み書き

import kotlinx.io.core.*
import kotlinx.io.file.FileSystem
import kotlinx.io.file.Path

val filePath = Path("example.txt")
val fileSystem = FileSystem.SYSTEM

// ファイル書き込み
fileSystem.write(filePath) {
    writeFully("Hello, Kotlinx.io!".toByteArray())
}

// ファイル読み込み
val content = fileSystem.read(filePath) {
    val buffer = ByteArray(1024)
    val bytesRead = readAvailable(buffer, 0, buffer.size)
    buffer.decodeToString(0, bytesRead)
}
println("File content: $content")

このコードは、Kotlinx.ioを使用してファイルの読み書きを効率化する方法を示しています。

Apache Commons IOを使った高度なファイル操作


Apache Commons IOは、ファイルのコピーやディレクトリの操作、ファイルフィルタリングなどを簡単に行えるJavaライブラリです。Kotlinでもそのまま利用可能です。

サンプルコード: ディレクトリのコピー

import org.apache.commons.io.FileUtils
import java.io.File

val sourceDir = File("sourceDir")
val destDir = File("destDir")

FileUtils.copyDirectory(sourceDir, destDir)
println("Directory copied from ${sourceDir.name} to ${destDir.name}")

このコードでは、ディレクトリ全体をコピーする処理を一行で実現しています。

Okioを使った効率的なバイナリ処理


Okioは、バイナリデータの効率的な操作を提供するライブラリです。ファイルの読み書きだけでなく、暗号化や圧縮などの高度な機能にも対応しています。

サンプルコード: ファイルの読み書き

import okio.buffer
import okio.sink
import okio.source
import java.io.File

val file = File("okio_example.txt")

// ファイル書き込み
file.sink().buffer().use { sink ->
    sink.writeUtf8("Hello, Okio!")
}

// ファイル読み込み
file.source().buffer().use { source ->
    val content = source.readUtf8()
    println("File content: $content")
}

ライブラリ活用による生産性の向上


これらのライブラリを活用することで、以下のようなメリットが得られます:

  1. コードの簡潔化: 複雑な処理を少ないコードで実現可能。
  2. パフォーマンスの向上: 高速なI/O処理が可能。
  3. 信頼性の向上: テスト済みのライブラリを利用することで、エラーを最小限に抑えられる。

実用例: データの圧縮と解凍


外部ライブラリを使用することで、ファイルの圧縮と解凍も簡単に実現できます。

サンプルコード: Zipファイルの圧縮

import java.util.zip.ZipOutputStream
import java.io.FileOutputStream
import java.util.zip.ZipEntry
import java.io.FileInputStream

val zipFile = File("example.zip")
val filesToZip = listOf(File("file1.txt"), File("file2.txt"))

ZipOutputStream(FileOutputStream(zipFile)).use { zipOut ->
    filesToZip.forEach { file ->
        FileInputStream(file).use { fis ->
            val zipEntry = ZipEntry(file.name)
            zipOut.putNextEntry(zipEntry)
            fis.copyTo(zipOut)
        }
    }
}
println("Files compressed into ${zipFile.name}")

これらのライブラリを組み合わせることで、ファイル操作の可能性が格段に広がります。次のセクションでは、Kotlinスクリプトを使用した小さなファイル管理ツールの作成について解説します。

実践演習: 小さなファイル管理ツールの作成


ここでは、Kotlinスクリプトを活用してシンプルなファイル管理ツールを作成します。このツールは、以下の機能を提供します:

  1. 指定ディレクトリ内のファイル一覧表示
  2. ファイル内容の検索と置換
  3. 古いファイルの自動削除

これにより、日常のファイル管理作業を効率化できます。

ファイル管理ツールの概要


ツールは、コマンドライン引数を利用して操作します。以下のような形式で実行します:

kotlinc -script FileManager.kts -- -list ./exampleDir
kotlinc -script FileManager.kts -- -replace ./exampleDir "OldText" "NewText"
kotlinc -script FileManager.kts -- -clean ./exampleDir 30
  1. -list: 指定したディレクトリのファイル一覧を表示します。
  2. -replace: 指定したディレクトリ内のすべてのファイルで検索と置換を行います。
  3. -clean: 指定日数以上経過したファイルを削除します。

スクリプトの実装

以下は、FileManager.ktsの実装例です。

#!/usr/bin/env kotlinc -script

import java.io.File
import java.util.concurrent.TimeUnit
import kotlin.system.exitProcess

if (args.size < 2) {
    println("Usage:")
    println("-list <directory>")
    println("-replace <directory> <searchText> <replaceText>")
    println("-clean <directory> <days>")
    exitProcess(1)
}

val command = args[0]
val directoryPath = args[1]
val directory = File(directoryPath)

if (!directory.exists() || !directory.isDirectory) {
    println("Invalid directory: $directoryPath")
    exitProcess(1)
}

when (command) {
    "-list" -> {
        directory.listFiles()?.forEach { file ->
            if (file.isFile) {
                println("File: ${file.name}, Size: ${file.length()} bytes")
            }
        }
    }

    "-replace" -> {
        if (args.size < 4) {
            println("Usage: -replace <directory> <searchText> <replaceText>")
            exitProcess(1)
        }
        val searchText = args[2]
        val replaceText = args[3]
        directory.listFiles { file -> file.isFile }?.forEach { file ->
            val content = file.readText()
            val updatedContent = content.replace(searchText, replaceText)
            file.writeText(updatedContent)
            println("Updated file: ${file.name}")
        }
    }

    "-clean" -> {
        if (args.size < 3) {
            println("Usage: -clean <directory> <days>")
            exitProcess(1)
        }
        val days = args[2].toLongOrNull() ?: run {
            println("Invalid number of days: ${args[2]}")
            exitProcess(1)
        }
        val thresholdMillis = System.currentTimeMillis() - TimeUnit.DAYS.toMillis(days)
        directory.listFiles { file -> file.isFile && file.lastModified() < thresholdMillis }?.forEach { file ->
            if (file.delete()) {
                println("Deleted file: ${file.name}")
            } else {
                println("Failed to delete file: ${file.name}")
            }
        }
    }

    else -> println("Unknown command: $command")
}

スクリプトの使い方

  1. リスト表示: 指定したディレクトリのファイル一覧を取得します。
  2. 検索と置換: ディレクトリ内のすべてのファイルで、特定のテキストを置換します。
  3. 古いファイルの削除: 指定日数を超えるファイルを削除します。

実行例

  • ファイル一覧の取得:
  kotlinc -script FileManager.kts -- -list ./exampleDir

出力例:

  File: file1.txt, Size: 1024 bytes
  File: file2.txt, Size: 2048 bytes
  • 検索と置換:
  kotlinc -script FileManager.kts -- -replace ./exampleDir "Hello" "Hi"

出力例:

  Updated file: file1.txt
  Updated file: file2.txt
  • 古いファイルの削除:
  kotlinc -script FileManager.kts -- -clean ./exampleDir 30

出力例:

  Deleted file: oldFile.txt

応用例


このスクリプトをベースに、以下の機能を追加することも可能です:

  • ファイルの圧縮と解凍
  • 指定拡張子のみの処理
  • 操作ログの保存

次のセクションでは、記事全体のまとめを行います。

まとめ


本記事では、Kotlinスクリプトを用いたファイル操作の効率化について解説しました。基本的なファイルの読み書きから、ディレクトリの管理、バッチ処理、外部ライブラリの活用、さらには小さなファイル管理ツールの作成まで、幅広い内容を取り上げました。

Kotlinスクリプトは、その簡潔な構文と柔軟性により、日常的なファイル操作の自動化やタスクの効率化に最適です。外部ライブラリを活用することでさらに高度な処理が可能になり、実践的なツールを簡単に構築できます。これらの技術を活用し、日常の作業を効率化してみてください。Kotlinスクリプトは、開発者にとって強力なツールとなるでしょう。

Kotlin
ファイル操作 スクリプト Kotlin

コメント

コメントする

目次