Go и MongoDB: создание CRUD API с нуля

В этом руководстве для начинающих мы рассмотрим процесс создания простого API CRUD с использованием Go и MongoDB. Мы рассмотрим основные шаги, предоставим примеры кода и дадим полезные советы.

Начало

Прежде всего, давайте настроим нашу среду:

1. Установка Go: загрузите и установите последнюю версию Go с https://go.dev/dl/ .
2. Настройка MongoDB. Если у вас не запущена MongoDB, вы можете загрузить и установить ее с https://www.mongodb.com/try/download/community .
3. IDE или текстовый редактор: выберите предпочитаемую среду написания кода. Некоторые популярные варианты включают VS Code, GoLand или Atom.

Структура проекта:

Создайте новый каталог проекта и организуйте файлы следующим образом:

my-crud-api/
├── main.go
├── models/
│   └── user.go
├── handlers/
│   └── user.go
└── config/
    └── config.go

Определение нашей модели

Начнем с определения нашей модели данных. В этом примере мы создадим простую User структуру:

// models/user.go
package models

import (
    "go.mongodb.org/mongo-driver/bson/primitive"
)

type User struct {
    ID     primitive.ObjectID `bson:"_id,omitempty"`
    Name   string             `bson:"name,omitempty"`
    Email  string             `bson:"email,omitempty"`
    Age    int                `bson:"age,omitempty"`
    Active bool               `bson:"active,omitempty"`
}

Объяснение:

• Мы используем primitive.ObjectID from mongo-driver package для представления уникального идентификатора документа MongoDB.
• Теги bson имеют решающее значение для сопоставления полей структуры Go с соответствующими полями в наших документах MongoDB.

Подключение к MongoDB

Нам нужно установить соединение с нашей базой данных MongoDB. Создайте config.go файл в config каталоге:

// config/config.go
package config

import (
    "context"
    "fmt"
    "os"

    "go.mongodb.org/mongo-driver/mongo"
    "go.mongodb.org/mongo-driver/mongo/options"
)

func ConnectToMongoDB() (*mongo.Client, error) {
    uri := os.Getenv("MONGODB_URI")
    if uri == "" {
        return nil, fmt.Errorf("MONGODB_URI is not set")
    }

    clientOptions := options.Client().ApplyURI(uri)
    client, err := mongo.Connect(context.Background(), clientOptions)
    if err != nil {
        return nil, err
    }

    err = client.Ping(context.Background(), nil)
    if err != nil {
        return nil, err
    }

    return client, nil
}

Объяснение:

• Мы используем os.Getenv для получения URI соединения MongoDB из переменной среды MONGODB_URI. Обязательно установите эту переменную в своей среде.
• Мы используем mongo-driver пакет для подключения к базе данных MongoDB и выполнения основных операций, таких как проверка связи с базой данных.

Построение обработчиков

Теперь давайте создадим обработчики API для наших операций CRUD. В handlers каталоге создайте user.go файл:

// handlers/user.go
package handlers

import (
    "context"
    "encoding/json"
    "fmt"
    "net/http"

    "github.com/your-username/my-crud-api/config"
    "github.com/your-username/my-crud-api/models"
    "go.mongodb.org/mongo-driver/bson"
    "go.mongodb.org/mongo-driver/bson/primitive"
    "go.mongodb.org/mongo-driver/mongo"
)

// Create a new user
func CreateUser(w http.ResponseWriter, r *http.Request) {
    client, err := config.ConnectToMongoDB()
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer client.Disconnect(context.Background())

    var user models.User
    if err := json.NewDecoder(r.Body).Decode(&user); err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    collection := client.Database("your_database_name").Collection("users")
    result, err := collection.InsertOne(context.Background(), user)
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }

    json.NewEncoder(w).Encode(result)
}

// Get all users
func GetAllUsers(w http.ResponseWriter, r *http.Request) {
    client, err := config.ConnectToMongoDB()
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer client.Disconnect(context.Background())

    collection := client.Database("your_database_name").Collection("users")
    cursor, err := collection.Find(context.Background(), bson.D{})
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer cursor.Close(context.Background())

    var users []models.User
    for cursor.Next(context.Background()) {
        var user models.User
        if err := cursor.Decode(&user); err != nil {
            http.Error(w, err.Error(), http.StatusInternalServerError)
            return
        }
        users = append(users, user)
    }

    json.NewEncoder(w).Encode(users)
}

