Translations:
Це базовий макет для проєктів Go-додатків. Це не є офіційним стандартом, визначеним командою розробників Go; тим не менш, це звід паттернів програмування в екосистемі Go, що склалися історично. Деякі з цих паттернів більш популярні та відомі ніж інші. Також в цьому макеті є декілька покращень, в тому числі декілька додаткових дерикторій, що використовуються в будь-якому достатньо великому реальному застосунку.
Якщо ви тільки вивчаєте Go або створюєте якийсь демонстраційний чи простий проєкт для себе цей макет буде занадто складним. Почність з чогось дійсно простого (одного файлу main.goтаgo.mod буде достатньо). Коли проєкт почне рости не забувайте, важливо щоб код залишався добре структурованим, інакше ви отримаєте брудний код з великою кількістю прихованих залежностей та глобальних станів. Якщо над проєктом працює більше людей, необхідно ще більше структури. Саме тоді важливо запровадити єдиний спосіб управління пакетами/бібліотеками. Коли ви маєте проєкт з відкритим вихідним кодом або коли ви знаєте, що інші проєкти імпортують код з вашого репозиторію проєкту, саме тоді важливо мати приватні (internal) пакети та код. Клонуйте сховище, зберігайте те, що вам потрібно, а все інше видаляйте! Те, що це є, не означає, що ви повинні використовувати все це. Жодна з цих моделей не використовується в кожному окремому проєкті. Навіть паттерн vendor не є універсальним.
Починаючи з Go 1.14 Go модулі нарешті готові до використання. Використовуйте Go модулі якщо у вас немає конкретної причини не використовувати їх, а якщо є, то вам не потрібно турбуватися про $GOPATH і про те, куди ви помістили свій проєкт. Базовий файл go.mod в репозиторії передбачає, що ваш проєкт розміщено на GitHub, однак це не є обов'язковою вимогою. Шлях до модуля може бути будь-яким, але перший компонент шляху до модуля повинен містити крапку в назві (поточна версія Go більше не вимагає цього, але якщо ви використовуєте трохи старіші версії, не дивуйтеся, якщо ваші збірки не працюватимуть без цього). Якщо ви хочете дізнатися більше про це, дивіться: 37554 та 32819.
Ця схема проєкту є навмисно загальною і не намагається нав'язати конкретну структуру пакета Go.
Це зусилля спільноти. Відкрийте тему, якщо ви бачите новий шаблон або якщо ви вважаєте, що один з існуючих шаблонів потребує оновлення.
Якщо вам потрібна допомога з іменуванням, форматуванням та стилем, почніть з запуску gofmt та golint. Також обов'язково ознайомтеся з цими керівними принципами та рекомендаціями щодо стилю коду Go:
- https://talks.golang.org/2014/names.slide
- https://golang.org/doc/effective_go.html#names
- https://blog.golang.org/package-names
- https://github.com/golang/go/wiki/CodeReviewComments
- Style guideline for Go packages (rakyll/JBD)
Дивіться Go Project Layout для додаткової довідкової інформації.
Більше про іменування та організацію пакетів, а також інші рекомендації щодо структури коду:
- GopherCon EU 2018: Peter Bourgon - Best Practices for Industrial Programming
- GopherCon Russia 2018: Ashley McNamara + Brian Ketelsen - Go best practices.
- GopherCon 2017: Edward Muller - Go Anti-Patterns
- GopherCon 2018: Kat Zien - How Do You Structure Your Go Apps
Китайська публікація про керівні принципи пакетно-орієнтованого проєктування та рівень архітектури
Головні застосунки цього проєкту
Ім'я каталогу для кожного додатка повинно збігатися з ім'ям виконуваного файлу, який ви хочете мати (наприклад /cmd/myapp).
Не розміщуйте багато коду в каталозі програми. Якщо ви вважаєте, що код може бути імпортований і використаний в інших проєктах, то він повинен знаходитися в каталозі /pkg. Якщо код не може бути використаний повторно або якщо ви не хочете, щоб інші використовували його повторно, помістіть цей код в каталог /internal. Ви будете здивовані тим, що будуть робити інші, тому будьте відверті у своїх намірах!
Зазвичай є невелика функція main, яка імпортує та викликає код з каталогів /internal та /pkg і нічого більше.
Дивіться /cmd для прикладів.
Приватний код додатків та бібліотек. Це код, який ви не хочете, щоб інші імпортували у свої програми або бібліотеки. Зауважте, що цей шаблон компонування забезпечується самим компілятором Go. Дивіться Go 1.4 release notes для додаткових деталей. Зверніть увагу, що ви не обмежені директорією internal верхнього рівня. Ви можете мати більше одного каталогу internal на будь-якому рівні дерева вашого проєкту.
За бажанням ви можете додати трохи додаткової структури до ваших внутрішніх пакунків, щоб відокремити ваш спільний і не спільний внутрішній код. Це не є обов'язковим (особливо для невеликих проєктів), але приємно мати візуальні підказки, що показують передбачуване використання пакунків. Ваш власне код програми може знаходитися у каталозі /internal/app (наприклад, /internal/app/myapp), а код, який використовується спільно з іншими програмами, у каталозі /internal/pkg (наприклад, /internal/pkg/myprivlib).
Код бібліотеки, який можна використовувати зовнішніми програмами (наприклад, /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).
Якщо ви хочете побачити, які популярні репозиторії Go використовують цей шаблон оформлення проєктів, зверніться до каталогу /pkg. Це загальноприйнятий шаблон, але він не є загальноприйнятим, і дехто у спільноті Go не рекомендує його використовувати.
Можна не використовувати його, якщо ваш проєкт програми дійсно невеликий і де додатковий рівень вкладеності не додає особливої цінності (якщо тільки ви дійсно цього не хочете :-)). Подумайте про це, коли він стане досить великим і ваш кореневий каталог буде досить зайнятий (особливо якщо у вас багато компонентів програми, які не є Go).
Походження каталогу pkg: старий вихідний код Go використовував pkg для своїх пакунків, а потім різні проєкти Go у спільноті почали копіювати цей шаблон (див. це твіт Бреда Фіцпатріка для більш детального контексту).
Залежності додатків (управляються вручну або за допомогою вашого улюбленого інструменту управління залежностями, наприклад, нової вбудованої функції Go модулі). Команда go mod vendor створить для вас каталог /vendor. Зауважте, що вам може знадобитися додати прапорець -mod=vendor до команди go build, якщо ви не використовуєте Go 1.14, де він увімкнений за замовчуванням.
Не фіксуйте залежності програми, якщо ви створюєте бібліотеку.
Зверніть увагу, що починаючи з 1.13 Go також включив функцію модульного проксі (використовуючи https://proxy.golang.org в якості свого модульного проксі-сервера за замовчуванням). Прочитайте більше про нього тут, щоб дізнатися, чи відповідає він усім вашим вимогам і обмеженням. Якщо так, то каталог vendor вам взагалі не знадобиться.
Специфікації OpenAPI/Swagger, файли схем JSON, файли визначення протоколів.
Приклади дивіться у каталозі /api.
Специфічні компоненти веб-додатків: статичні веб-активи, шаблони на стороні сервера та односторінкові застосунки.
Шаблони файлів конфігурації або конфігурації за замовчуванням.
Сюди викладіть файли шаблонів confd або consul-template.
Конфігурації системного запуску (systemd, upstart, sysv) та диспетчера/супервізора процесів (runit, supervisord).
Скрипти для виконання різних операцій по збірці, установці, аналізу і т.д.
Ці скрипти роблять Makefile кореневого рівня невеликим і простим (наприклад, https://github.com/hashicorp/terraform/blob/master/Makefile).
Приклади див. у каталозі /scripts.
Упаковка та безперервна інтеграція (CI).
Конфігурації хмарних (AMI), контейнерних (Docker), ОС (deb, rpm, pkg) пакетів та скрипти покладіть в каталог /build/package.
Помістіть конфігурації та скрипти CI (travis, circle, drone) в каталог /build/ci. Зверніть увагу, що деякі інструменти CI (наприклад, Travis CI) дуже прискіпливі до розташування своїх конфігураційних файлів. Спробуйте помістити конфігураційні файли в каталог /build/ci, пов'язавши їх з тим місцем, де їх очікують інструменти CI (коли це можливо).
Конфігурації та шаблони розгортання IaaS, PaaS, системної та контейнерної оркестрації (docker-compose, kubernetes/helm, mesos, terraform, bosh). Зверніть увагу, що в деяких репозиторіях (особливо для додатків, що розгортаються за допомогою kubernetes) цей каталог називається /deploy.
Додаткові зовнішні тестові програми та тестові дані. Не соромтеся структурувати каталог /test як завгодно. Для великих проєктів має сенс мати підкаталог даних. Наприклад, ви можете мати /test/data або /test/testdata, якщо вам потрібно, щоб команда Go ігнорувала те, що знаходиться в цьому каталозі. Зауважте, що Go також ігноруватиме каталоги або файли, які починаються з "." або "_", тому у вас є більше гнучкості в плані того, як ви можете назвати свій каталог тестових даних.
Приклади дивіться у каталозі /test.
Проєктна та користувацька документація (на додаток до вашої документації, згенерованої в godoc).
Приклади дивіться у каталозі /docs.
Допоміжні інструменти для цього проєкту. Зверніть увагу, що ці інструменти можуть імпортувати код з каталогів /pkg та /internal.
Приклади дивіться у каталозі /tools.
Приклади для ваших додатків та/або публічних бібліотек.
Приклади дивіться у каталозі /examples.
Зовнішні допоміжні інструменти, форкований код та інші утиліти сторонніх розробників (наприклад, Swagger UI).
Скріпти (хуки) Git.
Інші ресурси, які будуть супроводжувати ваш репозиторій (зображення, логотипи тощо).
Це місце для розміщення даних сайту вашого проєкту, якщо ви не використовуєте GitHub Pages.
Приклади дивіться у каталозі /website.
Деякі проєкти 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/ваш_проєкт/src/ваш_код.go. Зауважте, що з Go 1.11 можна мати проєкт поза GOPATH, але це ще не означає, що це гарна ідея використовувати цей шаблон компонування.
-
Go Report Card - відсканує ваш код за допомогою
gofmt,go vet,gocyclo,golint,ineffassign,licenseтаmisspell. Замінітьgithub.com/golang-standards/project-layoutпосиланням на ваш проєкт. -
GoDoc - надає онлайн-версію вашої документації, створеної у форматі GoDoc. Змініть посилання, щоб воно вказувало на ваш проєкт. -
Pkg.go.dev - Pkg.go.dev це нове місцезнаходження для дослідження Go та документації. Ви можете створити бейдж використовуючи badge generation tool.
-
Реліз - покаже номер останнього релізу для вашого проєкту. Змініть посилання на github, щоб воно вказувало на ваш проєкт.
Більш розгорнутий шаблон проєкту зі зразками/багаторазовими конфігураціями, скриптами та кодом - це WIP.