インターフェース定義

env ライブラリは細粒度インターフェース設計を採用し、依存性注入と柔軟な組み合わせをサポートしています。

コアインターフェース

EnvLoader

すべてのサブインターフェースを組み合わせた完全なローダーインターフェース：

type EnvLoader interface {
    EnvFileLoader
    EnvGetter
    EnvSetter
    EnvApplicator
    EnvCloser
}

EnvFileLoader

ファイル読み込みインターフェース：

type EnvFileLoader interface {
    LoadFiles(filenames ...string) error
}

用途： ファイル読み込み機能のみが必要な場面。

func loadConfig(loader env.EnvFileLoader) error {
    return loader.LoadFiles(".env")
}

EnvGetter

読み取りアクセスインターフェース：

type EnvGetter interface {
    GetString(key string, defaultValue ...string) string
    Lookup(key string) (string, bool)
    Keys() []string
    All() map[string]string
}

用途： 読み取り専用設定アクセス（最小インターフェース）。

func readConfig(getter env.EnvGetter) {
    host := getter.GetString("HOST", "localhost")
    value, exists := getter.Lookup("API_KEY")
    keys := getter.Keys()
}

注意

GetInt、GetBool、GetUint64、GetFloat64、GetDuration、GetSecure、Len は EnvGetter インターフェースの一部ではありません。これらのメソッドは *Loader 型に実装されていますが、最小インターフェースには含まれていません。

完全な読み取り機能が必要な場合は、*Loader 型を直接使用してください：

func readFullConfig(loader *env.Loader) {
    port := loader.GetInt("PORT", 8080)      // ✓ 利用可能
    debug := loader.GetBool("DEBUG", false)  // ✓ 利用可能
    count := loader.Len()                     // ✓ 利用可能
}

EnvSetter

書き込みアクセスインターフェース：

type EnvSetter interface {
    Set(key, value string) error
    Delete(key string) error
}

用途： 設定/削除機能のみが必要な場面。

func updateConfig(setter env.EnvSetter) error {
    if err := setter.Set("KEY", "value"); err != nil {
        return err
    }
    return setter.Delete("TEMP_KEY")
}

EnvApplicator

システム環境への適用インターフェース：

type EnvApplicator interface {
    Apply() error
}

用途： 読み込んだ変数を os.Environ に適用。

func applyToSystem(applicator env.EnvApplicator) error {
    return applicator.Apply()
}

EnvCloser

リソース解放インターフェース：

type EnvCloser interface {
    Close() error
}

用途： ローダーのリソースを解放。

検証インターフェース

Validator

複合検証インターフェース：

type Validator interface {
    KeyValidator
    ValueValidator
    RequiredValidator
}

注意

Validator は RequiredValidator を埋め込むことで ValidateRequired メソッドを提供します。KeyValidator のみを実装したカスタムバリデーターは、ValidateRequired を呼び出すと ErrValidateRequiredUnsupported を返します。

RequiredValidator

必須キー検証インターフェース：

type RequiredValidator interface {
    ValidateRequired(keys map[string]bool) error
}

すべての必須キーが存在するかどうかを検証します。

KeyValidator

キー検証インターフェース：

type KeyValidator interface {
    ValidateKey(key string) error
}

キー名がルールに準拠しているか（長さ、フォーマット、禁止キーなど）を検証します。

ValueValidator

値検証インターフェース：

type ValueValidator interface {
    ValidateValue(value string) error
}

値が安全かどうか（ヌルバイト、制御文字なし等）を検証します。

監査インターフェース

AuditLogger

最小監査ログインターフェース（internal.AuditLogger のエイリアス）：

type AuditLogger interface {
    LogError(action AuditAction, key, errMsg string) error
}

用途： カスタム監査ロガーの実装に便利な最小インターフェース。完全な監査機能が必要な場合は FullAuditLogger を使用してください。

FullAuditLogger

拡張監査ログインターフェース、完全な監査ログ機能を提供：

type FullAuditLogger interface {
    AuditLogger
    Log(action AuditAction, key, reason string, success bool) error
    LogWithFile(action AuditAction, key, file, reason string, success bool) error
    LogWithDuration(action AuditAction, key, reason string, success bool, duration time.Duration) error
    Close() error
}

用途： 完全な監査ログ機能。ComponentFactory.Auditor() はこのインターフェースを返します。

メソッド詳細：

方法	用途
LogError	エラーイベントを記録（AuditLogger から継承）
`Log`	一般的な監査イベントを記録
`LogWithFile`	ファイル情報を含むイベントを記録
`LogWithDuration`	所要時間を含むイベントを記録
`Close`	監査ログをクローズ

