Cara menggunakan Cobra untuk menjalankan server Golang Gin

Gin dan Cobra adalah dua alat yang populer dalam ekosistem Go (atau Golang) yang dapat digunakan untuk membuat aplikasi CLI (Command Line Interface) dan aplikasi web secara efisien. Dalam artikel ini, kita akan membahas cara menggunakan keduanya untuk membuat aplikasi CLI sederhana dan aplikasi web dengan Go.

Langkah 1: Instalasi Gin dan Cobra

Langkah pertama adalah instalasi Gin dan Cobra, sebelum instalasi Gin dan Cobra buatlah sebuah root folder project kita yang diberi nama gin-cobra.

mkdir gin-cobra
cd gin-cobra

Kemudian inisiasi mod module.

go mod init gin-cobra

Selanjutnya instalasi Gin dan Cobra, jalankan perintah dibawah ini untuk intalasi Gin dan Cobra.

go get \
    github.com/gin-gonic/gin \
    github.com/spf13/cobra/cobra

Setelah proses instalasi selesai, library Gin dan Cobra akan tersedia kedalam aplikasi.

Langkah 2: Membuat Directory dan File-File yang dibutuhkan

Sebelumnya anda telah membuat root folder untuk project yang akan digunakan untuk membuat aplikasi Gin dengan Cobra, tahapan ini adalah untuk membuat directory dan file-file yang akan dibutuhkan untuk menjalankan aplikasi Gin dan Cobra.

Selanjutnya buatlah file main.go file ini adalah entry point untuk menjalankan aplikasi Gin dan Cobra.

touch main.go

Isian awal untuk file main.go adalah sebagai berikut:

package main

func main() {}

Selanjutnya buatlah folder bin dan cmd.

Folder bin berguna untuk minyimpan syntax aplikasi Gin dimana isinya adalah sebuah code untuk menjalankanserver http dengan host localhost dan default port 3000.

Folder cmd berguna untuk menyimpan syntax command line Cobra untuk menjalankan code yang telah dibuat pada folder bin.

Jalankanlah perintah dibawah ini:

mkdir bin \
    cmd

Selanjutnya buatlah file app.go pada folder bin dan file root.go pada folder cmd.

Dimana telah disebutkan sebelumnya file app.go pada folder bin digunakan untuk menyimpan sebuah code untuk menjalankan aplikasi server Gin.

Dan file root.go pada folder cmd untuk menyimpan sebuah code inisiasi awal untuk kebutuhan command line Cobra.

Maka struktur folder akan seperti ini:

gin-cobra
├── bin
│   └── app.go
├── cmd
│   └── root.go
└── main.go

Langkah 3: Membuat Aplikasi Web Gin

Selanjutnya pada file bin/app.go copy code dibawah ini, script ini nantinya bertujuan untuk menjalankan aplikasi server web Gin

package bin

import (
    "fmt"
    "log"
    "net/http"

    "github.com/gin-gonic/gin"
)

type App struct {
    Router *gin.Engine
}

func (a *App) Initialize() {
    a.Router = gin.Default()
    a.setRoutes()
}

// setRoutes sets up the routes for the application.
func (a *App) setRoutes() {
    router := a.Router
    router.GET("/healthcheck", func(c *gin.Context) {
        c.JSON(http.StatusOK, "It's work")
    })
}

// Run starts the application.
func (a *App) Run(addr string) {
    fmt.Println("running", addr)
    err := http.ListenAndServe(addr, a.Router)
    if err != nil {
        log.Panic("Failed to start the server:", err)
    }
}

func NewApp() *App {
    app := App{}
    app.Initialize()

    return &app
}

Berikut adalah penjelasan singkat dari setiap bagian code diatas:

