Тема 3/3: Пакет os. Получение переменных окружения → Урок 1/5

Пакет os. Получение переменных окружения

А кроме флагов, есть ещё какой-нибудь способ передать параметры программе?

Саша

Да, можно передать их через переменные окружения.

Это лучше или хуже, чем через аргументы командной строки?

Саша

Выбор во многом зависит от задачи. Если приложение будет запускаться с одними и теми же параметрами, лучше использовать переменные окружения. Тогда не придётся указывать аргументы при запуске.

А если программа запускается с разными параметрами, тогда используй флаги. Иначе перед каждым запуском надо будет менять значения переменных.

Понятно.

Последняя тема спринта посвящена переменным окружения. В этой теме вы:

познакомитесь с пакетом os и сторонним пакетом caarlos0/env;
узнаете, как получать переменные окружения на Go;
научитесь использовать переменные окружения для конфигурирования сервисов.

Эти знания пригодятся вам для выполнения инкремента. Вы делаете учебный проект, в котором нет необходимости указывать разные адреса сервера. Поэтому вы будете передавать адрес (например, localhost:8080) через переменную окружения.

Переменные окружения

Переменные окружения — это средство операционной системы для конфигурирования программ. Через них можно:

передавать параметры программе;
получать конфигурацию операционной системы, например имя текущего пользователя и путь к домашней директории.

Выделяют три уровня переменных окружения:

локальные — определённые для текущей сессии;
пользовательские — определённые для конкретного пользователя;
системные — доступные во всей системе.

Переменные каждого уровня наследуют переменные уровнем ниже, могут их дополнять и переопределять в рамках своего уровня.

Саша

Чтобы лучше разобраться в теме и сразу набить руку, повторяй описываемые действия на своём компьютере.

Для начала выведем в консоль значение какой-нибудь переменной окружения — например, имя текущего пользователя.

Обратите внимание, что работа с переменными окружения в терминале различается на Linux, Windows и macOS:

Linux. Имя пользователя хранится в переменной USER. Чтобы получить её значение, запустите в консоли echo $USER. Список всех переменных окружения можно вывести командой env.
Windows. Имя пользователя хранится в переменной USERNAME. В отличие от Linux, на Windows имя переменной можно указывать в любом регистре. Поэтому echo %USERNAME% и echo %UserName% выведут одно и то же значение. Чтобы увидеть все переменные окружения, используйте команду set.
macOS. Как и на Linux, имя пользователя хранится в переменной USER. Для получения значения переменной примените echo $USER. Команда printenv выводит список всех переменных окружения.

Работа с переменными окружения с помощью пакета os

Теперь выведем значение переменной USER в примере на Go. Получить значение переменной можно функцией os.Getenv(key string) string:

GO
package main

import (
    "fmt"
    "os"
)

func main() {
    u := os.Getenv("USER")
    fmt.Println(u)
} 

Если переменной USER нет, функция GetEnv() вернёт пустую строку. Чтобы уточнить, отсутствует переменная или существует с пустым значением, используйте функцию os.LookupEnv(key string) (string, bool).

Получить значения всех переменных окружения можно функцией Environ() []string:

GO
package main

import (
    "fmt"
    "os"
)

func main() {
    envList := os.Environ()
    // выводим первые пять элементов
    for i := 0; i < 5 && i < len(envList); i++ {
        fmt.Println(envList[i])
    }
} 

Каждый элемент результирующего слайса представляет собой запись вида имя=значение. Вывод может выглядеть так:

TXT

SHELL=/bin/bash
SESSION_MANAGER=local/ak-desktop:@/tmp/.ICE-unix/1265,unix/ak-desktop:/tmp/.ICE-unix/1265
QT_ACCESSIBILITY=1
COLORTERM=truecolor
XDG_CONFIG_DIRS=/etc/xdg/xdg-cinnamon:/etc/xdg

Работа с переменными окружения с помощью сторонних пакетов

Чтобы вручную не парсить и не валидировать переменные окружения, можно воспользоваться сторонними пакетами. Один из самых популярных — github.com/caarlos0/env.

Этот пакет может парсить следующие типы данных:

базовые типы (string, int, bool, float32 и т. д.);
комплексные типы (time.Duration, url.URL);
типы, реализующие интерфейс encoding.TextUnmarshaler;
слайсы.

Пакет caarlos0/env позволяет проверить, существует ли переменная окружения и соответствует ли её значение определённому типу данных.

Он принимает параметры через структурные теги вида env:"NAME" от структуры, которую нужно заполнить значениями из окружения.