// Get a user by ID
func GetUserByID(w http.ResponseWriter, r *http.Request) {
    client, err := config.ConnectToMongoDB()
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer client.Disconnect(context.Background())

    id, err := primitive.ObjectIDFromHex(r.URL.Query().Get("id"))
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    collection := client.Database("your_database_name").Collection("users")
    var user models.User
    if err := collection.FindOne(context.Background(), bson.M{"_id": id}).Decode(&user); err != nil {
        http.Error(w, err.Error(), http.StatusNotFound)
        return
    }

    json.NewEncoder(w).Encode(user)
}

// Update a user
func UpdateUser(w http.ResponseWriter, r *http.Request) {
    client, err := config.ConnectToMongoDB()
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer client.Disconnect(context.Background())

    id, err := primitive.ObjectIDFromHex(r.URL.Query().Get("id"))
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    var updatedUser models.User
    if err := json.NewDecoder(r.Body).Decode(&updatedUser); err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    collection := client.Database("your_database_name").Collection("users")
    filter := bson.M{"_id": id}
    update := bson.M{"$set": updatedUser}
    result, err := collection.UpdateOne(context.Background(), filter, update)
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }

    json.NewEncoder(w).Encode(result)
}

// Delete a user
func DeleteUser(w http.ResponseWriter, r *http.Request) {
    client, err := config.ConnectToMongoDB()
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    defer client.Disconnect(context.Background())

    id, err := primitive.ObjectIDFromHex(r.URL.Query().Get("id"))
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }

    collection := client.Database("your_database_name").Collection("users")
    result, err := collection.DeleteOne(context.Background(), bson.M{"_id": id})
    if err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }

    json.NewEncoder(w).Encode(result)
}

Объяснение:

• Реализуем операции CRUD: CreateUser, GetAllUsers, GetUserByID, UpdateUser и DeleteUser.
• Каждая функция подключается к MongoDB, извлекает коллекцию, выполняет соответствующую операцию и возвращает ответ JSON.
• Мы обрабатываем потенциальные ошибки и возвращаем соответствующие коды состояния HTTP.

Настройка основного приложения

Наконец, давайте свяжем все вместе в нашем main.goфайле:

// main.go
package main

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

    "github.com/your-username/my-crud-api/handlers"
)

func main() {
    http.HandleFunc("/users", handlers.CreateUser)
    http.HandleFunc("/users", handlers.GetAllUsers)
    http.HandleFunc("/users/", handlers.GetUserByID)
    http.HandleFunc("/users/", handlers.UpdateUser)
    http.HandleFunc("/users/", handlers.DeleteUser)

    fmt.Println("Server running on port 8080")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

Объяснение:

• Мы регистрируем обработчики API с соответствующими конечными точками HTTP.
• Запускаем сервер и слушаем порт 8080.

Запуск API

1. Переменная среды: установите MONGODB_URIпеременную среды с помощью строки подключения MongoDB.
2. Сборка и запуск. Создайте приложение Go, используя go build, а затем запустите его, используя ./my-crud-api.

Тестирование API

Вы можете протестировать свой API с помощью таких инструментов, как Postman или Curl.

• Создать: отправьте запрос POST /users с полезными данными JSON, содержащими данные пользователя.
• Читать: Отправьте запрос GET, чтобы /users получить всех пользователей или /users/?id={user_id} получить конкретного пользователя.
• Обновление: отправьте запрос PUT /users/?id={user_id} с полезными данными JSON, содержащими обновленные сведения о пользователе.
• Удалить: отправьте запрос DELETE, чтобы /users/?id={user_id} удалить пользователя.

Советы

• Обработка ошибок: всегда обрабатывайте потенциальные ошибки и возвращайте значимые коды состояния HTTP.
• Безопасность. Внедрите правильные механизмы аутентификации и авторизации для вашего API.
• Проектирование базы данных: тщательно спроектируйте схему базы данных, чтобы оптимизировать производительность и масштабируемость.
• Документация: документируйте конечные точки API, форматы запросов/ответов и коды ошибок.

Поздравляем! Вы успешно создали базовый API CRUD, используя Go и MongoDB. Благодаря этой основе вы можете расширить свой API для поддержки более сложных функций и создания впечатляющих веб-приложений. Продолжайте учиться и исследовать безграничные возможности Go и MongoDB!