Go Language

Learn Go: Understanding init function in Golang #14

In Go init() function sets off a piece of code to run before any other part of your package.

Lets go!!

Published · Jan 21 2020

Previous Tutorial: Understanding Defer, Panic & Recover in Golang #13

Introduction
In Go, the predefined init() function sets off a piece of code to run before any other part of your package. 

This code will execute as soon as the package is imported, and can be used when you need your application to initialize in a specific state, such as when you have a specific configuration or set of resources with which your application needs to start.

  
In this tutorial, you’ll learn how init() is used for the setup and initialization of specific package variables, one time computations, and the registration of a package for use with another package.
. . .

The init Function
In Go, the init() function is incredibly powerful and compared to some other languages, is a lot easier to use within your Go programs. 

These init() functions can be used within a package block and regardless of how many times that package is imported, the init() function will only be called once.

Now, the fact that it is only called once is something you should pay close attention to. This effectively allows us to set up database connections, or register with various service registries, or perform any number of other tasks that you typically only want to do once.
package main

import "fmt"

func init() {
	fmt.Println("This will get called on main initialization")
}

func main() {
	fmt.Println("My Wonderful Go Program")
}

https://play.golang.org/p/RZBvNSc-V2Y

Notice in this above example, we’ve not explicitly called the init() function anywhere within our program. Go handles the execution for us implicitly and thus the above program should provide output that looks like this:
Output: 
This will get called on main initialization 
My Wonderful Go Program

Awesome, so with this working, we can start to do cool things such as variable initialization.
package main

import "fmt"

var name string

func init() {
	fmt.Println("This will get called on main initialization")
	name = "Elliot"
}

func main() {
	fmt.Println("My Wonderful Go Program")
	fmt.Printf("Name: %s\n", name)
}

https://play.golang.org/p/GQLwggu0ClD

In this example, we can start to see why using the init() function would be preferential when compared to having to explicitly call your own setup functions.

When we run the above program, you should see that our name variable has been properly set and whilst it’s not the most useful variable on the planet, we can certainly still use it throughout our Go program.
Output:
This will get called on main initializationMy 
Wonderful Go Program Name: Elliot
. . .

Multiple Packages
Let’s have a look at a more complex scenario that is closer to what you’d expect in a production Go system. Imagine we had 4 distinct Go packages within our application, main, broker, and database.

In each of these we could specify an init() function which would perform the task of setting up the connection pool to the various 3rd party services such as Kafka or MySQL.

Whenever we then call a function in our database package, it would then use the connection pool that we set up in our init() function.

Note - It’s incredibly important to note that you cannot rely upon the order of execution of your init() functions. It’s instead better to focus on writing your systems in such a way that the order does not matter.

. . .

Order of Initialization
For more complex systems, you may have more than one file making up any given package. Each of these files may indeed have their own init() functions present within them. So how does Go order the initialization of these packages?

When it comes to the order of the initialization, a few things are taken into consideration. Things in Go are typically initialized in the order in declaration order but explicitly after any variables they may depend on. 

This means that, should you have 2 files a.go and b.go in the same package, if the initialization of anything in a.go depends on things in b.go they will be initialized first.

Note - A more in-depth overview of the order of initialization in Go can be found in the official docs: Package Initialization

The key point to note from this is this order of declaration can lead to scenarios such as this:
// source: https://stackoverflow.com/questions/24790175/when-is-the-init-function-run

package main

import "fmt"

var WhatIsThe = AnswerToLife()

func AnswerToLife() int {
	return 42
}

func init() {
	WhatIsThe = 0
}

func main() {
	if WhatIsThe == 0 {
		fmt.Println("It's all a lie.")
	}
}

https://play.golang.org/p/1dwa_gxOptJ

In this scenario, you’ll see that AnswerToLife() will run before our init() function as our WhatIsThe variable is declared before our init() function is called.

. . .

Multiple Init Functions in the Same File
What happens if we have multiple init() functions within the same Go file? At first I didn’t think this was possible, but Go does indeed support having 2 separate init() functions within the one file.

These init() functions are again called in their respective order of declaration within the file:
package main

import "fmt"

// this variable is initialized first due to
// order of declaration
var initCounter int

func init() {
	fmt.Println("Called First in Order of Declaration")
	initCounter++
}

func init() {
	fmt.Println("Called second in order of declaration")
	initCounter++
}

func main() {
	fmt.Println("Does nothing of any significance")
	fmt.Printf("Init Counter: %d\n", initCounter)
}

https://play.golang.org/p/tsdPTkvLLQG

Now, when you run the above program, you should see the output look like so:
Called First in Order of Declaration
Called second in order of declaration
Does nothing of any significance
Init Counter: 2

Pretty cool, huh? But what is this for? Why do we allow this? Well, for more complex systems, it allows us to break up complex initialization procedures into multiple, easier-to-digest init() functions. 

It essentially allows us to avoid having one monolithic code block in a single init() function which is always a good thing. The one caveat of this style is that you will have to take care when ensuring declaration order.
. . .
Conclusion
So this concludes the basic introduction to the world of init() functions. Once you’ve mastered the use of the package initialization, you may find it useful to master the art of structuring your Go based projects.
. . .
Next Tutorial: How to Import & Use packages in Golang #15

Golang Tutorial Series:  Learn Go: Beginners Guide to Learn Golang from Scratch!
. . .
References: 
[ 1 ] The Go init Function