Managing Configuration Files with `viper` in Go

Introduction

When building applications in Go, managing configuration can become cumbersome without the right tools. The viper library is a powerful solution for handling configuration files efficiently. It supports multiple formats, remote key:value stores, and is fully customizable.

Installation

To use viper in your Go application, you need to first install it:

go get github.com/spf13/viper

Basic Usage

To get started with viper, you can follow these steps to read from a configuration file:

package main

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

func main() {
    viper.SetConfigName("config") // name of config file (without extension)
    viper.SetConfigType("json")   // REQUIRED if the config file does not have the extension in the name
    viper.AddConfigPath(".")       // optionally look for config in the working directory

    if err := viper.ReadInConfig(); err != nil { // Find and read the config file
        panic(fmt.Errorf("Fatal error config file: %w \n", err))
    }

    // Read values from the config file
    fmt.Println("App Name:", viper.GetString("app_name"))
}

This will read a config.json file located in the root directory. You can use formats such as JSON, YAML, TOML, or INI. Below is an example of how config.json might look:

{
    "app_name": "MyApp",
    "port": 8080
}

Setting Default Values

Viper allows you to set default values for configuration options. This can be particularly useful to make your application more robust:

viper.SetDefault("app_name", "DefaultApp")
viper.SetDefault("port", 3000)