https://github.com/hoangtien2k3/saga-pattern-microservice

Demo - Saga Pattern Microservice Spring Boot 3
https://github.com/hoangtien2k3/saga-pattern-microservice

microservices-architecture saga-pattern spring-boot-3

Last synced: about 1 year ago
JSON representation

Demo - Saga Pattern Microservice Spring Boot 3

Host: GitHub
URL: https://github.com/hoangtien2k3/saga-pattern-microservice
Owner: hoangtien2k3
License: mit
Created: 2024-04-27T16:36:32.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2024-07-26T04:56:16.000Z (almost 2 years ago)
Last Synced: 2025-03-25T00:17:03.730Z (about 1 year ago)
Topics: microservices-architecture, saga-pattern, spring-boot-3
Language: Java
Homepage:
Size: 274 KB
Stars: 6
Watchers: 1
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 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`

![1](1.png)

## Choreography in SAGA Pattern

![2](2.png)

## Orchestration-based saga

![3](3.png)

## Prerequisites

- `Java 17`
- `Docker`
- `Docker-run`
- `Docker-compose`

## Structure 'Order-Service' Demo

```text
├── pom.xml
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com
│   │   │   └── hoangtien2k3
│   │   │   └── orderservice
│   │   │   ├── OrderServiceApplication.java
│   │   │   ├── api
│   │   │   │   └── OrderController.java
│   │   │   ├── domain
│   │   │   │   ├── OrderRequest.java
│   │   │   │   ├── OrderUseCase.java
│   │   │   │   ├── PlacedOrderEvent.java
│   │   │   │   ├── entity
│   │   │   │   │   ├── Order.java
│   │   │   │   │   └── OrderStatus.java
│   │   │   │   └── port
│   │   │   │   ├── EventHandlerPort.java
│   │   │   │   ├── OrderRepositoryPort.java
│   │   │   │   └── OrderUseCasePort.java
│   │   │   └── infrastructure
│   │   │   ├── config
│   │   │   │   └── JacksonMapperConfig.java
│   │   │   ├── message
│   │   │   │   ├── EventHandlerAdapter.java
│   │   │   │   ├── log
│   │   │   │   │   ├── MessageLog.java
│   │   │   │   │   └── MessageLogRepository.java
│   │   │   │   └── outbox
│   │   │   │   ├── OutBox.java
│   │   │   │   └── OutBoxRepository.java
│   │   │   └── repository
│   │   │   ├── OrderEntity.java
│   │   │   ├── OrderJpaRepository.java
│   │   │   └── OrderRepositoryAdapter.java
│   │   └── resources
│   │   └── application.yml
```

## Get Started

### Setup environment

```shell
## docker run
docker run --name postgres -p 5434:5432 -e POSTGRES_PASSWORD=12042003 -d postgres:16
```

```shell
## docker compose
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

This project is licensed under the [MIT License](./LICENSE)

## Contributors ✨

_{Hoàng Anh Tiến}
💻 🚧 🤔 🎨 🐛

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/hoangtien2k3/saga-pattern-microservice

Awesome Lists containing this project

README