saga-pattern-microservices - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #typescript #golang #machine-learning #deep-learning #docker #nodejs #windows #kubernetes #vue #security #mcp #openai

saga-pattern-microservices

(★ 156)

Demo saga pattern, outbox pattern using Spring Boot, Debezium, Kafka, Kafka Connect

File Explorer

Download Latest Version (.zip)

- config.yml
- dependabot.yml
- - maven-wrapper.jar
  - maven-wrapper.properties
  - MavenWrapperDownloader.java
- pom.xml
- banner.jpg
- pom.xml
- pom.xml
- pom.xml
.gitignore
compose.yml
delete-connectors.sh
LICENSE
mvnw
mvnw.cmd
outbox_customer_connector.json
outbox_inventory_connector.json
outbox_order_connector.json
pom.xml
README.md
register-connectors.sh

# Installation Guide

1. Get the code

git clone https://github.com/uuhnaut69/saga-pattern-microservices

Downloads the entire project code from GitHub to your computer.

cd saga-pattern-microservices

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

export PLATFORM=linux/amd64 && docker-compose up -d

Runs the command against the services defined in the compose file.

export PLATFORM=linux/arm64 && docker-compose up -d

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

cd api-gateway

This project's files live in a subfolder, so move into it first.

mvn clean install

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Saga Pattern Microservices

![CircleCI](https://img.shields.io/circleci/build/github/uuhnaut69/saga-pattern-microservices/master?color=green&logo=circleci&style=for-the-badge)
![Maven Central](https://img.shields.io/maven-central/v/org.springframework.boot/spring-boot-starter-parent?color=green&label=spring-boot&logo=spring-boot&style=for-the-badge)
![Docker Image Version (tag latest semver)](https://img.shields.io/docker/v/confluentinc/cp-kafka/7.5.0?color=green&label=confluent&logo=apache-kafka&logoColor=green&style=for-the-badge)

Simple order flow to demo some concepts:

- Microservices using `Spring Boot`, `Spring Cloud`, `Spring Cloud Stream`
- Database per service using `Postgresql`
- Saga Pattern (Saga Orchestration): Distributed transaction span multiple services.
- Outbox Pattern: Avoid dual-writes, no 2PC required using `Kafka`,`Kafka Connect`, `Debezium`
  , `Outbox Event Router`

![Banner](https://raw.githubusercontent.com/uuhnaut69/saga-pattern-microservices/master/assets/banner.jpg)

## Prerequisites

- `Java 21`
- `Docker`
- `Docker-compose`

## Get Started

### Setup environment

#### AMD

```shell
export PLATFORM=linux/amd64 && docker-compose up -d
```
#### ARM

```shell
export PLATFORM=linux/arm64 && docker-compose up -d
```

### Build projects

```shell
./mvnw clean package -DskipTests=true
```

### Start Services

Run services `api-gateway`, `order-service`, `customer-service`, `inventory-service`

```shell
./mvnw -f api-gateway/pom.xml spring-boot:run
```

```shell
./mvnw -f order-service/pom.xml spring-boot:run
```

```shell
./mvnw -f customer-service/pom.xml spring-boot:run
```

```shell
./mvnw -f inventory-service/pom.xml spring-boot:run
```

| Service's name    | Endpoint       |
| ----------------- | -------------- |
| Api Gateway       | localhost:8080 |
| Order service     | localhost:9090 |
| Customer service  | localhost:9091 |
| Inventory service | localhost:9093 |

### Start outbox connectors

Create outbox connectors

```shell
sh register-connectors.sh
```

### Clean Up

Delete all connectors

```shell
sh delete-connectors.sh
```

### Useful commands

Create new customer

```shell
curl --location 'localhost:8080/customer-service/customers' \
--header 'Content-Type: application/json' \
--data '{
    "username": "usertest",
    "fullName": "Test user 1",
    "balance": 100
}'
```

Create new product

```shell
curl --location 'localhost:8080/inventory-service/products' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Test product 1",
    "stocks": 10
}'
```

Create new order

```shell
curl --location 'localhost:8080/order-service/orders' \
--header 'Content-Type: application/json' \
--data '{
    "customerId": "f0a000ad-ea44-4fa1-853b-207f9d9abe2c",
    "productId": "d212c9d6-da3b-4fe2-b016-a852c8a8d32f",
    "quantity": 1,
    "price": 2
}'
```

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT](./LICENSE)