go-clean-arch README

The project's README from github.com/bxcodec/go-clean-arch. As one markdown file: README.md.

go-clean-arch

Changelog

Author's Note

You may notice it diverges from the structures seen in previous versions. I encourage you to explore the branches for each version to select the structure that appeals to you the most. In my recent projects, the code structure has progressed to version 4. However, I do not strictly advocate for one version over another. You may encounter alternative examples on the internet that align more closely with your preferences. Rest assured, the foundational concept will remain consistent or at least bear resemblance. The differences are primarily in the arrangement of directories or the integration of advanced tools directly into the setup.

Description

This is an example of implementation of Clean Architecture in Go (Golang) projects.

Rule of Clean Architecture by Uncle Bob

More at https://8thlight.com/blog/uncle-bob/2012/08/13/the-clean-architecture.html

This project has 4 Domain layer :

The diagram:

golang clean architecture

The original explanation about this project's structure can read from this medium's post : https://medium.com/@imantumorang/golang-clean-archithecture-efd6d7c43047. It may be different already, but the concept still the same in application level, also you can see the change log from v1 to current version in Master.

How To Run This Project

Make Sure you have run the article.sql in your mysql

Since the project is already use Go Module, I recommend to put the source code in any folder but GOPATH.

Run the Testing

$ make tests

Run the Applications

Here is the steps to run it with docker-compose

#move to directory
$ cd workspace

# Clone into your workspace
$ git clone https://github.com/bxcodec/go-clean-arch.git

#move to project
$ cd go-clean-arch

# copy the example.env to .env
$ cp example.env .env

# Run the application
$ make up

# The hot reload will running

# Execute the call in another terminal
$ curl localhost:9090/articles

Tools Used:

In this project, I use some tools listed below. But you can use any similar library that have the same purposes. But, well, different library will have different implementation type. Just be creative and use anything that you really need.

go-clean-arch (bxcodec/go-clean-arch)

Searching Database…

Что это такое?Референсная реализация Чистой архитектуры дяди Боба на Go — пример проекта, показывающий, как структурировать настоящий бэкенд в виде многослойного кода, независимого от фреймворков.
Это фреймворк или библиотека, которую я могу импортировать?Ни то, ни другое — это полноценный пример проекта, который вы клонируете, читаете и адаптируете как шаблон для своих сервисов, а не пакет, который добавляется в go.mod.
Как его запустить?Сначала загрузите article.sql в базу данных MySQL, держите исходники вне GOPATH, так как проект использует Go modules, затем запустите его напрямую или по шагам docker-compose из README.
Что мне нужно установить?Нужны Go и экземпляр MySQL; Docker с docker-compose предлагается как альтернативный способ запуска, а утилита mockery генерирует моки, используемые в тестах.
Структура в ветке master — та, на которую мне ориентироваться?В master лежит v4, и её структура отличается от v1–v3; автор сохраняет нейтралитет — он советует изучить ветку каждой версии и выбрать ту структуру, которая вам больше нравится.
Это для обучения или для продакшена?Для обучения и в качестве отправной точки — сам код и есть главный результат, а README ссылается на статьи автора на Medium с полным объяснением архитектуры.
Что за четыре слоя?Models, Repository, Usecase и Delivery. Смысл разделения в том, что бизнес-правила остаются независимыми от фреймворков, интерфейса, базы данных и любых внешних систем.
Он привязывает меня к MySQL?Нет — независимость от базы данных входит в основные правила. MySQL просто использована в демо; идея в том, что её можно заменить на Mongo, CouchDB или что угодно ещё, не трогая бизнес-правила.
Что делает демо-приложение?Это демо раздачи статей: article.sql создаёт схему в MySQL, а запросы проходят через четыре слоя для управления статьями.
Creator
bxcodec
Size
0.4 MB
Stars
10.2K
Age
9y
Commits · 90 Days