【Go言語】ファイルの読み書き、コピーや移動方法を解説！

3行で要約すると

Goのosパッケージでファイルの開き、読み、書き、閉じる操作が行えます。
ReadとWriteメソッドで、簡単にファイルの内容を扱うことができる。
ファイル操作後は、Closeメソッドを使用してリソースを適切に解放することが重要です。

はじめに

今回は、Goでのファイルの操作を中心に解説していきます。日常の開発作業では、ファイルの読み書きは避けて通れない作業の一つです。特にサーバーサイドの開発を行う場合、設定ファイルやデータの読み書きなど、様々な場面で必要とされます。そこで、今回はosパッケージを使用して、基本的なファイルの操作方法を学んでいきましょう！

ファイルオブジェクト

まず最初に、osパッケージで提供されているFileオブジェクトについて理解しましょう。このFileオブジェクトは、ファイルへのアクセスや操作を行うための中心的な役割を果たします。

Go言語では、ファイルやディレクトリは*os.Fileという型で表されます。これはファイルへの参照、またはファイルディスクリプタとして考えることができます。*os.Fileオブジェクトを通じて、ファイルの内容の読み取りや書き込み、さらにはファイルのメタデータの取得など、様々な操作を行うことができるのです。

それでは、具体的な操作方法について詳しく見ていきましょう！

ファイルを開く(open)

ファイルを操作する前に、まずそのファイルを開く必要があります。Go言語では、osパッケージのOpen関数やOpenFile関数を使用して、ファイルを開くことができます。

読み込み権限onlyで開く

読み込み専用でファイルを開く場合は、os.Open関数を利用します。この関数は、指定したパスのファイルを読み込みモードで開くことができます。

package main

import (
    "fmt"
    "os"
)

func main() {
    // "sample.txt"という名前のファイルを読み込み専用で開く
    file, err := os.Open("sample.txt")
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer file.Close()

    // ここでファイルの読み取りなどの操作を行うことができます
}

上記のコードでは、sample.txtという名前のファイルを読み込み専用で開いています。エラーハンドリングも行っており、ファイルが開けなかった場合はエラーメッセージを表示して終了しています。

書き込み権限付きで開く

ファイルに書き込みを行う場合、または新しいファイルを作成する場合は、os.OpenFile関数を使用します。この関数は、指定したパスのファイルを読み書きモードや書き込み専用モードで開くことができます。

package main

import (
    "fmt"
    "os"
)

func main() {
    // "sample.txt"という名前のファイルを読み書きモードで開く
    file, err := os.OpenFile("sample.txt", os.O_RDWR|os.O_CREATE, 0666)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer file.Close()

    // ここでファイルの読み取りや書き込みなどの操作を行うことができます
}

上記のコードでは、os.OpenFile関数を使用して、sample.txtを読み書きモードで開いています。また、os.O_CREATEフラグを指定しているため、ファイルが存在しない場合は新しく作成されます。0666はファイルのパーミッションを示しており、この場合はユーザー、グループ、その他のユーザーが読み書きできる設定となっています。

ファイル内容の読み込み(read)

ファイルからデータを読み取る際、Go言語のosパッケージのFile型が提供するReadメソッドを使用します。このメソッドを使用することで、指定したバイト数だけファイルからデータを読み取ることができます。

package main

import (
    "fmt"
    "os"
)

func main() {
    file, err := os.Open("sample.txt")
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer file.Close()

    buffer := make([]byte, 100)  // 100バイト分のバッファを作成
    n, err := file.Read(buffer) // ファイルからデータを読み取る
    if err != nil {
        fmt.Println("Read error:", err)
        return
    }

    fmt.Printf("Read %d bytes: %s\n", n, buffer[:n])
}

上記のコードでは、sample.txtから最大100バイトのデータを読み取り、結果を表示しています。

ファイルへの書き込み(write)

ファイルへのデータ書き込みには、osパッケージのFile型が提供するWriteメソッドを使用します。このメソッドを使用することで、指定したデータをファイルに書き込むことができます。

package main

import (
    "fmt"
    "os"
)

func main() {
    file, err := os.OpenFile("sample.txt", os.O_WRONLY|os.O_CREATE, 0666)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer file.Close()

    data := []byte("Hello, Go!")               // 書き込むデータ
    n, err := file.Write(data)                 // データをファイルに書き込む
    if err != nil {
        fmt.Println("Write error:", err)
        return
    }

    fmt.Printf("Wrote %d bytes to file\n", n)
}

このコードは、sample.txtに"Hello, Go!"という文字列を書き込む例です。成功した場合、書き込んだバイト数が表示されます。

これで、基本的なファイルの読み取りと書き込みの方法を学ぶことができました。これらの基礎をマスターすることで、Goでのファイル操作がよりスムーズになります。

ファイルを閉じる(close)

ファイル操作が終了したら、開いたファイルを閉じる必要があります。これは、不要なリソースを解放し、他のプログラムやプロセスとの競合を避けるためです。osパッケージのFile型は、Closeメソッドを提供しており、これを使用してファイルを閉じます。

package main

import (
    "fmt"
    "os"
)

func main() {
    file, err := os.Open("sample.txt")
    if err != nil {
        fmt.Println("Error:", err)
        return
    }

    // ファイル操作のコード...

    // ファイルを閉じる
    err = file.Close()
    if err != nil {
        fmt.Println("Close error:", err)
        return
    }

    fmt.Println("File closed successfully!")
}