AuditHandler

監査ハンドラーインターフェース（Config.AuditHandler の設定に使用）：

type AuditHandler interface {
    Log(event AuditEvent) error
    Close() error
}

用途： このインターフェースを実装すると監査イベントの処理方法をカスタマイズできます。AuditLogger インターフェースとは異なり、AuditHandler は Log と Close の 2 つのメソッドを必要とし、監査イベントの受信処理とリソース解放に使用します。

組み込み実装：

JSONAuditHandler - JSON フォーマットのログを出力
LogAuditHandler - 標準 log パッケージを使用して出力
ChannelAuditHandler - チャネルに送信
CloseableChannelHandler - 独自のバッファチャネルを持つクローズ可能ハンドラー
NopAuditHandler - 何もしないハンドラー

変数展開インターフェース

VariableExpander

変数展開インターフェース：

type VariableExpander interface {
    Expand(s string) (string, error)
}

用途： カスタム変数展開ロジック。${VAR}、${VAR:-default} などの構文をサポート。

expanded, err := expander.Expand("${BASE_URL}/api")

解析インターフェース

EnvParser

パーサーインターフェース：

type EnvParser interface {
    Parse(r io.Reader, filename string) (map[string]string, error)
}

パラメータ：

r - ファイルコンテンツリーダー
filename - ファイル名（エラー情報用）

戻り値：

map[string]string - 解析されたキーと値のペア
error - 解析エラー

用途： カスタムファイルフォーマットパーサー。

ストレージインターフェース

EnvStorage

環境変数ストレージインターフェース：

type EnvStorage interface {
    Get(key string) (string, bool)
    Set(key, value string)
    Delete(key string)
    Keys() []string
    Len() int
    ToMap() map[string]string
    Clear()
}

用途： カスタムストレージバックエンド。

メソッド詳細：

方法	用途
`Get`	値の取得、値と存在有無を返す
`Set`	キーと値のペアを設定
`Delete`	キーを削除
`Keys`	すべてのキー名を返す
`Len`	キーと値のペアの数を返す
`ToMap`	すべてのキーと値のペアのコピーを返す
`Clear`	すべてのデータをクリア

シリアライズインターフェース

Marshaler

カスタムシリアライズインターフェース：

type Marshaler interface {
    MarshalEnv() ([]byte, error)
}

用途： カスタム型のシリアライズ。

type LogLevel string

func (l LogLevel) MarshalEnv() ([]byte, error) {
    return []byte(string(l)), nil
}

// 使用
level := LogLevel("debug")
env.Marshal(level)  // MarshalEnv を呼び出し

Unmarshaler

カスタムデシリアライズインターフェース：

type Unmarshaler interface {
    UnmarshalEnv(data map[string]string) error
}

用途： カスタム型のデシリアライズ。

type Config struct {
    Host string
    Port int
}

func (c *Config) UnmarshalEnv(data map[string]string) error {
    c.Host = data["HOST"]
    port, _ := strconv.Atoi(data["PORT"])
    c.Port = port
    return nil
}

// 使用
var cfg Config
env.UnmarshalInto(data, &cfg)  // UnmarshalEnv を呼び出し

ファイルシステムインターフェース

FileSystem

ファイルシステム抽象インターフェース：

type FileSystem interface {
    Open(name string) (File, error)
    OpenFile(name string, flag int, perm os.FileMode) (File, error)
    Stat(name string) (os.FileInfo, error)
    MkdirAll(path string, perm os.FileMode) error
    Remove(name string) error
    Rename(oldpath, newpath string) error
    Getenv(key string) string
    Setenv(key, value string) error
    Unsetenv(key string) error
    LookupEnv(key string) (string, bool)
}

用途： テスト時にファイルシステムをモック。

type MockFileSystem struct {
    files map[string]string
    env   map[string]string
}

// MockFile は env.File インターフェースを実装（テスト用）
type MockFile struct {
    reader *strings.Reader
}

func (f *MockFile) Read(p []byte) (n int, err error)   { return f.reader.Read(p) }
func (f *MockFile) Write(p []byte) (n int, err error)  { return 0, errors.ErrUnsupported }
func (f *MockFile) Close() error                       { return nil }
func (f *MockFile) Stat() (os.FileInfo, error)         { return nil, errors.ErrUnsupported }
func (f *MockFile) Sync() error                        { return nil }

