Introduction to Backend Services

🏗️ Repository Structure

Base Project Structure for Golang (Gin Framework)
Repository ini digunakan sebagai base project untuk pengembangan aplikasi backend menggunakan Golang dan Gin.
Struktur ini dirancang agar modular, scalable, dan mudah dikembangkan oleh banyak developer.

📦 Repository URL:
https://gitlab.komerce.id/backend/golang-arch

📁 Project Structure

 ├── database/
 │   ├── migration/
 │   │   ├── migrations_file/
 │   │   └── migration.go
 │   ├── database.go
 │   └── type.go
 ├── internal/
 │   ├── app/
 │   │   └── feature
 │   │      ├── handler.go
 │   │      ├── router.go
 │   │      ├── service.go
 │   │      └── formatter.go
 │   ├──  dto/
 │   │   ├── common.go
 │   │   └── user.go
 │   ├── factory/
 │   │   └── factory.go
 │   ├── http/
 │   │   └── http.go
 │   ├── middleware/
 │   │   └── middleware.go
 │   ├── model/
 │   │   ├── entity.go
 │   │   └── common.go
 │   └── repository/
 │      └── repository.go
 ├── pkg/
 │   ├──  config/
 │   │   ├── app.go
 │   │   ├── config.go
 │   │   └── mysql.go
 │   ├──  consts/
 │   │   └── mysql.go
 │   └── util/
 │      └── util.go
 ├── .gitignore
 ├── go.mod
 ├── go.sum
 ├── example.env
 ├── main.go
 └── readme.md

---

📚 Directory Explanation

🗄️ database/

Folder ini digunakan untuk mengelola koneksi database dan file migrasi.

Struktur:

• migration/migrations_file/ → Menyimpan seluruh file migrasi database.
• migration/migration.go → Menjalankan semua file migrasi.
• database.go → Inisialisasi koneksi database (MySQL, PostgreSQL, dll).
• type.go → Tipe dan konfigurasi tambahan yang terkait database.

Tujuan:

Semua hal terkait database terpusat di sini agar mudah dikelola dan di-maintain.

---

🧩 internal/

Berisi seluruh logika utama aplikasi.

📦 app/

Berisi folder untuk masing-masing feature/module seperti user, auth, product, dll.
Setiap feature berisi:

• handler.go → Menangani request & response HTTP.
• router.go → Mendaftarkan route per feature.
• service.go → Menyimpan logika bisnis (business logic).
• formatter.go → Mengatur format response ke client.

🧠 Prinsip:
Setiap feature harus terisolasi dan independen agar mudah dikembangkan dan diuji.

---

📄 dto/ (Data Transfer Object)

Menampung struct untuk memvalidasi dan mentransfer data antar layer:

• Struct untuk menerima request body / query param.
• Struct untuk mengembalikan response ke client.

Contoh:

type CreateUserRequest struct {
    Name  string `json:"name" binding:"required"`
    Email string `json:"email" binding:"required,email"`
}

🏭 factory/

Berisi dependency injection untuk repository, service, dan resource lain seperti config atau database. Dengan ini, dependency cukup didefinisikan satu kali dan bisa digunakan di mana saja.

func NewFactory() *Factory {
    db := database.InitDB()
    userRepo := repository.NewUserRepository(db)
    return &Factory{UserRepository: userRepo}
}

🌐 http/

Tempat semua route dari setiap feature diregistrasikan ke Gin Engine. Selain itu, file ini juga berfungsi untuk menambahkan middleware global seperti logging dan recovery.

// Here we define route function for user Handlers that accepts gin.Engine and factory parameters
func NewHttp(g *gin.Engine, f *factory.Factory) {
    // Definisikan router group API v1
    v1 := g.Group("/api/v1")

    // Registrasi route dari feature user
    user.NewHandler(f).Router(v1.Group("/user"))
}

Best Practice

• Gunakan router group untuk versioning API.
• Pisahkan setiap feature di internal/app.
• Gunakan middleware custom agar log lebih informatif.
• Hindari panic di handler — gunakan error handling di service layer.

🧱 middleware/

Berisi middleware custom seperti:

• JWT Authentication
• Authorization
• API Key Validation
• CORS Handling
• Custom Logging

Contoh:

func JWTAuthMiddleware() gin.HandlerFunc {
    return func(c *gin.Context) {
        // Validasi token JWT
        c.Next()
    }
}

🧬 model/

Menyimpan semua entity struct yang merepresentasikan tabel database. Biasanya digunakan oleh ORM seperti GORM. Contoh:

type User struct {
    ID        uint   `gorm:"primaryKey"`
    Name      string
    Email     string `gorm:"unique"`
    CreatedAt time.Time
}

💾 repository/

Berisi semua query dan operasi database (CRUD). Dengan repository pattern, logika akses data terpisah dari business logic.

Contoh:

func (r *UserRepository) FindByEmail(email string) (*model.User, error) {
    var user model.User
    if err := r.db.Where("email = ?", email).First(&user).Error; err != nil {
        return nil, err
    }
    return &user, nil
}

⚙️ pkg/

Berisi utility dan konfigurasi umum yang digunakan di seluruh aplikasi.

📁 config/

• app.go → konfigurasi dasar (nama app, port, dsb)
• config.go → load .env atau environment variable
• mysql.go → konfigurasi koneksi MySQL

📁 consts/

Berisi constant global, misal nama tabel atau error code standar.

📁 util/

Berisi fungsi utilitas seperti string helper, hash, converter, dll.

🧾 File Root

File	Deskripsi
.gitignore	Menentukan file/folder yang diabaikan Git
go.mod	Informasi dependency Go module
go.sum	Checksum dependency
example.env	Contoh konfigurasi environment
main.go	Entry point aplikasi (inisialisasi config, router, server)
README.md	Dokumentasi utama proyek

🚀 Alur Eksekusi Aplikasi

1. main.go menjalankan inisialisasi konfigurasi (pkg/config).
2. Koneksi database dibuat lewat database/database.go.
3. Dependency diatur melalui internal/factory.
4. Semua route diregistrasikan lewat internal/http/http.go.
5. Server dijalankan menggunakan Gin Engine.

🧭 Best Practices

• Gunakan Dependency Injection (factory pattern) untuk menjaga modularitas.
• Pisahkan handler, service, repository agar mudah di-maintain.
• Gunakan DTO untuk validasi input & output data.
• Simpan semua file migration di database/migration/migrations_file.
• Simpan konfigurasi sensitif di .env.
• Gunakan middleware custom agar log dan error lebih terstruktur.

📘 Last Updated: 2025-10-30 🧑‍💻 Maintained by: Backend Team – Komerce