Sign In
Sign In

For Loops in the Go Programming Language

For Loops in the Go Programming Language
Hostman Team
Technical writer
Go
11.12.2024
Reading time: 6 min

A loop is a block of code that runs until a specified condition is met or a required number of repetitions is completed. Loops are convenient for solving tasks where a program needs to repeat the same actions multiple times.

For example, imagine you have a list of directors. You need to extract each director's last name and display it on the screen. Instead of manually accessing each element of the list, it's easier to use a loop. A loop will iterate through the list and display each last name on the screen.

Loops in Go

In Go, there are only for loops. There are no while or do while loops like in some other languages. Similar concepts are implemented using the same for loop. This design choice makes the code more readable. Developers don't have to decide on a looping strategy — if you need to repeat actions, there's for, which can be used in various ways.

Let's explore how to create loops in Golang to solve specific tasks.

ForClause

The structure of a ForClause is simple. It consists of a condition and a body. The code inside the body executes if the condition is evaluated as true.

for i := 0; i < 6; i++ {
  fmt.Println(i)
}

Here:

  • i := 0 is the initializer. It sets the starting value of the loop.

  • i < 6 is the condition. If it is evaluated as true, the code inside the loop is executed.

  • fmt.Println(i) sequentially prints numbers from 0 to 5.

  • i++ is the post-operation that increments i by 1 after each iteration.


The code starts with i = 0. Since 0 < 6, the condition is true, and 0 is printed. Then, i++ increments i by 1, making i = 1. The loop continues as long as i < 6.

When i becomes 6, the condition i < 6 is false, and the loop stops. The number 6 is not printed.

Output:

0
1
2
3
4
5

You don't have to start at zero or stop at a fixed value. The for loop in Go allows you to adjust the logic as needed.

for i := 100; i < 150; i = i + 10 {
  fmt.Println(i)
}

Output:

100
110
120
130
140

If you modify the condition slightly, you can include the number 150:

for i := 100; i <= 150; i = i + 10 {
  fmt.Println(i)
}

Output:

100
110
120
130
140
150

You can also iterate in reverse, from the end to the beginning, by modifying the condition and the post-operation.

for i := 50; i > 0; i -= 10 {
  fmt.Println(i)
}

Here, the loop starts with i = 50. On each iteration, it checks if i > 0. If the condition is true, it subtracts 10 from the current value of i.

Output:

50
40
30
20
10

Note that 0 is not printed because the condition requires i > 0.

Loop with a Condition

If you remove the initializer and post-operator from the syntax, you get a simple construct that works based on a condition. The loop declaration in this case looks like this:

i := 0
for i < 6 {
    fmt.Println(i)
    i++
}

If you are familiar with other programming languages, you might recognize this as similar to a while loop.

In this example, i is defined outside the loop. The for loop only has a condition, which keeps the loop running while i is less than 6. Note that the increment operation (i++), previously specified as a post-operator, is now inside the body.

Sometimes, the number of iterations is unknown in advance. You can't specify a condition for ending the loop in such cases. To avoid infinite loops, Go supports the break keyword. Here's a simple example:

func main() {
    i := 0
    for {
        fmt.Println("Hello")
        if i == 5 {
            break
        }
        i++
    }
}

Initially, i = 0. The loop runs indefinitely, printing "Hello" each time. However, when i reaches 5, the break statement is executed, and the program stops.

RangeClause

Go also provides another type of loop — the RangeClause. It is similar to ForClause, but it returns two values by default: the index of an element and its value.

package main
import "fmt"

func main() {
    words := []string{"host", "man", "hostman", "cloud"}
    for i, word := range words {
        fmt.Println(i, word)
    }
}

Output:

0 host
1 man
2 hostman
3 cloud

To omit the index, use an underscore _ as a placeholder:

package main
import "fmt"

func main() {
    words := []string{"host", "man", "hostman", "cloud"}
    for _, word := range words {
        fmt.Println(word)
    }
}

Output:

host
man
hostman
cloud

You can also use range to add elements to a list:

package main
import "fmt"

func main() {
    words := []string{"host", "man", "hostman", "cloud"}

    for range words {
        words = append(words, "great")
    }

    fmt.Printf("%q\n", words)
}

Output:

["host" "man" "hostman" "cloud" "great" "great" "great" "great"]

In this example, the word "great" is added for each element in the original length of the words slice.

