構造体マッピング

構造体タグを使用して環境変数を Go 構造体に自動マッピングし、型安全な設定管理を実現します。

基本的なマッピング

シンプルな例

package main

import (
    "fmt"
    "github.com/cybergodev/env"
)

type Config struct {
    Host string `env:"SERVER_HOST"`
    Port int64  `env:"SERVER_PORT"`
    Debug bool  `env:"DEBUG"`
}

func main() {
    env.Load(".env")

    cfg := Config{}
    if err := env.ParseInto(&cfg); err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", cfg)
}

Loader インスタンスの使用

loader, _ := env.New(env.DefaultConfig())
loader.LoadFiles(".env")

var cfg Config
if err := loader.ParseInto(&cfg); err != nil {
    panic(err)
}

タグ構文

env タグ

環境変数名を指定します：

type Config struct {
    Host string `env:"SERVER_HOST"`  // SERVER_HOST にマッピング
    Port int64  `env:"PORT"`         // PORT にマッピング
}

envDefault タグ

デフォルト値を設定します：

type Config struct {
    Host    string `env:"HOST" envDefault:"localhost"`
    Port    int64  `env:"PORT" envDefault:"8080"`
    Debug   bool   `env:"DEBUG" envDefault:"false"`
    Timeout int64  `env:"TIMEOUT" envDefault:"30"`
}

フィールドの無視

env:"-" を使用してフィールドをスキップします：

type Config struct {
    Host    string `env:"HOST"`
    Ignored string `env:"-"`  // 値は設定されない
}

サポートされる型

基本型

type Config struct {
    String  string  `env:"STRING_VALUE"`
    Int     int     `env:"INT_VALUE"`
    Int8    int8    `env:"INT8_VALUE"`
    Int16   int16   `env:"INT16_VALUE"`
    Int32   int32   `env:"INT32_VALUE"`
    Int64   int64   `env:"INT64_VALUE"`
    Uint    uint    `env:"UINT_VALUE"`
    Uint64  uint64  `env:"UINT64_VALUE"`
    Float32 float32 `env:"FLOAT32_VALUE"`
    Float64 float64 `env:"FLOAT64_VALUE"`
    Bool    bool    `env:"BOOL_VALUE"`
}

時間型

import "time"

type Config struct {
    Timeout  time.Duration `env:"TIMEOUT"`
    Interval time.Duration `env:"INTERVAL"`
}

サポートされるフォーマット：

30s - 30 秒
5m - 5 分
1h30m - 1 時間 30 分
100ms - 100 ミリ秒

スライス型

スライスフィールドはカンマ , で区切られ、セパレータ前後の空白は自動的に削除されます。

type Config struct {
    Hosts []string `env:"HOSTS"`      // カンマ区切り
    Ports []int64  `env:"PORTS"`      // カンマ区切り
}

.env ファイル：

bash

HOSTS=localhost,example.com,api.example.com
PORTS=80,443,8080

ネストされた構造体

基本的なネスト

type DatabaseConfig struct {
    Host string `env:"DB_HOST" envDefault:"localhost"`
    Port int64  `env:"DB_PORT" envDefault:"5432"`
    User string `env:"DB_USER"`
    Password string `env:"DB_PASSWORD"`
}

type RedisConfig struct {
    Host string `env:"REDIS_HOST" envDefault:"localhost"`
    Port int64  `env:"REDIS_PORT" envDefault:"6379"`
}

type AppConfig struct {
    Database DatabaseConfig
    Redis    RedisConfig
    Debug    bool `env:"DEBUG" envDefault:"false"`
}

深いネスト

type Credentials struct {
    Username string `env:"DB_USER"`
    Password string `env:"DB_PASSWORD"`
}

type Connection struct {
    Host        string      `env:"DB_HOST"`
    Port        int64       `env:"DB_PORT"`
    Credentials Credentials
}

type Database struct {
    Connection Connection
    Name       string `env:"DB_NAME"`
}

ポインタ型

ポインタフィールドをサポートします：

package main

import (
    "fmt"

    "github.com/cybergodev/env"
)

type Config struct {
    Host    *string `env:"HOST"`
    Port    *int64  `env:"PORT"`
    Enabled *bool   `env:"ENABLED"`
}

