os パッケージ

os パッケージは、コマンドライン引数の参照、環境変数の取得、ファイル操作など、OS が提供する機能にアクセスするための関数を提供します。

1. コマンドライン引数の取得(os.Args)

os.Args は、実行時にプログラムへ渡されたコマンドライン引数を保持するスライスです。CLI ツールで、実行時のオプションやサブコマンドを受け取る用途で使います。書き方は以下のとおりです。

os.Args   // []string ─ コマンドライン引数(先頭はプログラムのパス)

次のコードは、実行時に渡されたコマンドライン引数を表示する例です。

package main

import (
    "fmt"
    "os"
)

func main() {
    fmt.Println("引数:", os.Args)
}

main.go として保存し、引数を2つ渡して実行します。

go run main.go hello world

以下のような実行結果が表示されます(先頭のパスは環境により異なります)。

引数: [/tmp/go-build.../exe/main hello world]

先頭にビルドされたバイナリのパスが入り、続いて渡した hello と world が並んで出力されました。

コードを解説します。

fmt.Println("引数:", os.Args)

os.Args は、プログラムを起動したときに渡されたコマンドライン引数のスライスです。先頭(os.Args[0])にはプログラム自身のパスが入り、2つ目以降にユーザが渡した引数が並びます。

2. 環境変数の取得(os.Getenv)

環境変数(environment variable)は、OS が管理する「名前と値」の設定情報で、実行中のプロセスから参照できます。シェルの export コマンドや、コンテナ実行時のオプション(docker run -e など)、サービス起動時の設定などで指定します。ソースコードに直接書きたくない値(データベース接続先・APIキー・動作モードの切り替えなど)を、実行時にプロセスへ渡す用途で広く使われます。

os.Getenv は、指定した名前の環境変数の値を取得する関数です。書き方は以下のとおりです。

os.Getenv("キー名")   // string ─ 環境変数の値。未設定なら空文字列

次のコードは、環境変数 MY_NAME の値を表示する例です。

package main

import (
    "fmt"
    "os"
)

func main() {
    fmt.Println("MY_NAME:", os.Getenv("MY_NAME"))
}

環境変数はプログラム側では設定できないため、実行前にシェル側で設定しておく必要があります。MY_NAME に Taro を設定した状態でプログラムを実行します。

macOS / Linux(bash / zsh):

export MY_NAME=Taro
go run main.go

Windows(PowerShell):

$env:MY_NAME = "Taro"
go run main.go

以下のような実行結果が表示されます。

MY_NAME: Taro

シェルで設定した MY_NAME の値が、Goプログラムから os.Getenv("MY_NAME") で取り出されて表示されました。

コードを解説します。

fmt.Println("MY_NAME:", os.Getenv("MY_NAME"))

os.Getenv("キー名") で、指定した名前の環境変数の値を取得できます。設定されていない場合は空文字列が返ります。

3. .env ファイルからの環境変数の読み込み(godotenv)

os.Getenv で環境変数を取り出せるようになりましたが、環境変数はシェル側で1つずつ export して用意する必要があります。キーの数が増えるとこの手順は煩雑で、ターミナルを開き直すたびに設定し直す手間もかかります。そこで実際の開発では、.env ファイル(環境変数を KEY=VALUE 形式で1行1変数書いたテキストファイル)にまとめて、godotenv パッケージで一括読み込みする形がよく使われます。

godotenv は外部パッケージなので、「Goモジュールとパッケージ」で扱った go get で導入します。ここでは、.env に書いた値を godotenv.Load で環境変数として登録し、os.Getenv で取り出す流れを体験します。

3.1 godotenv の導入

main.go があるフォルダで、godotenv を go get で取り込みます。

go get github.com/joho/godotenv

以下のような実行結果が表示されます。

go: added github.com/joho/godotenv v1.5.x

go.mod に godotenv がバージョン付きで追加され、import して使えるようになります。

3.2 .env ファイルの作成

main.go と同じフォルダに .env を作成します。書き方は以下のとおりです。1行に1変数、KEY=VALUE 形式で書きます。

キー1=値1
キー2=値2

次の内容の .env を作成します。

APP_NAME=DevOpsCamp
APP_ENV=development
💡 ポイント
.env にはパスワードやAPIキーなど、外部に出したくない値が入ることが多いため、通常は .gitignore に .env を追加して Git 管理から除外します。共有したい設定値(サンプル)は、値を空にした .env.example を別途 Git 管理下に置く運用が一般的です。

3.3 読み込みと取り出し

書き方は以下のとおりです。godotenv.Load() を呼ぶと、カレントディレクトリの .env が読み込まれ、書かれた KEY=VALUE がプロセスの環境変数として登録されます。登録後は、通常の環境変数と同じように os.Getenv で取り出せます。

