Best Practices For Writing Clean Interfaces in Go

Interfaces allow us to treat different types as the same type when it comes to specific behaviors. They are central to a Go programmers toolbelt and are often used improperly by new Go developers… leading to hard to read and buggy code.

Interfaces are named collections of method signatures, they are how we achieve a kind of polymorphism in Go. Click To Tweet

Recap on Interfaces

Let’s look to the standard library as an example of the way to write clean Go. The error interface is simple:

type error interface {
    Error() string
}

By definition, the error interface encapsulates any type that has an Error() method defined on it, accepts no parameters, and returns a string. For example, let’s define a struct that represents a network problem:

type networkProblem struct {
	message string
	code    int
}

Then we define an Error() method:

func (np networkProblem) Error() string {
	return fmt.Sprintf("network error! message: %s, code: %v", np.message, np.code)
}

Now, we can use an instance of the networkProblem struct wherever an error is accepted.

func handleErr(err error) {
	fmt.Println(err.Error())
}

np := networkProblem{
	message: "we received a problem",
	code:    404,
}

handleErr(np)

// prints "network error! message: we received a problem, code: 404"

Keep Interfaces Small

If there is only one piece of advice that you take away from this article, make it this: keep interfaces small! Interfaces are meant to define the minimal behavior necessary to accurately represent some entity.

Here is an example of a larger interface that remains a good example of defining minimal behavior:

type File interface {
    io.Closer
    io.Reader
    io.Seeker
    Readdir(count int) ([]os.FileInfo, error)
    Stat() (os.FileInfo, error)
}

http.Filehttps://golang.org/pkg/net/http/#pkg-overview

Any type that satisfies the interface’s behaviors can be considered by the HTTP package as a File. This is convenient because the HTTP package doesn’t need to know if it’s dealing with a file on disk, a network buffer, or a simple []byte.

Interfaces Should Have No Knowledge of Satisfying Types

An interface should define what is necessary for other types to classify as a member of that interface. They shouldn’t be aware of any types that happen to satisfy the interface at design time.

For example, let’s assume we are building an interface to describe the components necessary to define a car.

type car interface {
	GetColor() string
	GetSpeed() int
	IsFiretruck() bool
}

GetColor() and GetSpeed() make perfect sense, they are methods confined to the scope of a car. IsFiretruck() is an anti-pattern. We are forcing all cars to declare whether or not they are firetrucks. In order for this pattern to make any amount of sense, we would need a whole list of possible subtypes. IsPickup(), IsSedan(), IsTank()… where does it end??

Instead, the developer should have relied on the native functionality of type assertion to derive the underlying type when given an instance of the car interface. Or, if a sub-interface is needed, it can be defined as:

type firetruck interface {
	car
	HoseLength() int
}

Which inherits the required methods from car and adds one additional required method.

Interfaces Are Not Classes

Interfaces are not classes, they are slimmer.

Interfaces don’t have constructors or deconstructors that require that data is created or destroyed.

Interfaces aren’t hierarchical by nature, though there is syntactic sugar to create interfaces that happen to be supersets of other interfaces.

Interfaces define function signatures, but not underlying behavior. This means that making an interface often won’t DRY up your code in regards to struct methods. If five types satisfy the error interface, they all need their own version of the Error() function.

For more Go tips check out these articles:
How To Separate Library Packages in Go
Golang Mutexes – What Is RWMutex For?
How To Build JWT’s in Go (Golang)

Thanks For Reading!

Follow us on Twitter @q_vault if you have any questions or comments

Take game-like coding courses on Qvault Classroom

Subscribe to our Newsletter for more educational articles

%d bloggers like this: