Соглашения по именованию файлов в Go: snake_case или что-то ещё?

Основные правила именования файлов в Go

В Go нет жёстких синтаксических ограничений на имена файлов (кроме того, что они должны быть валидными для ОС), но есть устоявшиеся конвенции, которым следуют почти все Go-разработчики. Давайте разберём их по порядку.

1. Всегда используйте snake_case (строчные буквы с подчёркиваниями)

Это главное правило. Имена файлов должны быть в нижнем регистре, слова разделяются подчёркиванием _. Никакого CamelCase или PascalCase для файлов. Почему? Потому что на некоторых файловых системах (например, macOS по умолчанию нечувствительна к регистру, а Linux — чувствительна). Если вы назовёте файл MyHandler.go на macOS, он может работать, но на Linux вы получите ошибку, если где-то в импорте или сборке будет ссылка на myhandler.go.

Пример правильного именования:

// Плохо
MyHandler.go
UserRepository.go

// Хорошо
my_handler.go
user_repository.go

2. Имя файла должно отражать его содержимое

В Go принято, чтобы один файл содержал логически связанный код. Например:

• handlers.go — HTTP-обработчики
• models.go — структуры данных (модели)
• routes.go — маршруты
• middleware.go — промежуточное ПО
• errors.go — определения ошибок
• testing.go — тесты (хотя обычно тесты лежат в _test.go)

3. Специальные суффиксы: _test, _os, _arch

Go использует соглашения для условной компиляции и тестирования:

• Тесты: файлы должны заканчиваться на _test.go. Например, handlers_test.go.
• Платформозависимый код: используйте суффиксы _linux.go, _windows.go, _darwin.go и т.д. Например, file_unix.go, file_windows.go.
• Архитектурозависимый код: _amd64.go, _arm.go и т.д.

4. Имя файла не должно совпадать с именем пакета

Хотя технически это возможно, это может вызвать путаницу. Например, если ваш пакет называется handler, не называйте файл handler.go — лучше handlers.go или handler_impl.go.

5. Пример правильной структуры вашего проекта

Вот как можно организовать ваш проект с заметками:

// main.go
package main

func main() {
    // ...
}

// handlers.go
package main

func CreateNoteHandler() { ... }
func GetNoteHandler()    { ... }

// models.go
package main

type Note struct {
    ID   int
    Text string
}

// routes.go
package main

func SetupRoutes() { ... }

// database.go
package main

func InitDB() { ... }
func SaveNote(n Note) error { ... }

6. Что насчёт одного файла на тип?

В некоторых языках (Java, C#) принято иметь один файл на класс. В Go это не обязательно. Обычно один файл содержит несколько связанных типов и функций. Разделяйте файлы по логическим модулям, а не по каждому типу. Например:

• types.go — все основные типы и константы
• validation.go — функции валидации
• serialization.go — JSON/XML сериализация

7. Исключения из правил

Иногда в стандартной библиотеке Go встречаются файлы с одним словом без подчёркиваний: http.go, json.go, fmt.go. Это нормально, если имя короткое и однозначное. Но если имя состоит из нескольких слов, используйте подчёркивания: http_transport.go, json_encoder.go.

Итог: для вашего проекта используйте handlers.go, models.go, routes.go — это будет соответствовать конвенциям Go и не вызовет проблем на разных платформах.

api/
├── create.go       // логика создания ресурса
├── get.go          // логика получения
├── update.go       // обновление
├── delete.go       // удаление
├── middleware.go   // middleware
└── errors.go       // ошибки