Skip to content

Latest commit

 

History

History
211 lines (119 loc) · 24.2 KB

README_ru.md

File metadata and controls

211 lines (119 loc) · 24.2 KB
Raw

Стандартный макет Go проекта

Переводы:

Обзор

Это базовый макет организации проектов, разработанных на Go. Это не официально определенный командой разработчиков Go стандарт, однако он удовлетворяет исторически сложившимся шаблонам организации проекта в экосистеме Go. Некоторые из шаблонов могут быть известнее остальных. В макете также присутствуют несколько улучшений, включая дополнительные директории, используемые в любом достаточно большом реальном приложении.

Если вы пытаетесь изучить Go или собрать маленький обучающий проект для личного пользования, данный макет будет явным перебором. Стоит начать с чего-нибудь действительно простого (одного файла main.go будет достаточно). Как только ваш проект начнет расти, стоит задуматься о важности содержания кода в структурированном состоянии, чтобы в конечном итоге не получить грязный код с множеством скрытых зависимостей и global state. А когда над проектом начнут работать другие люди - понадобится еще большая структуризация. В этот момент важно определить стандартный путь организации пакетов/библиотек. Если вы разрабатываете проект с открытым исходным кодом или знаете, что вашим кодом будут пользоваться при разработке других проектов, необходимо понимать важность создания личных, внутренних (или internal) пакетов и кода. Клонируйте репозиторий, пользуйтесь тем, что действительно нужно, и удалите всё остальное! Наличие этого "всего остального" вовсе не означает, что это обязательно использовать. Заметьте, что ни один из этих шаблонов не обязан быть использован в абсолютно каждом проекте. Даже vendor не может быть универсален во всех случаях.

С выходом обновления Go 1.14, Go Modules стали наконец-то доступны для использования. Применяйте Go Modules везде, пока не столкнётесь с веской причиной отказаться от них, и если такой момент всё же настанет - вам больше не придётся волноваться о значении переменной окружения $GOPATH и месте, где вы размещаете свой проект. Базовый go.mod файл в репозитории показывает, что ваш проект размещён на GitHub, однако он не является обязательным. Путь к модулю может быть любым, при условии, что первый компонент пути должен содержать точку в имени (текущая версия Go больше не требует этого, но если вы используете достаточно устаревшие версии - не стоит удивляться, что ваши сборки могу перестать работать). Ознакомьтесь с проблемами: 37554 и 32819 если хотите узнать об этом больше.

Этот шаблон организации проекта намеренно сделан обобщенным, и не является примером структуры какого-то конкретного пакета Go.

Этот проект открыт сообществу для улучшения. Создайте заявку о проблеме, если вы нашли новый шаблон или считаете, что один из существующих шаблонов необходимо обновить.

Если вам нужна помощь в наименовании, форматировании или стилизации кода - начните с gofmt и golint. Также обязательно прочтите эти руководства по стилю для кода на Go и рекомендации:

Обратите внимание на Шаблон проекта Golang для получения дополнительной информации.

Еще больше про наименование и организацию пакетов, а так же про структуру кода можно узнать здесь:

Пост о руководствах по пакетно-ориентированному дизайну и архитектурным слоям

Директории Go

/cmd

Основные приложения для текущего проекта.

Имя директории для каждого приложения должно совпадать с именем исполняемого файла, который вы хотите собрать (например, /cmd/myapp).

Не стоит располагать в этой директории большие объёмы кода. Если вы предполагаете дальнейшее использование кода в других проектах, вам стоит хранить его в директории /pkg в корне проекта. Если же код не должен быть переиспользован где-то еще - ему самое место в директории /internal в корне проекта. Вы будете удивлены тем, что могут сделать другие люди, по тому выражайте свои намерения явно!

Самой распространённой практикой является использование маленькой main функции, которая импортирует и вызывает весь необходимый код из директорий /internal и /pkg, но не из других.

Примеры смотрите в директории /cmd.

/internal

Внутренний код приложения и библиотек. Это код, который не должен использоваться в других приложениях и библиотеках. Стоит отметить, что этот шаблон применяется самим компилятором Golang. Ознакомьтесь с release notes Go 1.4 для более детальной информации. Также, вы вольны использовать более одной директории internal на разных уровнях структуры своего проекта.

Вы можете добавить дополнительное структурирование, чтобы разделить открытую и закрытую части вашего внутреннего кода. Такой подход не является необходимым, особенно для маленьких проектов, но позволяет сразу визуально оценить применение кода. Код самого приложения может находиться в директории /internal/app (например, /internal/app/myapp), а код, который это приложение использует - в директории /internal/pkg (например, /internal/pkg/myprivlib).

/pkg

Код библиотек, пригодных для использования в сторонних приложениях (например, /pkg/mypubliclib). Другие проекты будут импортировать эти библиотеки, ожидая их автономной работы, поэтому стоит подумать дважды, прежде чем класть сюда какой-нибудь код. Обратите внимание, что использование директории internal - более оптимальный способ гарантировать что ваши внутренние пакеты, не будут импортированы, потому что это обеспечивает сам Go. Директория /pkg - всё еще хороший путь дать понять, что код в этой директории могут безопасно использовать другие. Статья I'll take pkg over internal в блоге Трэвиса Джеффери (Travis Jeffery) предоставляет хороший обзор директорий pkg и internal и когда есть смысл их использовать.

Это так же способ группировать код на Go в одном месте, когда ваша корневая директория содержит множество не относящихся к Go компонентов и директорий, что позволит облегчить работу с разными инструментами Go (как упомянуто в этих выступлениях: Best Practices for Industrial Programming с GopherCon EU 2018, GopherCon 2018: Kat Zien - How Do You Structure Your Go Apps и GoLab 2018 - Massimiliano Pippi - Project layout patterns in Go).

Ознакомьтесь с директорией /pkg, если хотите увидеть, какие популярные репозитории используют этот макет для организации проекта. Это часто используемый макет, но он не общепринятый, а некоторые в сообществе Go и вовсе не рекомендует его использовать.

Вы можете не использовать эту директорию, если проект совсем небольшой и добавление нового уровня вложенности не несет практического смысла (разве что вы сами этого не хотите). Подумайте об этом, когда ваша корневая директория начинает слишком сильно разрастаться, особенно, если у вас много компонентов, написанных не на Go.

/vendor

Зависимости приложений, управляемые вручную или с использованием вашей любимой системы управления зависимостями, вроде доступного из коробки Go Modules. Команда go mod vendor создаст для вас директорию /vendor. Обратите внимание, что вам возможно придётся добавить флаг -mod=vendor к команде go build, если вы используете версию, отличную от Go 1.14, где такой флаг выставлен по-умолчанию.

Не стоит отправлять зависимости вашего приложения в репозиторий, если собираетесь создавать библиотеку.

Стоит отметить, что начиная с версии 1.13 Go добавил возможность проксирования модулей (с использованием https://proxy.golang.org как прокси-сервера по-умолчанию). Здесь можно побольше узнать про эту возможность, чтобы убедиться, что она удовлетворяет вашим требованиям и ограничениям. Если это так - использование директории vendor не требуется вовсе.

Директории приложений-сервисов

/api

Спецификации OpenAPI/Swagger, JSON schema файлы, файлы определения протоколов.

Примеры смотрите в директории /api.

Директории Веб-приложений

/web

Специальные компоненты для веб-приложений: статические веб-ресурсы, серверные шаблоны и одностраничные приложения.

Распространенные директории

/configs

Шаблоны файлов конфигураций и файлы настроек по-умолчанию.

Поместите файлы конфигураций confd или consul-template сюда.

/init

Файлы конфигураций для инициализации системы (systemd, upstart, sysv) и менеджеров процессов (runit, supervisord).

/scripts

Скрипты для выполнения различных операций сборки, установки, анализа и т.п. операций.

Эти скрипты позволяют оставить основной Makefile небольшим и простым (например, https://github.com/hashicorp/terraform/blob/main/Makefile).

Примеры смотрите в директории /scripts.

/build

Сборка и непрерывная интеграция (Continuous Integration, CI).

Поместите файлы конфигурации и скрипты облака (AMI), контейнера (Docker), пакетов (deb, rpm, pkg) в директорию /build/package.

Поместите ваши файлы конфигурации CI (travis, circle, drone) и скрипты в директорию /build/ci. Обратите внимание, что некоторые инструменты CI (например, Travis CI) очень требовательны к расположению их конфигурационных файлов. Попробуйте поместить конфигурационные файлы в директорию /build/ci создав ссылку на них в месте, где их ожидают найти CI инструменты (если возможно).

/deployments

Шаблоны и файлы конфигураций разворачивания IaaS, PaaS, системной и контейнерной оркестрации (docker-compose, kubernetes/helm, mesos, terraform, bosh). Стоит заметить, что в некоторых репозиториях (особенно в приложениях, развернутых с использованием Kubernetes) эта директория называется /deploy.

/test

Дополнительные внешние тестовые приложения и данные для тестирования. Вы вольны организовывать структуру директории /test так, как вам угодно. Для больших проектов имеет смысл создавать вложенную директорию с данными для тестов. Например,/test/data или /test/testdata, если вы хотите, чтобы Go игнорировал находящиеся там файлы. Стоит заметить, что Go будет также игнорировать файлы, путь к которым начинается с "." или "_", что предоставляет вам гибкость в наименовании вашей директории с тестовыми данными.

Примеры смотрите в директории /test.

Другие Директории

/docs

Проектная и пользовательская документация (в дополнение к документации сгенерированной godoc).

Примеры смотрите в директории /docs.

/tools

Инструменты поддержки проекта. Обратите внимание, что эти инструменты могут импортировать код из директорий /pkg и /internal.

Примеры смотрите в директории /tools.

/examples

Примеры ваших приложений и/или библиотек.

Примеры смотрите в директории /examples.

/third_party

Внешние вспомогательные инструменты, ответвления кода и другие сторонние утилиты (например, Swagger UI).

/githooks

Git hooks.

/assets

Другие ресурсы, необходимые для использования вашего репозитория (изображения, логотипы и т.д.)

/website

Здесь можно разделить файлы для сайта вашего проекта, если вы не используете GitHub pages.

Примеры смотрите в директории /website.

Директории, которые не стоит размещать у себя в проекте

/src

Некоторые проекты на Go имеют директорию src, но это обычно происходит, когда разработкой занялся человек, пришедший из мира Java, где такой подход весьма распространен. Постарайтесь не использовать этот Java паттерн. Вы же не хотите, чтобы ваш код на Go или Go проект выглядел, будто написан на Java.

Не путайте директорию уровня проекта /src с директорией /src, которую Go использует для своих рабочих пространств, как это описано в How to Write Go Code. Переменная окружения $GOPATH указывает на ваше (текущее) рабочее пространство (по-умолчанию она указывает на $HOME/go на системах под управлением ОС, отличной от Windows). Это рабочее пространство включает высокоуровневые директории /pkg, /bin и /src. Ваш проект в свою очередь находится в директории вложенной в директорию /src, поэтому если у вас есть директория /src внутри вашего проекта, путь к проекту будет выглядеть примерно так: /some/path/to/workspace/src/your_project/src/your_code.go. Стоит заметить, что в версиях Go начиная с 1.11 ваш проект может хранить за пределами вашего GOPATH, но это всё еще не значит, что применять этот шаблон компоновки - это хорошая идея.

Badges

  • Go Report Card - Просканирует ваш код с помощью gofmt, go vet, gocyclo, golint, ineffassign, license и misspell. Замените github.com/golang-standards/project-layout на ссылку на ваш проект.

    Go Report Card

  • GoDoc - Предоставит онлайн версию вашей сгенерированной GoDoc документации. Измените ссылку, чтобы она указывала на ваш проект.

    Go Doc

  • Pkg.go.dev - Pkg.go.dev это новое место для исследования Go и документации. Вы можете создать бейдж с помощью badge generation tool.

    PkgGoDev

  • Release - Покажет версию последнего релиза вашего проекта. Измените ссылку на github, чтобы она указывала на ваш проект.

    Release

Примечания

Более продуманный шаблон проекта с образцами/повторно используемыми конфигурациями, скриптами и кодом — это WIP.