Suppose you have a slice of 10 zeros and need to populate it with numbers from 0 to 9:

package main
import "fmt"

func main() {
    integers := make([]int, 10)
    fmt.Println(integers)

    for i := range integers {
        integers[i] = i
    }
    fmt.Println(integers)
}
[0 0 0 0 0 0 0 0 0 0]
[0 1 2 3 4 5 6 7 8 9]

You can use range to iterate over each character in a string:

package main
import "fmt"

func main() {
    hostman := "Hostman"

    for _, letter := range hostman {
        fmt.Printf("%c\n", letter)
    }
}

Output:

H
o
s
t
m
a
n

This allows you to process each character in a string individually.

Nested Constructs

A for loop can be created inside another construct, making it nested. We can represent its syntax as:

for {
    [Action]
    for {
        [Action]  
    }
}

First, the outer loop starts running. It executes and then triggers the inner loop. After the inner loop finishes, the program returns to the outer loop. This process repeats as long as the given condition holds or until the program encounters a break statement.

There is also a risk of creating an infinite loop, which even the powerful resources of Hostman wouldn’t handle, as the program would never terminate. To avoid this, always ensure the condition is properly checked or use the break operator.

Here’s a simple example to demonstrate nested loops:

package main
import "fmt"

func main() {
    numList := []int{1, 2}
    alphaList := []string{"a", "b", "c"}
    for _, i := range numList {
        fmt.Println(i)
        for _, letter := range alphaList {
            fmt.Println(letter)
        }
    }
}

Output:

1
a
b
c
2
a
b
c

This example clearly demonstrates the order of operations:

  1. The first value from numList (1) is printed.

  2. The inner loop executes, printing each value from alphaList (a, b, c).

  3. The program returns to the outer loop and prints the next value from numList (2).

  4. The inner loop runs again, printing the values of alphaList (a, b, c) a second time.

Conclusion

Using for loops in Go is straightforward. Depending on the task, you can choose one of the three main forms of for or combine them to create nested constructs. You can control the loop's behavior by modifying the condition, initializer, and post-operator or by using break and continue statements.

Nested loops provide flexibility and power but should be used carefully to avoid infinite loops or excessive computational overhead.

You can deploy Go applications (such as Beego and Gin) on our app platform.

Go
11.12.2024
Reading time: 6 min

Similar

Go

How to Install Go on Windows

Go, or Golang, is a high-performance, multithreaded programming language developed by Google in 2007 and released in 2009. To this day, Golang continues to gain popularity.  The Go programming language supports many operating systems, making it a versatile choice for development across various platforms. In this guide, we will walk through the step-by-step process of installing Golang on Windows. Installing Go on Windows Go supports Windows 7 and newer versions. Ensure that you have a supported version of the OS installed. In this guide, we will use Windows 11. You will also need an administrator account to configure environment variables. To install Golang on Windows: Download the installer for the latest version of Microsoft Windows from the official Go website. If needed, you can select any other available version of the language instead of the latest one. Once the file has finished downloading, run it and follow the installation wizard's instructions. If necessary, you can change the file location. This will be useful when configuring environment variables. After the installation, check if Golang was successfully installed on your system. To do this, open the terminal (Win + R → cmd) and run the following command: go version The output should show the version of Go you just installed. For example: To update Golang to a newer version on Windows, you must uninstall the old version and follow the instructions to install the new one. Now, let's move on to setting up environment variables so that Go works properly. Setting Up Environment Variables Setting up environment variables is an important step in installing Go on Windows, as it allows the operating system to determine where the necessary Go files and directories are located. For Go to work correctly, two environment variables are required: GOPATH points to where Go stores downloaded and compiled packages. PATH allows the system to find Go executable files without specifying their full paths. GOPATH First, let's set up the GOPATH environment variable. For this, you need to organize a workspace where Go files and projects will be stored. In this guide, we will create a workspace at C:\GoProject. We will also add two directories to this folder: bin – for storing executable files (binary files). Go creates an executable file and places it in this directory when you compile your project. src – for storing Go source files. All .go files will be placed here. After creating the workspace, we will set the GOPATH environment variable. To do this, go to the Control Panel → System and Security → System and click on Advanced System Settings. There is also an easier way to access system properties: open the Run window (Win + R) and enter: sysdm.cpl Click on Environment Variables, then click the New button under the User Variables section. Here, you need to fill in two fields: the variable name and its value. In the Variable name field, enter GOPATH, and in the Variable value field, enter the path to the workspace you created earlier (in our case, C:\GoProject). Click OK twice to save the changes. To verify the creation of the system variable, open the Run window (Win + R) and enter the string: %GOPATH% If everything was done correctly, your workspace will open. PATH The PATH environment variable should have been automatically added after we installed Go. To check this, go to the Control Panel → System and Security → System and click on Advanced System Settings. In the window that opens, you need to find PATH among the system variables. To view its values, double-click on it. In the new window, there should be an entry that holds the path to the Go bin folder. In our case, it is C:\Program Files\Go\bin. If your value does not match what was specified during the Go installation, change it to the correct one using the Edit button. At this point, the installation of Golang on Windows and the setup of environment variables is complete. Now we can check its functionality by writing and running our first program. Verifying Installation To check the functionality of the newly installed Golang on Windows: Сreate a test file with the .go extension in the workspace (C:\GoProject\src). For example, ExampleProgram.go. Add the following simple code: package mainimport "fmt"func main() {    fmt.Println("Hello, Go has been successfully installed into your system!")} The program should display a message confirming that Go has been successfully installed on your system. To compile and run the program, enter the following command in the terminal: go run %GOPATH%/src/ExampleProgram.go As shown in the image below, the program compiles and runs, displaying the specified text on the screen. Conclusion Installing Go on Windows is a straightforward process, involving downloading the installer, setting up environment variables, and verifying the installation. Once Go is properly configured, you can easily start developing applications. With support for multiple operating systems, Go remains a powerful and versatile language, ideal for cross-platform development. On our app platform you can deploy Golang apps, such as Beego and Gin. 
10 December 2024 · 5 min to read
Go

