API Golang RESTful avec Gin, Gorm, PostgreSQL

Exemple complet d'un service Golang RESTful API qui utilise gin pour le routage, gorm pour ORM et PostgreSQL comme base de données. Cet exemple inclut les fonctionnalités PostgreSQL suivantes : création de bases de données et de tables, insertion et requête de données, indexation, fonctions et procédures stockées, déclencheurs, vues, CTE, transactions, contraintes et gestion JSON.

1. Configuration du projet

En supposant que PostgreSQL, Golang et Go Mod soient configurés, initialisez le projet :

mkdir library-api
cd library-api
go mod init library-api

Structure du projet

/library-api
|-- db.sql
|-- main.go
|-- go.mod

2. Installer les dépendances

Installez les packages nécessaires :

go get github.com/gin-gonic/gin
go get gorm.io/gorm
go get gorm.io/driver/postgres

3. Schéma PostgreSQL

Voici un script SQL pour créer le schéma de base de données :

-- Create the library database.
CREATE DATABASE library;

-- Connect to the library database.
\c library;

-- Create tables.
CREATE TABLE authors (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL UNIQUE,
    bio TEXT
);

CREATE TABLE books (
    id SERIAL PRIMARY KEY,
    title VARCHAR(200) NOT NULL,
    -- This creates a foreign key constraint:
    -- It establishes a relationship between author_id in the books table and the id column in the authors table, ensuring that each author_id corresponds to an existing id in the authors table.
    -- ON DELETE CASCADE: This means that if an author is deleted from the authors table, all related records in the books table (i.e., books written by that author) will automatically be deleted as well.
    author_id INTEGER REFERENCES authors(id) ON DELETE CASCADE,
    published_date DATE NOT NULL,
    description TEXT,
    details JSONB
);

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    email VARCHAR(100) UNIQUE NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

-- CREATE TABLE borrow_logs (
--     id SERIAL PRIMARY KEY,
--     user_id INTEGER REFERENCES users(id),
--     book_id INTEGER REFERENCES books(id),
--     borrowed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
--     returned_at TIMESTAMP
-- );

-- Create a partitioned table for borrow logs based on year.
-- The borrow_logs table is partitioned by year using PARTITION BY RANGE (borrowed_at).
CREATE TABLE borrow_logs (
    id SERIAL PRIMARY KEY,
    user_id INTEGER REFERENCES users(id),
    book_id INTEGER REFERENCES books(id),
    borrowed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    returned_at TIMESTAMP
) PARTITION BY RANGE (borrowed_at);

-- Create partitions for each year.
-- Automatic Routing: PostgreSQL automatically directs INSERT operations to the appropriate partition (borrow_logs_2023 or borrow_logs_2024) based on the borrowed_at date.
CREATE TABLE borrow_logs_2023 PARTITION OF borrow_logs
    FOR VALUES FROM ('2023-01-01') TO ('2024-01-01');

CREATE TABLE borrow_logs_2024 PARTITION OF borrow_logs
    FOR VALUES FROM ('2024-01-01') TO ('2025-01-01');
-- Benefit: This helps in improving query performance and managing large datasets by ensuring that data for each year is stored separately.



-- Indexes for faster searching.
CREATE INDEX idx_books_published_date ON books (published_date);
CREATE INDEX idx_books_details ON books USING GIN (details);
-- GIN Index (Generalized Inverted Index).  It is particularly useful for indexing columns with complex data types like arrays, JSONB, or text search fields


-- Add a full-text index to the title and description of books
CREATE INDEX book_text_idx ON books USING GIN (to_tsvector('english', title || ' ' || description));
-- to_tsvector('english', ...) converts the concatenated title and description fields into a Text Search Vector (tsv) suitable for full-text searching.
-- The || operator concatenates the title and description fields, so both fields are indexed together for searching.
-- 'english' specifies the language dictionary, which helps with stemming and stop-word filtering.