func main() {
    cfg := Config{}
    env.ParseInto(&cfg)

    if cfg.Port != nil {
        fmt.Println("Port:", *cfg.Port)
    }
}

カスタム型

encoding.TextUnmarshaler インターフェースの実装

構造体フィールドのカスタムデコードは、標準ライブラリ encoding.TextUnmarshaler インターフェースを実装することで行います。これはフィールド単位の充填時に実際に呼び出されるインターフェースです。

package main

import (
    "fmt"

    "github.com/cybergodev/env"
)

type LogLevel string

// encoding.TextUnmarshaler を実装 —— フィールドレベルで呼び出される
func (l *LogLevel) UnmarshalText(text []byte) error {
    switch string(text) {
    case "debug", "info", "warn", "error":
        *l = LogLevel(text)
        return nil
    default:
        return fmt.Errorf("invalid log level: %s", string(text))
    }
}

type Config struct {
    Level LogLevel `env:"LOG_LEVEL"`
}

func main() {
    data := map[string]string{"LOG_LEVEL": "info"}

    var cfg Config
    if err := env.UnmarshalInto(data, &cfg); err != nil {
        panic(err)
    }

    fmt.Println(cfg.Level)
    // 出力：info
}

バリデーション付きの型エイリアス

type Port int64

// encoding.TextUnmarshaler を実装、解析時に範囲バリデーションを伴う
func (p *Port) UnmarshalText(text []byte) error {
    val, err := strconv.ParseInt(string(text), 10, 64)
    if err != nil {
        return err
    }
    if val < 1 || val > 65535 {
        return errors.New("port must be 1-65535")
    }
    *p = Port(val)
    return nil
}

env.Marshaler / env.Unmarshaler インターフェースについて

env.Marshaler（MarshalEnv()）と env.Unmarshaler（UnmarshalEnv(map[string]string)）インターフェースは、env.Marshal/env.MarshalStruct/env.UnmarshalInto に渡されたトップレベルの値に対してのみ有効で、構造体のフィールド単位の充填ロジックからは呼び出されません。構造体フィールドでカスタムエンコード/デコードを行うには、標準ライブラリ encoding.TextMarshaler / encoding.TextUnmarshaler を実装してください。これらはフィールドレベルで認識されます。

設定の検証

構造体の検証

package main

import (
    "errors"
    "log"

    "github.com/cybergodev/env"
)

type ServerConfig struct {
    Host string `env:"SERVER_HOST" envDefault:"0.0.0.0"`
    Port int64  `env:"SERVER_PORT" envDefault:"8080"`
}

func (c *ServerConfig) Validate() error {
    if c.Port < 1024 || c.Port > 65535 {
        return errors.New("port must be 1024-65535")
    }
    return nil
}

func main() {
    cfg := ServerConfig{}
    if err := env.ParseInto(&cfg); err != nil {
        log.Fatal(err)
    }

    if err := cfg.Validate(); err != nil {
        log.Fatal(err)
    }
}

必須フィールドの検証

type Config struct {
    APIKey    string `env:"API_KEY"`     // 必須
    APISecret string `env:"API_SECRET"`  // 必須
    Timeout   int64  `env:"TIMEOUT" envDefault:"30"`  // オプション
}

func (c *Config) Validate() error {
    if c.APIKey == "" {
        return errors.New("API_KEY is required")
    }
    if c.APISecret == "" {
        return errors.New("API_SECRET is required")
    }
    return nil
}

実用的なパターン

集中設定管理

// config/config.go
package config

import "github.com/cybergodev/env"

type Config struct {
    Server   ServerConfig
    Database DatabaseConfig
    Redis    RedisConfig
    Log      LogConfig
}

func Load() (*Config, error) {
    if err := env.Load(".env"); err != nil {
        return nil, err
    }

    cfg := &Config{
        Server:   ServerConfig{},
        Database: DatabaseConfig{},
        Redis:    RedisConfig{},
        Log:      LogConfig{},
    }

    if err := env.ParseInto(cfg); err != nil {
        return nil, err
    }

    return cfg, nil
}

環境の区別

type BaseConfig struct {
    AppName string `env:"APP_NAME"`
    Version string `env:"APP_VERSION"`
}