godotenv.Load()           // error ─ .env を読み込み、環境変数として登録する
os.Getenv("キー名")        // string ─ 登録された環境変数の値

次のコードは、.env から APP_NAME と APP_ENV を読み込んで表示する例です。

package main

import (
    "fmt"
    "os"

    "github.com/joho/godotenv"
)

func main() {
    if err := godotenv.Load(); err != nil {
        fmt.Println(".envファイル読み込み失敗:", err)
        return
    }

    fmt.Println("APP_NAME:", os.Getenv("APP_NAME"))
    fmt.Println("APP_ENV:", os.Getenv("APP_ENV"))
}

main.go として保存し、以下のコマンドで実行します。

go run main.go

以下のような実行結果が表示されます。

APP_NAME: DevOpsCamp
APP_ENV: development

.env に書いた値がプロセスの環境変数として登録され、os.Getenv で取り出せていることが確認できます。シェル側で export する必要はありません。

コードを解説します。

if err := godotenv.Load(); err != nil {
    fmt.Println(".envファイル読み込み失敗:", err)
    return
}

godotenv.Load() は、実行時のカレントディレクトリにある .env を読み込み、書かれた KEY=VALUE を環境変数として登録します。ファイルが見つからない・書式が不正などの場合はエラーが返るため、if err != nil で判定して早期リターンします。

fmt.Println("APP_NAME:", os.Getenv("APP_NAME"))

godotenv.Load() を通した後は、os.Getenv の呼び出し方は export で設定したときとまったく同じです。値の取り出し側のコードを変えずに、設定の受け渡し方だけを差し替えられるのが godotenv を挟むメリットです。

4. ファイルの読み込み(os.ReadFile)

os.ReadFile は、ファイル全体を一度に読み込んで []byte として返す関数です。書き方は以下のとおりです。

os.ReadFile(ファイルパス)   // ([]byte, error) ─ ファイル全体を読み込む

サンプルを動かす前に、読み込み対象の hello.txt を作業ディレクトリ(main.go と同じ場所)に用意します。シェルから作成する場合は以下のようにします。

macOS / Linux(bash / zsh):

echo "Hello, Go!" > hello.txt

Windows(PowerShell):

Set-Content -Path hello.txt -Value "Hello, Go!"

Visual Studio Code で hello.txt を新規作成し、Hello, Go! と記入して保存しても構いません。

次のコードは、用意した hello.txt を読み込んで表示する例です。

package main

import (
    "fmt"
    "os"
)

func main() {
    data, err := os.ReadFile("hello.txt")
    if err != nil {
        fmt.Println("読み込みエラー:", err)
        return
    }
    fmt.Println(string(data))
}

main.go として保存し、以下のコマンドで実行します。

go run main.go

以下のような実行結果が表示されます。

Hello, Go!

os.ReadFile で hello.txt の中身が []byte として読み込まれ、string(data) で文字列に変換して表示されました。

コードを解説します。

data, err := os.ReadFile("hello.txt")

os.ReadFile(パス) は、指定したファイルの内容をすべて []byte として読み込みます。ファイルが存在しない場合や権限がない場合は err にエラー情報が入るため、判定して分岐します。[]byte を人間が読める形にするため、string(data) で文字列へ変換しています。

💡 ポイント
os.ReadFile はファイル全体を一度にメモリに読み込むため、巨大なファイル(数GB規模など)には向きません。行単位で処理したい場合や巨大ファイルを扱う場合は、os.Open で *os.File を取得し、bufio.NewScanner などのバッファ経由で処理します。

5. ファイルの書き込み(os.WriteFile)

os.WriteFile は、ファイルにデータを一度に書き込む関数です。ファイルが存在しなければ新規作成、存在すれば上書きされます。書き方は以下のとおりです。

os.WriteFile(ファイルパス, データ, パーミッション)   // error ─ ファイルにデータを書き込む

次のコードは、hello.txt に文字列を書き出す例です。

package main

import (
    "fmt"
    "os"
)

func main() {
    content := []byte("Hello, Go!\n")
    err := os.WriteFile("hello.txt", content, 0644)
    if err != nil {
        fmt.Println("書き込みエラー:", err)
        return
    }
    fmt.Println("hello.txt に書き込みました")
}

main.go として保存し、以下のコマンドで実行します。

go run main.go

以下のような実行結果が表示されます。

hello.txt に書き込みました

カレントディレクトリの hello.txt に Hello, Go! が書き込まれた状態になります。前節で用意したファイルがある場合は、上書きされます。

コードを解説します。

err := os.WriteFile("hello.txt", content, 0644)

os.WriteFile(パス, データ, パーミッション) は、指定パスに []byte の内容をまとめて書き込みます。第3引数の 0644 は Unix系のファイルパーミッション(所有者は読み書き可、他は読み取りのみ)を表します。Windows では効果を持ちませんが、指定は必要です。