Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 10.6 KB

readme.md

File metadata and controls

115 lines (83 loc) · 10.6 KB
Raw

🧺 Store Golang Microservices Sample

CI Go Report Card Go Version Gitpod ready-to-code

A practical store sample, built with Golang and different software architecture and technologies like Microservices Architecture, Vertical Slice Architecture , CQRS Pattern, Domain Driven Design (DDD), Event Sourcing, Event Driven Architecture. For communication between independent services, We use asynchronous messaging with using RabbitMQ, and sometimes we use synchronous communication for real-time communications with using REST and gRPC calls.

💡 This application is not business oriented and my focus is mostly on technical part, I just want to implement a sample with using different technologies, software architecture design, principles and all the thing we need for creating a microservices app.

🌀 This Application is in-progress and I will add new features and thecnologies over time.

Features

  • ✅ Using Vertical Slice Architecture as a high level architecture
  • ✅ Using Event Driven Architecture on top of RabbitMQ Message Broker with a custom Event Bus
  • ✅ Using Data Centeric Architecture based on CRUD in Catalogs Read Service
  • ✅ Using Event Sourcing in Audit Based services like Orders Service
  • ✅ Using CQRS Pattern and Mediator Patternon top of Go-MediatR library
  • ✅ Using RESTFul api with Echo framework and using swagger with swaggo/swag library
  • ✅ Using gRpc for internal service communication
  • ✅ Using go-playground/validator for validating input data in the REST and gRpc
  • ✅ Using Postgres and EventStoreDB for write databases as relational DB and MongoDB and Elasric Search for read databases
  • ✅ Using OpenTelemetry for collection Metrics and Distributed Tracing
  • ✅ Using docker and docker-compose for deployment

Roadmap

  • 🚧 Add Dependecny Injections with using uber-go/fx
  • 🚧 Using Domain Driven Design in some of services like Catalogs Write Service
  • 🚧 Using Helm and Kubernetes for deployment
  • 🚧 Add Identity Management and OAuth

Technologies - Libraries

System Architecture

Application Structure

In this project I used vertical slice architecture or Restructuring to a Vertical Slice Architecture also I used feature folder structure in this project.

  • We treat each request as a distinct use case or slice, encapsulating and grouping all concerns from front-end to back.
  • When We adding or changing a feature in an application in n-tire architecture, we are typically touching many different "layers" in an application. we are changing the user interface, adding fields to models, modifying validation, and so on. Instead of coupling across a layer, we couple vertically along a slice and each change affects only one slice.
  • We Minimize coupling between slices, and maximize coupling in a slice.
  • With this approach, each of our vertical slices can decide for itself how to best fulfill the request. New features only add code, we're not changing shared code and worrying about side effects. For implementing vertical slice architecture using cqrs pattern is a good match.

Also here I used CQRS for decompose my features to very small parts that makes our application:

  • maximize performance, scalability and simplicity.
  • adding new feature to this mechanism is very easy without any breaking change in other part of our codes. New features only add code, we're not changing shared code and worrying about side effects.
  • easy to maintain and any changes only affect on one command or query (or a slice) and avoid any breaking changes on other parts
  • it gives us better separation of concerns and cross cutting concern (with help of MediatR behavior pipelines) in our code instead of a big service class for doing a lot of things.

With using CQRS, our code will be more aligned with SOLID principles, especially with:

  • Single Responsibility rule - because logic responsible for a given operation is enclosed in its own type.
  • Open-Closed rule - because to add new operation you don’t need to edit any of the existing types, instead you need to add a new file with a new type representing that operation.

Here instead of some Technical Splitting for example a folder or layer for our services, controllers and data models which increase dependencies between our technical splitting and also jump between layers or folders, We cut each business functionality into some vertical slices, and inner each of these slices we have Technical Folders Structure specific to that feature (command, handlers, infrastructure, repository, controllers, data models, ...).

Usually, when we work on a given functionality we need some technical things for example:

  • API endpoint (Controller)
  • Request Input (Dto)
  • Request Output (Dto)
  • Some class to handle Request, For example Command and Command Handler or Query and Query Handler
  • Data Model

Now we could all of these things beside each other and it decrease jumping and dependencies between some layers or folders.

Keeping such a split works great with CQRS. It segregates our operations and slices the application code vertically instead of horizontally. In Our CQRS pattern each command/query handler is a separate slice. This is where you can reduce coupling between layers. Each handler can be a separated code unit, even copy/pasted. Thanks to that, we can tune down the specific method to not follow general conventions (e.g. use custom SQL query or even different storage). In a traditional layered architecture, when we change the core generic mechanism in one layer, it can impact all methods.

Catalogs Service Structure

High Level Structure

References