Type Conversion in Go

Go is a statically typed programming language, meaning that data types are tied to variables. If you declare a variable as int to store numerical values, you cannot store a string in it. This rule works in the reverse direction as well. Static typing protects developers from errors where the program expects one data type and gets another. However, this strict binding can be limiting when performing certain operations. Go provides type conversion (or type casting) to overcome this limitation. This formal process allows developers to convert integer values to floating-point numbers, strings to numbers, and vice versa. This article will help you understand how to perform such conversions. Data Types in Go The basic types in Go are as follows: bool — Boolean values: true or false string — Strings int, int8, int16, int32, int64 — Signed integer types uint, uint8, uint16, uint32, uint64, uintptr — Unsigned integer types byte — Alias for uint8 rune — Alias for int32 float32, float64 — Floating-point numbers complex64, complex128 — Complex numbers The types int, uint, and uintptr have a width of 32 bits in 32-bit systems and 64 bits in 64-bit systems. When you need an integer value, you should use int unless you have a specific reason for using a sized or unsigned integer type. Go does not have a char data type. The language uses byte and rune to represent character values. byte represents ASCII characters, while rune represents a broader set of Unicode characters encoded in UTF-8. To define characters in Go, you enclose them in single quotes like this: 'a'. The default type for character values is rune. If you do not explicitly declare the type when assigning a character value, Go will infer the type as rune: var firstLetter = 'A' // Type inferred as `rune` You can explicitly declare a byte variable like this: var lastLetter byte = 'Z' Both byte and rune are integer types. For example, a byte with the value 'a' is converted to the integer 97. Similarly, a rune with the Unicode value '♥' is converted to the corresponding Unicode code point U+2665, where U+ indicates Unicode, and the numbers are in hexadecimal, which is essentially an integer. Here's an example: package main import "fmt" func main() { var myByte byte = 'a' var myRune rune = '♥' fmt.Printf("%c = %d and %c = %U\n", myByte, myByte, myRune, myRune) } Output: a = 97 and ♥ = U+2665 When you need to convert from int to string or vice versa, you essentially take the type initially assigned to a variable and convert it to another type. As mentioned earlier, Go strictly formalizes these actions. The examples in this article will help you understand the basics of such conversions. Number Conversion in Go Converting numeric types can be useful when solving various tasks. For example, we decided to add a calculator to the website. It should perform only one operation: division. The main requirement is that the result be accurate down to the last digit. However, when dividing two integer variables, the result may be inaccurate. For example: package main import "fmt" func main() { var first int = 15 var second int = 6 var result = first / second fmt.Println(result) } Output: 2 After executing this code, you get 2. The program outputs the nearest integer quotient, but this is far from the precise division you need. Such a calculator is not useful. To improve the accuracy, you need to cast both variables to float. Here's how you can do it: package main import "fmt" func main() { var first int = 15 var second int = 6 var result = float64(first) / float64(second) fmt.Println(result) } Output: 2.5 Now the output will be precise — 2.5. It was quite easy to achieve by simply wrapping the variables with the float64() or float32() conversion functions. Now the calculator works as expected. Product metrics are not a concern, as the feature is technically implemented correctly. You can also divide numbers without explicitly converting them to float. When you use floating-point numbers, other types are automatically cast to float. Try this code: package main import "fmt" func main() { a := 5.0 / 2 fmt.Println(a) } Output: 2.5 Even though you didn’t explicitly use the float64() or float32() wrapper in the code, Go's compiler automatically recognizes that 5.0 is a floating-point number and performs the division with the floating-point precision. The result is displayed as a floating-point number. In the first example with division, you explicitly cast the integers to float using the float64() function. Here’s another example of converting from int64 to float64: package main import "fmt" func main() { var x int64 = 57 var y float64 = float64(x) fmt.Printf("%.2f\n", y) } Output: 57.00 The two zeros after the decimal point appear because we added the %.2f\n format specifier. Instead of 2, you could specify any other number, depending on how many decimal places you want to display. You can also convert from float to int. Here's an example: package main import "fmt" func main() { var f float64 = 409.8 var i int = int(f) fmt.Printf("f = %.3f\n", f) fmt.Printf("i = %d\n", i) } Output: f = 409.800i = 409 In this example, the program prints f = 409.800 with three decimal places. In the second print statement, the float is first converted to int, and the decimal part is discarded. Note that Go does not perform rounding, so the result is 409 without any rounding to the nearest integer. Strings Conversion in Go In Golang, we can convert a number to a string using the method strconv.Itoa. This method is part of the strconv package in the language's standard library. Run this code: package main import ( "fmt" "strconv" ) func main() { a := strconv.Itoa(12) fmt.Printf("%q\n", a) } The result should be the string "12". The quotes in the output indicate that this is no longer a number. In practice, such string-to-number and number-to-string conversions are often used to display useful information to users. For example, if you're building an online store, you can host it at Hostman, implement the core business logic, and fill it with products. After some time, the product manager suggests improving the user profile. The user should see the amount they have spent and how much more they need to spend to reach the next level. To do this, you need to display a message in the user profile that consists of a simple text and a set of digits. Try running this code: package main import ( "fmt" ) func main() { user := "Alex" sum := 50 fmt.Println("Congratulations, " + user + "! You have already spent " + lines + " dollars.") } The result will be an error message. You cannot concatenate a string and a number. The solution to this problem is to convert the data in Go. Let's fix the code by converting the variable lines to a string: package main import ( "fmt" "strconv" ) func main() { user := "Alex" sum := 50 fmt.Println("Congratulations, " + user + "! You have already spent " + strconv.Itoa(sum) + " dollars.") } Now, there will be no error, and the output will display the correct message with the proper set of digits. Of course, this is a simplified example. In real projects, the logic is much more complex and challenging. However, knowing the basic operations helps avoid a large number of errors. This is especially important when working with complex systems. Let's go back to our example. The product manager comes again and says that customers want to see the exact total amount of their purchases in their profile, down to the pennies. An integer value won't work here. As you already understood from the examples above, all digits after the decimal point are simply discarded. To make sure the total purchase amount in the user profile is displayed correctly, we will convert not an int, but a float to a string. For this task, there is a method fmt.Sprint, which is part of the fmt package. package main import ( "fmt" ) func main() { fmt.Println(fmt.Sprint(421.034)) f := 5524.53 fmt.Println(fmt.Sprint(f)) } To verify that the conversion was successful, concatenate the total with the string. For example: package main import ( "fmt" ) func main() { f := 5524.53 fmt.Println("Alex spent " + fmt.Sprint(f) + " dollars.") } There is no error now, and the information message correctly displays the floating-point number. Customers can see how much money they've spent in your store, with all expenses accounted for down to the penny. A common reverse task is to convert a string into numbers. For example, you have a form where the user enters their age or any other numeric values. The entered data is saved in the string format. Let's try working with this data— for instance, performing a subtraction: package main import ( "fmt" ) func main() { lines_yesterday := "50" lines_today := "108" lines_more := lines_today - lines_yesterday fmt.Println(lines_more) } The result of running this code will be an error message, as subtraction cannot be applied to string values. To perform mathematical operations on data stored as strings, you need to convert them to int or float. The choice of method depends on the type you will convert the string to. If you are working with integers, use the strconv.Atoi method. For floating-point numbers, use the strconv.ParseFloat method. package main import ( "fmt" "log" "strconv" ) func main() { lines_yesterday := "50" lines_today := "108" yesterday, err := strconv.Atoi(lines_yesterday) if err != nil { log.Fatal(err) } today, err := strconv.Atoi(lines_today) if err != nil { log.Fatal(err) } lines_more := today - yesterday fmt.Println(lines_more) } In this example, you use the if operator to check whether the conversion was successful. If an error occurs, the program will terminate, and the error information will be saved in the log. If the conversion is successful, the output will give you the correct result: 108 - 50 = 58. If you try to convert a string that does not contain a numerical value in the same way, you will receive an error message: strconv.Atoi: parsing "not a number": invalid syntax Try running this code: package main import ( "fmt" "strconv" ) func main() { a := "not a number" b, err := strconv.Atoi(a) fmt.Println(b) fmt.Println(err) } The code from the example above will fail because you are trying to convert a string whose value is not a number into a numeric type. Strings can also be converted to byte slices and back using the []byte() and string() constructs.  package main import ( "fmt" ) func main() { a := "hostman" b := []byte(a) c := string(b) fmt.Println(a) fmt.Println(b) fmt.Println(c) } In this function, you save the string to variable a, then convert the same string into a byte slice and save it to variable b, then turn the byte slice into a string and save the result to variable c. The output will be like this: hostman[104 111 115 116 109 97 110]hostman This simple example shows that you can easily convert strings to byte slices and back. Conclusion In this article, we only covered the basics. We looked at the available data types and how to perform type conversion in Go. If you want to learn more, explore the language documentation or at least the "A Tour of Go" tutorial — it's an interactive introduction to Go divided into three sections. The first section covers basic syntax and data structures, the second discusses methods and interfaces, and the third introduces Go's concurrency primitives. Each section concludes with several exercises so you can practice what you've learned.  In addition,  you can deploy Go applications (such as Beego and Gin) on our app platform.
10 December 2024 · 10 min to read
Go

