いろいろ備忘録日記

主に .NET とか Go とか Flutter とか Python絡みのメモを公開しています。

Goメモ-434 (envメモ)(04.use-fieldname-by-default)

関連記事

devlights.hatenablog.com

devlights.hatenablog.com

devlights.hatenablog.com

GitHub - devlights/blog-summary: ブログ「いろいろ備忘録日記」のまとめ

概要

以下、自分用のメモです。

前回に引き続き、github.com/caarlos0/env のメモです。

今回は、構造体のフィールド名を自動的に環境変数名にマッピングして処理してもらう設定について。

サンプル

package main

import (
    "github.com/caarlos0/env/v11"
    "github.com/k0kubun/pp/v3"
)

type (
    // Config は、環境変数の値を保持する構造体です.
    //
    // # REFERENCES
    //   - https://github.com/caarlos0/env
    Config struct {
        Home   string
        MyEnv1 string
        MyEnv2 int
    }
)

func main() {
    if err := run(); err != nil {
        pp.Fatal(err)
    }
}

func run() error {
    var (
        cfg  Config
        opts = env.Options{
            UseFieldNameByDefault: true, // デフォルトでフィールド名を環境変数として使用する
        }
        err error
    )

    // 環境変数の値を取得して値を構造体に設定してもらう
    err = env.ParseWithOptions(&cfg, opts)
    if err != nil {
        return err
    }

    // Pretty Print
    pp.Println(cfg)

    return nil
}

オプションにて、UseFieldNameByDefault を true に設定することにより、 デフォルトでフィールド名を環境変数として使用してくれます。なのでこの場合はタグの付与無しでも自動マッピングとなります。

変換規則は、MyValue というフィールド名の場合は MY_VALUE という環境変数にマッピングされる感じです。

実行すると以下のようになります。

# https://taskfile.dev

version: '3'

vars:
  APP_NAME: app

tasks:
  default:
    cmds:
      - task: run
  build:
    cmds:
      - go build -o {{.APP_NAME}}
  run:
    deps: [ build ]
    cmds:
      - ./{{.APP_NAME}}
    env:
      MY_ENV1: helloworld
      MY_ENV2: 999
  clean:
    cmds:
      - rm -f ./{{.APP_NAME}}
$ task
task: [build] go build -o app
task: [run] ./app
main.Config{
  Home:   "/home/gitpod",
  MyEnv1: "helloworld",
  MyEnv2: 999,
}

構造体タグを設定していないけど、ちゃんと読み取ってくれてますね。

サンプルは以下にアップしてあります。

try-golang-extlib/examples/singleapp/env/04.use-fieldname-by-default at main · devlights/try-golang-extlib · GitHub

参考情報

carlosbecker.com

Goのおすすめ書籍


過去の記事については、以下のページからご参照下さい。

サンプルコードは、以下の場所で公開しています。