type DevelopmentConfig struct {
    BaseConfig
    Debug bool `env:"DEBUG" envDefault:"true"`
}

type ProductionConfig struct {
    BaseConfig
    Debug bool `env:"DEBUG" envDefault:"false"`
}

func LoadConfig() interface{} {
    env.Load(".env")

    switch os.Getenv("GO_ENV") {
    case "production":
        cfg := ProductionConfig{}
        env.ParseInto(&cfg)
        return cfg
    default:
        cfg := DevelopmentConfig{}
        env.ParseInto(&cfg)
        return cfg
    }
}

エラー処理

解析エラー

cfg := Config{}
if err := env.ParseInto(&cfg); err != nil {
    var parseErr *env.ParseError
    if errors.As(err, &parseErr) {
        log.Fatalf("Parse error at %s:%d", parseErr.File, parseErr.Line)
    }
    log.Fatal(err)
}

型変換エラー

type Config struct {
    Port int64 `env:"PORT"`  // PORT が有効な整数でない場合
}

cfg := Config{}
if err := env.ParseInto(&cfg); err != nil {
    // 型変換の失敗はエラーを返す
}

完全な例

package main

import (
    "errors"
    "fmt"
    "log"
    "time"

    "github.com/cybergodev/env"
)

type ServerConfig struct {
    Host         string        `env:"SERVER_HOST" envDefault:"0.0.0.0"`
    Port         int64         `env:"SERVER_PORT" envDefault:"8080"`
    ReadTimeout  time.Duration `env:"READ_TIMEOUT" envDefault:"30s"`
    WriteTimeout time.Duration `env:"WRITE_TIMEOUT" envDefault:"30s"`
}

func (c *ServerConfig) Validate() error {
    if c.Port < 1024 || c.Port > 65535 {
        return errors.New("port must be 1024-65535")
    }
    return nil
}

type DatabaseConfig struct {
    Host     string `env:"DB_HOST" envDefault:"localhost"`
    Port     int64  `env:"DB_PORT" envDefault:"5432"`
    User     string `env:"DB_USER" envDefault:"postgres"`
    Password string `env:"DB_PASSWORD"`
    Name     string `env:"DB_NAME" envDefault:"myapp"`
}

func (c *DatabaseConfig) Validate() error {
    if c.Password == "" {
        return errors.New("DB_PASSWORD is required")
    }
    return nil
}

type Config struct {
    Server   ServerConfig
    Database DatabaseConfig
}

func LoadConfig() (*Config, error) {
    if err := env.Load(".env"); err != nil {
        return nil, fmt.Errorf("load env: %w", err)
    }

    cfg := &Config{
        Server:   ServerConfig{},
        Database: DatabaseConfig{},
    }

    if err := env.ParseInto(cfg); err != nil {
        return nil, fmt.Errorf("parse config: %w", err)
    }

    if err := cfg.Server.Validate(); err != nil {
        return nil, fmt.Errorf("server config: %w", err)
    }

    if err := cfg.Database.Validate(); err != nil {
        return nil, fmt.Errorf("database config: %w", err)
    }

    return cfg, nil
}

func main() {
    cfg, err := LoadConfig()
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("Server: %s:%d\n", cfg.Server.Host, cfg.Server.Port)
    fmt.Printf("Database: %s@%s:%d/%s\n",
        cfg.Database.User,
        cfg.Database.Host,
        cfg.Database.Port,
        cfg.Database.Name,
    )
}

構造体マッピング ​

基本的なマッピング ​

シンプルな例 ​

Loader インスタンスの使用 ​

タグ構文 ​

env タグ ​

envDefault タグ ​

フィールドの無視 ​

サポートされる型 ​

基本型 ​

時間型 ​

スライス型 ​

ネストされた構造体 ​

基本的なネスト ​

深いネスト ​

ポインタ型 ​

カスタム型 ​

encoding.TextUnmarshaler インターフェースの実装 ​

バリデーション付きの型エイリアス ​

設定の検証 ​

構造体の検証 ​

必須フィールドの検証 ​

実用的なパターン ​

集中設定管理 ​

環境の区別 ​

エラー処理 ​

解析エラー ​

型変換エラー ​

完全な例 ​

関連ドキュメント ​