Рассмотрим пример использования пакета. Предположим, для конфигурации требуются:

список файлов, записанных в переменную FILES и разделённых двоеточием;
домашняя директория HOME;
интервал запуска задач TASK_DURATION (если эта переменная отсутствует, завершим программу с ошибкой).

GO
package main

import (
    "github.com/caarlos0/env/v6"
    "log"
    "time"
)

type Config struct {
    Files        []string      `env:"FILES" envSeparator:":"`
    Home         string        `env:"HOME"`
    // required требует, чтобы переменная TASK_DURATION была определена
    TaskDuration time.Duration `env:"TASK_DURATION,required"`
}

func main() {
    var cfg Config
    err := env.Parse(&cfg)
    if err != nil {
        log.Fatal(err)
    }

    log.Println(cfg)
} 

Если вы запустите эту программу, она выведет ошибку env: required environment variable "TASK_DURATION" is not set. Задайте на своём компьютере переменные окружения FILES и TASK_DURATION.

На Windows переменные окружения задаются командой SET:

BAT

SET FILES=test1.txt:test2.txt
SET TASK_DURATION=5s

На Linux это можно сделать командой export:

BASH

export FILES=test1.txt:test2.txt
export TASK_DURATION=5s

Теперь снова запустите программу и посмотрите на результат.

Задание 1/1

Выведите имя текущего пользователя в консоль с помощью пакета caarlos0/env.

GO
package main

import (
    "fmt"
    "github.com/caarlos0/env/v6"
)

type Config struct {
    User string  // укажите тег env
}

func main() {
    var cfg Config
    // допишите код

    fmt.Printf("Current user is %s\n", cfg.User)
} 

Готово

GO
package main

import (
    "fmt"
    "log"
    "github.com/caarlos0/env/v6"
)

type Config struct {
    User string `env:"USER"`
}

func main() {
    var cfg Config
    err := env.Parse(&cfg)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Printf("Current user is %s\n", cfg.User)
} 

Лиза

Оп! А вот и я!

Саша

Аж вздрогнул, Лиз, не пугай так больше, ладно?

Лиза

Ладно 😀 Какой у вас «интервал запуска задач»? Найдётся окошко для Алисы?

Всегда найдётся!

Саша

Доверяю вам этого замечательного человека, а сам пойду готовиться к совещанию 😜

Обучаем Алису

Гоша

В некоторых системах развёртывания приложений может не быть возможности передавать исполняемому файлу аргументы командной строки.

Лиза

И тогда для конфигурирования программы используют переменные окружения.

Добавим возможность конфигурировать навык Алисы с помощью переменных окружения. Для этого понадобится немного изменить файл cmd/skill/flags.go:

GO
package main

import (
    "flag"
    "os"
)

var flagRunAddr string

func parseFlags() {
    flag.StringVar(&flagRunAddr, "a", ":8080", "address and port to run server")
    flag.Parse()

    // для случаев, когда в переменной окружения RUN_ADDR присутствует непустое значение,
    // переопределим адрес запуска сервера,
    // даже если он был передан через аргумент командной строки
    if envRunAddr := os.Getenv("RUN_ADDR"); envRunAddr != "" {
        flagRunAddr = envRunAddr
    }
}
  

Теперь можем скомпилировать приложение и протестировать переопределение конфигурации:

SHELL

$ go build -o skill
$ RUN_ADDR=:8081 ./skill
Running server on :8081

$ RUN_ADDR=:8082 ./skill -a :8081
Running server on :8082

Гоша

Вот и всё!

Лиза

Ура! Теперь мы можем конфигурировать навык Алисы любым удобным способом — через аргументы командной строки или с помощью переменных окружения.

Выглядит просто. Попробую повторить в своём проекте. Спасибо!

Дополнительные материалы

go.dev/os — документация пакета os.
Losst | Переменные окружения в Linux — подробная статья о переменных окружения.
GitHub | caarlos0/env — пакет caarlos0/env.
GitHub | kelseyhightower/envconfig — пакет kelseyhightower/envconfig.

Спринт 1

Пакет os. Получение переменных окружения

Переменные окружения

Работа с переменными окружения с помощью пакета os

Работа с переменными окружения с помощью сторонних пакетов

Задание 1/1

Обучаем Алису

Дополнительные материалы

00. Введение и входной тест

00. Начало обучения

01. Спринт 1

02. Спринт 2

03. Спринт 3

04. Спринт 4

06. Спринты 5-6. Выпускной проект

07. Спринт 7

08. Спринт 8

09. Спринт 9

10. Спринт 10

12. Спринты 11-12. Второй выпускной проект