11.05.2023 в 15:36

Управление конфигурацией в Go

Вы когда-нибудь работали в сервисе, который требует большого количества настроек, таких как конечные точки API, секретные значения, язык и другие конфигурации? Если у вас есть, вы знаете, насколько утомительным может быть управление ими всеми без надлежащей системы. К счастью, в Go есть отличный пакет, который поможет вам легко управлять вашими конфигурациями.

Viper - это мощная и легко настраиваемая библиотека для управления конфигурацией приложений в Go. Viper гибок, прост в использовании и прост в настройке и управлении конфигурацией в ваших приложениях Go. Это позволяет инженерам работать с несколькими источниками конфигурации, включая файлы, переменные окружения, флаги командной строки и удаленные хранилища значений ключей.

В этом посте в блоге мы подробно рассмотрим Viper, изучим его функции и приведем примеры того, как использовать его в ваших проектах. К концу вы будете хорошо подготовлены к использованию Viper в своих приложениях Go.

Viper был разработан с учетом принципов 12-факторного приложения, стремясь создать для инженеров удобный интерфейс при работе с конфигурационными данными.

Ключевые особенности Viper

Некоторые ключевые особенности Viper включают:

Поддержка нескольких форматов файлов конфигурации (JSON, TOML, YAML, HCL, INI и другие)
Автоматическая привязка переменных окружения и флагов командной строки
Поддержка удаленных хранилищ значений ключей, таких как etcd или Consul
Обнаружение изменений в режиме реального времени и оперативное обновление конфигурации
Значения по умолчанию и разархивирование в пользовательские структуры

Установка и настройка

Чтобы начать работу с Viper, вам сначала нужно установить пакет, используя следующую команду:

go get github.com/spf13/viper

Затем импортируйте пакет Viper в свой код Go:

import "github.com/spf13/viper"

Работа с конфигурационными файлами

Viper поддерживает несколько форматов файлов конфигурации, включая JSON, TOML, YAML, HCL и INI.

Пример конфигурации. файл yaml

# 
server:
  port: 8080
  host: localhost
database:
  driver: mysql
  host: localhost
  port: 3306
  name: mydb
  user: myuser
  password: mypass

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

viper.SetConfigName("config")
viper.SetConfigType("yaml")
viper.AddConfigPath("/etc/app/")
viper.AddConfigPath("$HOME/.app")
viper.AddConfigPath(".")

В этом примере Viper ищет файл с именем Config.yaml в каталогах /etc/app/, $HOME/.app и в основном каталоге вашего проекта. Чтобы прочитать файл конфигурации, вызовите функцию ReadInConfig():

err := viper.ReadInConfig()
if err != nil {
    log.Fatalf("Error reading config file: %s", err)
}

Теперь вы можете получить доступ к значениям в файле конфигурации, используя Get() или методы определенного типа, такие как getString(), getInt() и GetBool().

port := viper.GetInt("server.port")

Переменные среды и флаги командной строки

Viper может автоматически привязывать переменные среды и флаги командной строки к вашим конфигурационным ключам. Для этого используйте функцию AutomaticEnv() и определите привязки флагов.

viper.AutomaticEnv()

flag.Int("port", 8080, "Port to run the server on")
flag.Parse()

viper.BindPFlag("server.port", flag.Lookup("port"))

Теперь, если вы зададите переменную окружения или передадите флаг командной строки, Viper будет использовать предоставленное значение вместо значения из файла конфигурации.

Удаленные хранилища значений ключей

Viper также поддерживает удаленные хранилища значений ключей, такие как etcd или Consul. Чтобы использовать удаленное хранилище, импортируйте соответствующий пакет удаленного поставщика и настройте информацию о подключении. Вот пример использования etcd:

Сначала установите удаленный провайдер etcd Viper:

go get github.com/spf13/viper/remote

Импортируйте необходимые пакеты в свой код Go:

import (
    "github.com/spf13/viper"
    "github.com/spf13/viper/remote"
)

Настройте Viper для использования провайдера etcd:

const etcdConfigKey = "/config/myapp"

err := viper.AddRemoteProvider("etcd", "http://127.0.0.1:2379", etcdConfigKey)
if err != nil {
    log.Fatalf("Unable to add remote provider: %s", err)
}

viper.SetConfigType("yaml")
err = viper.ReadRemoteConfig()
if err != nil {
    log.Fatalf("Error reading remote config: %s", err)
}

Теперь Viper будет читать данные конфигурации, хранящиеся в ключе /config/myapp на сервере etcd.

Значения по умолчанию и демаршаллинг

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

viper.SetDefault("server.port", 8080)

Viper также может разархивировать данные конфигурации в пользовательскую структуру. Это упрощает работу с конфигурационными данными в вашем приложении, поскольку вы можете получить к ним доступ, используя определенную структуру. Вот пример:

type Config struct {
    Server struct {
        Port int
    }
}

var config Config
err := viper.Unmarshal(&config)
if err != nil {
    log.Fatalf("Error unmarshalling config: %s", err)
}

port := config.Server.Port

Наблюдая за изменениями

Одной из мощных функций Viper является его способность отслеживать изменения конфигурации и обновлять значения в режиме реального времени. Чтобы включить эту функцию, вызовите функцию WatchConfig() и зарегистрируйте функцию обратного вызова для обработки изменений.

viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
    log.Printf("Config file changed: %s", e.Name)
    // Reload your configuration or perform any necessary actions here
})

Viper автоматически обновит значения при изменении файла конфигурации и вызовет зарегистрированную функцию обратного вызова.

Источник:

Configuration Management in Go. Unleashing the Power of Viper | by Mehran | May, 2023 | ITNEXT

#Golang

754

Войти на сайт