gecho-starter
gecho-starter is a boilerplate for writing services in Golang quicker out the gates.
Foreword
This is my first attempt to write non-trivial code in this architecture style in Golang, so feedback is both greatly welcomed and desired.
The architecture used for this boilerplate is more or less derived from Clean Architecture and similar patterns such as Onion Architecture, and Hexagonal Architecture but is not strictly following any one pattern.
It attempts to strike a balance between being just wet enough to bring seperation but DRY enough to not make you catch a cold.
Architecture & Structure
In keeping with Clean Architecture, there are four layers
- External Interfaces (/http via Echo, /repository)
- Controllers (/http/controller)
- Use Cases (/interactor)
- Entities (/entity)
If you get Clean Architecture, this pattern should be pretty similar and easy to follow. Things like like inward dependencies only (layers can reach can reach in but never out) all hold true.
Various notes on implementation:
- Entities, or the domain, are just structs. They describe our data in it's pure form and how we interact with it in Golang.
- Interactors should be using entities, keeping it interface agnostic.
- Repositories should be using entities too for actual data. Control entities needed such as limit or cursot are just implemented as parameters on the function.
- Interactors are responsible for validation of data and proper default setting in addition to the logic.
- Controllers are thin. In our case they just convert data to/from the interface.
- Echo is our "http" interface in this example, which has a
main.gofile for running/starting that interface. - Error handling is centralized at the interface level so errors can be customized to the specific interface. This means everything should return both value and error and bubble up on error.
Running It
If you would like to run it make sure to populate a .env file with your database settings, reference .template_env for the naming.
To run the HTTP interface (Echo):
go run http/main.go
To run the unit tests with coverage:
go test -v ./... -race -covermode=atomic -coverprofile=coverage.out
Special Thanks
Special thanks to the "dev" community (ya'll know who you are) for helping me understand many of these concepts and providing feedback.