func (m *MockFileSystem) Open(name string) (env.File, error) {
    content, ok := m.files[name]
    if !ok {
        return nil, os.ErrNotExist
    }
    return &MockFile{reader: strings.NewReader(content)}, nil
}

func (m *MockFileSystem) OpenFile(name string, flag int, perm os.FileMode) (env.File, error) {
    return m.Open(name)
}

func (m *MockFileSystem) Stat(name string) (os.FileInfo, error) {
    if _, ok := m.files[name]; !ok {
        return nil, os.ErrNotExist
    }
    return nil, nil
}

func (m *MockFileSystem) MkdirAll(path string, perm os.FileMode) error { return nil }
func (m *MockFileSystem) Remove(name string) error                     { delete(m.files, name); return nil }
func (m *MockFileSystem) Rename(oldpath, newpath string) error {
    m.files[newpath] = m.files[oldpath]
    delete(m.files, oldpath)
    return nil
}

func (m *MockFileSystem) Getenv(key string) string            { return m.env[key] }
func (m *MockFileSystem) Setenv(key, value string) error      { m.env[key] = value; return nil }
func (m *MockFileSystem) Unsetenv(key string) error           { delete(m.env, key); return nil }
func (m *MockFileSystem) LookupEnv(key string) (string, bool) { val, ok := m.env[key]; return val, ok }

// 使用
cfg := env.TestingConfig()
cfg.FileSystem = &MockFileSystem{
    files: map[string]string{".env": "KEY=value"},
    env:   make(map[string]string),
}

File

ファイルインターフェース：

type File interface {
    io.Reader
    io.Writer
    io.Closer
    Stat() (os.FileInfo, error)
    Sync() error
}

メソッド詳細：

方法	用途
Read	データの読み取り
Write	データの書き込み
Close	ファイルをクローズ
Stat	ファイル情報の取得
Sync	ディスクに同期

DefaultFileSystem

デフォルトファイルシステム実装：

var DefaultFileSystem FileSystem = OSFileSystem{}

実際のオペレーティングシステムのファイルシステムと環境変数を使用：

cfg := env.DefaultConfig()
cfg.FileSystem = env.DefaultFileSystem  // デフォルト値

監査ハンドラー

JSONAuditHandler

JSON フォーマットの監査ログを出力：

func NewJSONAuditHandler(w io.Writer) *JSONAuditHandler

パラメータ：

w - 出力先（os.Stdout、ファイルなど）

handler := env.NewJSONAuditHandler(os.Stdout)

出力例：

json

{"timestamp":"2024-01-15T10:30:00Z","action":"load","key":"API_KEY","success":true}

LogAuditHandler

標準 log パッケージを使用して出力：

func NewLogAuditHandler(logger *log.Logger) *LogAuditHandler

パラメータ：

logger - 標準 log.Logger インスタンス

import "log"

logger := log.New(os.Stderr, "[AUDIT] ", log.LstdFlags)
handler := env.NewLogAuditHandler(logger)

出力例：

text

[AUDIT] 2024/01/15 10:30:00 load .env success

ChannelAuditHandler

チャネルに送信：

func NewChannelAuditHandler(ch chan<- AuditEvent) *ChannelAuditHandler

パラメータ：

ch - 監査イベントチャネル

ch := make(chan env.AuditEvent, 100)
handler := env.NewChannelAuditHandler(ch)

// 非同期処理
go func() {
    for event := range ch {
        processAuditEvent(event)
    }
}()

NopAuditHandler

空操作ハンドラー（すべてのイベントを破棄）：

func NewNopAuditHandler() *NopAuditHandler

handler := env.NewNopAuditHandler()

監査型

AuditAction

操作タイプ定数：

type AuditAction = internal.Action

const (
    ActionLoad       AuditAction = "load"        // ファイル読み込み
    ActionParse      AuditAction = "parse"       // 解析操作
    ActionGet        AuditAction = "get"         // 変数読み取り
    ActionSet        AuditAction = "set"         // 変数設定
    ActionDelete     AuditAction = "delete"      // 変数削除
    ActionValidate   AuditAction = "validate"    // 検証操作
    ActionExpand     AuditAction = "expand"      // 変数展開
    ActionSecurity   AuditAction = "security"    // セキュリティイベント
    ActionError      AuditAction = "error"       // エラーイベント
    ActionFileAccess AuditAction = "file_access" // ファイルアクセス
)

AuditEvent

監査イベント構造：

type AuditEvent = internal.Event

フィールド：