-- Create a simple view for books with author information.
CREATE VIEW book_author_view AS
SELECT books.id AS book_id, books.title, authors.name AS author_name
FROM books
JOIN authors ON books.author_id = authors.id;

-- Create a view to get user borrow history
CREATE VIEW user_borrow_history AS
SELECT
    u.id AS user_id,
    u.name AS user_name,
    b.title AS book_title,
    bl.borrowed_at,
    bl.returned_at
FROM
    users u
    JOIN borrow_logs bl ON u.id = bl.user_id
    JOIN books b ON bl.book_id = b.id;

-- Use a CTE to get all active borrow logs (not yet returned)
WITH active_borrows AS (
    SELECT * FROM borrow_logs WHERE returned_at IS NULL
)
SELECT * FROM active_borrows;

-- Function to calculate the number of books borrowed by a user.
-- Creates a function that takes an INT parameter user_id and returns an INT value. If the function already exists, it will replace it.
CREATE OR REPLACE FUNCTION get_borrow_count(user_id INT) RETURNS INT AS $$
    --  is a placeholder for the first input. When the function is executed, PostgreSQL replaces  with the actual user_id value that is passed in by the caller.
    SELECT COUNT(*) FROM borrow_logs WHERE user_id = ;
$$ LANGUAGE SQL;
-- AS $$ ... $$: This defines the body of the function between the dollar signs ($$).
-- LANGUAGE SQL: Specifies that the function is written in SQL.


-- Trigger to log activities.
CREATE TABLE activity_logs (
    id SERIAL PRIMARY KEY,
    description TEXT,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

CREATE OR REPLACE FUNCTION log_activity() RETURNS TRIGGER AS $$
BEGIN
    INSERT INTO activity_logs (description)
    -- NEW refers to the new row being inserted or modified by the triggering event.
    VALUES ('A borrow_log entry has been added with ID ' || NEW.id);
    -- The function returns NEW, which means that the new data will be used as it is after the trigger action.
    RETURN NEW;
END;
$$ LANGUAGE plpgsql;
-- It uses plpgsql, which is a procedural language in PostgreSQL

CREATE TRIGGER log_borrow_activity
AFTER INSERT ON borrow_logs
FOR EACH ROW EXECUTE FUNCTION log_activity();

-- Add a JSONB column to store metadata
ALTER TABLE books ADD COLUMN metadata JSONB;
-- Example metadata: {"tags": ["fiction", "bestseller"], "page_count": 320}

4. Code Golang

Voici un exemple complet d'API RESTful utilisant Gin et GORM :

package main

import (
    "net/http"
    "time"

    "github.com/gin-gonic/gin"
    "gorm.io/driver/postgres"
    "gorm.io/gorm"
)

type Author struct {
    ID   uint   `gorm:"primaryKey"`
    Name string `gorm:"not null;unique"`
    Bio  string
}

type Book struct {
    ID            uint                   `gorm:"primaryKey"`
    Title         string                 `gorm:"not null"`
    AuthorID      uint                   `gorm:"not null"`
    PublishedDate time.Time              `gorm:"not null"`
    Details       map[string]interface{} `gorm:"type:jsonb"`
}

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

type BorrowLog struct {
    ID         uint      `gorm:"primaryKey"`
    UserID     uint      `gorm:"not null"`
    BookID     uint      `gorm:"not null"`
    BorrowedAt time.Time `gorm:"default:CURRENT_TIMESTAMP"`
    ReturnedAt *time.Time
}

var db *gorm.DB

func initDB() {
    dsn := "host=localhost user=postgres password=yourpassword dbname=library port=5432 sslmode=disable"
    var err error
    db, err = gorm.Open(postgres.Open(dsn), &gorm.Config{})
    if err != nil {
        panic("failed to connect to database")
    }

    // Auto-migrate models.
    db.AutoMigrate(&Author{}, &Book{}, &User{}, &BorrowLog{})
}

func main() {
    initDB()
    r := gin.Default()

    r.POST("/authors", createAuthor)
    r.POST("/books", createBook)
    r.POST("/users", createUser)
    r.POST("/borrow", borrowBook)
    r.GET("/borrow/:id", getBorrowCount)
    r.GET("/books", listBooks)

    r.Run(":8080")
}

func createAuthor(c *gin.Context) {
    var author Author
    if err := c.ShouldBindJSON(&author); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }
    if err := db.Create(&author).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    c.JSON(http.StatusOK, author)
}