Using Interfaces in Go

In object-oriented programming (OOP), the concept of interfaces plays a key role and is closely associated with one of the foundational principles—encapsulation. Interface as a Contract Simply put, an interface is a contract that defines the expected behavior between system components, such as how they exchange information. A real-world analogy for this concept can be seen in the Unix philosophy of "Everything is a file." This principle represents access to various resources—documents, peripherals, internal processes, and even network communication—as byte streams within the file system namespace. The advantage of this approach is that it allows a wide range of tools, utilities, and libraries to work uniformly with many types of resources. In OOP, an interface describes the structure of an object but leaves out implementation details. Interfaces in OOP Languages and Go Unlike languages like Java, C++, or PHP, Go is not a classically object-oriented language. When asked if Golang is OOP, the creators give an ambiguous answer: "Yes and no." While Go includes types and methods and supports an object-oriented programming style, it lacks class hierarchies (or even classes themselves), and the relationship between concrete and abstract (interface) types is implicit, unlike languages such as Java or C++. In traditional OOP languages, implementing an interface involves explicitly declaring that a class conforms to it (e.g., public class MyClass implements MyInterface). The implementing class must also define all methods described in the interface, matching their declared signatures exactly. In Go, there is no need for an explicit declaration that a type implements an interface. As long as a type provides definitions for all the methods specified in the interface, it is considered to implement that interface. In the Java example below, the class Circle is not an implementation of the interface Shape if the class description does not explicitly declare that it implements the interface, even if it contains methods matching those in Shape. In contrast, the class Square would be recognized as a Shape implementation because it explicitly declares so. // Shape.java interface Shape { public double area(); public double perimeter(); } // Circle.java public class Circle { private double radius; // constructor public Circle(double radius) { this.radius = radius; } public double area() { return this.radius * this.radius * Math.PI; } public double perimeter() { return 2 * this.radius * Math.PI; } } // Square.java public class Square implements Shape { private double x; // constructor public Square(double x) { this.x = x; } public double area() { return this.x * this.x; } public double perimeter() { return 4 * this.x; } } We can easily verify this by creating a function calculate that accepts an object implementing the Shape interface as an argument: // Calculator.java public class Calculator { public static void calculate(Shape shape) { double area = shape.area(); double perimeter = shape.area(); System.out.printf("Area: %f,%nPerimeter: %f."); } public static void main() { Square s = new Square(20); Circle c = new Circle(10); calculate(s); calculate(c); } } If we try to compile such code, we will get an error: javac Calculator.java Calculator.java:16: error: incompatible types: Circle cannot be converted to Shape calculate(c); ^ Note: Some messages have been simplified; recompile with -Xdiags:verbose to get full output 1 error In Golang, there is no requirement for a type to declare the interfaces it implements explicitly. It is sufficient to implement the methods described in the interface (the code below is adapted from Mihalis Tsoukalos's book "Mastering Go"): package main import ( "fmt" "math" ) type Shape interface { Area() float64 Perimeter() float64 } type Square struct { X float64 } func (s Square) Area() float64 { return s.X * s.X } func (s Square) Perimeter() float64 { return 4 * s.X } type Circle struct { Radius float64 } func (c Circle) Area() float64 { return c.Radius * c.Radius * math.Pi } func (c Circle) Perimeter() float64 { return 2 * c.Radius * math.Pi } func Calculate(x Shape) { fmt.Printf("Area: %f,\nPerimeter: %f\n\n", x.Area(), x.Perimeter()) } func main() { s := Square{X: 20} c := Circle{Radius: 10} Calculate(s) Calculate(c) } Area: 400.000000, Perimeter: 80.000000 Area: 314.159265, Perimeter: 62.831853 If we try to use a type that does not implement the Shape interface as an argument for the Calculate function, we will get a compilation error. It is shown in the following example, where the Rectangle type does not implement the Shape interface (the Perimeter method is missing): package main import "fmt" type Shape interface { Area() float64 Perimeter() float64 } type Rectangle struct { W, H float64 } func (r Rectangle) Area() float64 { return r.W * r.H } func Calculate(x Shape) { fmt.Printf("Area: %f,\nPerimeter: %f\n\n", x.Area(), x.Perimeter()) } func main() { r := Rectangle{W: 10, H: 20} Calculate(r) } ./main.go:25:12: cannot use r (variable of type Rectangle) as type Shape in argument to Calculate: Rectangle does not implement Shape (missing Perimeter method) Notice how the Golang language compiler provides a more informative error message, unlike the Java language compiler. Problems and Solutions On the one hand, this approach to interface implementation simplifies writing programs, but on the other hand, it can become a source of errors that are sometimes hard to catch. Let’s look at an example. While working on a client library for a popular API, we needed to implement a caching mechanism — saving already retrieved data locally "on the client" to avoid repeated requests to the remote API server. API access was provided within packages that had a limited number of requests per month, so using a caching mechanism was economically beneficial for users. However, since the use cases for this library weren't limited to just web applications (although that was the most common scenario), we couldn't implement a single caching strategy that would satisfy everyone. Even in the case of applications running within a web server, there are at least two (or even all three) caching options — in-memory caching and using something like Memcached or Redis. However, there are also CLI (command-line interface) applications, and the caching strategies that work well for web applications are not suitable for command-line ones. As a result, we decided not to implement a single caching strategy, but to create our own interface listing methods for retrieving and storing data in the cache. We also wrote implementations of this interface for various caching strategies. This way, users of our library (other developers) could either use one of the implementations provided with the library or write their own custom implementation of the caching interface for their needs. Thus, the situation arose where the interface implementation and its application were separated into different codebases: the implementations were in "our" library, while the application of the interface was in other developers' applications. Our task was to check that our own implementations were indeed correct implementations of our own interface. Let's assume we have the cache.Interface interface and the cache.InMemory and cache.OnDisk types: package cache import ( "encoding/json" "fmt" "os" "sync" ) type Interface interface { Get(key string) (value []byte, ok bool) Set(key string, value []byte) Delete(key string) } type InMemory struct { mu sync.Mutex items map[string][]byte } func NewInMemory() *InMemory { return &InMemory{ items: make(map[string][]byte), } } func (c *InMemory) Get(key string) (value []byte, ok bool) { c.mu.Lock() value, ok = c.items[key] c.mu.Unlock() return value, ok } func (c *InMemory) Set(key string, value []byte) { c.mu.Lock() c.items[key] = value c.mu.Unlock() } func (c *InMemory) Delete(key string) { c.mu.Lock() delete(c.items, key) c.mu.Unlock() } type OnDisk struct { mu sync.Mutex items map[string][]byte filename string } func NewOnDisk(filename string) *OnDisk { return &OnDisk{ items: make(map[string][]byte), filename: filename, } } func (c *OnDisk) Get(key string) (value []byte, err error) { c.mu.Lock() defer c.mu.Unlock() f, err := os.Open(c.filename) if err != nil { return nil, err } defer f.Close() dec := json.NewDecoder(f) if err := dec.Decode(&c.items); err != nil { return nil, err } value, ok := c.items[key] if !ok { return nil, fmt.Errorf("no value for key: %s", key) } return value, nil } func (c *OnDisk) Set(key string, value []byte) error { c.mu.Lock() defer c.mu.Unlock() c.items[key] = value f, err := os.Create(c.filename) if err != nil { return err } enc := json.NewEncoder(f) if err := enc.Encode(c.items); err != nil { return err } return nil } func (c *OnDisk) Delete(key string) error { c.mu.Lock() defer c.mu.Unlock() delete(c.items, key) f, err := os.Create(c.filename) if err != nil { return err } enc := json.NewEncoder(f) if err := enc.Encode(c.items); err != nil { return err } return nil } Now we need to make sure that both of our types, cache.InMemory and cache.OnDisk, implement the cache.Interface. How can we achieve this? The first answer that comes to mind is to write a test. Test Let's write two small tests to check that our types cache.InMemory and cache.OnDisk implement the cache.Interface: package cache import "testing" func TestInMemoryImplementsInterface(t *testing.T) { var v interface{} = NewInMemory() _, ok := v.(Interface) if !ok { t.Error("InMemory does not implement Interface") } } func TestOnDiskImplementsInterface(t *testing.T) { var v interface{} = NewOnDisk("cache.json") _, ok := v.(Interface) if !ok { t.Error("OnDisk does not implement Interface") } } Let’s run these tests: go test -v ./cache === RUN TestInMemoryImplementsInterface --- PASS: TestInMemoryImplementsInterface (0.00s) === RUN TestOnDiskImplementsInterface cache_test.go:17: OnDisk does not implement Interface --- FAIL: TestOnDiskImplementsInterface (0.00s) FAIL FAIL cache 0.002s FAIL As seen from the test results, the cache.InMemory type implements the cache.Interface, but the cache.OnDisk type does not. But there is an easier way! While using tests to check for interface implementation works, it does require a certain level of discipline from the developer. You need to remember to write the tests and, just as importantly, to run them periodically. Fortunately, there is a simpler way to check whether a specific type implements the required interface. You only need to write a single line of code (for us, two lines, since we have two types) and run go build. package cache // ... var _ Interface = (*InMemory)(nil) var _ Interface = (*OnDisk)(nil) go build ./cache cache/cache.go:6:19: cannot use (*OnDisk)(nil) (value of type *OnDisk) as type Interface in variable declaration: *OnDisk does not implement Interface (wrong type for Delete method) have Delete(key string) error want Delete(key string) As you can see, the Golang compiler not only informs us that a type does not implement the interface, but also provides insight into the reason for this. In our case, it’s due to different method signatures. What is this magic? There’s no magic. The underscore symbol (_) is a special variable name used when we need to assign a value but do not intend to use it later. One of the most common uses of such variables is to ignore errors, for example: f, _ := os.Open("/path/to/file") In the above example, we open a file but do not check for potential errors. Thus, we create an unused variable of type cache.Interface and assign it a nil pointer to the implementation type (cache.InMemory or cache.OnDisk). Conclusion In this article, we explored the concept of an "interface" in different programming languages. We determined whether Go is an object-oriented language and learned how to check if a type implements an interface both via tests and during the compilation stage. On our app platform you can deploy Golang apps, such as Beego and Gin.
06 December 2024 · 10 min to read

Do you have questions,
comments, or concerns?

Our professionals are available to assist you at any moment,
whether you need help or are just unsure of where to start.
Email us
Hostman's Support