Working with CSV Files Using `encoding/csv` in Go

The Go programming language provides excellent support for working with CSV files through the encoding/csv package. This powerful package allows you to read from and write to CSV (Comma Separated Values) files effortlessly. In this article, we will explore how to use this package with practical examples.

Reading CSV Files

To read CSV files, you first need to open the file and then create a new CSV reader. Below is a simple example to read a CSV file:

package main

import (
    "encoding/csv"
    "fmt"
    "log"
    "os"
)

func main() {
    file, err := os.Open("data.csv")
    if err != nil {
        log.Fatalf("Error opening file: %v", err)
    }
    defer file.Close()

    reader := csv.NewReader(file)
    records, err := reader.ReadAll()
    if err != nil {
        log.Fatal(err)
    }

    for _, record := range records {
        fmt.Println(record)
    }
}

In this code, we open a CSV file named data.csv, create a new CSV reader using csv.NewReader, and then read all records using reader.ReadAll(). This returns a slice of records, which you can iterate over to process each record as needed.

Writing CSV Files

Similar to reading CSV files, writing is straightforward. You create a CSV writer and call the writer methods to output records. Let’s see an example:

package main

import (
    "encoding/csv"
    "log"
    "os"
)

func main() {
    file, err := os.Create("output.csv")
    if err != nil {
        log.Fatalf("Error creating file: %v", err)
    }
    defer file.Close()

    writer := csv.NewWriter(file)
    defer writer.Flush()

    records := [][]string{
        {"Name", "Age", "City"},
        {"John Doe", "29", "New York"},
        {"Jane Smith", "34", "Los Angeles"},
        {"Sam Brown", "22", "Chicago"},
    }

    for _, record := range records {
        if err := writer.Write(record); err != nil {
            log.Fatal(err)
        }
    }
}

In this example, we create a new CSV file named output.csv. We use csv.NewWriter to create a new CSV writer. writer.Flush() ensures that all buffered data is written. We iterate over a slice of records and use writer.Write() to write each record to the file.

Handling Complex CSV Files

CSV files can sometimes be complex with special characters. Go’s CSV package provides options to customize separators and handle quoted fields.

To change the default comma separator, you can set the Comma field of the reader or writer:

reader := csv.NewReader(file)
reader.Comma = ';'

This little tweak allows you to work with files that use a semicolon instead of a comma.

Go's encoding/csv package is an excellent tool for handling CSV files, whether they’re used for simple list storage or complex data interchange. By leveraging this built-in package, you not only save time but also adhere to Go's philosophy of simplicity and performance.