1. type App struct: Ini adalah sebuah struktur yang mendefinisikan aplikasi. Struktur ini memiliki satu properti yaitu Router yang bertipe *gin.Engine.
2. func (a *App) Initialize(): Ini adalah method untuk menginisialisasi aplikasi. Method ini membuat router menggunakan gin.Default() dan memanggil method setRoutes() untuk menetapkan rute-rute aplikasi.
3. func (a *App) setRoutes(): Ini adalah method untuk menetapkan rute-rute aplikasi. Dalam contoh ini, hanya ada satu rute yaitu /healthcheck yang akan merespons dengan pesan "It's work" jika diakses.
4. func (a *App) Run(addr string): Ini adalah method untuk menjalankan server. Method ini mencetak pesan "running" diikuti dengan alamat server yang sedang berjalan, kemudian memulai server HTTP menggunakan http.ListenAndServe().
5. func NewApp() *App: Ini adalah fungsi pembuat (constructor) untuk membuat instance baru dari aplikasi. Fungsi ini membuat instance dari App, memanggil method Initialize() untuk menginisialisasinya, dan mengembalikan pointer ke instance tersebut.

Dengan demikian, code diatas membuat sebuah aplikasi web sederhana yang dapat menjalankan server HTTP dengan satu rute /healthcheck yang akan merespons dengan pesan "It's work" jika diakses.

Lankah 4: Membuat Command Line untuk menjalankan server menggunakan Cobra

Kemudian pada file cmd/root.go buatlah sebuah inisiasi awal untuk menjalankan aplikasi command line Cobra, pada file ini kita tidak akan menggunakannya untuk menjalankan server, melainkan file ini hanya bertujuan untuk root awal command line saja.

cd cmd \
    touch root.go

package cmd

import (
    "fmt"
    "os"

    "github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
    Use:   "gin-cobra",
    Short: "gin-cobra menjalankan sebuah aplikasi server dengan command line",
    Long:  "",
    Run: func(cmd *cobra.Command, args []string) {
        // some code
    },
}

func Execute() {
    if err := rootCmd.Execute(); err != nil {
        fmt.Fprintf(os.Stderr, "Whoops. There was an error while executing your CLI '%s'", err)
        os.Exit(1)
    }
}

Selanjutnya buatlah file serve.go di dalam file ini kita akan membuat sebuah script untuk menjalankan aplikasi web server yang telah kita buat sebelumnya pada file bin/app.go

touch serve.go

Copy code dibawah ini kedalam file cmd/serve.go:

package cmd

import (
    "fmt"
    "gin-cobra/bin"

    "github.com/spf13/cobra"
)

var serveCmd = &cobra.Command{
    Use:   "serve",
    Short: "command untuk menjalankan aplikasi server gin-cobra",
    Long:  "",
    Run: func(cmd *cobra.Command, args []string) {
        app := bin.NewApp()
        port := "3000"
        app.Run(fmt.Sprint(":", port))
    },
}

func init() {
    rootCmd.AddCommand(serveCmd)
}

Berikut adalah penjelasan singkat tentang setiap bagian code diatas:

1. var serveCmd = &cobra.Command{...}: Ini adalah definisi dari command serve menggunakan library Cobra. Command ini digunakan untuk menjalankan aplikasi server gin-cobra.
2. func init() {...}: Ini adalah fungsi init() yang digunakan untuk melakukan inisialisasi pada package. Di sini, command serveCmd ditambahkan ke root command (rootCmd) pada file cmd/root.go.

Selanjutnya pada root folder tambahkan script dibawah ini pada file main.go:

package main

import "gin-cobra/cmd"

func main() {
    cmd.Execute()
}

Lankah 5: Menjalankan aplikasi server dengan command line

Pada tahapan ini kita sudah bisa menjalankan sebuah aplikasi server menggunakan command line, cukup jalankan perintah dibawah ini:

go run . serve

Selanjutnya akan muncul log seperti dibawah ini, maka aplikasi server kita sudah berhasil dijalankan.

[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /healthcheck              --> gin-cobra/bin.(*App).setRoutes.func1 (3 handlers)
running :3000

Kesimpulan

Dengan menggunakan Cobra dan Gin, Anda dapat dengan mudah membuat aplikasi CLI dan aplikasi web menggunakan Go. Kedua alat ini menyediakan abstraksi yang kuat untuk mempercepat pengembangan dan memungkinkan Anda fokus pada logika bisnis aplikasi Anda.

check full source code disini: dinobaggio/gin-cobra