func createBook(c *gin.Context) {
    var book Book
    if err := c.ShouldBindJSON(&book); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }
    if err := db.Create(&book).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    c.JSON(http.StatusOK, book)
}

func createUser(c *gin.Context) {
    var user User
    if err := c.ShouldBindJSON(&user); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }
    if err := db.Create(&user).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    c.JSON(http.StatusOK, user)
}

// The Golang code does not need changes specifically to use the partitioned tables; the partitioning is handled by PostgreSQL
// you simply insert into the borrow_logs table, and PostgreSQL will automatically route the data to the correct partition.
func borrowBook(c *gin.Context) {
    var log BorrowLog
    if err := c.ShouldBindJSON(&log); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    tx := db.Begin()
    if err := tx.Create(&log).Error; err != nil {
        tx.Rollback()
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    tx.Commit()
    c.JSON(http.StatusOK, log)
}

func getBorrowCount(c *gin.Context) {
    userID := c.Param("id")
    var count int
    if err := db.Raw("SELECT get_borrow_count(?)", userID).Scan(&count).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    c.JSON(http.StatusOK, gin.H{"borrow_count": count})
}

// When querying a partitioned table in PostgreSQL using Golang, no changes are needed in the query logic or code.
// You interact with the parent table (borrow_logs in this case) as you would with any normal table, and PostgreSQL automatically manages retrieving the data from the appropriate partitions.
// Performance: PostgreSQL optimizes the query by scanning only the relevant partitions, which can significantly speed up queries when dealing with large datasets.
// Here’s how you might query the borrow_logs table using GORM, even though it’s partitioned:
func getBorrowLogs(c *gin.Context) {
    var logs []BorrowLog
    if err := db.Where("user_id = ?", c.Param("user_id")).Find(&logs).Error; err != nil {
        c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
        return
    }
    c.JSON(http.StatusOK, logs)
}

func listBooks(c *gin.Context) {
    var books []Book
    db.Preload("Author").Find(&books)
    c.JSON(http.StatusOK, books)
}

Explication du code Golang :

• Initialisation de la base de données : se connecte à la base de données PostgreSQL et initialise GORM.
• Routes : définit des itinéraires pour créer des auteurs, des livres, des utilisateurs, emprunter des livres et récupérer le nombre d'emprunts.
• Gestion des transactions : utilise une transaction lors de l'emprunt d'un livre pour garantir la cohérence.
• Preload : utilise le préchargement de GORM pour joindre des tables associées (auteurs avec des livres).
• Appel de procédure stockée : utilise db.Raw pour appeler une fonction PostgreSQL personnalisée afin de calculer le nombre d'emprunts.

5. Exécution de l'API

• Exécutez le script SQL PostgreSQL pour créer des tables, des index, des vues, des fonctions et des déclencheurs.

• Démarrez le serveur Golang en utilisant
  

   go run main.go
  

Vous disposez désormais d'une API RESTful Golang complète qui couvre diverses fonctionnalités de PostgreSQL, ce qui en fait un exemple robuste pour l'apprentissage ou les entretiens.

6. Ajout de quelques fonctionnalités supplémentaires.

Améliorons l'exemple API RESTful Golang avec des fonctionnalités PostgreSQL supplémentaires en incorporant des Vues, des CTE (Expressions de table communes), indexation en texte intégral , et Gestion JSON. Chacune de ces fonctionnalités sera démontrée avec les définitions de tables PostgreSQL pertinentes et le code Golang pour interagir avec elles.

Le schéma de données pour cette partie est déjà préparé à partir de la dernière section, il nous suffit donc d'ajouter plus de code Golang.

mkdir library-api
cd library-api
go mod init library-api

Résumé des fonctionnalités :

• Vues : simplifiez l'accès aux données avec la vue user_borrow_history, facilitant ainsi l'interrogation des jointures complexes.
• CTE : utilisez les clauses WITH pour les requêtes organisées telles que la récupération des journaux d'emprunt actifs.
• Index de texte intégral : améliorez les capacités de recherche sur les livres avec un index GIN sur to_tsvector.

• Gestion JSON :

  • Stockez et mettez à jour des métadonnées riches en utilisant le type JSONB.
  • getBookTags récupère un champ JSON spécifique (tags) de la colonne de métadonnées JSONB.
  • updateBookPageCount met à jour ou ajoute le champ page_count dans la colonne de métadonnées JSONB.

  En utilisant db.Raw et db.Exec pour le SQL brut avec GORM, vous pouvez exploiter les puissantes fonctionnalités de PostgreSQL tout en conservant les capacités ORM de GORM pour d'autres parties de votre application. Cela rend la solution à la fois flexible et riche en fonctionnalités.

7. Autres fonctionnalités avancées

Dans cet exemple étendu, je vais montrer comment intégrer les fonctionnalités suivantes à l'aide de Golang et PostgreSQL :

1. VIDE : utilisé pour récupérer l'espace de stockage occupé par les tuples morts et éviter le gonflement de la table.
2. MVCC : Un concept qui permet des transactions simultanées en conservant différentes versions de lignes.
3. Fonctions de fenêtre : utilisées pour effectuer des calculs sur un ensemble de lignes de tableau liées à la ligne actuelle.

1. Utiliser VACUUM dans Golang

VACUUM est généralement utilisé comme tâche de maintenance, et non directement à partir du code de l'application. Cependant, vous pouvez l'exécuter à l'aide de GORM's Exec à des fins de gestion :

/library-api
|-- db.sql
|-- main.go
|-- go.mod

• VACUUM ANALYZE books : récupère le stockage et met à jour les statistiques utilisées par le planificateur de requêtes pour la table books.
• L'exécution de VACUUM s'effectue généralement pendant les heures creuses ou dans le cadre d'un script de maintenance plutôt qu'à chaque demande.

2. Comprendre MVCC (contrôle de concurrence multiversion)

MVCC de PostgreSQL permet des transactions simultanées en conservant différentes versions de lignes. Voici un exemple de la façon de démontrer le comportement MVCC dans Golang à l'aide de transactions :

go get github.com/gin-gonic/gin
go get gorm.io/gorm
go get gorm.io/driver/postgres

• POUR MISE À JOUR : verrouille la ligne sélectionnée pour les mises à jour pendant la transaction, empêchant d'autres transactions de la modifier jusqu'à la fin de la transaction en cours.
• Cela garantit la cohérence lors des accès simultanés, montrant comment MVCC autorise les lectures simultanées mais verrouille les lignes pour les mises à jour.

3. Utilisation des fonctions de fenêtre avec GORM

Les fonctions de fenêtre sont utilisées pour effectuer des calculs sur un ensemble de lignes de tableau liées à la ligne actuelle. Voici un exemple d'utilisation d'une fonction de fenêtre pour calculer le total cumulé des livres empruntés pour chaque auteur :

mkdir library-api
cd library-api
go mod init library-api

• SUM(COUNT(bl.id)) OVER (PARTITION BY a.id ORDER BY bl.borrowed_at) : Une fonction de fenêtre qui calcule le total cumulé des livres empruntés pour chaque auteur, classés par date d'emprunt_at.
• Cela peut fournir des informations telles que la manière dont les tendances d'emprunt évoluent au fil du temps pour chaque auteur.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!