Что за папка cmd в проекте?

Папка cmd в Go-проектах: назначение и лучшие практики

Папка cmd в Go-проектах служит контейнером для исполняемых приложений (команд). Это стандартная практика организации кода, рекомендованная сообществом Go и следующих принципам, изложенным в Standard Go Project Layout.

Основное назначение

Каждый подкаталог внутри cmd представляет собой отдельное исполняемое приложение со своей точкой входа main.go. Это позволяет проекту содержать несколько CLI-утилит, серверов или других исполняемых файлов в одном репозитории, сохраняя при этом чистую архитектуру.

Типичная структура проекта

myproject/
├── cmd/
│   ├── api-server/
│   │   └── main.go
│   ├── cli-tool/
│   │   └── main.go
│   └── worker/
│       └── main.go
├── internal/
│   ├── service/
│   ├── repository/
│   └── models/
├── pkg/
│   ├── utils/
│   └── lib/
├── go.mod
└── go.sum

Почему именно cmd/, а не корневая директория?

1. Разделение ответственности: Пакет main имеет особый статус в Go — он не может быть импортирован другими пакетами. Размещение его в cmd/ физически отделяет точку входа от основной логики.

2. Чистота импортов: Вся бизнес-логика размещается в internal/ или pkg/, что делает зависимости явными и предотвращает циклические импорты.

3. Масштабируемость: Легко добавлять новые исполняемые компоненты без рефакторинга всей структуры.

Пример реализации

Рассмотрим проект с API-сервером и CLI-утилитой:

// cmd/api-server/main.go
package main

import (
    "myproject/internal/api"
    "log"
)

func main() {
    server := api.NewServer()
    if err := server.Start(":8080"); err != nil {
        log.Fatal("Failed to start server:", err)
    }
}

// cmd/cli-tool/main.go
package main

import (
    "myproject/internal/processor"
    "flag"
)

func main() {
    input := flag.String("input", "", "Input file path")
    flag.Parse()
    
    processor.ProcessFile(*input)
}

Ключевые преимущества такого подхода

• Прозрачность структуры: Новые разработчики сразу понимают, где искать точки входа
• Упрощение сборки: Можно собирать конкретное приложение: go build ./cmd/api-server
• Изоляция зависимостей: Каждое приложение может иметь свои уникальные зависимости в main.go
• Соблюдение идиом Go: Соответствие принципу "один пакет — одна директория"

Распространенные альтернативы и исключения

• Небольшие проекты: Для tiny-утилит допустимо размещение main.go в корне
• Моноприложения: Если проект содержит только одну команду, иногда используют корневую main.go
• Инструменты сборки: Некоторые используют cmd/ для скриптов сборки и миграций

Практические рекомендации

1. Именование поддиректорий: Используйте понятные имена (например, cmd/server, cmd/migrate)
2. Минимализм в main.go: Точка входа должна содержать только инициализацию и запуск
3. Разделение конфигурации: Флаги командной строки обрабатываются в cmd/, а конфигурация хранится в отдельном пакете

Таким образом, папка cmd — это не просто соглашение, а архитектурный паттерн, который способствует поддержанию чистоты кода, облегчает тестирование и делает проект более понятным для всей команды разработчиков.