フィールド	型	説明
Timestamp	`time.Time`	タイムスタンプ
Action	`AuditAction`	操作タイプ
Key	`string`	キー名（マスク済み）
File	`string`	ファイル名
Reason	`string`	原因/説明
Success	`bool`	成功したかどうか
Masked	`bool`	マスク済みかどうか
Details	`string`	詳細
Duration	`int64`	所要時間（ナノ秒）

ComponentFactory

コンポーネントファクトリー、共有コンポーネントを管理：

type ComponentFactory struct {
    // プライベートフィールドを含む
}

方法

func (f *ComponentFactory) Validator() Validator
func (f *ComponentFactory) Auditor() FullAuditLogger
func (f *ComponentFactory) Expander() VariableExpander
func (f *ComponentFactory) Close() error
func (f *ComponentFactory) IsClosed() bool

用途： 内部使用、Loader 作成時に自動管理。詳細は ComponentFactory API を参照。

完全な例

カスタム監査ハンドラーの実装

package main

import (
    "fmt"

    "github.com/cybergodev/env"
)

// カスタム監査ハンドラー
type CustomAuditHandler struct {
    events []env.AuditEvent
}

func (h *CustomAuditHandler) Log(event env.AuditEvent) error {
    h.events = append(h.events, event)
    return nil
}

func (h *CustomAuditHandler) Close() error {
    return nil
}

func main() {
    cfg := env.ProductionConfig()
    cfg.AuditEnabled = true
    handler := &CustomAuditHandler{}
    cfg.AuditHandler = handler

    loader, _ := env.New(cfg)
    defer loader.Close()
    // 使用 loader...

    // 查看監査イベント
    for _, event := range handler.events {
        fmt.Printf("%s: %s - %s\n", event.Action, event.Key, event.Reason)
    }
}

細粒度インターフェースの使用

package main

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

// 読み取り機能のみ必要
func printConfig(getter env.EnvGetter) {
    for _, key := range getter.Keys() {
        value, _ := getter.Lookup(key)
        fmt.Printf("%s = %s\n", key, value)
    }
}

// 書き込み機能のみ必要
func setDefaults(setter env.EnvSetter) error {
    return setter.Set("DEFAULT_KEY", "default_value")
}

// 読み込み機能のみ必要
func loadConfig(loader env.EnvFileLoader) error {
    return loader.LoadFiles(".env")
}

func main() {
    cfg := env.DefaultConfig()
    loader, _ := env.New(cfg)
    defer loader.Close()

    // 細粒度インターフェースの使用
    loadConfig(loader)
    setDefaults(loader)
    printConfig(loader)
}

インターフェース定義 ​

コアインターフェース ​

EnvLoader ​

EnvFileLoader ​

EnvGetter ​

EnvSetter ​

EnvApplicator ​

EnvCloser ​

検証インターフェース ​

Validator ​

RequiredValidator ​

KeyValidator ​

ValueValidator ​

監査インターフェース ​

AuditLogger ​

FullAuditLogger ​

AuditHandler ​

変数展開インターフェース ​

VariableExpander ​

解析インターフェース ​

EnvParser ​

ストレージインターフェース ​

EnvStorage ​

シリアライズインターフェース ​

Marshaler ​

Unmarshaler ​

ファイルシステムインターフェース ​

FileSystem ​

File ​

DefaultFileSystem ​

監査ハンドラー ​

JSONAuditHandler ​

LogAuditHandler ​

ChannelAuditHandler ​

NopAuditHandler ​

監査型 ​

AuditAction ​

AuditEvent ​

ComponentFactory ​

方法 ​

完全な例 ​

カスタム監査ハンドラーの実装 ​

細粒度インターフェースの使用 ​

関連ドキュメント ​

インターフェース定義

コアインターフェース

EnvLoader

EnvFileLoader

EnvGetter

EnvSetter

EnvApplicator

EnvCloser

検証インターフェース

Validator

RequiredValidator

KeyValidator

ValueValidator

監査インターフェース

AuditLogger

FullAuditLogger

AuditHandler

変数展開インターフェース

VariableExpander

解析インターフェース

EnvParser

ストレージインターフェース

EnvStorage

シリアライズインターフェース

Marshaler

Unmarshaler

ファイルシステムインターフェース

FileSystem

File

DefaultFileSystem

監査ハンドラー

JSONAuditHandler

LogAuditHandler

ChannelAuditHandler

NopAuditHandler

監査型

AuditAction

AuditEvent

ComponentFactory

方法

完全な例

カスタム監査ハンドラーの実装

細粒度インターフェースの使用

関連ドキュメント